Skip to content

Commit

Permalink
Doc v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
treyssede committed Feb 6, 2024
1 parent 47269ec commit 256bd1a
Show file tree
Hide file tree
Showing 2 changed files with 2,001 additions and 0 deletions.
174 changes: 174 additions & 0 deletions docs/documentation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation &mdash; waveguicsx 1.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="waveguicsx.waveguide" href="waveguicsx.html" />
<link rel="prev" title="Presentation" href="readme_link.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/logo_doc.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="readme_link.html">Presentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#introduction">0. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#basic-examples">1. Basic examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#prerequisites">2. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#installation">3. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#documentation">4. Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#tutorials">5. Tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#authors-and-contributors">6. Authors and contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#how-to-cite">7. How to cite</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme_link.html#license">8. License</a></li>
</ul>
</li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#d-elastic-bar-of-square-cross-section">3D elastic bar of square cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#d-elastic-bar-of-square-cross-section-with-parallelization">3D elastic bar of square cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium">3D elastic bar of square cross-section buried into a PML external medium</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium-using-gmsh">3D elastic bar of square cross-section buried into a PML external medium using gmsh</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section">Excitation of a 3D elastic bar of circular cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section-with-parallelization">Excitation of a 3D elastic bar of circular cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#time-response-of-a-plate-excited-near-its-first-zgv-resonance">Time response of a plate excited near its first ZGV resonance</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorials.html#dispersion-curves-of-a-rail">Dispersion curves of a rail</a></li>
</ul>
</li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">waveguicsx</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/documentation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide"><code class="docutils literal notranslate"><span class="pre">Waveguide</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.set_parameters"><code class="docutils literal notranslate"><span class="pre">Waveguide.set_parameters()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.solve"><code class="docutils literal notranslate"><span class="pre">Waveguide.solve()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_eigenforces"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_eigenforces()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_poynting_normalization"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_poynting_normalization()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_energy_velocity"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_energy_velocity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_opposite_going"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_opposite_going()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_group_velocity"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_group_velocity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_traveling_direction"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_traveling_direction()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_pml_ratio"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_pml_ratio()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_response_coefficient"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_response_coefficient()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.compute_response"><code class="docutils literal notranslate"><span class="pre">Waveguide.compute_response()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_phase_velocity"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_phase_velocity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_attenuation"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_attenuation()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_energy_velocity"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_energy_velocity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_group_velocity"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_group_velocity()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_coefficient"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_coefficient()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_excitability"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_excitability()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.set_plot_scaler"><code class="docutils literal notranslate"><span class="pre">Waveguide.set_plot_scaler()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.plot_spectrum"><code class="docutils literal notranslate"><span class="pre">Waveguide.plot_spectrum()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal"><code class="docutils literal notranslate"><span class="pre">Signal</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.fft"><code class="docutils literal notranslate"><span class="pre">Signal.fft()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.ifft"><code class="docutils literal notranslate"><span class="pre">Signal.ifft()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.ricker"><code class="docutils literal notranslate"><span class="pre">Signal.ricker()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.toneburst"><code class="docutils literal notranslate"><span class="pre">Signal.toneburst()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.chirp"><code class="docutils literal notranslate"><span class="pre">Signal.chirp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.plot"><code class="docutils literal notranslate"><span class="pre">Signal.plot()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.plot_spectrum"><code class="docutils literal notranslate"><span class="pre">Signal.plot_spectrum()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="readme_link.html" class="btn btn-neutral float-left" title="Presentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="waveguicsx.html" class="btn btn-neutral float-right" title="waveguicsx.waveguide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023-2024, Fabien Treyssede.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 256bd1a

Please sign in to comment.