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 Jun 11, 2024
1 parent 24d6b7c commit f77a2e9
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion classDiffusiveNeutralSolver-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@

<p>This is the complete list of members for <a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644">DiffusiveNeutralSolver</a>(IReactionRate const &amp;chargexchange, IReactionRate const &amp;ionization, IReactionRate const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</td><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac">DiffusiveNeutralSolver</a>(IReactionRate const &amp;charge_exchange, IReactionRate const &amp;ionization, IReactionRate const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</td><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a">get_derivative</a>(DSpanSpMX dn, DViewSpMX n, DViewSpX density, DViewSpX velocity, DViewSpX temperature) const</td><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e">operator()</a>(DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const override</td><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>~DiffusiveNeutralSolver</b>() override=default (defined in <a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a>)</td><td class="entry"><a class="el" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></td><td class="entry"></td></tr>
Expand Down
14 changes: 7 additions & 7 deletions classDiffusiveNeutralSolver.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,9 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4e8da82c0223e1338581b8e0889c7644"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644">DiffusiveNeutralSolver</a> (<a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;chargexchange, <a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;ionization, <a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</td></tr>
<tr class="memdesc:a4e8da82c0223e1338581b8e0889c7644"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an instance of the <a class="el" href="classDiffusiveNeutralSolver.html" title="A class that solves a so-called &quot;pressure-diffusive&quot; fluid neutral model.">DiffusiveNeutralSolver</a> class. <a href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644">More...</a><br /></td></tr>
<tr class="separator:a4e8da82c0223e1338581b8e0889c7644"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59c3999309be8830fd85c7e1c4ef0aac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac">DiffusiveNeutralSolver</a> (<a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;charge_exchange, <a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;ionization, <a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</td></tr>
<tr class="memdesc:a59c3999309be8830fd85c7e1c4ef0aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an instance of the <a class="el" href="classDiffusiveNeutralSolver.html" title="A class that solves a so-called &quot;pressure-diffusive&quot; fluid neutral model.">DiffusiveNeutralSolver</a> class. <a href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac">More...</a><br /></td></tr>
<tr class="separator:a59c3999309be8830fd85c7e1c4ef0aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfa7ed6b9809fc0338cd689b7d8dd37e"><td class="memItemLeft" align="right" valign="top">DSpanSpMX&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e">operator()</a> (DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const override</td></tr>
<tr class="memdesc:abfa7ed6b9809fc0338cd689b7d8dd37e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the neutral fluid moments according to the pressure-diffusive neutral model. <a href="classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e">More...</a><br /></td></tr>
<tr class="separator:abfa7ed6b9809fc0338cd689b7d8dd37e"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -157,8 +157,8 @@
<p>Where \(\alpha_0\) is a normalization coefficient equal to \(\alpha_0 = \omega_{pe0}/(n_0 K_0)\). All the terms that appear in this normalized equation keep the same expression as when writing the dimensional form of the model, except that quantities involved are normalized.</p>
<p>The pressure-diffusive model is solved using a <a class="el" href="classRK2.html" title="A class which provides an implementation of a second-order Runge-Kutta method.">RK2</a> time integrator. Spatial derivatives are computed using splines polynomials. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4e8da82c0223e1338581b8e0889c7644"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e8da82c0223e1338581b8e0889c7644">&#9670;&nbsp;</a></span>DiffusiveNeutralSolver()</h2>
<a id="a59c3999309be8830fd85c7e1c4ef0aac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c3999309be8830fd85c7e1c4ef0aac">&#9670;&nbsp;</a></span>DiffusiveNeutralSolver()</h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -167,7 +167,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4e8da82c0223e1338581b8e0
<td class="memname">DiffusiveNeutralSolver::DiffusiveNeutralSolver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classIReactionRate.html">IReactionRate</a> const &amp;&#160;</td>
<td class="paramname"><em>chargexchange</em>, </td>
<td class="paramname"><em>charge_exchange</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
Expand Down Expand Up @@ -222,7 +222,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4e8da82c0223e1338581b8e0
<p>Creates an instance of the <a class="el" href="classDiffusiveNeutralSolver.html" title="A class that solves a so-called &quot;pressure-diffusive&quot; fluid neutral model.">DiffusiveNeutralSolver</a> class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">chargexchange</td><td>An object that represents charge-exchange reaction rate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">charge_exchange</td><td>An object that represents charge-exchange reaction rate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ionization</td><td>An object that represents ionization reaction rate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">recombination</td><td>An object that represents recombination reaction rate. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">temperature</td><td>The constant temperature of neutrals. </td></tr>
Expand Down
2 changes: 1 addition & 1 deletion classDiffusiveNeutralSolver.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var classDiffusiveNeutralSolver =
[
[ "DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644", null ],
[ "DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac", null ],
[ "~DiffusiveNeutralSolver", "classDiffusiveNeutralSolver.html#af85115e532382e213d94d67cba76b058", null ],
[ "operator()", "classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e", null ],
[ "get_derivative", "classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a", null ]
Expand Down
8 changes: 4 additions & 4 deletions diffusiveneutralsolver_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classDiffusiveNeutralSolver.html"> 60</a></span>&#160;<span class="keyword">class </span><a class="code" href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a> : <span class="keyword">public</span> <a class="code" href="classIFluidSolver.html">IFluidSolver</a></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;{</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; m_chargexchange;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; m_charge_exchange;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; m_ionization;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; m_recombination;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
Expand All @@ -131,8 +131,8 @@
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; IndexSp find_ion(IDomainSp <span class="keyword">const</span> dom_kinsp) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644"> 89</a></span>&#160; <a class="code" href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644">DiffusiveNeutralSolver</a>(</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; chargexchange,</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac"> 89</a></span>&#160; <a class="code" href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac">DiffusiveNeutralSolver</a>(</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; charge_exchange,</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; ionization,</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="classIReactionRate.html">IReactionRate</a> <span class="keyword">const</span>&amp; recombination,</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">double</span> <span class="keyword">const</span> temperature,</div>
Expand All @@ -154,7 +154,7 @@
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; DViewSpX temperature) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;};</div>
<div class="ttc" id="aclassDiffusiveNeutralSolver_html"><div class="ttname"><a href="classDiffusiveNeutralSolver.html">DiffusiveNeutralSolver</a></div><div class="ttdoc">A class that solves a so-called &quot;pressure-diffusive&quot; fluid neutral model.</div><div class="ttdef"><b>Definition:</b> diffusiveneutralsolver.hpp:61</div></div>
<div class="ttc" id="aclassDiffusiveNeutralSolver_html_a4e8da82c0223e1338581b8e0889c7644"><div class="ttname"><a href="classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644">DiffusiveNeutralSolver::DiffusiveNeutralSolver</a></div><div class="ttdeci">DiffusiveNeutralSolver(IReactionRate const &amp;chargexchange, IReactionRate const &amp;ionization, IReactionRate const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</div><div class="ttdoc">Creates an instance of the DiffusiveNeutralSolver class.</div></div>
<div class="ttc" id="aclassDiffusiveNeutralSolver_html_a59c3999309be8830fd85c7e1c4ef0aac"><div class="ttname"><a href="classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac">DiffusiveNeutralSolver::DiffusiveNeutralSolver</a></div><div class="ttdeci">DiffusiveNeutralSolver(IReactionRate const &amp;charge_exchange, IReactionRate const &amp;ionization, IReactionRate const &amp;recombination, double const temperature, double const normalization_coeff, SplineXBuilder_1d const &amp;spline_x_builder, SplineXEvaluator_1d const &amp;spline_x_evaluator, DViewVx const &amp;quadrature_coeffs)</div><div class="ttdoc">Creates an instance of the DiffusiveNeutralSolver class.</div></div>
<div class="ttc" id="aclassDiffusiveNeutralSolver_html_abfa7ed6b9809fc0338cd689b7d8dd37e"><div class="ttname"><a href="classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e">DiffusiveNeutralSolver::operator()</a></div><div class="ttdeci">DSpanSpMX operator()(DSpanSpMX neutrals, DViewSpXVx allfdistribu, DViewX efield, double dt) const override</div><div class="ttdoc">Updates the neutral fluid moments according to the pressure-diffusive neutral model.</div></div>
<div class="ttc" id="aclassDiffusiveNeutralSolver_html_ae5ebfe3292a4555f0c0df1cdd2a0fa6a"><div class="ttname"><a href="classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a">DiffusiveNeutralSolver::get_derivative</a></div><div class="ttdeci">void get_derivative(DSpanSpMX dn, DViewSpMX n, DViewSpX density, DViewSpX velocity, DViewSpX temperature) const</div><div class="ttdoc">Computes the expression of the time derivative of the neutral fluid moments.</div></div>
<div class="ttc" id="aclassIFluidSolver_html"><div class="ttname"><a href="classIFluidSolver.html">IFluidSolver</a></div><div class="ttdoc">An abstract class for solving a fluid model.</div><div class="ttdef"><b>Definition:</b> ifluidsolver.hpp:11</div></div>
Expand Down
2 changes: 1 addition & 1 deletion navtreeindex1.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ var NAVTREEINDEX1 =
"classDecentredRotationSimulation.html":[16,46],
"classDecentredRotationSimulation.html#a94d97e6be53cae16d5458fd5c05e46e8":[16,46,0],
"classDiffusiveNeutralSolver.html":[16,47],
"classDiffusiveNeutralSolver.html#a4e8da82c0223e1338581b8e0889c7644":[16,47,0],
"classDiffusiveNeutralSolver.html#a59c3999309be8830fd85c7e1c4ef0aac":[16,47,0],
"classDiffusiveNeutralSolver.html#abfa7ed6b9809fc0338cd689b7d8dd37e":[16,47,2],
"classDiffusiveNeutralSolver.html#ae5ebfe3292a4555f0c0df1cdd2a0fa6a":[16,47,3],
"classDiffusiveNeutralSolver.html#af85115e532382e213d94d67cba76b058":[16,47,1],
Expand Down
2 changes: 1 addition & 1 deletion search/all_3.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion search/functions_3.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f77a2e9

Please sign in to comment.