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 Jan 15, 2025
1 parent b190d2b commit b80f0fb
Show file tree
Hide file tree
Showing 22 changed files with 1,560 additions and 1,598 deletions.
2 changes: 1 addition & 1 deletion bsl__predcorr_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@
<div class="ttc" id="aclassPoissonLikeRHSFunction_html"><div class="ttname"><a href="classPoissonLikeRHSFunction.html">PoissonLikeRHSFunction</a></div><div class="ttdoc">Type of right-hand side (rhs) function of the Poisson equation.</div><div class="ttdef"><b>Definition</b> poisson_like_rhs_function.hpp:17</div></div>
<div class="ttc" id="aclassPolarBSplines_html_ae4895a87f3e1ed953614a3546c319762"><div class="ttname"><a href="classPolarBSplines.html#ae4895a87f3e1ed953614a3546c319762">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static int constexpr continuity</div><div class="ttdoc">The continuity enforced by the bsplines at the singular point.</div><div class="ttdef"><b>Definition</b> polar_bsplines.hpp:65</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a></div><div class="ttdoc">Define an evaluator on polar B-splines.</div><div class="ttdef"><b>Definition</b> polar_spline_evaluator.hpp:15</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:51</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:53</div></div>
<div class="ttc" id="aclassRK2_html"><div class="ttname"><a href="classRK2.html">RK2</a></div><div class="ttdoc">A class which provides an implementation of a second-order Runge-Kutta method.</div><div class="ttdef"><b>Definition</b> rk2.hpp:37</div></div>
<div class="ttc" id="aclassRK2_html_af39ff8c3200cb2b37a4254030288963d"><div class="ttname"><a href="classRK2.html#af39ff8c3200cb2b37a4254030288963d">RK2::update</a></div><div class="ttdeci">void update(ExecSpace const &amp;exec_space, ValField y, double dt, std::function&lt; void(DerivField, ValConstField)&gt; dy_calculator, std::function&lt; void(ValField, DerivConstField, double)&gt; y_update) const final</div><div class="ttdoc">Carry out one step of the Runge-Kutta scheme.</div><div class="ttdef"><b>Definition</b> rk2.hpp:77</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">A class which holds multiple (scalar) fields in order to represent a vector field.</div><div class="ttdef"><b>Definition</b> vector_field.hpp:64</div></div>
Expand Down
2 changes: 1 addition & 1 deletion bsl__predcorr__second__order__explicit_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@
<div class="ttc" id="aclassPoissonLikeRHSFunction_html"><div class="ttname"><a href="classPoissonLikeRHSFunction.html">PoissonLikeRHSFunction</a></div><div class="ttdoc">Type of right-hand side (rhs) function of the Poisson equation.</div><div class="ttdef"><b>Definition</b> poisson_like_rhs_function.hpp:17</div></div>
<div class="ttc" id="aclassPolarBSplines_html_ae4895a87f3e1ed953614a3546c319762"><div class="ttname"><a href="classPolarBSplines.html#ae4895a87f3e1ed953614a3546c319762">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static int constexpr continuity</div><div class="ttdoc">The continuity enforced by the bsplines at the singular point.</div><div class="ttdef"><b>Definition</b> polar_bsplines.hpp:65</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a></div><div class="ttdoc">Define an evaluator on polar B-splines.</div><div class="ttdef"><b>Definition</b> polar_spline_evaluator.hpp:15</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:51</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:53</div></div>
<div class="ttc" id="aclassSplineFootFinder_html"><div class="ttname"><a href="classSplineFootFinder.html">SplineFootFinder</a></div><div class="ttdoc">Define a base class for all the time integration methods used for the advection.</div><div class="ttdef"><b>Definition</b> spline_foot_finder.hpp:25</div></div>
<div class="ttc" id="astructGridR_html"><div class="ttname"><a href="structGridR.html">GridR</a></div><div class="ttdef"><b>Definition</b> geometry.hpp:115</div></div>
<div class="ttc" id="astructGridTheta_html"><div class="ttname"><a href="structGridTheta.html">GridTheta</a></div><div class="ttdef"><b>Definition</b> geometry.hpp:118</div></div>
Expand Down
2 changes: 1 addition & 1 deletion bsl__predcorr__second__order__implicit_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@
<div class="ttc" id="aclassPoissonLikeRHSFunction_html"><div class="ttname"><a href="classPoissonLikeRHSFunction.html">PoissonLikeRHSFunction</a></div><div class="ttdoc">Type of right-hand side (rhs) function of the Poisson equation.</div><div class="ttdef"><b>Definition</b> poisson_like_rhs_function.hpp:17</div></div>
<div class="ttc" id="aclassPolarBSplines_html_ae4895a87f3e1ed953614a3546c319762"><div class="ttname"><a href="classPolarBSplines.html#ae4895a87f3e1ed953614a3546c319762">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static int constexpr continuity</div><div class="ttdoc">The continuity enforced by the bsplines at the singular point.</div><div class="ttdef"><b>Definition</b> polar_bsplines.hpp:65</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a></div><div class="ttdoc">Define an evaluator on polar B-splines.</div><div class="ttdef"><b>Definition</b> polar_spline_evaluator.hpp:15</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:51</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonLikeSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a></div><div class="ttdoc">Define a polar PDE solver for a Poisson-like equation.</div><div class="ttdef"><b>Definition</b> polarpoissonlikesolver.hpp:53</div></div>
<div class="ttc" id="aclassSplineFootFinder_html"><div class="ttname"><a href="classSplineFootFinder.html">SplineFootFinder</a></div><div class="ttdoc">Define a base class for all the time integration methods used for the advection.</div><div class="ttdef"><b>Definition</b> spline_foot_finder.hpp:25</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">A class which holds multiple (scalar) fields in order to represent a vector field.</div><div class="ttdef"><b>Definition</b> vector_field.hpp:64</div></div>
<div class="ttc" id="astructGridR_html"><div class="ttname"><a href="structGridR.html">GridR</a></div><div class="ttdef"><b>Definition</b> geometry.hpp:115</div></div>
Expand Down
3 changes: 2 additions & 1 deletion classGaussLegendre-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@
<tr class="even"><td class="entry"><a class="el" href="classGaussLegendre.html#abb70874897c85fa6df64c91511e2d24e">GaussLegendre</a>(std::initializer_list&lt; Coord&lt; Dim &gt; &gt; const mesh_edges)</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classGaussLegendre.html#a9f220a3c718cd167fc78e412c734a3c2">GaussLegendre</a>(ConstField&lt; Coord&lt; Dim &gt;, IdxRange&lt; Grid1D &gt;, Kokkos::HostSpace &gt; mesh_edges)</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classGaussLegendre.html#aaeeb0f98363b55a366f009b2fb77ed2f">get_idx_range</a>() const</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classGaussLegendre.html#a24a562fa02d5517588d6c4b4daa8c171">order</a>()</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61">Grid1D</a> typedef</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classGaussLegendre.html#a24a562fa02d5517588d6c4b4daa8c171">order</a>()</td><td class="entry"><a class="el" href="classGaussLegendre.html">GaussLegendre&lt; GLGrid, NPoints &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
16 changes: 12 additions & 4 deletions classGaussLegendre.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@

<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classGaussLegendre-members.html">List of all members</a> </div>
Expand All @@ -114,6 +115,13 @@
<p>An operator for constructing a Gauss-Legendre quadrature.
<a href="classGaussLegendre.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad4beb0ab162fcd8fd6961ae9013c3f61" id="r_ad4beb0ab162fcd8fd6961ae9013c3f61"><td class="memItemLeft" align="right" valign="top"><a id="ad4beb0ab162fcd8fd6961ae9013c3f61" name="ad4beb0ab162fcd8fd6961ae9013c3f61"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>Grid1D</b> = GLGrid</td></tr>
<tr class="memdesc:ad4beb0ab162fcd8fd6961ae9013c3f61"><td class="mdescLeft">&#160;</td><td class="mdescRight">The grid on which the quadrature scheme is defined. <br /></td></tr>
<tr class="separator:ad4beb0ab162fcd8fd6961ae9013c3f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab95e7e25b98a2ccf293b2462b3817a84" id="r_ab95e7e25b98a2ccf293b2462b3817a84"><td class="memTemplParams" colspan="2">template&lt;class InputIt &gt; </td></tr>
Expand All @@ -123,8 +131,8 @@
<tr class="memitem:abb70874897c85fa6df64c91511e2d24e" id="r_abb70874897c85fa6df64c91511e2d24e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGaussLegendre.html#abb70874897c85fa6df64c91511e2d24e">GaussLegendre</a> (std::initializer_list&lt; Coord&lt; Dim &gt; &gt; const mesh_edges)</td></tr>
<tr class="memdesc:abb70874897c85fa6df64c91511e2d24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor of the <a class="el" href="classGaussLegendre.html" title="An operator for constructing a Gauss-Legendre quadrature.">GaussLegendre</a> class. <br /></td></tr>
<tr class="separator:abb70874897c85fa6df64c91511e2d24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f220a3c718cd167fc78e412c734a3c2" id="r_a9f220a3c718cd167fc78e412c734a3c2"><td class="memTemplParams" colspan="2">template&lt;class Grid1D &gt; </td></tr>
<tr class="memitem:a9f220a3c718cd167fc78e412c734a3c2"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGaussLegendre.html#a9f220a3c718cd167fc78e412c734a3c2">GaussLegendre</a> (ConstField&lt; Coord&lt; Dim &gt;, IdxRange&lt; Grid1D &gt;, Kokkos::HostSpace &gt; mesh_edges)</td></tr>
<tr class="memitem:a9f220a3c718cd167fc78e412c734a3c2" id="r_a9f220a3c718cd167fc78e412c734a3c2"><td class="memTemplParams" colspan="2">template&lt;class <a class="el" href="classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61">Grid1D</a> &gt; </td></tr>
<tr class="memitem:a9f220a3c718cd167fc78e412c734a3c2"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classGaussLegendre.html#a9f220a3c718cd167fc78e412c734a3c2">GaussLegendre</a> (ConstField&lt; Coord&lt; Dim &gt;, IdxRange&lt; <a class="el" href="classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61">Grid1D</a> &gt;, Kokkos::HostSpace &gt; mesh_edges)</td></tr>
<tr class="memdesc:a9f220a3c718cd167fc78e412c734a3c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">A constructor of the <a class="el" href="classGaussLegendre.html" title="An operator for constructing a Gauss-Legendre quadrature.">GaussLegendre</a> class. <br /></td></tr>
<tr class="separator:a9f220a3c718cd167fc78e412c734a3c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeeb0f98363b55a366f009b2fb77ed2f" id="r_aaeeb0f98363b55a366f009b2fb77ed2f"><td class="memItemLeft" align="right" valign="top">IdxRange&lt; GLGrid &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGaussLegendre.html#aaeeb0f98363b55a366f009b2fb77ed2f">get_idx_range</a> () const</td></tr>
Expand Down Expand Up @@ -245,15 +253,15 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9f220a3c718cd167fc78e412
<div class="memtemplate">
template&lt;class GLGrid , std::size_t NPoints&gt; </div>
<div class="memtemplate">
template&lt;class Grid1D &gt; </div>
template&lt;class <a class="el" href="classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61">Grid1D</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGaussLegendre.html">GaussLegendre</a>&lt; GLGrid, NPoints &gt;<a class="el" href="classGaussLegendre.html">::GaussLegendre</a> </td>
<td>(</td>
<td class="paramtype">ConstField&lt; Coord&lt; Dim &gt;, IdxRange&lt; Grid1D &gt;, Kokkos::HostSpace &gt;&#160;</td>
<td class="paramtype">ConstField&lt; Coord&lt; Dim &gt;, IdxRange&lt; <a class="el" href="classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61">Grid1D</a> &gt;, Kokkos::HostSpace &gt;&#160;</td>
<td class="paramname"><em>mesh_edges</em></td><td>)</td>
<td></td>
</tr>
Expand Down
1 change: 1 addition & 0 deletions classGaussLegendre.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
var classGaussLegendre =
[
[ "Grid1D", "classGaussLegendre.html#ad4beb0ab162fcd8fd6961ae9013c3f61", null ],
[ "GaussLegendre", "classGaussLegendre.html#ab95e7e25b98a2ccf293b2462b3817a84", null ],
[ "GaussLegendre", "classGaussLegendre.html#abb70874897c85fa6df64c91511e2d24e", null ],
[ "GaussLegendre", "classGaussLegendre.html#a9f220a3c718cd167fc78e412c734a3c2", null ],
Expand Down
Loading

0 comments on commit b80f0fb

Please sign in to comment.