Update docs

gyselax · Jan 16, 2024 · a399ae3 · a399ae3
1 parent 93f14df
commit a399ae3
Show file tree

Hide file tree

Showing 28 changed files with 152 additions and 140 deletions.
diff --git a/annotated.html b/annotated.html
@@ -226,7 +226,7 @@
 <tr id="row_98_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNullAdvectionVelocity.html" target="_self">NullAdvectionVelocity</a></td><td class="desc"></td></tr>
 <tr id="row_99_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNullBoundaryValue.html" target="_self">NullBoundaryValue</a></td><td class="desc"></td></tr>
 <tr id="row_100_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNullBoundaryValue2D.html" target="_self">NullBoundaryValue2D</a></td><td class="desc"></td></tr>
-<tr id="row_101_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNullPoissonSolver.html" target="_self">NullPoissonSolver</a></td><td class="desc"></td></tr>
+<tr id="row_101_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNullPoissonSolver.html" target="_self">NullPoissonSolver</a></td><td class="desc">Null operator </td></tr>
 <tr id="row_102_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPoissonRHSFunction.html" target="_self">PoissonRHSFunction</a></td><td class="desc">Type of right-hand side (rhs) function of the Poisson equation </td></tr>
 <tr id="row_103_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPoissonSolution.html" target="_self">PoissonSolution</a></td><td class="desc">Base class for the exact solutions of the Poisson equation </td></tr>
 <tr id="row_104_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_104_" class="arrow" onclick="toggleFolder('104_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarBSplines.html" target="_self">PolarBSplines</a></td><td class="desc"></td></tr>

diff --git a/classFemNonPeriodicPoissonSolver-members.html b/classFemNonPeriodicPoissonSolver-members.html
@@ -107,7 +107,7 @@
 <p>This is the complete list of members for <a class="el" href="classFemNonPeriodicPoissonSolver.html">FemNonPeriodicPoissonSolver</a>, including all inherited members.</p>
 <table class="directory">
   <tr class="even"><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html#af921493cf49bc87d9da03f41d9f857fa">FemNonPeriodicPoissonSolver</a>(SplineXBuilder const &amp;spline_x_builder, SplineEvaluator&lt; BSplinesX &gt; const &amp;spline_x_evaluator, IChargeDensityCalculator const &amp;compute_rho)</td><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html">FemNonPeriodicPoissonSolver</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html#ae81c12b0b37dd2f2bf3f4f24d7d7bf66">operator()</a>(DSpanX electrostatic_potential, DSpanX electric_field, DViewSpXVx allfdistribu) const override</td><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html">FemNonPeriodicPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html#aab4a613cf57eeff7a597c0a81c6d82e3">operator()</a>(device_t&lt; DSpanX &gt; electrostatic_potential_device, device_t&lt; DSpanX &gt; electric_field_device, device_t&lt; DViewSpXVx &gt; allfdistribu_device) const override</td><td class="entry"><a class="el" href="classFemNonPeriodicPoissonSolver.html">FemNonPeriodicPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classIPoissonSolver.html#a2e07de086727dd87d194d5132517e8a5">IPoissonSolver::operator()</a>(DSpanRP electrostatic_potential, VectorFieldSpan&lt; double, IDomainRP, NDTag&lt; RDimX, RDimY &gt;&gt; electric_field, DViewRP allfdistribu) const =0</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classIPoissonSolver.html#acc648976a27e0b36daf0615d7b8eebd6">IPoissonSolver::operator()</a>(DSpanXY electrostatic_potential, DSpanXY electric_field_x, DSpanXY electric_field_y, DViewSpXYVxVy allfdistribu) const =0</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~IPoissonSolver</b>()=default (defined in <a class="el" href="classIPoissonSolver.html">IPoissonSolver</a>)</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>

diff --git a/classFemNonPeriodicPoissonSolver.html b/classFemNonPeriodicPoissonSolver.html
@@ -131,9 +131,9 @@
 <tr class="memitem:af921493cf49bc87d9da03f41d9f857fa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFemNonPeriodicPoissonSolver.html#af921493cf49bc87d9da03f41d9f857fa">FemNonPeriodicPoissonSolver</a> (<a class="el" href="classSplineBuilder.html">SplineXBuilder</a> const &amp;spline_x_builder, <a class="el" href="classSplineEvaluator.html">SplineEvaluator</a>&lt; BSplinesX &gt; const &amp;spline_x_evaluator, <a class="el" href="classIChargeDensityCalculator.html">IChargeDensityCalculator</a> const &amp;compute_rho)</td></tr>
 <tr class="memdesc:af921493cf49bc87d9da03f41d9f857fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the <a class="el" href="classFemNonPeriodicPoissonSolver.html" title="An operator which solves the Poisson equation using Finite Elements on a non-periodic domain.">FemNonPeriodicPoissonSolver</a> operator.  <a href="classFemNonPeriodicPoissonSolver.html#af921493cf49bc87d9da03f41d9f857fa">More...</a><br /></td></tr>
 <tr class="separator:af921493cf49bc87d9da03f41d9f857fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae81c12b0b37dd2f2bf3f4f24d7d7bf66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFemNonPeriodicPoissonSolver.html#ae81c12b0b37dd2f2bf3f4f24d7d7bf66">operator()</a> (DSpanX electrostatic_potential, DSpanX electric_field, DViewSpXVx allfdistribu) const override</td></tr>
-<tr class="memdesc:ae81c12b0b37dd2f2bf3f4f24d7d7bf66"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operator which solves the equation using the method described by the class.  <a href="classFemNonPeriodicPoissonSolver.html#ae81c12b0b37dd2f2bf3f4f24d7d7bf66">More...</a><br /></td></tr>
-<tr class="separator:ae81c12b0b37dd2f2bf3f4f24d7d7bf66"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aab4a613cf57eeff7a597c0a81c6d82e3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFemNonPeriodicPoissonSolver.html#aab4a613cf57eeff7a597c0a81c6d82e3">operator()</a> (device_t&lt; DSpanX &gt; electrostatic_potential_device, device_t&lt; DSpanX &gt; electric_field_device, device_t&lt; DViewSpXVx &gt; allfdistribu_device) const override</td></tr>
+<tr class="memdesc:aab4a613cf57eeff7a597c0a81c6d82e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operator which solves the equation using the method described by the class.  <a href="classFemNonPeriodicPoissonSolver.html#aab4a613cf57eeff7a597c0a81c6d82e3">More...</a><br /></td></tr>
+<tr class="separator:aab4a613cf57eeff7a597c0a81c6d82e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pub_methods_classIPoissonSolver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIPoissonSolver')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td></tr>
 <tr class="memitem:a2e07de086727dd87d194d5132517e8a5 inherit pub_methods_classIPoissonSolver"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIPoissonSolver.html#a2e07de086727dd87d194d5132517e8a5">operator()</a> (DSpanRP electrostatic_potential, <a class="el" href="classVectorFieldSpan.html">VectorFieldSpan</a>&lt; double, IDomainRP, NDTag&lt; <a class="el" href="structRDimX.html">RDimX</a>, <a class="el" href="structRDimY.html">RDimY</a> &gt;&gt; electric_field, DViewRP allfdistribu) const =0</td></tr>
 <tr class="memdesc:a2e07de086727dd87d194d5132517e8a5 inherit pub_methods_classIPoissonSolver"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the electrical potential and the electric field from the Poisson equation.  <a href="classIPoissonSolver.html#a2e07de086727dd87d194d5132517e8a5">More...</a><br /></td></tr>
@@ -207,8 +207,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#af921493cf49bc87d9da03f41
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a id="ae81c12b0b37dd2f2bf3f4f24d7d7bf66"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae81c12b0b37dd2f2bf3f4f24d7d7bf66">&#9670;&nbsp;</a></span>operator()()</h2>
+<a id="aab4a613cf57eeff7a597c0a81c6d82e3"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aab4a613cf57eeff7a597c0a81c6d82e3">&#9670;&nbsp;</a></span>operator()()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -219,20 +219,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae81c12b0b37dd2f2bf3f4f24
         <tr>
           <td class="memname">void FemNonPeriodicPoissonSolver::operator() </td>
           <td>(</td>
-          <td class="paramtype">DSpanX&#160;</td>
-          <td class="paramname"><em>electrostatic_potential</em>, </td>
+          <td class="paramtype">device_t&lt; DSpanX &gt;&#160;</td>
+          <td class="paramname"><em>electrostatic_potential_device</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">DSpanX&#160;</td>
-          <td class="paramname"><em>electric_field</em>, </td>
+          <td class="paramtype">device_t&lt; DSpanX &gt;&#160;</td>
+          <td class="paramname"><em>electric_field_device</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">DViewSpXVx&#160;</td>
-          <td class="paramname"><em>allfdistribu</em>&#160;</td>
+          <td class="paramtype">device_t&lt; DViewSpXVx &gt;&#160;</td>
+          <td class="paramname"><em>allfdistribu_device</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
@@ -250,14 +250,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae81c12b0b37dd2f2bf3f4f24
 <p>The operator which solves the equation using the method described by the class. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">electrostatic_potential</td><td>The electrostatic potential, the result of the poisson solver. </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">electric_field</td><td>The electric field, the derivative of the electrostatic potential. </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">allfdistribu</td><td>The distribution function. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">electrostatic_potential_device</td><td>The electrostatic potential, the result of the poisson solver. </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">electric_field_device</td><td>The electric field, the derivative of the electrostatic potential. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">allfdistribu_device</td><td>The distribution function. </td></tr>
   </table>
   </dd>
 </dl>
 
-<p>Implements <a class="el" href="classIPoissonSolver.html#a2819621d345ddde4acad30a47c8fd7f9">IPoissonSolver</a>.</p>
+<p>Implements <a class="el" href="classIPoissonSolver.html#a2e103a767415b050081cd0243ae4e505">IPoissonSolver</a>.</p>
 
 </div>
 </div>

diff --git a/classFemNonPeriodicPoissonSolver.js b/classFemNonPeriodicPoissonSolver.js
@@ -2,5 +2,5 @@ var classFemNonPeriodicPoissonSolver =
 [
     [ "QDimX", "classFemNonPeriodicPoissonSolver.html#structFemNonPeriodicPoissonSolver_1_1QDimX", null ],
     [ "FemNonPeriodicPoissonSolver", "classFemNonPeriodicPoissonSolver.html#af921493cf49bc87d9da03f41d9f857fa", null ],
-    [ "operator()", "classFemNonPeriodicPoissonSolver.html#ae81c12b0b37dd2f2bf3f4f24d7d7bf66", null ]
+    [ "operator()", "classFemNonPeriodicPoissonSolver.html#aab4a613cf57eeff7a597c0a81c6d82e3", null ]
 ];
diff --git a/classFemPeriodicPoissonSolver-members.html b/classFemPeriodicPoissonSolver-members.html
@@ -107,7 +107,7 @@
 <p>This is the complete list of members for <a class="el" href="classFemPeriodicPoissonSolver.html">FemPeriodicPoissonSolver</a>, including all inherited members.</p>
 <table class="directory">
   <tr class="even"><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html#a9e92800dd60cee9ab3898f55ce08e82f">FemPeriodicPoissonSolver</a>(SplineXBuilder const &amp;spline_x_builder, SplineEvaluator&lt; BSplinesX &gt; const &amp;spline_x_evaluator, IChargeDensityCalculator const &amp;compute_rho)</td><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html">FemPeriodicPoissonSolver</a></td><td class="entry"></td></tr>
-  <tr><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html#a29947ba0529fe6de504b85780a0d741e">operator()</a>(DSpanX electrostatic_potential, DSpanX electric_field, DViewSpXVx allfdistribu) const override</td><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html">FemPeriodicPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html#ad4956088f1ee27d71cd451b7450f416b">operator()</a>(device_t&lt; DSpanX &gt; electrostatic_potential_device, device_t&lt; DSpanX &gt; electric_field_device, device_t&lt; DViewSpXVx &gt; allfdistribu_device) const override</td><td class="entry"><a class="el" href="classFemPeriodicPoissonSolver.html">FemPeriodicPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classIPoissonSolver.html#a2e07de086727dd87d194d5132517e8a5">IPoissonSolver::operator()</a>(DSpanRP electrostatic_potential, VectorFieldSpan&lt; double, IDomainRP, NDTag&lt; RDimX, RDimY &gt;&gt; electric_field, DViewRP allfdistribu) const =0</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classIPoissonSolver.html#acc648976a27e0b36daf0615d7b8eebd6">IPoissonSolver::operator()</a>(DSpanXY electrostatic_potential, DSpanXY electric_field_x, DSpanXY electric_field_y, DViewSpXYVxVy allfdistribu) const =0</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~IPoissonSolver</b>()=default (defined in <a class="el" href="classIPoissonSolver.html">IPoissonSolver</a>)</td><td class="entry"><a class="el" href="classIPoissonSolver.html">IPoissonSolver</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>