jan/meanas
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Publish docs for local build

Browse source
This commit is contained in:
Forgejo Actions 2026-04-19 00:50:40 -07:00
commit e7cd1f4d50
5 changed files with 161 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

3
api/meanas/index.html
View file

@ -630,7 +630,8 @@
<div class="doc doc-contents first">
<p>Electromagnetic simulation tools</p>
<p>See the readme or <code>import meanas; help(meanas)</code> for more info.</p>
<p>See the tracked examples for end-to-end workflows, and <code>help(meanas)</code> for the
toolbox overview and API derivations.</p>

30
index.html
View file

@ -284,10 +284,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#recommended-starting-points" class="md-nav__link">
<a href="#examples-and-api-map" class="md-nav__link">
<span class="md-ellipsis">
Recommended starting points
Examples and API Map
</span>
</a>
@ -594,10 +594,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#recommended-starting-points" class="md-nav__link">
<a href="#examples-and-api-map" class="md-nav__link">
<span class="md-ellipsis">
Recommended starting points
Examples and API Map
</span>
</a>
@ -643,16 +643,20 @@ It combines:</p>
<p>This documentation is built directly from the package docstrings. The API pages
are the source of truth for the mathematical derivations and calling
conventions.</p>
<h2 id="recommended-starting-points">Recommended starting points<a class="headerlink" href="#recommended-starting-points" title="Permanent link">&para;</a></h2>
<h2 id="examples-and-api-map">Examples and API Map<a class="headerlink" href="#examples-and-api-map" title="Permanent link">&para;</a></h2>
<p>For most users, the tracked examples under <code>examples/</code> are the right entry
point. They show the intended combinations of tools for solving complete
problems.</p>
<p>The API pages are better read as a toolbox map and derivation reference:</p>
<ul>
<li>Use the <a href="api/fdtd/">FDTD API</a> when you need time-domain stepping, CPML, or
phasor extraction.</li>
<li>Use the <a href="api/fdfd/">FDFD API</a> when you need driven frequency-domain solves
or operator algebra.</li>
<li>Use the <a href="api/waveguides/">Waveguide API</a> for mode solving, port sources, and
overlap windows.</li>
<li>Use the <a href="api/fdmath/">fdmath API</a> when you need the lower-level finite-difference
operators or the derivation background shared across the package.</li>
<li>Use the <a href="api/fdtd/">FDTD API</a> for time-domain stepping, CPML, and phasor
extraction.</li>
<li>Use the <a href="api/fdfd/">FDFD API</a> for driven frequency-domain solves and sparse
operator algebra.</li>
<li>Use the <a href="api/waveguides/">Waveguide API</a> for mode solving, port sources,
and overlap windows.</li>
<li>Use the <a href="api/fdmath/">fdmath API</a> for the lower-level finite-difference
operators and the shared discrete derivations underneath both solvers.</li>
</ul>
<h2 id="build-outputs">Build outputs<a class="headerlink" href="#build-outputs" title="Permanent link">&para;</a></h2>
<p>The docs build generates two HTML views from the same source:</p>

135
print_page/index.html
View file

@ -667,16 +667,20 @@ It combines:</p>
<p>This documentation is built directly from the package docstrings. The API pages
are the source of truth for the mathematical derivations and calling
conventions.</p>
<h2 id="index-recommended-starting-points">Recommended starting points<a class="headerlink" href="#index-recommended-starting-points" title="Permanent link">&para;</a></h2>
<h2 id="index-examples-and-api-map">Examples and API Map<a class="headerlink" href="#index-examples-and-api-map" title="Permanent link">&para;</a></h2>
<p>For most users, the tracked examples under <code>examples/</code> are the right entry
point. They show the intended combinations of tools for solving complete
problems.</p>
<p>The API pages are better read as a toolbox map and derivation reference:</p>
<ul>
<li>Use the <a href="#api-fdtd">FDTD API</a> when you need time-domain stepping, CPML, or
phasor extraction.</li>
<li>Use the <a href="#api-fdfd">FDFD API</a> when you need driven frequency-domain solves
or operator algebra.</li>
<li>Use the <a href="#api-waveguides">Waveguide API</a> for mode solving, port sources, and
overlap windows.</li>
<li>Use the <a href="#api-fdmath">fdmath API</a> when you need the lower-level finite-difference
operators or the derivation background shared across the package.</li>
<li>Use the <a href="#api-fdtd">FDTD API</a> for time-domain stepping, CPML, and phasor
extraction.</li>
<li>Use the <a href="#api-fdfd">FDFD API</a> for driven frequency-domain solves and sparse
operator algebra.</li>
<li>Use the <a href="#api-waveguides">Waveguide API</a> for mode solving, port sources,
and overlap windows.</li>
<li>Use the <a href="#api-fdmath">fdmath API</a> for the lower-level finite-difference
operators and the shared discrete derivations underneath both solvers.</li>
</ul>
<h2 id="index-build-outputs">Build outputs<a class="headerlink" href="#index-build-outputs" title="Permanent link">&para;</a></h2>
<p>The docs build generates two HTML views from the same source:</p>
@ -717,7 +721,8 @@ mathematical derivations rather than just the callable reference.</p></section><
<div class="doc doc-contents first">
<p>Electromagnetic simulation tools</p>
<p>See the readme or <code>import meanas; help(meanas)</code> for more info.</p>
<p>See the tracked examples for end-to-end workflows, and <code>help(meanas)</code> for the
toolbox overview and API derivations.</p>
@ -850,7 +855,7 @@ mathematical derivations rather than just the callable reference.</p></section><
<code>iterations</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -963,7 +968,7 @@ mathematical derivations rather than just the callable reference.</p></section><
<code>iterations</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -1095,7 +1100,7 @@ mathematical derivations rather than just the callable reference.</p></section><
<code>how_many</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -1597,7 +1602,7 @@ See <code>operators.eh_full</code>.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>], <a class="autorefs autorefs-internal" href="#tuple">tuple</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>, <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>], <a class="autorefs autorefs-internal" href="#tuple">tuple</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>, <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]]</code>
</td>
<td>
<div class="doc-md-description">
@ -1607,7 +1612,7 @@ See <code>operators.eh_full</code>.</p>
</tr>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>], <a class="autorefs autorefs-internal" href="#tuple">tuple</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>, <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>], <a class="autorefs autorefs-internal" href="#tuple">tuple</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>, <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]]</code>
</td>
<td>
<div class="doc-md-description">
@ -2164,7 +2169,7 @@ instead.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>], <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>], <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -2174,7 +2179,7 @@ instead.</p>
</tr>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a>], <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Callable" href="#collections.abc.Callable">Callable</a>[[<a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>, <a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a>], <a class="autorefs autorefs-internal" title="meanas.fdmath.cfdfield_t" href="#meanas.fdmath.cfdfield_t">cfdfield_t</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -4219,7 +4224,7 @@ customize the PML parameters.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -4235,7 +4240,7 @@ customize the PML parameters.</p>
<code>thicknesses</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -4321,7 +4326,7 @@ customize the PML parameters.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
</td>
<td>
<div class="doc-md-description">
@ -4377,7 +4382,7 @@ customize the PML parameters.</p>
<code>dxes</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
</td>
<td>
<div class="doc-md-description">
@ -4393,7 +4398,7 @@ customize the PML parameters.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -4409,7 +4414,7 @@ customize the PML parameters.</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -4458,7 +4463,7 @@ customize the PML parameters.</p>
<code>thickness</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -4506,7 +4511,7 @@ customize the PML parameters.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
</td>
<td>
<div class="doc-md-description">
@ -4516,7 +4521,7 @@ customize the PML parameters.</p>
</tr>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="numpy.typing.NDArray" href="#numpy.typing.NDArray">NDArray</a>[<a class="autorefs autorefs-internal" title="numpy.float64" href="#numpy.float64">float64</a>]]]</code>
</td>
<td>
<div class="doc-md-description">
@ -4680,7 +4685,7 @@ customize the PML parameters.</p>
<code>padded_size</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>] | <a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a> | None</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>] | <a class="autorefs autorefs-internal" href="#print-site-page">int</a> | None</code>
</td>
<td>
<div class="doc-md-description">
@ -4911,7 +4916,7 @@ customize the PML parameters.</p>
<code>padded_size</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>] | <a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a> | None</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>] | <a class="autorefs autorefs-internal" href="#print-site-page">int</a> | None</code>
</td>
<td>
<div class="doc-md-description">
@ -7509,7 +7514,7 @@ elementwise multiplications <span class="arithmatex">\(\vec{sens} = \vec{v}_{lef
<code>mode_numbers</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -7594,7 +7599,7 @@ elementwise multiplications <span class="arithmatex">\(\vec{sens} = \vec{v}_{lef
<code>mode_margin</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -7682,7 +7687,7 @@ elementwise multiplications <span class="arithmatex">\(\vec{sens} = \vec{v}_{lef
<code>mode_number</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8035,7 +8040,7 @@ solve for an eigenmode propagating through that slice.</p>
<code>mode_number</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8088,7 +8093,7 @@ solve for an eigenmode propagating through that slice.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8104,7 +8109,7 @@ solve for an eigenmode propagating through that slice.</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8120,7 +8125,7 @@ solve for an eigenmode propagating through that slice.</p>
<code>slices</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.vfdslice">slice</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.cfdslice">slice</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -8293,7 +8298,7 @@ necessary to position a unidirectional source at the slice location.</p>
<code>E</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a></code>
<code><a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8362,7 +8367,7 @@ necessary to position a unidirectional source at the slice location.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8378,7 +8383,7 @@ necessary to position a unidirectional source at the slice location.</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8394,7 +8399,7 @@ necessary to position a unidirectional source at the slice location.</p>
<code>slices</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.vfdslice">slice</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.cfdslice">slice</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -8581,7 +8586,7 @@ B/wu (Ex Emx + Ey Emy) - j/wu (Ex dx Emz + Ey dy Emz)</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8597,7 +8602,7 @@ B/wu (Ex Emx + Ey Emy) - j/wu (Ex dx Emz + Ey dy Emz)</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8613,7 +8618,7 @@ B/wu (Ex Emx + Ey Emy) - j/wu (Ex dx Emz + Ey dy Emz)</p>
<code>slices</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.vfdslice">slice</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.cfdslice">slice</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -8709,7 +8714,7 @@ where it is valid.</p>
<code>E</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield">cfdfield</a></code>
<code><a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="#api-fdmath-meanas.fdmath.types.cfdfield2">cfdfield</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8762,7 +8767,7 @@ where it is valid.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8778,7 +8783,7 @@ where it is valid.</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -8794,7 +8799,7 @@ where it is valid.</p>
<code>slices</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.vfdslice">slice</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.cfdslice">slice</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -9339,7 +9344,7 @@ the fields, with <code>beta = angular_wavenumber / rmin</code>).</p>
<code>mode_number</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -9452,7 +9457,7 @@ the fields, with <code>beta = angular_wavenumber / rmin</code>).</p>
<code>e_xys</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.vcfdfield2_t" href="#meanas.fdmath.vcfdfield2_t">vcfdfield2_t</a>]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="meanas.fdmath.vcfdfield2_t" href="#meanas.fdmath.vcfdfield2_t">vcfdfield2_t</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -10948,7 +10953,7 @@ with <code>None</code>.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -10964,7 +10969,7 @@ with <code>None</code>.</p>
<code>polarity</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -10997,7 +11002,7 @@ with <code>None</code>.</p>
<code>thickness</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -13983,7 +13988,7 @@ normalized results are needed.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -13999,7 +14004,7 @@ normalized results are needed.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -14015,7 +14020,7 @@ normalized results are needed.</p>
<code>shift_distance</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -14092,7 +14097,7 @@ boundary conditions applied to the cells beyond the receding edge.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -14108,7 +14113,7 @@ boundary conditions applied to the cells beyond the receding edge.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -14124,7 +14129,7 @@ boundary conditions applied to the cells beyond the receding edge.</p>
<code>shift_distance</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -14227,7 +14232,7 @@ boundary conditions applied to the cells beyond the receding edge.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="scipy.sparse.sparray" href="#scipy.sparse.sparray">sparray</a>]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="scipy.sparse.sparray" href="#scipy.sparse.sparray">sparray</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -14304,7 +14309,7 @@ boundary conditions applied to the cells beyond the receding edge.</p>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_mut">list</a>[<a class="autorefs autorefs-internal" title="scipy.sparse.sparray" href="#scipy.sparse.sparray">sparray</a>]</code>
<code><a class="autorefs autorefs-internal" href="#api-fdmath-meanas.fdmath.types.dx_lists_t">list</a>[<a class="autorefs autorefs-internal" title="scipy.sparse.sparray" href="#scipy.sparse.sparray">sparray</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -14483,7 +14488,7 @@ portions of the operator on the left side of the cross product.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -14499,7 +14504,7 @@ portions of the operator on the left side of the cross product.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -14573,7 +14578,7 @@ portions of the operator on the left side of the cross product.</p>
<code>axis</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">
@ -14589,7 +14594,7 @@ portions of the operator on the left side of the cross product.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -15030,7 +15035,7 @@ Vectorized versions of the field use row-major (ie., C-style) ordering.</p>
<code>shape</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a>]</code>
<code><a class="autorefs autorefs-internal" title="collections.abc.Sequence" href="#collections.abc.Sequence">Sequence</a>[<a class="autorefs autorefs-internal" href="#print-site-page">int</a>]</code>
</td>
<td>
<div class="doc-md-description">
@ -15046,7 +15051,7 @@ Vectorized versions of the field use row-major (ie., C-style) ordering.</p>
<code>nvdim</code>
</td>
<td>
<code><a class="autorefs autorefs-internal" href="#index-recommended-starting-points">int</a></code>
<code><a class="autorefs autorefs-internal" href="#print-site-page">int</a></code>
</td>
<td>
<div class="doc-md-description">

2
search/search_index.json
View file

File diff suppressed because one or more lines are too long

137
standalone.html
View file

File diff suppressed because one or more lines are too long