Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub CI Documentation builder committed Jan 9, 2025
1 parent 6feb2b6 commit da6a98c
Show file tree
Hide file tree
Showing 80 changed files with 4,351 additions and 3,146 deletions.
4 changes: 2 additions & 2 deletions advection__2d__rp_2test__cases_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -513,8 +513,8 @@
<div class="ttc" id="aclassRotationSimulation_html_a24cab55207f4b65feffd1255545b92dd"><div class="ttname"><a href="classRotationSimulation.html#a24cab55207f4b65feffd1255545b92dd">RotationSimulation::RotationSimulation</a></div><div class="ttdeci">RotationSimulation(Mapping const &amp;mapping, double const rmin, double const rmax)</div><div class="ttdoc">Instantiate a RotationSimulation simulation.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:545</div></div>
<div class="ttc" id="aclassTranslationSimulation_html"><div class="ttname"><a href="classTranslationSimulation.html">TranslationSimulation</a></div><div class="ttdoc">Simulation of a translated Gaussian.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:482</div></div>
<div class="ttc" id="aclassTranslationSimulation_html_a93ef880e4bde7812610f07198d620be1"><div class="ttname"><a href="classTranslationSimulation.html#a93ef880e4bde7812610f07198d620be1">TranslationSimulation::TranslationSimulation</a></div><div class="ttdeci">TranslationSimulation(Mapping const &amp;mapping, double const rmin, double const rmax)</div><div class="ttdoc">Instantiate a TranslationSimulation simulation.</div><div class="ttdef"><b>Definition</b> test_cases.hpp:494</div></div>
<div class="ttc" id="astructVx_html"><div class="ttname"><a href="structVx.html">Vx</a></div><div class="ttdoc">Define non periodic real X velocity dimension.</div><div class="ttdef"><b>Definition</b> geometry.hpp:300</div></div>
<div class="ttc" id="astructVy_html"><div class="ttname"><a href="structVy.html">Vy</a></div><div class="ttdoc">Define non periodic real Y velocity dimension.</div><div class="ttdef"><b>Definition</b> geometry.hpp:311</div></div>
<div class="ttc" id="astructVx_html"><div class="ttname"><a href="structVx.html">Vx</a></div><div class="ttdoc">Define non periodic real X velocity dimension.</div><div class="ttdef"><b>Definition</b> geometry.hpp:341</div></div>
<div class="ttc" id="astructVy_html"><div class="ttname"><a href="structVy.html">Vy</a></div><div class="ttdoc">Define non periodic real Y velocity dimension.</div><div class="ttdef"><b>Definition</b> geometry.hpp:352</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion advection__field__rp_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@
<div class="ttc" id="aclassAdvectionFieldFinder_html_af8a043f36e90ea2b67a30978ccbca01b"><div class="ttname"><a href="classAdvectionFieldFinder.html#af8a043f36e90ea2b67a30978ccbca01b">AdvectionFieldFinder::operator()</a></div><div class="ttdeci">void operator()(host_t&lt; Spline2D &gt; electrostatic_potential_coef, host_t&lt; DVectorFieldRTheta&lt; R, Theta &gt; &gt; advection_field_rp, CoordXY &amp;advection_field_xy_center) const</div><div class="ttdoc">Compute the advection field from a spline representation of .</div><div class="ttdef"><b>Definition</b> advection_field_rp.hpp:388</div></div>
<div class="ttc" id="aclassInverseJacobianMatrix_html"><div class="ttname"><a href="classInverseJacobianMatrix.html">InverseJacobianMatrix</a></div><div class="ttdoc">A class to calculate the inverse of the Jacobian matrix.</div><div class="ttdef"><b>Definition</b> inverse_jacobian_matrix.hpp:18</div></div>
<div class="ttc" id="aclassMetricTensor_html"><div class="ttname"><a href="classMetricTensor.html">MetricTensor</a></div><div class="ttdoc">An operator for calculating the metric tensor.</div><div class="ttdef"><b>Definition</b> metric_tensor.hpp:15</div></div>
<div class="ttc" id="aclassPolarBSplines_html_ae4895a87f3e1ed953614a3546c319762"><div class="ttname"><a href="classPolarBSplines.html#ae4895a87f3e1ed953614a3546c319762">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static int constexpr continuity</div><div class="ttdoc">The continuity enforced by the bsplines at the singular point.</div><div class="ttdef"><b>Definition</b> polar_bsplines.hpp:61</div></div>
<div class="ttc" id="aclassPolarBSplines_html_ae4895a87f3e1ed953614a3546c319762"><div class="ttname"><a href="classPolarBSplines.html#ae4895a87f3e1ed953614a3546c319762">PolarBSplines&lt; BSplinesR, BSplinesTheta, 1 &gt;::continuity</a></div><div class="ttdeci">static int constexpr continuity</div><div class="ttdoc">The continuity enforced by the bsplines at the singular point.</div><div class="ttdef"><b>Definition</b> polar_bsplines.hpp:62</div></div>
<div class="ttc" id="aclassPolarSplineEvaluator_html"><div class="ttname"><a href="classPolarSplineEvaluator.html">PolarSplineEvaluator</a></div><div class="ttdoc">Define an evaluator on polar B-splines.</div><div class="ttdef"><b>Definition</b> polar_spline_evaluator.hpp:13</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">A class which holds multiple (scalar) fields in order to represent a vector field.</div><div class="ttdef"><b>Definition</b> vector_field.hpp:64</div></div>
<div class="ttc" id="astructNullExtrapolationRule_html"><div class="ttname"><a href="structNullExtrapolationRule.html">NullExtrapolationRule</a></div><div class="ttdoc">Define null extrapolation rule commun to all geometries.</div><div class="ttdef"><b>Definition</b> null_extrapolation_rules.hpp:17</div></div>
Expand Down
14 changes: 8 additions & 6 deletions annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -424,12 +424,14 @@
<tr id="row_182_" 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="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_183_" class="odd"><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_184_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_184_" class="arrow" onclick="toggleFolder('184_')">&#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_184_0_" class="odd" 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_184_1_" class="odd" 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_1QDimThetaMesh.html" target="_self">QDimThetaMesh</a></td><td class="desc">Tag the second dimension for the quadrature mesh </td></tr>
<tr id="row_184_2_" class="odd" 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_184_3_" class="odd" 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_184_4_" class="odd" 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_1ThetaBasisSubset" target="_self">ThetaBasisSubset</a></td><td class="desc"></td></tr>
<tr id="row_184_5_" class="odd" 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_1ThetaCellDim" target="_self">ThetaCellDim</a></td><td class="desc"></td></tr>
<tr id="row_184_0_" class="odd" 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_1EvalDeriv1DType" target="_self">EvalDeriv1DType</a></td><td class="desc">Object storing a value and a value of the derivative of a 1D function </td></tr>
<tr id="row_184_1_" class="odd" 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_1EvalDeriv2DType" target="_self">EvalDeriv2DType</a></td><td class="desc">Object storing a value and a value of the derivatives in each direction of a 2D function </td></tr>
<tr id="row_184_2_" class="odd" 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_184_3_" class="odd" 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_1QDimThetaMesh.html" target="_self">QDimThetaMesh</a></td><td class="desc">Tag the second dimension for the quadrature mesh </td></tr>
<tr id="row_184_4_" class="odd" 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_184_5_" class="odd" 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_184_6_" class="odd" 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_1ThetaBasisSubset" target="_self">ThetaBasisSubset</a></td><td class="desc"></td></tr>
<tr id="row_184_7_" class="odd" 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_1ThetaCellDim" target="_self">ThetaCellDim</a></td><td class="desc"></td></tr>
<tr id="row_185_" class="odd"><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_186_" 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="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_187_" class="odd"><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="classPreallocatableLagrangeInterpolator.html" target="_self">PreallocatableLagrangeInterpolator</a></td><td class="desc">A class which stores information necessary to create an instance of the <a class="el" href="classLagrangeInterpolator.html" title="A class for interpolating a function using Lagrange polynomials.">LagrangeInterpolator</a> class </td></tr>
Expand Down
Loading

0 comments on commit da6a98c

Please sign in to comment.