Update docs

gyselax · Nov 28, 2023 · fd7eb4f · fd7eb4f
1 parent 90dcdd1
commit fd7eb4f
Show file tree

Hide file tree

Showing 152 changed files with 3,708 additions and 2,096 deletions.
diff --git a/annotated.html b/annotated.html
diff --git a/annotated.js b/annotated.js
@@ -31,7 +31,6 @@ var annotated =
     [ "CartesianSolution", "classCartesianSolution.html", "classCartesianSolution" ],
     [ "CartesianToBarycentricCoordinates", "classCartesianToBarycentricCoordinates.html", "classCartesianToBarycentricCoordinates" ],
     [ "ChargeDensityCalculator", "classChargeDensityCalculator.html", "classChargeDensityCalculator" ],
-    [ "ChargeDensityCalculatorSplineless", "classChargeDensityCalculatorSplineless.html", "classChargeDensityCalculatorSplineless" ],
     [ "CircularToCartesian", "classCircularToCartesian.html", "classCircularToCartesian" ],
     [ "CollisionsInter", "classCollisionsInter.html", "classCollisionsInter" ],
     [ "CollisionsIntra", "classCollisionsIntra.html", "classCollisionsIntra" ],
@@ -56,7 +55,6 @@ var annotated =
     [ "FemNonPeriodicPoissonSolver", "classFemNonPeriodicPoissonSolver.html", "classFemNonPeriodicPoissonSolver" ],
     [ "FemPeriodicPoissonSolver", "classFemPeriodicPoissonSolver.html", "classFemPeriodicPoissonSolver" ],
     [ "FftPoissonSolver", "classFftPoissonSolver.html", "classFftPoissonSolver" ],
-    [ "FftPoissonSolverSplineX", "classFftPoissonSolverSplineX.html", "classFftPoissonSolverSplineX" ],
     [ "FluidMoments", "classFluidMoments.html", "classFluidMoments" ],
     [ "for_each_tuple_cat", "structfor__each__tuple__cat.html", null ],
     [ "for_each_tuple_cat< std::tuple< Tuples... >, Tuple >", "structfor__each__tuple__cat_3_01std_1_1tuple_3_01Tuples_8_8_8_01_4_00_01Tuple_01_4.html", "structfor__each__tuple__cat_3_01std_1_1tuple_3_01Tuples_8_8_8_01_4_00_01Tuple_01_4" ],
@@ -72,6 +70,7 @@ var annotated =
     [ "IAdvectionSpatial", "classIAdvectionSpatial.html", "classIAdvectionSpatial" ],
     [ "IAdvectionVelocity", "classIAdvectionVelocity.html", "classIAdvectionVelocity" ],
     [ "IBoltzmannSolver", "classIBoltzmannSolver.html", "classIBoltzmannSolver" ],
+    [ "IChargeDensityCalculator", "classIChargeDensityCalculator.html", "classIChargeDensityCalculator" ],
     [ "IEquilibrium", "classIEquilibrium.html", "classIEquilibrium" ],
     [ "IFootFinder", "classIFootFinder.html", "classIFootFinder" ],
     [ "IInitialization", "classIInitialization.html", "classIInitialization" ],
@@ -143,6 +142,7 @@ var annotated =
     [ "SplineBoundaryValue2D", "classSplineBoundaryValue2D.html", "classSplineBoundaryValue2D" ],
     [ "SplineBuilder", "classSplineBuilder.html", "classSplineBuilder" ],
     [ "SplineBuilder2D", "classSplineBuilder2D.html", "classSplineBuilder2D" ],
+    [ "SplineChargeDensityCalculator", "classSplineChargeDensityCalculator.html", "classSplineChargeDensityCalculator" ],
     [ "SplineErrorBounds", "classSplineErrorBounds.html", "classSplineErrorBounds" ],
     [ "SplineEvaluator", "classSplineEvaluator.html", "classSplineEvaluator" ],
     [ "SplineEvaluator2D", "classSplineEvaluator2D.html", "classSplineEvaluator2D" ],

diff --git a/classChargeDensityCalculator-members.html b/classChargeDensityCalculator-members.html
@@ -106,10 +106,10 @@
 
 <p>This is the complete list of members for <a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a>, including all inherited members.</p>
 <table class="directory">
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ChargeDensityCalculator</b>(SplineVxBuilder const &amp;spline_vx_builder, SplineEvaluator&lt; BSplinesVx &gt; const &amp;spline_vx_evaluator) (defined in <a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a>)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>ChargeDensityCalculator</b>(SplineVxVyBuilder const &amp;spline_vxvy_builder, SplineVxVyEvaluator const &amp;spline_vxvy_evaluator) (defined in <a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a>)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator()</b>(DSpanX rho, DViewSpXVx allfdistribu) const (defined in <a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a>)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
-  <tr bgcolor="#f0f0f0"><td class="entry"><b>operator()</b>(DSpanXY rho, DViewSpXYVxVy allfdistribu) const (defined in <a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a>)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classChargeDensityCalculator.html#aed12a305287ed4637657cc3e8b71c0ab">ChargeDensityCalculator</a>(const Quadrature&lt; IDimVx &gt; &amp;quad)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="classChargeDensityCalculator.html#a2d97d4f1d146845b2ec7f54f83344089">ChargeDensityCalculator</a>(SplineVxVyBuilder const &amp;spline_vxvy_builder, SplineVxVyEvaluator const &amp;spline_vxvy_evaluator)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classChargeDensityCalculator.html#ad7440f208cab363eef9c4374da155fea">operator()</a>(DSpanX rho, DViewSpXVx allfdistribu) const final</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classChargeDensityCalculator.html#aa171397828c246922b136642e0295e26">operator()</a>(DSpanXY rho, DViewSpXYVxVy allfdistribu) const final</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
 </table></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/classChargeDensityCalculator.html b/classChargeDensityCalculator.html
@@ -106,22 +106,201 @@
 <div class="title">ChargeDensityCalculator Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">
+
+<p>A class which computes charges density.  
+ <a href="classChargeDensityCalculator.html#details">More...</a></p>
+<div class="dynheader">
+Inheritance diagram for ChargeDensityCalculator:</div>
+<div class="dyncontent">
+ <div class="center">
+  <img src="classChargeDensityCalculator.png" usemap="#ChargeDensityCalculator_map" alt=""/>
+  <map id="ChargeDensityCalculator_map" name="ChargeDensityCalculator_map">
+<area href="classIChargeDensityCalculator.html" title="A class which calculates the charge density." alt="IChargeDensityCalculator" shape="rect" coords="0,0,157,24"/>
+<area href="classIChargeDensityCalculator.html" title="A class which calculates the charge density." alt="IChargeDensityCalculator" shape="rect" coords="167,0,324,24"/>
+  </map>
+</div></div>
 <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:a33e8c38151bcf381a37fab85f8b4af8a"><td class="memItemLeft" align="right" valign="top"><a id="a33e8c38151bcf381a37fab85f8b4af8a"></a>
-&#160;</td><td class="memItemRight" valign="bottom"><b>ChargeDensityCalculator</b> (<a class="el" href="classSplineBuilder.html">SplineVxBuilder</a> const &amp;spline_vx_builder, <a class="el" href="classSplineEvaluator.html">SplineEvaluator</a>&lt; BSplinesVx &gt; const &amp;spline_vx_evaluator)</td></tr>
-<tr class="separator:a33e8c38151bcf381a37fab85f8b4af8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a6fb1024fafc2032fee7b27b66841094a"><td class="memItemLeft" align="right" valign="top"><a id="a6fb1024fafc2032fee7b27b66841094a"></a>
-void&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (DSpanX rho, DViewSpXVx allfdistribu) const</td></tr>
-<tr class="separator:a6fb1024fafc2032fee7b27b66841094a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2d97d4f1d146845b2ec7f54f83344089"><td class="memItemLeft" align="right" valign="top"><a id="a2d97d4f1d146845b2ec7f54f83344089"></a>
-&#160;</td><td class="memItemRight" valign="bottom"><b>ChargeDensityCalculator</b> (<a class="el" href="classSplineBuilder2D.html">SplineVxVyBuilder</a> const &amp;spline_vxvy_builder, <a class="el" href="classSplineEvaluator2D.html">SplineVxVyEvaluator</a> const &amp;spline_vxvy_evaluator)</td></tr>
+<tr class="memitem:aed12a305287ed4637657cc3e8b71c0ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChargeDensityCalculator.html#aed12a305287ed4637657cc3e8b71c0ab">ChargeDensityCalculator</a> (const <a class="el" href="classQuadrature.html">Quadrature</a>&lt; IDimVx &gt; &amp;quad)</td></tr>
+<tr class="memdesc:aed12a305287ed4637657cc3e8b71c0ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="classChargeDensityCalculator.html" title="A class which computes charges density.">ChargeDensityCalculator</a> object.  <a href="classChargeDensityCalculator.html#aed12a305287ed4637657cc3e8b71c0ab">More...</a><br /></td></tr>
+<tr class="separator:aed12a305287ed4637657cc3e8b71c0ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad7440f208cab363eef9c4374da155fea"><td class="memItemLeft" align="right" valign="top">DSpanX&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChargeDensityCalculator.html#ad7440f208cab363eef9c4374da155fea">operator()</a> (DSpanX rho, DViewSpXVx allfdistribu) const final</td></tr>
+<tr class="memdesc:ad7440f208cab363eef9c4374da155fea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the charge density rho from the distribution function.  <a href="classChargeDensityCalculator.html#ad7440f208cab363eef9c4374da155fea">More...</a><br /></td></tr>
+<tr class="separator:ad7440f208cab363eef9c4374da155fea"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2d97d4f1d146845b2ec7f54f83344089"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChargeDensityCalculator.html#a2d97d4f1d146845b2ec7f54f83344089">ChargeDensityCalculator</a> (<a class="el" href="classSplineBuilder2D.html">SplineVxVyBuilder</a> const &amp;spline_vxvy_builder, <a class="el" href="classSplineEvaluator2D.html">SplineVxVyEvaluator</a> const &amp;spline_vxvy_evaluator)</td></tr>
+<tr class="memdesc:a2d97d4f1d146845b2ec7f54f83344089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor of <a class="el" href="classSplineChargeDensityCalculator.html" title="A class which calculates the charge density.">SplineChargeDensityCalculator</a>.  <a href="classChargeDensityCalculator.html#a2d97d4f1d146845b2ec7f54f83344089">More...</a><br /></td></tr>
 <tr class="separator:a2d97d4f1d146845b2ec7f54f83344089"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a8aa580a2d9e043e3f8eb907d7730cb19"><td class="memItemLeft" align="right" valign="top"><a id="a8aa580a2d9e043e3f8eb907d7730cb19"></a>
-void&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (DSpanXY rho, DViewSpXYVxVy allfdistribu) const</td></tr>
-<tr class="separator:a8aa580a2d9e043e3f8eb907d7730cb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa171397828c246922b136642e0295e26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChargeDensityCalculator.html#aa171397828c246922b136642e0295e26">operator()</a> (DSpanXY rho, DViewSpXYVxVy allfdistribu) const final</td></tr>
+<tr class="memdesc:aa171397828c246922b136642e0295e26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the charge density rho from the distribution function.  <a href="classChargeDensityCalculator.html#aa171397828c246922b136642e0295e26">More...</a><br /></td></tr>
+<tr class="separator:aa171397828c246922b136642e0295e26"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>A class which computes charges density. </p>
+<p>A class which computes charges density by solving the equation: \( \int_{v} q_s f_s(x,v) dv \) where \( q_s \) is the charge of the species \( s \) and \( f_s(x,v) \) is the distribution function.</p>
+<p>A class which computes charges density by solving the equation: \( \int_{v} q_s f_s(x,v) dv \) where \( q_s \) is the charge of the species \( s \) and \( f_s(x,v) \) is the distribution function.</p>
+<p>This equation is solved using an intermediate spline representation. </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aed12a305287ed4637657cc3e8b71c0ab"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aed12a305287ed4637657cc3e8b71c0ab">&#9670;&nbsp;</a></span>ChargeDensityCalculator() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ChargeDensityCalculator::ChargeDensityCalculator </td>
+          <td>(</td>
+          <td class="paramtype">const <a class="el" href="classQuadrature.html">Quadrature</a>&lt; IDimVx &gt; &amp;&#160;</td>
+          <td class="paramname"><em>quad</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Create a <a class="el" href="classChargeDensityCalculator.html" title="A class which computes charges density.">ChargeDensityCalculator</a> object. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">quad</td><td>The quadrature method which should be used. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a id="a2d97d4f1d146845b2ec7f54f83344089"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2d97d4f1d146845b2ec7f54f83344089">&#9670;&nbsp;</a></span>ChargeDensityCalculator() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">ChargeDensityCalculator::ChargeDensityCalculator </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="classSplineBuilder2D.html">SplineVxVyBuilder</a> const &amp;&#160;</td>
+          <td class="paramname"><em>spline_vxvy_builder</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="classSplineEvaluator2D.html">SplineVxVyEvaluator</a> const &amp;&#160;</td>
+          <td class="paramname"><em>spline_vxvy_evaluator</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Constructor of <a class="el" href="classSplineChargeDensityCalculator.html" title="A class which calculates the charge density.">SplineChargeDensityCalculator</a>. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">spline_vxvy_builder</td><td>A spline builder which calculates the coefficients of a spline representation. </td></tr>
+    <tr><td class="paramname">spline_vxvy_evaluator</td><td>A spline evaluator which provides the value of a spline representation from its coefficients. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="ad7440f208cab363eef9c4374da155fea"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad7440f208cab363eef9c4374da155fea">&#9670;&nbsp;</a></span>operator()() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">DSpanX ChargeDensityCalculator::operator() </td>
+          <td>(</td>
+          <td class="paramtype">DSpanX&#160;</td>
+          <td class="paramname"><em>rho</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">DViewSpXVx&#160;</td>
+          <td class="paramname"><em>allfdistribu</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
 </table>
+</div><div class="memdoc">
+
+<p>Computes the charge density rho from the distribution function. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">rho</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">allfdistribu</td><td></td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>rho The charge density. </dd></dl>
+
+<p>Implements <a class="el" href="classIChargeDensityCalculator.html#a94853ddecb41d04c60155fdc18f9fcf3">IChargeDensityCalculator</a>.</p>
+
+</div>
+</div>
+<a id="aa171397828c246922b136642e0295e26"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa171397828c246922b136642e0295e26">&#9670;&nbsp;</a></span>operator()() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">void ChargeDensityCalculator::operator() </td>
+          <td>(</td>
+          <td class="paramtype">DSpanXY&#160;</td>
+          <td class="paramname"><em>rho</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">DViewSpXYVxVy&#160;</td>
+          <td class="paramname"><em>allfdistribu</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Calculate the charge density rho from the distribution function. </p>
+<p>Calculate the charge density by calculating the spline representation of slices of the distribution function at each spatial point along the velocity direction. This representation is then integrated and multiplied by the charge to find the charge density.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">rho</td><td>The charge density. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">allfdistribu</td><td>The distribution function. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p>Implements <a class="el" href="classIChargeDensityCalculator.html#a720c2444f9f9f61cf70755b592f53c7b">IChargeDensityCalculator</a>.</p>
+
+</div>
+</div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>/__w/gyselalibxx/gyselalibxx/code_branch/src/geometryXVx/poisson/<a class="el" href="geometryXVx_2poisson_2chargedensitycalculator_8hpp_source.html">chargedensitycalculator.hpp</a></li>
 </ul>