Publish docs for local build

This commit is contained in:
Forgejo Actions 2026-04-21 21:20:52 -07:00
commit 4c39fa6ae7
8 changed files with 381 additions and 390 deletions

View file

@ -4782,11 +4782,11 @@ customize the PML parameters.</p>
<a href="#meanas.fdfd.farfield.near_to_farfield" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdfd.farfield.near_to_farfield" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">near_to_farfield</span><span class="p">(</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">near_to_farfield</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E_near</span><span class="p">:</span> <span class="n">cfdfield_t</span><span class="p">,</span> <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E_near</span><span class="p">:</span> <span class="n">transverse_slice_pair</span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">H_near</span><span class="p">:</span> <span class="n">cfdfield_t</span><span class="p">,</span> <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">H_near</span><span class="p">:</span> <span class="n">transverse_slice_pair</span><span class="p">,</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dx</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dx</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dy</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dy</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">padded_size</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">padded_size</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
</code></pre></div> </code></pre></div>
@ -4813,7 +4813,7 @@ customize the PML parameters.</p>
<code>E_near</code> <code>E_near</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.cfdfield_t">cfdfield_t</span></code> <code><span title="meanas.fdfd.farfield.transverse_slice_pair">transverse_slice_pair</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4830,7 +4830,7 @@ customize the PML parameters.</p>
<code>H_near</code> <code>H_near</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.cfdfield_t">cfdfield_t</span></code> <code><span title="meanas.fdfd.farfield.transverse_slice_pair">transverse_slice_pair</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4879,7 +4879,7 @@ customize the PML parameters.</p>
<code>padded_size</code> <code>padded_size</code>
</td> </td>
<td> <td>
<code><span title="list">list</span>[<span title="int">int</span>] | <span title="int">int</span> | None</code> <code><span title="collections.abc.Sequence">Sequence</span>[<span title="int">int</span>] | <span title="int">int</span> | None</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -5009,11 +5009,11 @@ customize the PML parameters.</p>
<a href="#meanas.fdfd.farfield.far_to_nearfield" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdfd.farfield.far_to_nearfield" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">far_to_nearfield</span><span class="p">(</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">far_to_nearfield</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E_far</span><span class="p">:</span> <span class="n">cfdfield_t</span><span class="p">,</span> <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E_far</span><span class="p">:</span> <span class="n">transverse_slice_pair</span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">H_far</span><span class="p">:</span> <span class="n">cfdfield_t</span><span class="p">,</span> <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">H_far</span><span class="p">:</span> <span class="n">transverse_slice_pair</span><span class="p">,</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dkx</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dkx</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dky</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dky</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">padded_size</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">padded_size</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
</code></pre></div> </code></pre></div>
@ -5040,7 +5040,7 @@ customize the PML parameters.</p>
<code>E_far</code> <code>E_far</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.cfdfield_t">cfdfield_t</span></code> <code><span title="meanas.fdfd.farfield.transverse_slice_pair">transverse_slice_pair</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -5059,7 +5059,7 @@ customize the PML parameters.</p>
<code>H_far</code> <code>H_far</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.cfdfield_t">cfdfield_t</span></code> <code><span title="meanas.fdfd.farfield.transverse_slice_pair">transverse_slice_pair</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -5110,7 +5110,7 @@ customize the PML parameters.</p>
<code>padded_size</code> <code>padded_size</code>
</td> </td>
<td> <td>
<code><span title="list">list</span>[<span title="int">int</span>] | <span title="int">int</span> | None</code> <code><span title="collections.abc.Sequence">Sequence</span>[<span title="int">int</span>] | <span title="int">int</span> | None</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">

View file

@ -3493,7 +3493,7 @@ portions of the operator on the left side of the cross product.</p>
<a href="#meanas.fdmath.operators.vec_cross" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdmath.operators.vec_cross" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">vec_cross</span><span class="p">(</span><span class="n">b</span><span class="p">:</span> <span class="n">vfdfield_t</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sparse</span><span class="o">.</span><span class="n">sparray</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">vec_cross</span><span class="p">(</span><span class="n">b</span><span class="p">:</span> <span class="n">vfdfield</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">sparse</span><span class="o">.</span><span class="n">sparray</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
@ -3517,7 +3517,7 @@ portions of the operator on the left side of the cross product.</p>
<code>b</code> <code>b</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.types.vfdfield_t">vfdfield_t</span></code> <code><a class="autorefs autorefs-internal" title=" vfdfield (meanas.fdmath.types.vfdfield)" href="#meanas.fdmath.types.vfdfield">vfdfield</a></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4344,12 +4344,12 @@ Vectorized versions of the field use row-major (ie., C-style) ordering.</p>
</span> </span>
<a href="#meanas.fdmath.types.fdfield_updater_t" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdmath.types.fdfield_updater_t" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">fdfield_updater_t</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">fdfield_t</span><span class="p">]</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">fdfield_updater_t</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">fdfield</span><span class="p">]</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
<p>Convenience type for functions which take and return an fdfield_t</p> <p>Convenience type for functions which take and return a real <code>fdfield</code></p>
</div> </div>
@ -4368,12 +4368,12 @@ Vectorized versions of the field use row-major (ie., C-style) ordering.</p>
</span> </span>
<a href="#meanas.fdmath.types.cfdfield_updater_t" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdmath.types.cfdfield_updater_t" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">cfdfield_updater_t</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">cfdfield_t</span><span class="p">]</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">cfdfield_updater_t</span> <span class="o">=</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">cfdfield</span><span class="p">]</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
<p>Convenience type for functions which take and return an cfdfield_t</p> <p>Convenience type for functions which take and return a complex <code>cfdfield</code></p>
</div> </div>

View file

@ -2315,10 +2315,7 @@ with <code>None</code>.</p>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">fdfield</span><span class="p">,</span> <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">fdfield</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span> <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">*</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">dtype</span><span class="p">:</span> <span class="n">DTypeLike</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span> <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">dtype</span><span class="p">:</span> <span class="n">DTypeLike</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">float32</span><span class="p">,</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span> <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="kc">None</span><span class="p">],</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="kc">None</span><span class="p">]]</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">Callable</span><span class="p">[[</span><span class="n">fdfield_t</span><span class="p">,</span> <span class="n">fdfield_t</span><span class="p">,</span> <span class="n">fdfield_t</span><span class="p">],</span> <span class="kc">None</span><span class="p">],</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="n">Callable</span><span class="p">[[</span><span class="n">fdfield_t</span><span class="p">,</span> <span class="n">fdfield_t</span><span class="p">,</span> <span class="n">fdfield_t</span><span class="p">],</span> <span class="kc">None</span><span class="p">],</span>
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="p">]</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
@ -2439,7 +2436,7 @@ Entries are the dictionaries returned by <code>cpml_params(...)</code>; use
<tbody> <tbody>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None]</code> <code><span title="collections.abc.Callable">Callable</span>[..., None]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -2449,7 +2446,7 @@ Entries are the dictionaries returned by <code>cpml_params(...)</code>; use
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None]</code> <code><span title="collections.abc.Callable">Callable</span>[..., None]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -2459,7 +2456,7 @@ Entries are the dictionaries returned by <code>cpml_params(...)</code>; use
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None], <span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None]]</code> <code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[..., None], <span title="collections.abc.Callable">Callable</span>[..., None]]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -2471,7 +2468,7 @@ Entries are the dictionaries returned by <code>cpml_params(...)</code>; use
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None], <span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None]]</code> <code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[..., None], <span title="collections.abc.Callable">Callable</span>[..., None]]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -2483,7 +2480,7 @@ Entries are the dictionaries returned by <code>cpml_params(...)</code>; use
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None], <span title="collections.abc.Callable">Callable</span>[[<span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>, <span title="meanas.fdmath.fdfield_t">fdfield_t</span>], None]]</code> <code><span title="tuple">tuple</span>[<span title="collections.abc.Callable">Callable</span>[..., None], <span title="collections.abc.Callable">Callable</span>[..., None]]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">

View file

@ -4449,7 +4449,7 @@ overlap window and how the expanded field is phased.</p>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">slices</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">slice</span><span class="p">],</span> <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">slices</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">slice</span><span class="p">],</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">fdfield</span><span class="p">,</span> <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">fdfield</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">mu</span><span class="p">:</span> <span class="n">fdfield</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a> <span class="n">mu</span><span class="p">:</span> <span class="n">fdfield</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">complex</span> <span class="o">|</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">complexfloating</span><span class="p">]]</span> <a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Waveguide3DMode</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
@ -4618,7 +4618,7 @@ as the waveguide cross-section. <code>slices[axis]</code> must select exactly on
<tbody> <tbody>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="dict">dict</span>[<span title="str">str</span>, <span title="complex">complex</span> | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complexfloating">complexfloating</span>]]</code> <code><span title="meanas.fdfd.waveguide_3d.Waveguide3DMode">Waveguide3DMode</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4628,7 +4628,7 @@ as the waveguide cross-section. <code>slices[axis]</code> must select exactly on
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="dict">dict</span>[<span title="str">str</span>, <span title="complex">complex</span> | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complexfloating">complexfloating</span>]]</code> <code><span title="meanas.fdfd.waveguide_3d.Waveguide3DMode">Waveguide3DMode</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4640,7 +4640,7 @@ as the waveguide cross-section. <code>slices[axis]</code> must select exactly on
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="dict">dict</span>[<span title="str">str</span>, <span title="complex">complex</span> | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complexfloating">complexfloating</span>]]</code> <code><span title="meanas.fdfd.waveguide_3d.Waveguide3DMode">Waveguide3DMode</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4652,7 +4652,7 @@ as the waveguide cross-section. <code>slices[axis]</code> must select exactly on
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="dict">dict</span>[<span title="str">str</span>, <span title="complex">complex</span> | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complexfloating">complexfloating</span>]]</code> <code><span title="meanas.fdfd.waveguide_3d.Waveguide3DMode">Waveguide3DMode</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4665,7 +4665,7 @@ propagation axis</li>
</tr> </tr>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="dict">dict</span>[<span title="str">str</span>, <span title="complex">complex</span> | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complexfloating">complexfloating</span>]]</code> <code><span title="meanas.fdfd.waveguide_3d.Waveguide3DMode">Waveguide3DMode</span></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -4909,13 +4909,13 @@ same sign convention used elsewhere in the package:</p>
<a href="#meanas.fdfd.waveguide_3d.compute_overlap_e" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdfd.waveguide_3d.compute_overlap_e" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">compute_overlap_e</span><span class="p">(</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">compute_overlap_e</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E</span><span class="p">:</span> <span class="n">cfdfield_t</span><span class="p">,</span> <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">E</span><span class="p">:</span> <span class="n">cfdfield</span><span class="p">,</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">wavenumber</span><span class="p">:</span> <span class="nb">complex</span><span class="p">,</span> <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">wavenumber</span><span class="p">:</span> <span class="nb">complex</span><span class="p">,</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dxes</span><span class="p">:</span> <span class="n">dx_lists_t</span><span class="p">,</span> <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">dxes</span><span class="p">:</span> <span class="n">dx_lists_t</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">axis</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">axis</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">polarity</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="n">polarity</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">slices</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">slice</span><span class="p">],</span> <a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a> <span class="n">slices</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">slice</span><span class="p">],</span>
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">omega</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="n">_omega</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">cfdfield_t</span> <a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">cfdfield_t</span>
</code></pre></div> </code></pre></div>
@ -4969,7 +4969,7 @@ B/wu (Ex Emx + Ey Emy) - j/wu (Ex dx Emz + Ey dy Emz)</p>
<code>E</code> <code>E</code>
</td> </td>
<td> <td>
<code><span title="meanas.fdmath.cfdfield_t">cfdfield_t</span></code> <code><a class="autorefs autorefs-internal" title=" cfdfield (meanas.fdmath.cfdfield)" href="../fdmath/#meanas.fdmath.types.cfdfield">cfdfield</a></code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -5766,7 +5766,7 @@ r within the simulation domain.</p>
<a href="#meanas.fdfd.waveguide_cyl.solve_mode" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdfd.waveguide_cyl.solve_mode" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">solve_mode</span><span class="p">(</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">solve_mode</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">mode_number</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span> <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">mode_number</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">vcfdslice</span><span class="p">,</span> <span class="nb">complex</span><span class="p">]</span> <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">vcfdfield2</span><span class="p">,</span> <span class="nb">complex</span><span class="p">]</span>
</code></pre></div> </code></pre></div>
<div class="doc doc-contents "> <div class="doc doc-contents ">
@ -5848,7 +5848,7 @@ r within the simulation domain.</p>
<tbody> <tbody>
<tr class="doc-section-item"> <tr class="doc-section-item">
<td> <td>
<code><span title="tuple">tuple</span>[<a class="autorefs autorefs-internal" title=" vcfdslice (meanas.fdmath.vcfdslice)" href="../fdmath/#meanas.fdmath.types.vcfdslice">vcfdslice</a>, <span title="complex">complex</span>]</code> <code><span title="tuple">tuple</span>[<a class="autorefs autorefs-internal" title=" vcfdfield2 (meanas.fdmath.vcfdfield2)" href="../fdmath/#meanas.fdmath.types.vcfdfield2">vcfdfield2</a>, <span title="complex">complex</span>]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">
@ -5873,7 +5873,7 @@ r within the simulation domain.</p>
<a href="#meanas.fdfd.waveguide_cyl.linear_wavenumbers" class="headerlink" title="Permanent link">&para;</a></h3> <a href="#meanas.fdfd.waveguide_cyl.linear_wavenumbers" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">linear_wavenumbers</span><span class="p">(</span> <div class="doc-signature highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">linear_wavenumbers</span><span class="p">(</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">e_xys</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">vcfdfield2_t</span><span class="p">],</span> <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a> <span class="n">e_xys</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">vcfdfield2</span><span class="p">]</span> <span class="o">|</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">complex128</span><span class="p">],</span>
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">angular_wavenumbers</span><span class="p">:</span> <span class="n">ArrayLike</span><span class="p">,</span> <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="n">angular_wavenumbers</span><span class="p">:</span> <span class="n">ArrayLike</span><span class="p">,</span>
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">vfdslice</span><span class="p">,</span> <a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a> <span class="n">epsilon</span><span class="p">:</span> <span class="n">vfdslice</span><span class="p">,</span>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dxes</span><span class="p">:</span> <span class="n">dx_lists2_t</span><span class="p">,</span> <a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a> <span class="n">dxes</span><span class="p">:</span> <span class="n">dx_lists2_t</span><span class="p">,</span>
@ -5903,7 +5903,7 @@ r within the simulation domain.</p>
<code>e_xys</code> <code>e_xys</code>
</td> </td>
<td> <td>
<code><span title="list">list</span>[<span title="meanas.fdmath.vcfdfield2_t">vcfdfield2_t</span>]</code> <code><span title="collections.abc.Sequence">Sequence</span>[<a class="autorefs autorefs-internal" title=" vcfdfield2 (meanas.fdmath.vcfdfield2)" href="../fdmath/#meanas.fdmath.types.vcfdfield2">vcfdfield2</a>] | <span title="numpy.typing.NDArray">NDArray</span>[<span title="numpy.complex128">complex128</span>]</code>
</td> </td>
<td> <td>
<div class="doc-md-description"> <div class="doc-md-description">

Binary file not shown.

File diff suppressed because it is too large Load diff

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long