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 24, 2024
1 parent 98b89bc commit 100a1fb
Show file tree
Hide file tree
Showing 161 changed files with 3,045 additions and 1,866 deletions.
6 changes: 3 additions & 3 deletions advection__domain_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; CoordXY <span class="keyword">const</span> feet_xy = coord_xy - dt * advection_field(irp);</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a611dfcf6e3f686331e7a6f112ea93d8c">norm_inf</a>(feet_xy - coord_center) &lt; 1e-15) {</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a>(feet_xy - coord_center) &lt; 1e-15) {</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; feet_coords_rp(irp) = CoordRP(0, 0);</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; feet_coords_rp(irp) = m_mapping(feet_xy);</div>
Expand Down Expand Up @@ -229,7 +229,7 @@
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; <a class="code" href="classAdvectionPseudoCartesianDomain.html#a6f41e47d28f2b78e657fafb7d45c4aa1">CoordXY_adv</a> <span class="keyword">const</span> feet_xy_pseudo_cart</div>
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160; = coord_xy_pseudo_cart - dt * advection_field(irp);</div>
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160; </div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a611dfcf6e3f686331e7a6f112ea93d8c">norm_inf</a>(feet_xy_pseudo_cart - center_xy_pseudo_cart) &lt; 1e-15) {</div>
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a>(feet_xy_pseudo_cart - center_xy_pseudo_cart) &lt; 1e-15) {</div>
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160; feet_coords_rp(irp) = CoordRP(0, 0);</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160; feet_coords_rp(irp) = pseudo_Cartesian_mapping(feet_xy_pseudo_cart);</div>
Expand Down Expand Up @@ -326,7 +326,7 @@
<div class="ttc" id="astructRDimX_html"><div class="ttname"><a href="structRDimX.html">RDimX</a></div><div class="ttdoc">Define non periodic real X dimension.</div><div class="ttdef"><b>Definition:</b> geometry.hpp:435</div></div>
<div class="ttc" id="astructRDimY_html"><div class="ttname"><a href="structRDimY.html">RDimY</a></div><div class="ttdoc">Define non periodic real Y dimension.</div><div class="ttdef"><b>Definition:</b> geometry.hpp:648</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 class="ttc" id="autils__tools_8hpp_html_a611dfcf6e3f686331e7a6f112ea93d8c"><div class="ttname"><a href="utils__tools_8hpp.html#a611dfcf6e3f686331e7a6f112ea93d8c">norm_inf</a></div><div class="ttdeci">double norm_inf(ddc::Coordinate&lt; Tags... &gt; coord)</div><div class="ttdoc">Compute the infinity norm.</div><div class="ttdef"><b>Definition:</b> utils_tools.hpp:23</div></div>
<div class="ttc" id="autils__tools_8hpp_html_a939e3995d29bdb32c073e38494563009"><div class="ttname"><a href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a></div><div class="ttdeci">KOKKOS_FUNCTION double norm_inf(ddc::Coordinate&lt; Tags... &gt; coord)</div><div class="ttdoc">Compute the infinity norm.</div><div class="ttdef"><b>Definition:</b> utils_tools.hpp:23</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
4 changes: 2 additions & 2 deletions advection__maths__tools_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; coord_xy = CoordXY(feet_x, feet_y);</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; CoordXY <span class="keyword">const</span> coord_diff = coord_xy - coord_xy_center;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a611dfcf6e3f686331e7a6f112ea93d8c">norm_inf</a>(coord_diff) &lt; 1e-15) {</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a>(coord_diff) &lt; 1e-15) {</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; feet_coords_rp(irp) = CoordRP(0, 0);</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; feet_coords_rp(irp) = mapping(coord_xy);</div>
Expand Down Expand Up @@ -601,7 +601,7 @@
<div class="ttc" id="atrapezoid__quadrature_8hpp_html"><div class="ttname"><a href="trapezoid__quadrature_8hpp.html">trapezoid_quadrature.hpp</a></div><div class="ttdoc">File providing quadrature coefficients via the trapezoidal method.</div></div>
<div class="ttc" id="atrapezoid__quadrature_8hpp_html_a9b37968b97363d75ad6401309016c8f9"><div class="ttname"><a href="trapezoid__quadrature_8hpp.html#a9b37968b97363d75ad6401309016c8f9">trapezoid_quadrature_coefficients</a></div><div class="ttdeci">ddc::Chunk&lt; double, ddc::DiscreteDomain&lt; ODims... &gt; &gt; trapezoid_quadrature_coefficients(ddc::DiscreteDomain&lt; ODims... &gt; const &amp;domain)</div><div class="ttdoc">Get the trapezoid coefficients in ND.</div><div class="ttdef"><b>Definition:</b> trapezoid_quadrature.hpp:54</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 class="ttc" id="autils__tools_8hpp_html_a611dfcf6e3f686331e7a6f112ea93d8c"><div class="ttname"><a href="utils__tools_8hpp.html#a611dfcf6e3f686331e7a6f112ea93d8c">norm_inf</a></div><div class="ttdeci">double norm_inf(ddc::Coordinate&lt; Tags... &gt; coord)</div><div class="ttdoc">Compute the infinity norm.</div><div class="ttdef"><b>Definition:</b> utils_tools.hpp:23</div></div>
<div class="ttc" id="autils__tools_8hpp_html_a939e3995d29bdb32c073e38494563009"><div class="ttname"><a href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a></div><div class="ttdeci">KOKKOS_FUNCTION double norm_inf(ddc::Coordinate&lt; Tags... &gt; coord)</div><div class="ttdoc">Compute the infinity norm.</div><div class="ttdef"><b>Definition:</b> utils_tools.hpp:23</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
51 changes: 28 additions & 23 deletions bsl__predcorr_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,27 +215,32 @@
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; </div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; start_time = std::chrono::system_clock::now();</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> iter(0); iter &lt; steps; ++iter) {</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; time_stepper.<a class="code" href="classRK2.html#aa215475ac2ff63e25d2451175cff5759">update</a>(allfdistribu, dt, define_advection_field, advect_allfdistribu);</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; DFieldRP electrical_potential(grid);</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <a class="code" href="classVectorField.html">VectorDFieldRP&lt;RDimX, RDimY&gt;</a> electric_field(grid);</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; m_vlasov_poisson_solver(electrical_potential, electric_field, allfdistribu);</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; </div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; ddc::PdiEvent(<span class="stringliteral">&quot;iteration&quot;</span>)</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; .with(<span class="stringliteral">&quot;iter&quot;</span>, iter + 1)</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; .and_with(<span class="stringliteral">&quot;time&quot;</span>, iter * dt)</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; .and_with(<span class="stringliteral">&quot;density&quot;</span>, allfdistribu)</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; .and_with(<span class="stringliteral">&quot;electrical_potential&quot;</span>, electrical_potential);</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; }</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; end_time = std::chrono::system_clock::now();</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; </div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <a class="code" href="classITimeSolverRP.html#aa9b8aa593b80793bd9b8586a6c50dd2a">display_time_difference</a>(<span class="stringliteral">&quot;Iterations time: &quot;</span>, start_time, end_time);</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; <span class="keywordflow">return</span> allfdistribu;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; }</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;};</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; time_stepper</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; .<a class="code" href="classRK2.html#aa215475ac2ff63e25d2451175cff5759">update</a>(Kokkos::Serial(),</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; allfdistribu,</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; dt,</div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; define_advection_field,</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; advect_allfdistribu);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; DFieldRP electrical_potential(grid);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; <a class="code" href="classVectorField.html">VectorDFieldRP&lt;RDimX, RDimY&gt;</a> electric_field(grid);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; m_vlasov_poisson_solver(electrical_potential, electric_field, allfdistribu);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; ddc::PdiEvent(<span class="stringliteral">&quot;iteration&quot;</span>)</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; .with(<span class="stringliteral">&quot;iter&quot;</span>, iter + 1)</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; .and_with(<span class="stringliteral">&quot;time&quot;</span>, iter * dt)</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; .and_with(<span class="stringliteral">&quot;density&quot;</span>, allfdistribu)</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; .and_with(<span class="stringliteral">&quot;electrical_potential&quot;</span>, electrical_potential);</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; }</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; end_time = std::chrono::system_clock::now();</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; </div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; <a class="code" href="classITimeSolverRP.html#aa9b8aa593b80793bd9b8586a6c50dd2a">display_time_difference</a>(<span class="stringliteral">&quot;Iterations time: &quot;</span>, start_time, end_time);</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; </div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="keywordflow">return</span> allfdistribu;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; }</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;};</div>
<div class="ttc" id="aclassAdvectionDomain_html"><div class="ttname"><a href="classAdvectionDomain.html">AdvectionDomain</a></div><div class="ttdoc">Define a domain for the advection.</div><div class="ttdef"><b>Definition:</b> advection_domain.hpp:41</div></div>
<div class="ttc" id="aclassBslAdvectionRP_html"><div class="ttname"><a href="classBslAdvectionRP.html">BslAdvectionRP</a></div><div class="ttdoc">Define an advection operator on 2D domain.</div><div class="ttdef"><b>Definition:</b> bsl_advection_rp.hpp:61</div></div>
<div class="ttc" id="aclassBslPredCorrRP_html"><div class="ttname"><a href="classBslPredCorrRP.html">BslPredCorrRP</a></div><div class="ttdoc">Predictor-corrector for the Vlasov-Poisson equations.</div><div class="ttdef"><b>Definition:</b> bsl_predcorr.hpp:62</div></div>
Expand All @@ -244,8 +249,8 @@
<div class="ttc" id="aclassITimeSolverRP_html"><div class="ttname"><a href="classITimeSolverRP.html">ITimeSolverRP</a></div><div class="ttdoc">Base class for the time solvers.</div><div class="ttdef"><b>Definition:</b> itimesolver.hpp:11</div></div>
<div class="ttc" id="aclassITimeSolverRP_html_aa9b8aa593b80793bd9b8586a6c50dd2a"><div class="ttname"><a href="classITimeSolverRP.html#aa9b8aa593b80793bd9b8586a6c50dd2a">ITimeSolverRP::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:45</div></div>
<div class="ttc" id="aclassPolarSplineFEMPoissonSolver_html"><div class="ttname"><a href="classPolarSplineFEMPoissonSolver.html">PolarSplineFEMPoissonSolver</a></div><div class="ttdoc">Define a polar Poisson solver.</div><div class="ttdef"><b>Definition:</b> polarpoissonsolver.hpp:37</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:31</div></div>
<div class="ttc" id="aclassRK2_html_aa215475ac2ff63e25d2451175cff5759"><div class="ttname"><a href="classRK2.html#aa215475ac2ff63e25d2451175cff5759">RK2::update</a></div><div class="ttdeci">void update(ValSpan y, double dt, std::function&lt; void(DerivSpan, ValView)&gt; dy) const</div><div class="ttdoc">Carry out one step of the Runge-Kutta scheme.</div><div class="ttdef"><b>Definition:</b> rk2.hpp:75</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:32</div></div>
<div class="ttc" id="aclassRK2_html_aa215475ac2ff63e25d2451175cff5759"><div class="ttname"><a href="classRK2.html#aa215475ac2ff63e25d2451175cff5759">RK2::update</a></div><div class="ttdeci">void update(ValSpan y, double dt, std::function&lt; void(DerivSpan, ValView)&gt; dy) const</div><div class="ttdoc">Carry out one step of the Runge-Kutta scheme.</div><div class="ttdef"><b>Definition:</b> rk2.hpp:76</div></div>
<div class="ttc" id="aclassSplineBuilder2D_html"><div class="ttname"><a href="classSplineBuilder2D.html">SplineBuilder2D</a></div><div class="ttdoc">A class for creating a 2D spline approximation of a function.</div><div class="ttdef"><b>Definition:</b> spline_builder_2d.hpp:15</div></div>
<div class="ttc" id="aclassSplineEvaluator2D_html"><div class="ttname"><a href="classSplineEvaluator2D.html">SplineEvaluator2D&lt; BSplinesR, BSplinesP &gt;</a></div></div>
<div class="ttc" id="aclassVectorFieldSpan_html"><div class="ttname"><a href="classVectorFieldSpan.html">VectorFieldSpan</a></div><div class="ttdoc">Pre-declaration of VectorFieldSpan.</div><div class="ttdef"><b>Definition:</b> vector_field_span.hpp:45</div></div>
Expand Down
Loading

0 comments on commit 100a1fb

Please sign in to comment.