Update docs

gyselax · Jul 31, 2024 · 9883b49 · 9883b49
1 parent 4285bc7
commit 9883b49
Show file tree

Hide file tree

Showing 76 changed files with 1,355 additions and 1,359 deletions.
diff --git a/CollisionSpVparMu_8hpp_source.html b/CollisionSpVparMu_8hpp_source.html
diff --git a/annotated.html b/annotated.html
@@ -112,13 +112,13 @@
 <tr id="row_0_3_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim" target="_self">ExtractRDim</a></td><td class="desc">Class to get the type of the radial dimension from a field containing a radial profile </td></tr>
 <tr id="row_0_4_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim" target="_self">ExtractThetaDim</a></td><td class="desc">Class to get the type of the poloidal dimension from a field containing a profile on the poloidal plane </td></tr>
 <tr id="row_0_5_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01double_01_4" target="_self">ExtractRDim&lt; double &gt;</a></td><td class="desc">If radial profile is stored in a double then the grid tag must be spoofed </td></tr>
-<tr id="row_0_6_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discrete66ae31fe0208a2bfe0fe11cb4a94ddf5" target="_self">ExtractRDim&lt; ddc::ChunkView&lt; double, ddc::DiscreteDomain&lt; GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt; &gt;</a></td><td class="desc">If radial profile is stored in a 1D chunk then the grid tag is extracted </td></tr>
-<tr id="row_0_7_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ddc_1_1ChunkSpan_3_01ElementType_00_01Domain_00_da4a2a82b6813ff15d11a26b6c8b6c9b" target="_self">ExtractRDim&lt; ddc::ChunkSpan&lt; ElementType, Domain, Layout, MemSpace &gt; &gt;</a></td><td class="desc">If radial profile is stored in a chunk then information about why the chunk has the wrong type is provided </td></tr>
+<tr id="row_0_6_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ConstField_3_01double_00_01IdxRange_3_01GridR_01e5eec9867dc0367509479a78f691ed0d" target="_self">ExtractRDim&lt; ConstField&lt; double, IdxRange&lt; GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt; &gt;</a></td><td class="desc">If radial profile is stored in a 1D chunk then the grid tag is extracted </td></tr>
+<tr id="row_0_7_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01Field_3_01ElementType_00_01IdxRange_00_01Layout_00_01MemSpace_01_4_01_4" target="_self">ExtractRDim&lt; Field&lt; ElementType, IdxRange, Layout, MemSpace &gt; &gt;</a></td><td class="desc">If radial profile is stored in a chunk then information about why the chunk has the wrong type is provided </td></tr>
 <tr id="row_0_8_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01double_00_01InternalSpoofGridR_01_4" target="_self">ExtractThetaDim&lt; double, InternalSpoofGridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a double then the grid tag must be spoofed </td></tr>
-<tr id="row_0_9_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc938a530d697f9d9fb11b161daabf5b5d" target="_self">ExtractThetaDim&lt; ddc::ChunkView&lt; double, ddc::DiscreteDomain&lt; GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a chunk on radial values then the grid tag must be spoofed </td></tr>
-<tr id="row_0_10_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc19a320c953e3676a9b294c0d809c012c" target="_self">ExtractThetaDim&lt; ddc::ChunkView&lt; double, ddc::DiscreteDomain&lt; GridTheta &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a chunk on poloidal values then the grid tag is extracted </td></tr>
-<tr id="row_0_11_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discb3286abb5e86ec1901aa831a4f0ee9e7" target="_self">ExtractThetaDim&lt; ddc::ChunkView&lt; double, ddc::DiscreteDomain&lt; GridTheta, GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a 2D chunk then the grid tag is extracted </td></tr>
-<tr id="row_0_12_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkSpan_3_01ElementType_00_01Domainb357245815e290438e21c3de4c88ad13" target="_self">ExtractThetaDim&lt; ddc::ChunkSpan&lt; ElementType, Domain, Layout, MemSpace &gt;, GridR &gt;</a></td><td class="desc">If poloidal profile is stored in a chunk then information about why the chunk has the wrong type is provided </td></tr>
+<tr id="row_0_9_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Gridefb14dd7b92083f6c86f080a59b9ace4" target="_self">ExtractThetaDim&lt; ConstField&lt; double, IdxRange&lt; GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a chunk on radial values then the grid tag must be spoofed </td></tr>
+<tr id="row_0_10_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid60f8483db1988437fdeb2a198e9fb77b" target="_self">ExtractThetaDim&lt; ConstField&lt; double, IdxRange&lt; GridTheta &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a chunk on poloidal values then the grid tag is extracted </td></tr>
+<tr id="row_0_11_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid57b262a660e92e54969d1eee8b470fb5" target="_self">ExtractThetaDim&lt; ConstField&lt; double, IdxRange&lt; GridTheta, GridR &gt;, Layout, Kokkos::DefaultExecutionSpace::memory_space &gt;, GridR &gt;</a></td><td class="desc">If the profile on the poloidal plane is stored in a 2D chunk then the grid tag is extracted </td></tr>
+<tr id="row_0_12_" 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="namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01Field_3_01ElementType_00_01IdxRange_00_01Lay7ee29cfb5ae685a651db9670325b8a2b" target="_self">ExtractThetaDim&lt; Field&lt; ElementType, IdxRange, Layout, MemSpace &gt;, GridR &gt;</a></td><td class="desc">If poloidal profile is stored in a chunk then information about why the chunk has the wrong type is provided </td></tr>
 <tr id="row_1_"><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="classAdvectionDomain.html" target="_self">AdvectionDomain</a></td><td class="desc">Define a domain for the advection </td></tr>
 <tr id="row_2_" 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="classAdvectionField.html" target="_self">AdvectionField</a></td><td class="desc">Base class for the advection field for the tests of the 2D polar advection operator </td></tr>
 <tr id="row_3_"><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="classAdvectionField__decentred__rotation.html" target="_self">AdvectionField_decentred_rotation</a></td><td class="desc">Advection field for the tests of the 2D polar advection operator </td></tr>

diff --git a/annotated.js b/annotated.js
@@ -7,13 +7,13 @@ var annotated =
       [ "ExtractRDim", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim", null ],
       [ "ExtractThetaDim", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim", null ],
       [ "ExtractRDim< double >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01double_01_4", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractRDim_3_01double_01_4_dup" ],
-      [ "ExtractRDim< ddc::ChunkView< double, ddc::DiscreteDomain< GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space > >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discrete66ae31fe0208a2bfe0fe11cb4a94ddf5", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractRDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discrete66ae31fe0208a2bfe0fe11cb4a94ddf5_dup" ],
-      [ "ExtractRDim< ddc::ChunkSpan< ElementType, Domain, Layout, MemSpace > >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ddc_1_1ChunkSpan_3_01ElementType_00_01Domain_00_da4a2a82b6813ff15d11a26b6c8b6c9b", null ],
+      [ "ExtractRDim< ConstField< double, IdxRange< GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space > >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01ConstField_3_01double_00_01IdxRange_3_01GridR_01e5eec9867dc0367509479a78f691ed0d", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractRDim_3_01ConstField_3_01double_00_01IdxRange_3_01GridR_01e5eec9867dc0367509479a78f691ed0d_dup" ],
+      [ "ExtractRDim< Field< ElementType, IdxRange, Layout, MemSpace > >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractRDim_3_01Field_3_01ElementType_00_01IdxRange_00_01Layout_00_01MemSpace_01_4_01_4", null ],
       [ "ExtractThetaDim< double, InternalSpoofGridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01double_00_01InternalSpoofGridR_01_4", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01double_00_01InternalSpoofGridR_01_4_dup" ],
-      [ "ExtractThetaDim< ddc::ChunkView< double, ddc::DiscreteDomain< GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc938a530d697f9d9fb11b161daabf5b5d", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc938a530d697f9d9fb11b161daabf5b5d_dup" ],
-      [ "ExtractThetaDim< ddc::ChunkView< double, ddc::DiscreteDomain< GridTheta >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc19a320c953e3676a9b294c0d809c012c", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Disc19a320c953e3676a9b294c0d809c012c_dup" ],
-      [ "ExtractThetaDim< ddc::ChunkView< double, ddc::DiscreteDomain< GridTheta, GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discb3286abb5e86ec1901aa831a4f0ee9e7", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkView_3_01double_00_01ddc_1_1Discb3286abb5e86ec1901aa831a4f0ee9e7_dup" ],
-      [ "ExtractThetaDim< ddc::ChunkSpan< ElementType, Domain, Layout, MemSpace >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ddc_1_1ChunkSpan_3_01ElementType_00_01Domainb357245815e290438e21c3de4c88ad13", null ]
+      [ "ExtractThetaDim< ConstField< double, IdxRange< GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Gridefb14dd7b92083f6c86f080a59b9ace4", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Gridefb14dd7b92083f6c86f080a59b9ace4_dup" ],
+      [ "ExtractThetaDim< ConstField< double, IdxRange< GridTheta >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid60f8483db1988437fdeb2a198e9fb77b", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid60f8483db1988437fdeb2a198e9fb77b_dup" ],
+      [ "ExtractThetaDim< ConstField< double, IdxRange< GridTheta, GridR >, Layout, Kokkos::DefaultExecutionSpace::memory_space >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid57b262a660e92e54969d1eee8b470fb5", "namespacecollisions__dimensions_structcollisions__dimensions_1_1ExtractThetaDim_3_01ConstField_3_01double_00_01IdxRange_3_01Grid57b262a660e92e54969d1eee8b470fb5_dup" ],
+      [ "ExtractThetaDim< Field< ElementType, IdxRange, Layout, MemSpace >, GridR >", "namespacecollisions__dimensions.html#structcollisions__dimensions_1_1ExtractThetaDim_3_01Field_3_01ElementType_00_01IdxRange_00_01Lay7ee29cfb5ae685a651db9670325b8a2b", null ]
     ] ],
     [ "AdvectionDomain", "classAdvectionDomain.html", "classAdvectionDomain" ],
     [ "AdvectionField", "classAdvectionField.html", "classAdvectionField" ],

diff --git a/classBumpontailEquilibrium-members.html b/classBumpontailEquilibrium-members.html
@@ -112,7 +112,7 @@
   <tr><td class="entry"><a class="el" href="classBumpontailEquilibrium.html#aed05ad7969a0072faec31baff6e79190">init_from_input</a>(IdxRangeSp dom_kinsp, PC_tree_t const &amp;yaml_input_file)</td><td class="entry"><a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classBumpontailEquilibrium.html#a0288d56e370eca487bc93d038b178114">mean_velocity_bot</a>() const</td><td class="entry"><a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr><td class="entry"><a class="el" href="classBumpontailEquilibrium.html#a4cd4ddf29a44f068db013ed7dc2a0215">operator()</a>(DSpanSpVx allfequilibrium) const override</td><td class="entry"><a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classIEquilibrium.html#af90b39211d1e331b572c9dc349e7908f">IEquilibrium::operator()</a>(DSpanSpVparMu allfequilibrium) const =0</td><td class="entry"><a class="el" href="classIEquilibrium.html">IEquilibrium</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classIEquilibrium.html#a425f7b104d75900fcc769bdee9c0cdbd">IEquilibrium::operator()</a>(DFieldSpVparMu allfequilibrium) const =0</td><td class="entry"><a class="el" href="classIEquilibrium.html">IEquilibrium</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr><td class="entry"><a class="el" href="classIEquilibrium.html#ac3766d5ef01c1e949ec3dd6d55892a75">IEquilibrium::operator()</a>(DFieldSpVxVy allfequilibrium) const =0</td><td class="entry"><a class="el" href="classIEquilibrium.html">IEquilibrium</a></td><td class="entry"><span class="mlabel">pure virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classBumpontailEquilibrium.html#a8e74948ac659299209e1550bab1fe694">temperature_bot</a>() const</td><td class="entry"><a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr bgcolor="#f0f0f0"><td class="entry"><b>~BumpontailEquilibrium</b>() override=default (defined in <a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a>)</td><td class="entry"><a class="el" href="classBumpontailEquilibrium.html">BumpontailEquilibrium</a></td><td class="entry"></td></tr>