Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub CI Documentation builder committed Sep 4, 2024
1 parent b010c60 commit 574f0be
Show file tree
Hide file tree
Showing 145 changed files with 4,627 additions and 3,223 deletions.
225 changes: 225 additions & 0 deletions 2patches__2d__onion__shape__non__uniform_8hpp_source.html

Large diffs are not rendered by default.

561 changes: 284 additions & 277 deletions annotated.html

Large diffs are not rendered by default.

12 changes: 10 additions & 2 deletions annotated.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,14 @@ var annotated =
[ "BSplinesX", "structnon__periodic__uniform__2d__3patches_1_1BSplinesX.html", null ],
[ "BSplinesY", "structnon__periodic__uniform__2d__3patches_1_1BSplinesY.html", null ]
] ],
[ "onion_shape_non_uniform_2d_2patches", null, [
[ "R", "structonion__shape__non__uniform__2d__2patches_1_1R.html", null ],
[ "Theta", "structonion__shape__non__uniform__2d__2patches_1_1Theta.html", null ],
[ "GridR", "structonion__shape__non__uniform__2d__2patches_1_1GridR.html", null ],
[ "GridTheta", "structonion__shape__non__uniform__2d__2patches_1_1GridTheta.html", null ],
[ "BSplinesR", "structonion__shape__non__uniform__2d__2patches_1_1BSplinesR.html", null ],
[ "BSplinesTheta", "structonion__shape__non__uniform__2d__2patches_1_1BSplinesTheta.html", null ]
] ],
[ "onion_shape_uniform_2d_2patches", null, [
[ "R", "structonion__shape__uniform__2d__2patches_1_1R.html", null ],
[ "Theta", "structonion__shape__uniform__2d__2patches_1_1Theta.html", null ],
Expand Down Expand Up @@ -237,7 +245,7 @@ var annotated =
[ "interpolator_on_idx_range", "structinterpolator__on__idx__range.html", null ],
[ "interpolator_on_idx_range< Interp, GridInterp, IdxRange< Grid1D... > >", "structinterpolator__on__idx__range_3_01Interp_00_01GridInterp_00_01IdxRange_3_01Grid1D_8_8_8_01_4_01_4.html", "structinterpolator__on__idx__range_3_01Interp_00_01GridInterp_00_01IdxRange_3_01Grid1D_8_8_8_01_4_01_4" ],
[ "IonizationRate", "classIonizationRate.html", "classIonizationRate" ],
[ "IPatchLocator", "classIPatchLocator.html", "classIPatchLocator" ],
[ "IPatchLocator", "classIPatchLocator.html", null ],
[ "IPoissonSolver", "classIPoissonSolver.html", null ],
[ "IPoissonSolver< IdxRange< ODims... >, IdxRangeFull, LayoutSpace, MemorySpace >", "classIPoissonSolver_3_01IdxRange_3_01ODims_8_8_8_01_4_00_01IdxRangeFull_00_01LayoutSpace_00_01MemorySpace_01_4.html", "classIPoissonSolver_3_01IdxRange_3_01ODims_8_8_8_01_4_00_01IdxRangeFull_00_01LayoutSpace_00_01MemorySpace_01_4" ],
[ "IPreallocatableInterpolator", "classIPreallocatableInterpolator.html", "classIPreallocatableInterpolator" ],
Expand Down Expand Up @@ -287,7 +295,7 @@ var annotated =
[ "NullFluidSolver", "classNullFluidSolver.html", "classNullFluidSolver" ],
[ "NullQNSolver", "classNullQNSolver.html", "classNullQNSolver" ],
[ "OnionPatchLocator", "classOnionPatchLocator.html", null ],
[ "OnionPatchLocator< MultipatchType< IdxRangeOnPatch, Patches... >, Mapping >", "classOnionPatchLocator_3_01MultipatchType_3_01IdxRangeOnPatch_00_01Patches_8_8_8_01_4_00_01Mapping_01_4.html", "classOnionPatchLocator_3_01MultipatchType_3_01IdxRangeOnPatch_00_01Patches_8_8_8_01_4_00_01Mapping_01_4" ],
[ "OnionPatchLocator< MultipatchType< IdxRangeOnPatch, Patches... >, Mapping, ExecSpace >", "classOnionPatchLocator_3_01MultipatchType_3_01IdxRangeOnPatch_00_01Patches_8_8_8_01_4_00_01Mapping_00_01ExecSpace_01_4.html", "classOnionPatchLocator_3_01MultipatchType_3_01IdxRangeOnPatch_00_01Patches_8_8_8_01_4_00_01Mapping_00_01ExecSpace_01_4" ],
[ "OutsideEdge", "structOutsideEdge.html", null ],
[ "Patch", "structPatch.html", null ],
[ "Patch< grid1, grid2, bsplines_dim1, bsplines_dim2 >", "structPatch_3_01grid1_00_01grid2_00_01bsplines__dim1_00_01bsplines__dim2_01_4.html", "structPatch_3_01grid1_00_01grid2_00_01bsplines__dim1_00_01bsplines__dim2_01_4" ],
Expand Down
4 changes: 2 additions & 2 deletions classEdgeTransformation-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,10 @@
<p>This is the complete list of members for <a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classEdgeTransformation.html#a11c84fec5577a58b0addfd13bd744117">EdgeTransformation</a>(IdxRangeEdge1 const &amp;idx_range_patch_1, IdxRangeEdge2 const &amp;idx_range_patch_2)</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classEdgeTransformation.html#a3df119bf2d4697601126025f86fe4e85">is_match_available</a>(CurrentIdx const &amp;current_idx) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classEdgeTransformation.html#a608a25e1800da17a87d13fa7f8a5cfc7">is_match_available</a>(CurrentIdx const &amp;current_idx) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classEdgeTransformation.html#ade4e3d76c60e46f6d36a8f6fc9fd8f49">operator()</a>(Coord&lt; CurrentDim &gt; const &amp;current_coord) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classEdgeTransformation.html#a953cea3a043308fbce6a55438daf7376">operator()</a>(CurrentIdx const &amp;current_idx) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classEdgeTransformation.html#a05254973d20aa858b71866be692df574">search_for_match</a>(Idx&lt; TargetGrid &gt; &amp;target_idx, Idx&lt; CurrentGrid &gt; const &amp;current_idx) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classEdgeTransformation.html#a0259680760413ed6fbbdfc9ffda44fc4">search_for_match</a>(Idx&lt; TargetGrid &gt; &amp;target_idx, Idx&lt; CurrentGrid &gt; const &amp;current_idx) const</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~EdgeTransformation</b>()=default (defined in <a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a>)</td><td class="entry"><a class="el" href="classEdgeTransformation.html">EdgeTransformation&lt; Interface &gt;</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
28 changes: 14 additions & 14 deletions classEdgeTransformation.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@
<tr class="memitem:a953cea3a043308fbce6a55438daf7376"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEdgeTransformation.html#a953cea3a043308fbce6a55438daf7376">operator()</a> (CurrentIdx const &amp;current_idx) const</td></tr>
<tr class="memdesc:a953cea3a043308fbce6a55438daf7376"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transform an index on the edge in the dimension of the current patch to the analogous index on the target patch. <a href="classEdgeTransformation.html#a953cea3a043308fbce6a55438daf7376">More...</a><br /></td></tr>
<tr class="separator:a953cea3a043308fbce6a55438daf7376"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3df119bf2d4697601126025f86fe4e85"><td class="memTemplParams" colspan="2">template&lt;class CurrentIdx &gt; </td></tr>
<tr class="memitem:a3df119bf2d4697601126025f86fe4e85"><td class="memTemplItemLeft" align="right" valign="top">bool const&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEdgeTransformation.html#a3df119bf2d4697601126025f86fe4e85">is_match_available</a> (CurrentIdx const &amp;current_idx) const</td></tr>
<tr class="memdesc:a3df119bf2d4697601126025f86fe4e85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given index has an equivalent index on the other patch of an interface. <a href="classEdgeTransformation.html#a3df119bf2d4697601126025f86fe4e85">More...</a><br /></td></tr>
<tr class="separator:a3df119bf2d4697601126025f86fe4e85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05254973d20aa858b71866be692df574"><td class="memTemplParams" colspan="2">template&lt;class CurrentGrid , class TargetGrid &gt; </td></tr>
<tr class="memitem:a05254973d20aa858b71866be692df574"><td class="memTemplItemLeft" align="right" valign="top">bool const&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEdgeTransformation.html#a05254973d20aa858b71866be692df574">search_for_match</a> (Idx&lt; TargetGrid &gt; &amp;target_idx, Idx&lt; CurrentGrid &gt; const &amp;current_idx) const</td></tr>
<tr class="memdesc:a05254973d20aa858b71866be692df574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given index has an equivalent index and transform an index on the edge in the dimension of the current patch to the analogous index on the target patch. <a href="classEdgeTransformation.html#a05254973d20aa858b71866be692df574">More...</a><br /></td></tr>
<tr class="separator:a05254973d20aa858b71866be692df574"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a608a25e1800da17a87d13fa7f8a5cfc7"><td class="memTemplParams" colspan="2">template&lt;class CurrentIdx &gt; </td></tr>
<tr class="memitem:a608a25e1800da17a87d13fa7f8a5cfc7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEdgeTransformation.html#a608a25e1800da17a87d13fa7f8a5cfc7">is_match_available</a> (CurrentIdx const &amp;current_idx) const</td></tr>
<tr class="memdesc:a608a25e1800da17a87d13fa7f8a5cfc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given index has an equivalent index on the other patch of an interface. <a href="classEdgeTransformation.html#a608a25e1800da17a87d13fa7f8a5cfc7">More...</a><br /></td></tr>
<tr class="separator:a608a25e1800da17a87d13fa7f8a5cfc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0259680760413ed6fbbdfc9ffda44fc4"><td class="memTemplParams" colspan="2">template&lt;class CurrentGrid , class TargetGrid &gt; </td></tr>
<tr class="memitem:a0259680760413ed6fbbdfc9ffda44fc4"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEdgeTransformation.html#a0259680760413ed6fbbdfc9ffda44fc4">search_for_match</a> (Idx&lt; TargetGrid &gt; &amp;target_idx, Idx&lt; CurrentGrid &gt; const &amp;current_idx) const</td></tr>
<tr class="memdesc:a0259680760413ed6fbbdfc9ffda44fc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given index has an equivalent index and transform an index on the edge in the dimension of the current patch to the analogous index on the target patch. <a href="classEdgeTransformation.html#a0259680760413ed6fbbdfc9ffda44fc4">More...</a><br /></td></tr>
<tr class="separator:a0259680760413ed6fbbdfc9ffda44fc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Interface&gt;<br />
Expand Down Expand Up @@ -290,8 +290,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a953cea3a043308fbce6a5543

</div>
</div>
<a id="a3df119bf2d4697601126025f86fe4e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3df119bf2d4697601126025f86fe4e85">&#9670;&nbsp;</a></span>is_match_available()</h2>
<a id="a608a25e1800da17a87d13fa7f8a5cfc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a608a25e1800da17a87d13fa7f8a5cfc7">&#9670;&nbsp;</a></span>is_match_available()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -304,7 +304,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3df119bf2d4697601126025f
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool const <a class="el" href="classEdgeTransformation.html">EdgeTransformation</a>&lt; <a class="el" href="structInterface.html">Interface</a> &gt;::is_match_available </td>
<td class="memname">bool <a class="el" href="classEdgeTransformation.html">EdgeTransformation</a>&lt; <a class="el" href="structInterface.html">Interface</a> &gt;::is_match_available </td>
<td>(</td>
<td class="paramtype">CurrentIdx const &amp;&#160;</td>
<td class="paramname"><em>current_idx</em></td><td>)</td>
Expand Down Expand Up @@ -338,8 +338,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3df119bf2d4697601126025f

</div>
</div>
<a id="a05254973d20aa858b71866be692df574"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05254973d20aa858b71866be692df574">&#9670;&nbsp;</a></span>search_for_match()</h2>
<a id="a0259680760413ed6fbbdfc9ffda44fc4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0259680760413ed6fbbdfc9ffda44fc4">&#9670;&nbsp;</a></span>search_for_match()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -352,7 +352,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a05254973d20aa858b71866be
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool const <a class="el" href="classEdgeTransformation.html">EdgeTransformation</a>&lt; <a class="el" href="structInterface.html">Interface</a> &gt;::search_for_match </td>
<td class="memname">bool <a class="el" href="classEdgeTransformation.html">EdgeTransformation</a>&lt; <a class="el" href="structInterface.html">Interface</a> &gt;::search_for_match </td>
<td>(</td>
<td class="paramtype">Idx&lt; TargetGrid &gt; &amp;&#160;</td>
<td class="paramname"><em>target_idx</em>, </td>
Expand Down
4 changes: 2 additions & 2 deletions classEdgeTransformation.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ var classEdgeTransformation =
[ "~EdgeTransformation", "classEdgeTransformation.html#a91afccef9c7c3d5767a08ed75e05adef", null ],
[ "operator()", "classEdgeTransformation.html#ade4e3d76c60e46f6d36a8f6fc9fd8f49", null ],
[ "operator()", "classEdgeTransformation.html#a953cea3a043308fbce6a55438daf7376", null ],
[ "is_match_available", "classEdgeTransformation.html#a3df119bf2d4697601126025f86fe4e85", null ],
[ "search_for_match", "classEdgeTransformation.html#a05254973d20aa858b71866be692df574", null ]
[ "is_match_available", "classEdgeTransformation.html#a608a25e1800da17a87d13fa7f8a5cfc7", null ],
[ "search_for_match", "classEdgeTransformation.html#a0259680760413ed6fbbdfc9ffda44fc4", null ]
];
9 changes: 3 additions & 6 deletions classIPatchLocator-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,13 @@

<div class="header">
<div class="headertitle">
<div class="title">IPatchLocator&lt; X, Y &gt; Member List</div> </div>
<div class="title">IPatchLocator Member List</div> </div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a>, including all inherited members.</p>
<p>This is the complete list of members for <a class="el" href="classIPatchLocator.html">IPatchLocator</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>IPatchLocator</b>()=default (defined in <a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a>)</td><td class="entry"><a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classIPatchLocator.html#ab0e4beddff967a7b48b454829666f1c3">operator()</a>(Coord&lt; X, Y &gt; const &amp;coord) const =0</td><td class="entry"><a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classIPatchLocator.html#a904332415176f262278aac06114ffd05">outside_domain</a></td><td class="entry"><a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~IPatchLocator</b>()=default (defined in <a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a>)</td><td class="entry"><a class="el" href="classIPatchLocator.html">IPatchLocator&lt; X, Y &gt;</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classIPatchLocator.html#a3bbbe7b20783325bebdd435ecfaa9802">outside_domain</a></td><td class="entry"><a class="el" href="classIPatchLocator.html">IPatchLocator</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 574f0be

Please sign in to comment.