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 22, 2024
1 parent f0f71ef commit 0f1428e
Show file tree
Hide file tree
Showing 8 changed files with 159 additions and 160 deletions.
289 changes: 144 additions & 145 deletions bsl__predcorr__second__order__explicit_8hpp_source.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions classBslExplicitPredCorrRTheta-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html#a798b7348c59ee58fb5bdc09d2792b6cc">BslExplicitPredCorrRTheta</a>(AdvectionDomain const &amp;advection_domain, Mapping const &amp;mapping, BslAdvectionRTheta&lt; SplineFootFinder&lt; EulerMethod, AdvectionDomain &gt;, Mapping &gt; &amp;advection_solver, IdxRangeRTheta const &amp;grid, SplineRThetaBuilder const &amp;builder, SplineRThetaEvaluatorNullBound const &amp;rhs_evaluator, PolarSplineFEMPoissonLikeSolver const &amp;poisson_solver, SplineRThetaEvaluatorConstBound const &amp;advection_evaluator)</td><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classITimeSolverRTheta.html#a5503beee2f7240e8b09ef8ac3be2af24">display_time_difference</a>(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</td><td class="entry"><a class="el" href="classITimeSolverRTheta.html">ITimeSolverRTheta</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43">operator()</a>(host_t&lt; DFieldRTheta &gt; allfdistribu, double const dt, int const steps) const</td><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~BslExplicitPredCorrRTheta</b>() (defined in <a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>)</td><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95">operator()</a>(host_t&lt; DFieldRTheta &gt; allfdistribu, double const dt, int const steps) const final</td><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~BslExplicitPredCorrRTheta</b>() override (defined in <a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>)</td><td class="entry"><a class="el" href="classBslExplicitPredCorrRTheta.html">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~ITimeSolverRTheta</b>()=default (defined in <a class="el" href="classITimeSolverRTheta.html">ITimeSolverRTheta</a>)</td><td class="entry"><a class="el" href="classITimeSolverRTheta.html">ITimeSolverRTheta</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
12 changes: 6 additions & 6 deletions classBslExplicitPredCorrRTheta.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,9 @@
<tr class="memitem:a798b7348c59ee58fb5bdc09d2792b6cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBslExplicitPredCorrRTheta.html#a798b7348c59ee58fb5bdc09d2792b6cc">BslExplicitPredCorrRTheta</a> (<a class="el" href="classAdvectionDomain.html">AdvectionDomain</a> const &amp;advection_domain, <a class="el" href="classCircularToCartesian.html">Mapping</a> const &amp;mapping, <a class="el" href="classBslAdvectionRTheta.html">BslAdvectionRTheta</a>&lt; <a class="el" href="classSplineFootFinder.html">SplineFootFinder</a>&lt; <a class="el" href="classEuler.html">EulerMethod</a>, <a class="el" href="classAdvectionDomain.html">AdvectionDomain</a> &gt;, <a class="el" href="classCircularToCartesian.html">Mapping</a> &gt; &amp;advection_solver, IdxRangeRTheta const &amp;grid, SplineRThetaBuilder const &amp;builder, SplineRThetaEvaluatorNullBound const &amp;rhs_evaluator, <a class="el" href="classPolarSplineFEMPoissonLikeSolver.html">PolarSplineFEMPoissonLikeSolver</a> const &amp;poisson_solver, SplineRThetaEvaluatorConstBound const &amp;advection_evaluator)</td></tr>
<tr class="memdesc:a798b7348c59ee58fb5bdc09d2792b6cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instantiate a <a class="el" href="classBslExplicitPredCorrRTheta.html" title="A second order explicit predictor-corrector for the Vlasov-Poisson equations.">BslExplicitPredCorrRTheta</a>. <a href="classBslExplicitPredCorrRTheta.html#a798b7348c59ee58fb5bdc09d2792b6cc">More...</a><br /></td></tr>
<tr class="separator:a798b7348c59ee58fb5bdc09d2792b6cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a0d13a36c04660e9416fd8dba361e43"><td class="memItemLeft" align="right" valign="top">host_t&lt; DFieldRTheta &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43">operator()</a> (host_t&lt; DFieldRTheta &gt; allfdistribu, double const dt, int const steps) const</td></tr>
<tr class="memdesc:a4a0d13a36c04660e9416fd8dba361e43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves on \( T = dt*N \) the equations system. <a href="classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43">More...</a><br /></td></tr>
<tr class="separator:a4a0d13a36c04660e9416fd8dba361e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf7de730188384e04d3121a0aab47d95"><td class="memItemLeft" align="right" valign="top">host_t&lt; DFieldRTheta &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95">operator()</a> (host_t&lt; DFieldRTheta &gt; allfdistribu, double const dt, int const steps) const final</td></tr>
<tr class="memdesc:aaf7de730188384e04d3121a0aab47d95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves on \( T = dt*N \) the equations system. <a href="classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95">More...</a><br /></td></tr>
<tr class="separator:aaf7de730188384e04d3121a0aab47d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
Expand Down Expand Up @@ -260,8 +260,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a798b7348c59ee58fb5bdc09d
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4a0d13a36c04660e9416fd8dba361e43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a0d13a36c04660e9416fd8dba361e43">&#9670;&nbsp;</a></span>operator()()</h2>
<a id="aaf7de730188384e04d3121a0aab47d95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf7de730188384e04d3121a0aab47d95">&#9670;&nbsp;</a></span>operator()()</h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -297,7 +297,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4a0d13a36c04660e9416fd8d
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
4 changes: 2 additions & 2 deletions classBslExplicitPredCorrRTheta.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var classBslExplicitPredCorrRTheta =
[
[ "BslExplicitPredCorrRTheta", "classBslExplicitPredCorrRTheta.html#a798b7348c59ee58fb5bdc09d2792b6cc", null ],
[ "~BslExplicitPredCorrRTheta", "classBslExplicitPredCorrRTheta.html#ab5b5e97a788d1556035afad5cdffb4db", null ],
[ "operator()", "classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43", null ]
[ "~BslExplicitPredCorrRTheta", "classBslExplicitPredCorrRTheta.html#a26b8afb30dc2978dab211c9b8cab1508", null ],
[ "operator()", "classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95", null ]
];
2 changes: 1 addition & 1 deletion classITimeSolverRTheta.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6b757c78184c80859037e523
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Field toward allfdistribu. </dd></dl>

<p>Implemented in <a class="el" href="classBslImplicitPredCorrRTheta.html#ac3d7835dd0c995e3a9ecaa49474fc657">BslImplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>, <a class="el" href="classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>, and <a class="el" href="classBslPredCorrRTheta.html#afcf39ab7a2574a1f4bb644d74347a84b">BslPredCorrRTheta&lt; Mapping, FootFinder &gt;</a>.</p>
<p>Implemented in <a class="el" href="classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95">BslExplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>, <a class="el" href="classBslImplicitPredCorrRTheta.html#ac3d7835dd0c995e3a9ecaa49474fc657">BslImplicitPredCorrRTheta&lt; Mapping, AdvectionDomain &gt;</a>, and <a class="el" href="classBslPredCorrRTheta.html#afcf39ab7a2574a1f4bb644d74347a84b">BslPredCorrRTheta&lt; Mapping, FootFinder &gt;</a>.</p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions navtreeindex0.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ var NAVTREEINDEX0 =
"classBslAdvectionVelocity.html#a85c69c265dbb2410fdd60f7b78117593":[16,26,0],
"classBslAdvectionVelocity.html#ad1278ae4fb0647b24ca667c123bb3e36":[16,26,2],
"classBslExplicitPredCorrRTheta.html":[16,27],
"classBslExplicitPredCorrRTheta.html#a4a0d13a36c04660e9416fd8dba361e43":[16,27,2],
"classBslExplicitPredCorrRTheta.html#a26b8afb30dc2978dab211c9b8cab1508":[16,27,1],
"classBslExplicitPredCorrRTheta.html#a798b7348c59ee58fb5bdc09d2792b6cc":[16,27,0],
"classBslExplicitPredCorrRTheta.html#ab5b5e97a788d1556035afad5cdffb4db":[16,27,1],
"classBslExplicitPredCorrRTheta.html#aaf7de730188384e04d3121a0aab47d95":[16,27,2],
"classBslImplicitPredCorrRTheta.html":[16,28],
"classBslImplicitPredCorrRTheta.html#a4dfd555928be9aaae3c0dd3529cb8be5":[16,28,0],
"classBslImplicitPredCorrRTheta.html#a50ff84270975342a39ce7d967017e753":[16,28,1],
Expand Down
2 changes: 1 addition & 1 deletion search/all_e.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion search/functions_e.js
View file

Large diffs are not rendered by default.

0 comments on commit 0f1428e

Please sign in to comment.