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 Oct 25, 2024
1 parent 8251120 commit 0a27a11
Show file tree
Hide file tree
Showing 54 changed files with 2,493 additions and 2,444 deletions.
519 changes: 260 additions & 259 deletions advection__field__rp_8hpp_source.html
View file

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions bsl__predcorr_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,11 @@
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; IdxStep&lt;BSplinesR&gt; {<a class="code" href="classPolarBSplines.html#ae187bdd3ed2fd780c51fa644c45386a9">PolarBSplinesRTheta::continuity</a> + 1}));</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; IdxRangeBSTheta polar_idx_range(ddc::discrete_space&lt;BSplinesTheta&gt;().full_domain());</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <a class="code" href="structPolarSpline.html">SplinePolar</a> electrostatic_potential_coef(</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; host_t&lt;SplinePolar&gt; electrostatic_potential_coef(</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; PolarBSplinesRTheta::singular_idx_range&lt;PolarBSplinesRTheta&gt;(),</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; IdxRangeBSRTheta(radial_bsplines, polar_idx_range));</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; ddc::NullExtrapolationRule extrapolation_rule;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule&gt;</a></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace&gt;</a></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; polar_spline_evaluator(extrapolation_rule);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; </div>
Expand Down Expand Up @@ -270,12 +270,11 @@
<div class="ttc" id="aclassITimeSolverRTheta_html_a5503beee2f7240e8b09ef8ac3be2af24"><div class="ttname"><a href="classITimeSolverRTheta.html#a5503beee2f7240e8b09ef8ac3be2af24">ITimeSolverRTheta::display_time_difference</a></div><div class="ttdeci">void display_time_difference(std::string const &amp;title, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;start_time, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;end_time) const</div><div class="ttdoc">Displays the time difference between two given times and a title.</div><div class="ttdef"><b>Definition:</b> itimesolver.hpp:47</div></div>
<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_ae187bdd3ed2fd780c51fa644c45386a9"><div class="ttname"><a href="classPolarBSplines.html#ae187bdd3ed2fd780c51fa644c45386a9">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static constexpr int 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:61</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule &gt;</a></div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace &gt;</a></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:39</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:79</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="astructPolarSpline_html"><div class="ttname"><a href="structPolarSpline.html">PolarSpline</a></div><div class="ttdoc">A structure containing the two Chunks necessary to define a spline on a set of polar basis splines.</div><div class="ttdef"><b>Definition:</b> polar_spline.hpp:20</div></div>
<div class="ttc" id="autils__tools_8hpp_html"><div class="ttname"><a href="utils__tools_8hpp.html">utils_tools.hpp</a></div><div class="ttdoc">File Describing useful functions.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
7 changes: 3 additions & 4 deletions bsl__predcorr__second__order__explicit_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,12 @@
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="comment">// --- Electrostatic potential (phi). -------------------------------------------------------------</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; host_t&lt;DFieldMemRTheta&gt; electrical_potential(grid);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <a class="code" href="structPolarSpline.html">SplinePolar</a> electrostatic_potential_coef(</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; host_t&lt;SplinePolar&gt; electrostatic_potential_coef(</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; PolarBSplinesRTheta::singular_idx_range&lt;PolarBSplinesRTheta&gt;(),</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; IdxRangeBSRTheta(radial_bsplines, polar_idx_range));</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; ddc::NullExtrapolationRule extrapolation_rule;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule&gt;</a></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace&gt;</a></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; polar_spline_evaluator(extrapolation_rule);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="comment">// --- For the computation of advection field from the electrostatic potential (phi): -------------</span></div>
Expand Down Expand Up @@ -345,10 +345,9 @@
<div class="ttc" id="aclassITimeSolverRTheta_html_a5503beee2f7240e8b09ef8ac3be2af24"><div class="ttname"><a href="classITimeSolverRTheta.html#a5503beee2f7240e8b09ef8ac3be2af24">ITimeSolverRTheta::display_time_difference</a></div><div class="ttdeci">void display_time_difference(std::string const &amp;title, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;start_time, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;end_time) const</div><div class="ttdoc">Displays the time difference between two given times and a title.</div><div class="ttdef"><b>Definition:</b> itimesolver.hpp:47</div></div>
<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_ae187bdd3ed2fd780c51fa644c45386a9"><div class="ttname"><a href="classPolarBSplines.html#ae187bdd3ed2fd780c51fa644c45386a9">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static constexpr int 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:61</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule &gt;</a></div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace &gt;</a></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:39</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:21</div></div>
<div class="ttc" id="astructPolarSpline_html"><div class="ttname"><a href="structPolarSpline.html">PolarSpline</a></div><div class="ttdoc">A structure containing the two Chunks necessary to define a spline on a set of polar basis splines.</div><div class="ttdef"><b>Definition:</b> polar_spline.hpp:20</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
7 changes: 3 additions & 4 deletions bsl__predcorr__second__order__implicit_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,12 @@
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; <span class="comment">// --- Electrostatic potential (phi). -------------------------------------------------------------</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; host_t&lt;DFieldMemRTheta&gt; electrical_potential(grid);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; <a class="code" href="structPolarSpline.html">SplinePolar</a> electrostatic_potential_coef(</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; host_t&lt;SplinePolar&gt; electrostatic_potential_coef(</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; PolarBSplinesRTheta::singular_idx_range&lt;PolarBSplinesRTheta&gt;(),</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; IdxRangeBSRTheta(radial_bsplines, polar_idx_range));</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; </div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; ddc::NullExtrapolationRule extrapolation_rule;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule&gt;</a></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <a class="code" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace&gt;</a></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; polar_spline_evaluator(extrapolation_rule);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="comment">// --- For the computation of advection field from the electrostatic potential (phi): -------------</span></div>
Expand Down Expand Up @@ -477,12 +477,11 @@
<div class="ttc" id="aclassITimeSolverRTheta_html_a5503beee2f7240e8b09ef8ac3be2af24"><div class="ttname"><a href="classITimeSolverRTheta.html#a5503beee2f7240e8b09ef8ac3be2af24">ITimeSolverRTheta::display_time_difference</a></div><div class="ttdeci">void display_time_difference(std::string const &amp;title, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;start_time, std::chrono::time_point&lt; std::chrono::system_clock &gt; const &amp;end_time) const</div><div class="ttdoc">Displays the time difference between two given times and a title.</div><div class="ttdef"><b>Definition:</b> itimesolver.hpp:47</div></div>
<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_ae187bdd3ed2fd780c51fa644c45386a9"><div class="ttname"><a href="classPolarBSplines.html#ae187bdd3ed2fd780c51fa644c45386a9">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static constexpr int 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:61</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule &gt;</a></div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt; PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace &gt;</a></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:39</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:21</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="anamespacecollisions__dimensions_html_a3ed65919dbae64a2ec9f5da42b393781"><div class="ttname"><a href="namespacecollisions__dimensions.html#a3ed65919dbae64a2ec9f5da42b393781">collisions_dimensions::get_idx_range</a></div><div class="ttdeci">IdxRange&lt; Grid1D... &gt; get_idx_range(IdxRangeFDistrib idx_range)</div><div class="ttdoc">Get the index range for specific grid dimensions from a multi-D index range.</div><div class="ttdef"><b>Definition:</b> collisions_dimensions.hpp:83</div></div>
<div class="ttc" id="astructPolarSpline_html"><div class="ttname"><a href="structPolarSpline.html">PolarSpline</a></div><div class="ttdoc">A structure containing the two Chunks necessary to define a spline on a set of polar basis splines.</div><div class="ttdef"><b>Definition:</b> polar_spline.hpp:20</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 0a27a11

Please sign in to comment.