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 8, 2025
1 parent 5a9314f commit 32dc164
Show file tree
Hide file tree
Showing 59 changed files with 353 additions and 350 deletions.
10 changes: 5 additions & 5 deletions advection__field__rp_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <a class="code hl_class" href="classPolarSplineEvaluator.html">PolarSplineEvaluator&lt;PolarBSplinesRTheta, ddc::NullExtrapolationRule, Kokkos::HostSpace&gt;</a> <span class="keyword">const</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> m_polar_spline_evaluator;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> SplineRThetaEvaluatorNullBound <span class="keyword">const</span> m_spline_evaluator;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> SplineRThetaEvaluatorNullBound_host <span class="keyword">const</span> m_spline_evaluator;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keywordtype">double</span> <span class="keyword">const</span> m_epsilon;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
Expand Down Expand Up @@ -168,7 +168,7 @@
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> IdxRangeRTheta <span class="keyword">const</span> grid = get_idx_range(advection_field_xy);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="comment">// Compute the spline representation of the electrostatic potential</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> SplineRThetaBuilder <span class="keyword">const</span> builder(grid);</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> SplineRThetaBuilder_host <span class="keyword">const</span> builder(grid);</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> IdxRangeBSRTheta <span class="keyword">const</span> idx_range_bsplinesRTheta = get_spline_idx_range(builder);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> host_t&lt;Spline2DMem&gt; electrostatic_potential_coef(idx_range_bsplinesRTheta);</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> builder(get_field(electrostatic_potential_coef), get_const_field(electrostatic_potential));</div>
Expand Down Expand Up @@ -215,7 +215,7 @@
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> (std::is_same_v&lt;</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> Evaluator,</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> SplineRThetaEvaluatorNullBound&gt; &amp;&amp; std::is_same_v&lt;SplineType, host_t&lt;Spline2D&gt;&gt;)</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> SplineRThetaEvaluatorNullBound_host&gt; &amp;&amp; std::is_same_v&lt;SplineType, host_t&lt;Spline2D&gt;&gt;)</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> || (std::is_same_v&lt;</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> Evaluator,</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <a class="code hl_class" href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a>&lt;</div>
Expand Down Expand Up @@ -353,7 +353,7 @@
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno"> 362</span> IdxRangeRTheta <span class="keyword">const</span> grid = get_idx_range(electrostatic_potential);</div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno"> 363</span> </div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno"> 364</span> <span class="comment">// Compute the spline representation of the electrostatic potential</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"> 365</span> SplineRThetaBuilder <span class="keyword">const</span> builder(grid);</div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno"> 365</span> SplineRThetaBuilder_host <span class="keyword">const</span> builder(grid);</div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno"> 366</span> IdxRangeBSRTheta <span class="keyword">const</span> idx_range_bsplinesRTheta = get_spline_idx_range(builder);</div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno"> 367</span> host_t&lt;Spline2DMem&gt; electrostatic_potential_coef(idx_range_bsplinesRTheta);</div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno"> 368</span> builder(get_field(electrostatic_potential_coef), get_const_field(electrostatic_potential));</div>
Expand Down Expand Up @@ -408,7 +408,7 @@
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno"> 446</span> <span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno"> 447</span> (std::is_same_v&lt;</div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno"> 448</span> Evaluator,</div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> SplineRThetaEvaluatorNullBound&gt; &amp;&amp; std::is_same_v&lt;SplineType, host_t&lt;Spline2D&gt;&gt;)</div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno"> 449</span> SplineRThetaEvaluatorNullBound_host&gt; &amp;&amp; std::is_same_v&lt;SplineType, host_t&lt;Spline2D&gt;&gt;)</div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno"> 450</span> || (std::is_same_v&lt;</div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno"> 451</span> Evaluator,</div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno"> 452</span> <a class="code hl_class" href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a>&lt;</div>
Expand Down
12 changes: 6 additions & 6 deletions advection__simulation__utils_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span>{</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span> <span class="keyword">static_assert</span>(!std::is_same_v&lt;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> <a class="code hl_class" href="classCircularToCartesian.html">LogicalToPhysicalMapping</a>,</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <a class="code hl_class" href="classDiscreteToCartesian.html">DiscreteToCartesian&lt;X, Y, SplineRThetaEvaluatorConstBound&gt;</a>&gt;);</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> <a class="code hl_class" href="classDiscreteToCartesian.html">DiscreteToCartesian&lt;X, Y, SplineRThetaEvaluatorConstBound_host&gt;</a>&gt;);</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> host_t&lt;FieldMemRTheta&lt;CoordRTheta&gt;&gt; feet_coords_rp(idx_range_rp);</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> CoordXY <span class="keyword">const</span> coord_xy_center = CoordXY(logical_to_physical_mapping(CoordRTheta(0, 0)));</div>
Expand Down Expand Up @@ -319,8 +319,8 @@
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno"> 351</span> Simulation&amp; simulation,</div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"> 352</span> <a class="code hl_class" href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta&lt;ddc::NullExtrapolationRule&gt;</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno"> 353</span> function_interpolator,</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> SplineRThetaBuilder <span class="keyword">const</span>&amp; advection_builder,</div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> SplineRThetaEvaluatorConstBound&amp; advection_evaluator,</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno"> 354</span> SplineRThetaBuilder_host <span class="keyword">const</span>&amp; advection_builder,</div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno"> 355</span> SplineRThetaEvaluatorConstBound_host&amp; advection_evaluator,</div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno"> 356</span> <span class="keywordtype">double</span> <span class="keyword">const</span> final_time,</div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno"> 357</span> <span class="keywordtype">double</span> <span class="keyword">const</span> dt,</div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno"> 358</span> <span class="keywordtype">bool</span> save_curves,</div>
Expand Down Expand Up @@ -508,8 +508,8 @@
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno"> 585</span> <a class="code hl_class" href="classAdvectionDomain.html">AdvectionDomain</a>&amp; advection_domain,</div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno"> 586</span> <a class="code hl_class" href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta&lt;ddc::NullExtrapolationRule&gt;</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno"> 587</span> function_interpolator,</div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno"> 588</span> SplineRThetaBuilder <span class="keyword">const</span>&amp; advection_builder,</div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno"> 589</span> SplineRThetaEvaluatorConstBound&amp; advection_evaluator,</div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno"> 588</span> SplineRThetaBuilder_host <span class="keyword">const</span>&amp; advection_builder,</div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno"> 589</span> SplineRThetaEvaluatorConstBound_host&amp; advection_evaluator,</div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno"> 590</span> <span class="keywordtype">double</span> <span class="keyword">const</span> final_time,</div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno"> 591</span> <span class="keywordtype">double</span> <span class="keyword">const</span> dt,</div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno"> 592</span> <span class="keywordtype">bool</span> <span class="keyword">const</span>&amp; save_curves,</div>
Expand Down Expand Up @@ -603,7 +603,7 @@
<div class="ttc" id="aclassCircularToCartesian_html"><div class="ttname"><a href="classCircularToCartesian.html">CircularToCartesian</a></div><div class="ttdoc">A class for describing the circular 2D mapping.</div><div class="ttdef"><b>Definition</b> circular_to_cartesian.hpp:43</div></div>
<div class="ttc" id="aclassDecentredRotationSimulation_html"><div class="ttname"><a href="classDecentredRotationSimulation.html">DecentredRotationSimulation</a></div><div class="ttdoc">Simulation of a decentred rotated elipse-type function.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:585</div></div>
<div class="ttc" id="aclassDiscreteToCartesian_html"><div class="ttname"><a href="classDiscreteToCartesian.html">DiscreteToCartesian</a></div><div class="ttdoc">A class for describing discrete 2D mappings from the logical domain to the physical domain.</div><div class="ttdef"><b>Definition</b> discrete_to_cartesian.hpp:32</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta</a></div><div class="ttdoc">A class which stores information necessary to create a pointer to an instance of the SplineInterpolat...</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:110</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta</a></div><div class="ttdoc">A class which stores information necessary to create a pointer to an instance of the SplineInterpolat...</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:113</div></div>
<div class="ttc" id="aclassRotationSimulation_html"><div class="ttname"><a href="classRotationSimulation.html">RotationSimulation</a></div><div class="ttdoc">Simulation of a rotated Gaussian.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:533</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:26</div></div>
<div class="ttc" id="aclassTranslationSimulation_html"><div class="ttname"><a href="classTranslationSimulation.html">TranslationSimulation</a></div><div class="ttdoc">Simulation of a translated Gaussian.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:482</div></div>
Expand Down
4 changes: 2 additions & 2 deletions bsl__advection__rp_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,8 @@
<div class="ttc" id="aclassBslAdvectionRTheta_html_affe3f9d4097bf05e95ce8d1c14557ca6"><div class="ttname"><a href="classBslAdvectionRTheta.html#affe3f9d4097bf05e95ce8d1c14557ca6">BslAdvectionRTheta::operator()</a></div><div class="ttdeci">host_t&lt; DFieldRTheta &gt; operator()(host_t&lt; DFieldRTheta &gt; allfdistribu, host_t&lt; DConstVectorFieldRTheta&lt; R, Theta &gt; &gt; advection_field_rp, CoordXY const &amp;advection_field_xy_center, double dt) const override</div><div class="ttdoc">Allocate a Field to the advected function.</div><div class="ttdef"><b>Definition</b> bsl_advection_rp.hpp:151</div></div>
<div class="ttc" id="aclassIAdvectionRTheta_html"><div class="ttname"><a href="classIAdvectionRTheta.html">IAdvectionRTheta</a></div><div class="ttdoc">Define the base class of 2D advection operators in polar index range.</div><div class="ttdef"><b>Definition</b> iadvectionrp.hpp:13</div></div>
<div class="ttc" id="aclassMetricTensor_html"><div class="ttname"><a href="classMetricTensor.html">MetricTensor</a></div><div class="ttdoc">An operator for calculating the metric tensor.</div><div class="ttdef"><b>Definition</b> metric_tensor.hpp:15</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta</a></div><div class="ttdoc">A class which stores information necessary to create a pointer to an instance of the SplineInterpolat...</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:110</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html_a1a1b5f3ba479aaba5c26177f57946ba6"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html#a1a1b5f3ba479aaba5c26177f57946ba6">PreallocatableSplineInterpolatorRTheta::preallocate</a></div><div class="ttdeci">std::unique_ptr&lt; IInterpolatorRTheta &gt; preallocate() const override</div><div class="ttdoc">Create a pointer to an instance of the SplineInterpolatorRTheta class.</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:153</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html">PreallocatableSplineInterpolatorRTheta</a></div><div class="ttdoc">A class which stores information necessary to create a pointer to an instance of the SplineInterpolat...</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:113</div></div>
<div class="ttc" id="aclassPreallocatableSplineInterpolatorRTheta_html_a1a1b5f3ba479aaba5c26177f57946ba6"><div class="ttname"><a href="classPreallocatableSplineInterpolatorRTheta.html#a1a1b5f3ba479aaba5c26177f57946ba6">PreallocatableSplineInterpolatorRTheta::preallocate</a></div><div class="ttdeci">std::unique_ptr&lt; IInterpolatorRTheta &gt; preallocate() const override</div><div class="ttdoc">Create a pointer to an instance of the SplineInterpolatorRTheta class.</div><div class="ttdef"><b>Definition</b> spline_interpolator_2d_rp.hpp:156</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><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
Loading

0 comments on commit 32dc164

Please sign in to comment.