Update docs

gyselax · Jun 25, 2024 · 85a4512 · 85a4512
1 parent a3c6d79
commit 85a4512
Show file tree

Hide file tree

Showing 122 changed files with 1,925 additions and 2,532 deletions.
diff --git a/annotated.html b/annotated.html
@@ -278,15 +278,12 @@
 <tr id="row_153_"><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="structPolarSpline.html" target="_self">PolarSpline</a></td><td class="desc">A structure containing the two Chunks necessary to define a spline on a set of polar basis splines </td></tr>
 <tr id="row_154_" 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="classPolarSplineEvaluator.html" target="_self">PolarSplineEvaluator</a></td><td class="desc">Define an evaluator on polar B-splines </td></tr>
 <tr id="row_155_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_155_" class="arrow" onclick="toggleFolder('155_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html" target="_self">PolarSplineFEMPoissonLikeSolver</a></td><td class="desc">Define a polar PDE solver for a Poisson-like equation </td></tr>
-<tr id="row_155_0_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator" target="_self">InternalTagGenerator</a></td><td class="desc">This struct is used to provide alternative tags </td></tr>
-<tr id="row_155_1_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset" target="_self">PBasisSubset</a></td><td class="desc"></td></tr>
-<tr id="row_155_2_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim" target="_self">PCellDim</a></td><td class="desc"></td></tr>
-<tr id="row_155_3_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimP.html" target="_self">QDimP</a></td><td class="desc">Tag the second dimension for the quadrature </td></tr>
-<tr id="row_155_4_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimPMesh.html" target="_self">QDimPMesh</a></td><td class="desc">Tag the second dimension for the quadrature mesh </td></tr>
-<tr id="row_155_5_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimR.html" target="_self">QDimR</a></td><td class="desc">Tag the first dimension for the quadrature </td></tr>
-<tr id="row_155_6_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimRMesh.html" target="_self">QDimRMesh</a></td><td class="desc">Tag the first dimension for the quadrature mesh </td></tr>
-<tr id="row_155_7_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RBasisSubset" target="_self">RBasisSubset</a></td><td class="desc"></td></tr>
-<tr id="row_155_8_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RCellDim" target="_self">RCellDim</a></td><td class="desc"></td></tr>
+<tr id="row_155_0_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset" target="_self">PBasisSubset</a></td><td class="desc"></td></tr>
+<tr id="row_155_1_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim" target="_self">PCellDim</a></td><td class="desc"></td></tr>
+<tr id="row_155_2_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimPMesh.html" target="_self">QDimPMesh</a></td><td class="desc">Tag the second dimension for the quadrature mesh </td></tr>
+<tr id="row_155_3_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimRMesh.html" target="_self">QDimRMesh</a></td><td class="desc">Tag the first dimension for the quadrature mesh </td></tr>
+<tr id="row_155_4_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RBasisSubset" target="_self">RBasisSubset</a></td><td class="desc"></td></tr>
+<tr id="row_155_5_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RCellDim" target="_self">RCellDim</a></td><td class="desc"></td></tr>
 <tr id="row_156_" 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="structPolarSplineSpan.html" target="_self">PolarSplineSpan</a></td><td class="desc">A structure containing the two ChunkSpans necessary to define a reference to a spline on a set of polar basis splines </td></tr>
 <tr id="row_157_"><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="structPolarSplineView.html" target="_self">PolarSplineView</a></td><td class="desc">A structure containing the two ChunkViews necessary to define a constant reference to a spline on a set of polar basis splines </td></tr>
 <tr id="row_158_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_158_" class="arrow" onclick="toggleFolder('158_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structPolynomialEvaluator.html" target="_self">PolynomialEvaluator</a></td><td class="desc"></td></tr>

diff --git a/classPolarSplineFEMPoissonLikeSolver.html b/classPolarSplineFEMPoissonLikeSolver.html
@@ -113,22 +113,13 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 Classes</h2></td></tr>
-<tr class="memitem:structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator">InternalTagGenerator</a></td></tr>
-<tr class="memdesc:structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator"><td class="mdescLeft">&#160;</td><td class="mdescRight">This struct is used to provide alternative tags.  <a href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator">More...</a><br /></td></tr>
-<tr class="separator:structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset">PBasisSubset</a></td></tr>
 <tr class="separator:structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:structPolarSplineFEMPoissonLikeSolver_1_1PCellDim"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim">PCellDim</a></td></tr>
 <tr class="separator:structPolarSplineFEMPoissonLikeSolver_1_1PCellDim"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimP.html">QDimP</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag the second dimension for the quadrature.  <a href="structPolarSplineFEMPoissonLikeSolver_1_1QDimP.html#details">More...</a><br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimPMesh.html">QDimPMesh</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag the second dimension for the quadrature mesh.  <a href="structPolarSplineFEMPoissonLikeSolver_1_1QDimPMesh.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimR.html">QDimR</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag the first dimension for the quadrature.  <a href="structPolarSplineFEMPoissonLikeSolver_1_1QDimR.html#details">More...</a><br /></td></tr>
-<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPolarSplineFEMPoissonLikeSolver_1_1QDimRMesh.html">QDimRMesh</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tag the first dimension for the quadrature mesh.  <a href="structPolarSplineFEMPoissonLikeSolver_1_1QDimRMesh.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -161,34 +152,6 @@
 <p>(see in Emily Bourne's thesis "Non-Uniform Numerical Schemes for the Modelling of Turbulence
  in the 5D GYSELA Code". December 2022.) </p>
 </div><hr/><h2 class="groupheader">Class Documentation</h2>
-<a name="structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator" id="structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator">&#9670;&nbsp;</a></span>PolarSplineFEMPoissonLikeSolver::InternalTagGenerator</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct PolarSplineFEMPoissonLikeSolver::InternalTagGenerator</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<div class="textblock"><h3>template&lt;class T&gt;<br />
-struct PolarSplineFEMPoissonLikeSolver::InternalTagGenerator&lt; T &gt;</h3>
-
-<p>This struct is used to provide alternative tags. </p>
-<p>It is used to create new meshes. This is necessary because in DDC we can only create a single mesh for a tagged dimension. </p>
-</div><table class="fieldtable">
-<tr><th colspan="3">Class Members</th></tr>
-<tr><td class="fieldtype">
-<a id="a2813fb2feb0aa859d8d83f600fe9b134"></a>typedef T</td>
-<td class="fieldname">
-tag</td>
-<td class="fielddoc">
-</td></tr>
-</table>
-
-</div>
-</div>
 <a name="structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset" id="structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset">&#9670;&nbsp;</a></span>PolarSplineFEMPoissonLikeSolver::PBasisSubset</h2>
 

diff --git a/classPolarSplineFEMPoissonLikeSolver.js b/classPolarSplineFEMPoissonLikeSolver.js
@@ -1,13 +1,8 @@
 var classPolarSplineFEMPoissonLikeSolver =
 [
-    [ "InternalTagGenerator", "classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator", [
-      [ "tag", "classPolarSplineFEMPoissonLikeSolver.html#a2813fb2feb0aa859d8d83f600fe9b134", null ]
-    ] ],
     [ "PBasisSubset", "classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset", null ],
     [ "PCellDim", "classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim", null ],
-    [ "QDimP", "structPolarSplineFEMPoissonLikeSolver_1_1QDimP.html", null ],
     [ "QDimPMesh", "structPolarSplineFEMPoissonLikeSolver_1_1QDimPMesh.html", null ],
-    [ "QDimR", "structPolarSplineFEMPoissonLikeSolver_1_1QDimR.html", null ],
     [ "QDimRMesh", "structPolarSplineFEMPoissonLikeSolver_1_1QDimRMesh.html", null ],
     [ "RBasisSubset", "classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RBasisSubset", null ],
     [ "RCellDim", "classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RCellDim", null ],

diff --git a/navtreedata.js b/navtreedata.js
@@ -90,9 +90,9 @@ var NAVTREEINDEX =
 "classCrankNicolson.html#a55cb75c920e5ee4791900c1f7f71bc7f",
 "classFemNonPeriodicQNSolver.html",
 "classMatrix__Dense.html#a2738310b5ae0c4357127d5275ea7cadd",
-"classSpeciesInformation_1_1Impl.html#aec6f1661184ffda483c7c00de7bd0198",
-"iadvectionvx_8hpp_source.html",
-"structGridVpar.html"
+"classSplineFootFinder.html#a318c630fd5384ed0093581774239c9df",
+"iboltzmannsolver_8hpp_source.html",
+"structIDimM.html"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronisation';

diff --git a/navtreeindex3.js b/navtreeindex3.js
@@ -122,15 +122,13 @@ var NAVTREEINDEX3 =
 "classPolarSplineEvaluator.html#af5de8a13917331a541a20a989b1564a0":[18,154,18],
 "classPolarSplineEvaluator.html#af825f47ac1278302e5dd3ac0d906f09c":[18,154,1],
 "classPolarSplineFEMPoissonLikeSolver.html":[18,155],
-"classPolarSplineFEMPoissonLikeSolver.html#a208c1aab7d91aedcbe30231a46979c49":[18,155,10],
-"classPolarSplineFEMPoissonLikeSolver.html#a2813fb2feb0aa859d8d83f600fe9b134":[18,155,0,0],
-"classPolarSplineFEMPoissonLikeSolver.html#a516c5cef90e719084d9aeb3ccb52ae91":[18,155,9],
-"classPolarSplineFEMPoissonLikeSolver.html#ae4998db0ac9dd7fc04e8a372d349d1be":[18,155,11],
-"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1InternalTagGenerator":[18,155,0],
-"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset":[18,155,1],
-"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim":[18,155,2],
-"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RBasisSubset":[18,155,7],
-"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RCellDim":[18,155,8],
+"classPolarSplineFEMPoissonLikeSolver.html#a208c1aab7d91aedcbe30231a46979c49":[18,155,7],
+"classPolarSplineFEMPoissonLikeSolver.html#a516c5cef90e719084d9aeb3ccb52ae91":[18,155,6],
+"classPolarSplineFEMPoissonLikeSolver.html#ae4998db0ac9dd7fc04e8a372d349d1be":[18,155,8],
+"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PBasisSubset":[18,155,0],
+"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1PCellDim":[18,155,1],
+"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RBasisSubset":[18,155,4],
+"classPolarSplineFEMPoissonLikeSolver.html#structPolarSplineFEMPoissonLikeSolver_1_1RCellDim":[18,155,5],
 "classPreallocatableLagrangeInterpolator.html":[18,159],
 "classPreallocatableLagrangeInterpolator.html#a0afbc6bd81cf0889945992f180c7837d":[18,159,2],
 "classPreallocatableLagrangeInterpolator.html#a34dd082893c1f3bcafb527c74214ca3f":[18,159,0],
@@ -249,5 +247,7 @@ var NAVTREEINDEX3 =
 "classSpeciesInformation_1_1Impl.html#aaadb8479b456bd558cb68cd39180ce1c":[18,183,0,0],
 "classSpeciesInformation_1_1Impl.html#adcaf2527acc2c7a0a18f741240082b56":[18,183,0,8],
 "classSpeciesInformation_1_1Impl.html#ade8f1e1c64db40ed7edf425dcb165dd3":[18,183,0,2],
-"classSpeciesInformation_1_1Impl.html#aea203192b710292dcbb7f6a3049c56ab":[18,183,0,7]
+"classSpeciesInformation_1_1Impl.html#aea203192b710292dcbb7f6a3049c56ab":[18,183,0,7],
+"classSpeciesInformation_1_1Impl.html#aec6f1661184ffda483c7c00de7bd0198":[18,183,0,1],
+"classSplineFootFinder.html":[18,184]
 };
diff --git a/navtreeindex4.js b/navtreeindex4.js
@@ -1,7 +1,5 @@
 var NAVTREEINDEX4 =
 {
-"classSpeciesInformation_1_1Impl.html#aec6f1661184ffda483c7c00de7bd0198":[18,183,0,1],
-"classSplineFootFinder.html":[18,184],
 "classSplineFootFinder.html#a318c630fd5384ed0093581774239c9df":[18,184,1],
 "classSplineFootFinder.html#a3da5df4e45c0771002568987d24f922c":[18,184,0],
 "classSplineFootFinder.html#a6c99a3c797b8e49db511bee6d62e051d":[18,184,2],
@@ -249,5 +247,7 @@ var NAVTREEINDEX4 =
 "geometryXYVxVy_2vlasov_2splitvlasovsolver_8hpp_source.html":[19,0,6,4,1],
 "geometry__pseudo__cartesian_8hpp_source.html":[19,0,4,0,2],
 "i__interpolator__2d__rp_8hpp_source.html":[19,0,4,4,0],
-"iadvectionrp_8hpp_source.html":[19,0,4,0,3]
+"iadvectionrp_8hpp_source.html":[19,0,4,0,3],
+"iadvectionvx_8hpp_source.html":[19,0,0,2],
+"iadvectionx_8hpp_source.html":[19,0,0,3]
 };
diff --git a/navtreeindex5.js b/navtreeindex5.js
@@ -1,7 +1,5 @@
 var NAVTREEINDEX5 =
 {
-"iadvectionvx_8hpp_source.html":[19,0,0,2],
-"iadvectionx_8hpp_source.html":[19,0,0,3],
 "iboltzmannsolver_8hpp_source.html":[19,0,5,0,0],
 "ifluidinitialization_8hpp_source.html":[19,0,5,2,0,32],
 "ifluidsolver_8hpp_source.html":[19,0,5,2,1,1],
@@ -249,5 +247,7 @@ var NAVTREEINDEX5 =
 "structGridMu.html":[18,82],
 "structGridTor1.html":[18,83],
 "structGridTor2.html":[18,84],
-"structGridTor3.html":[18,85]
+"structGridTor3.html":[18,85],
+"structGridVpar.html":[18,86],
+"structHiddenNUBSplinesX.html":[18,87]
 };