Update docs

gyselax · Mar 18, 2024 · d212974 · d212974
1 parent 300fd86
commit d212974
Show file tree

Hide file tree

Showing 97 changed files with 1,084 additions and 1,063 deletions.
diff --git a/classChargeDensityCalculator-members.html b/classChargeDensityCalculator-members.html
@@ -107,7 +107,7 @@
 <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 class="even"><td class="entry"><a class="el" href="classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf">ChargeDensityCalculator</a>(const ChunkViewType &amp;coeffs)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"><span class="mlabel">explicit</span></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><td class="entry"><a class="el" href="classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf">ChargeDensityCalculator</a>(const ChunkViewType &amp;coeffs)</td><td class="entry"><a class="el" href="classChargeDensityCalculator.html">ChargeDensityCalculator</a></td><td class="entry"><span class="mlabel">explicit</span></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 -->

diff --git a/classChargeDensityCalculator.html b/classChargeDensityCalculator.html
@@ -128,19 +128,17 @@
 <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 SplineChargeDensityCalculator.  <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:a9b209db47e420d108fbb6f329a65bbdf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf">ChargeDensityCalculator</a> (const ChunkViewType &amp;coeffs)</td></tr>
+<tr class="memdesc:a9b209db47e420d108fbb6f329a65bbdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="classChargeDensityCalculator.html" title="A class which computes charges density with Kokkos.">ChargeDensityCalculator</a> object.  <a href="classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf">More...</a><br /></td></tr>
+<tr class="separator:a9b209db47e420d108fbb6f329a65bbdf"><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="memdesc:aa171397828c246922b136642e0295e26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes 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 with Kokkos. </p>
-<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>
+<p>A class which computes charges density by solving the equation: \( \int_{vx} \int_{vy} q_s f_s(x,y,vx,vy) dvx dvy \) where \( q_s \) is the charge of the species \( s \) and \( f_s(x,y,vx,vy) \) is the distribution function. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a9b209db47e420d108fbb6f329a65bbdf"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a9b209db47e420d108fbb6f329a65bbdf">&#9670;&nbsp;</a></span>ChargeDensityCalculator() <span class="overload">[1/2]</span></h2>
@@ -176,37 +174,34 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9b209db47e420d108fbb6f32
 
 </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>
+<a id="a9b209db47e420d108fbb6f329a65bbdf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9b209db47e420d108fbb6f329a65bbdf">&#9670;&nbsp;</a></span>ChargeDensityCalculator() <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">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 class="paramtype">const ChunkViewType &amp;&#160;</td>
+          <td class="paramname"><em>coeffs</em></td><td>)</td>
           <td></td>
-          <td>)</td>
-          <td></td><td></td>
         </tr>
       </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
+  </tr>
+</table>
 </div><div class="memdoc">
 
-<p>Constructor of SplineChargeDensityCalculator. </p>
+<p>Create a <a class="el" href="classChargeDensityCalculator.html" title="A class which computes charges density with Kokkos.">ChargeDensityCalculator</a> object. </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>
+    <tr><td class="paramdir">[in]</td><td class="paramname">coeffs</td><td>The coefficients of the quadrature. </td></tr>
   </table>
   </dd>
 </dl>
@@ -296,12 +291,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa171397828c246922b136642
 </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>
+<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">[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>
+    <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>

diff --git a/classChargeDensityCalculator.js b/classChargeDensityCalculator.js
@@ -1,7 +1,7 @@
 var classChargeDensityCalculator =
 [
     [ "ChargeDensityCalculator", "classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf", null ],
-    [ "ChargeDensityCalculator", "classChargeDensityCalculator.html#a2d97d4f1d146845b2ec7f54f83344089", null ],
+    [ "ChargeDensityCalculator", "classChargeDensityCalculator.html#a9b209db47e420d108fbb6f329a65bbdf", null ],
     [ "operator()", "classChargeDensityCalculator.html#ad7440f208cab363eef9c4374da155fea", null ],
     [ "operator()", "classChargeDensityCalculator.html#aa171397828c246922b136642e0295e26", null ]
 ];