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 Mar 14, 2024
1 parent 1bf4a90 commit 0ee6dbe
Show file tree
Hide file tree
Showing 10 changed files with 110 additions and 120 deletions.
2 changes: 1 addition & 1 deletion bsl__predcorr__second__order__explicit_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@
<div class="ttc" id="aclassSplineFootFinder_html"><div class="ttname"><a href="classSplineFootFinder.html">SplineFootFinder</a></div><div class="ttdoc">Define a base class for all the time integration methods used for the advection.</div><div class="ttdef"><b>Definition:</b> spline_foot_finder.hpp:19</div></div>
<div class="ttc" id="aclassSplineInterpolatorRP_html"><div class="ttname"><a href="classSplineInterpolatorRP.html">SplineInterpolatorRP</a></div><div class="ttdoc">A class for interpolating a function using splines in polar coordinates.</div><div class="ttdef"><b>Definition:</b> spline_interpolator_2d_rp.hpp:16</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">Pre-declaration of VectorField.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:34</div></div>
<div class="ttc" id="aclassVectorField_html_acb9821e3a1405005d7251bfbfea66f89"><div class="ttname"><a href="classVectorField.html#acb9821e3a1405005d7251bfbfea66f89">VectorField::span_view</a></div><div class="ttdeci">view_type span_view() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:192</div></div>
<div class="ttc" id="aclassVectorField_html_acb9821e3a1405005d7251bfbfea66f89"><div class="ttname"><a href="classVectorField.html#acb9821e3a1405005d7251bfbfea66f89">VectorField::span_view</a></div><div class="ttdeci">view_type span_view() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:182</div></div>
<div class="ttc" id="aclassVlasovPoissonSolver_html"><div class="ttname"><a href="classVlasovPoissonSolver.html">VlasovPoissonSolver</a></div><div class="ttdoc">Solve the Poisson equation and return the electric field for the coupled Vlasov equation.</div><div class="ttdef"><b>Definition:</b> vlasovpoissonsolver.hpp:89</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
2 changes: 1 addition & 1 deletion bsl__predcorr__second__order__implicit_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@
<div class="ttc" id="aclassSplineInterpolatorRP_html"><div class="ttname"><a href="classSplineInterpolatorRP.html">SplineInterpolatorRP</a></div><div class="ttdoc">A class for interpolating a function using splines in polar coordinates.</div><div class="ttdef"><b>Definition:</b> spline_interpolator_2d_rp.hpp:16</div></div>
<div class="ttc" id="aclassVectorFieldSpan_html"><div class="ttname"><a href="classVectorFieldSpan.html">VectorFieldSpan</a></div><div class="ttdoc">Pre-declaration of VectorFieldSpan.</div><div class="ttdef"><b>Definition:</b> vector_field_span.hpp:45</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">Pre-declaration of VectorField.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:34</div></div>
<div class="ttc" id="aclassVectorField_html_ae5421322e080a9f2ae63ff7796da6ed3"><div class="ttname"><a href="classVectorField.html#ae5421322e080a9f2ae63ff7796da6ed3">VectorField::span_cview</a></div><div class="ttdeci">view_type span_cview() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:182</div></div>
<div class="ttc" id="aclassVectorField_html_ae5421322e080a9f2ae63ff7796da6ed3"><div class="ttname"><a href="classVectorField.html#ae5421322e080a9f2ae63ff7796da6ed3">VectorField::span_cview</a></div><div class="ttdeci">view_type span_cview() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:172</div></div>
<div class="ttc" id="aclassVlasovPoissonSolver_html"><div class="ttname"><a href="classVlasovPoissonSolver.html">VlasovPoissonSolver</a></div><div class="ttdoc">Solve the Poisson equation and return the electric field for the coupled Vlasov equation.</div><div class="ttdef"><b>Definition:</b> vlasovpoissonsolver.hpp:89</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
2 changes: 1 addition & 1 deletion classVectorField-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
<tr><td class="entry"><a class="el" href="classVectorField.html#a9355ed87913f63a941e03f6b61a4c9e0">VectorField</a>(mdomain_type const &amp;domain, Allocator allocator=Allocator())</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classVectorField.html#a8e6b67ec99341f76401f77a27575cbfc">VectorField</a>(VectorFieldSpan&lt; OElementType, Domain, NDTag, LayoutDomain, MemorySpace &gt; field_span)</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr><td class="entry"><a class="el" href="classVectorField.html#a4838971fca188dc404dc50d8af9ef3d9">VectorField</a>(VectorField const &amp;other)=delete</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classVectorField.html#adbe8eb7a72060630bc31bdac5c9414a4">VectorField</a>(VectorField &amp;&amp;other)</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classVectorField.html#ae23926389df672431636ef26e20f7780">VectorField</a>(VectorField &amp;&amp;other)=default</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classVectorField.html#a3ec69912b7bbe42bf8302013b4ee3bcd">view_type</a> typedef</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~VectorField</b>()=default (defined in <a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a>)</td><td class="entry"><a class="el" href="classVectorField.html">VectorField&lt; ElementType, Domain, NDTag, Allocator &gt;</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
Expand Down
12 changes: 6 additions & 6 deletions classVectorField.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVectorField.html#a4838971fca188dc404dc50d8af9ef3d9">VectorField</a> (<a class="el" href="classVectorField.html">VectorField</a> const &amp;other)=delete</td></tr>
<tr class="memdesc:a4838971fca188dc404dc50d8af9ef3d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted: use deepcopy instead. <br /></td></tr>
<tr class="separator:a4838971fca188dc404dc50d8af9ef3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbe8eb7a72060630bc31bdac5c9414a4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVectorField.html#adbe8eb7a72060630bc31bdac5c9414a4">VectorField</a> (<a class="el" href="classVectorField.html">VectorField</a> &amp;&amp;other)</td></tr>
<tr class="memdesc:adbe8eb7a72060630bc31bdac5c9414a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classVectorField.html" title="Pre-declaration of VectorField.">VectorField</a> by move. <a href="classVectorField.html#adbe8eb7a72060630bc31bdac5c9414a4">More...</a><br /></td></tr>
<tr class="separator:adbe8eb7a72060630bc31bdac5c9414a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae23926389df672431636ef26e20f7780"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVectorField.html#ae23926389df672431636ef26e20f7780">VectorField</a> (<a class="el" href="classVectorField.html">VectorField</a> &amp;&amp;other)=default</td></tr>
<tr class="memdesc:ae23926389df672431636ef26e20f7780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="classVectorField.html" title="Pre-declaration of VectorField.">VectorField</a> by move. <a href="classVectorField.html#ae23926389df672431636ef26e20f7780">More...</a><br /></td></tr>
<tr class="separator:ae23926389df672431636ef26e20f7780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31bf11f64d085382acf099a2454fa9bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classVectorField.html">VectorField</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVectorField.html#a31bf11f64d085382acf099a2454fa9bf">operator=</a> (<a class="el" href="classVectorField.html">VectorField</a> const &amp;other)=default</td></tr>
<tr class="memdesc:a31bf11f64d085382acf099a2454fa9bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy-assigns a new value to this <a class="el" href="classVectorFieldSpan.html" title="Pre-declaration of VectorFieldSpan.">VectorFieldSpan</a>, yields a new view to the same data. <a href="classVectorField.html#a31bf11f64d085382acf099a2454fa9bf">More...</a><br /></td></tr>
<tr class="separator:a31bf11f64d085382acf099a2454fa9bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -300,8 +300,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8e6b67ec99341f76401f77a2

</div>
</div>
<a id="adbe8eb7a72060630bc31bdac5c9414a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbe8eb7a72060630bc31bdac5c9414a4">&#9670;&nbsp;</a></span>VectorField() <span class="overload">[3/3]</span></h2>
<a id="ae23926389df672431636ef26e20f7780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae23926389df672431636ef26e20f7780">&#9670;&nbsp;</a></span>VectorField() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
Expand All @@ -321,7 +321,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adbe8eb7a72060630bc31bdac
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
Expand Down
2 changes: 1 addition & 1 deletion classVectorField.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ var classVectorField =
[ "VectorField", "classVectorField.html#a9355ed87913f63a941e03f6b61a4c9e0", null ],
[ "VectorField", "classVectorField.html#a8e6b67ec99341f76401f77a27575cbfc", null ],
[ "VectorField", "classVectorField.html#a4838971fca188dc404dc50d8af9ef3d9", null ],
[ "VectorField", "classVectorField.html#adbe8eb7a72060630bc31bdac5c9414a4", null ],
[ "VectorField", "classVectorField.html#ae23926389df672431636ef26e20f7780", null ],
[ "~VectorField", "classVectorField.html#a0a1908a2429ba38ef8d891567cbc22c9", null ],
[ "operator=", "classVectorField.html#a31bf11f64d085382acf099a2454fa9bf", null ],
[ "operator=", "classVectorField.html#a4b839128727925cdffed6fbfca8da63e", null ],
Expand Down
2 changes: 1 addition & 1 deletion navtreeindex3.js
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ var NAVTREEINDEX3 =
"classVectorField.html#ab896e267b63db730e4344e1e15f2956f":[11,157,4],
"classVectorField.html#acb1058aa8ea2bd2cc6e2449c3b5c3eb6":[11,157,17],
"classVectorField.html#acb9821e3a1405005d7251bfbfea66f89":[11,157,15],
"classVectorField.html#adbe8eb7a72060630bc31bdac5c9414a4":[11,157,10],
"classVectorField.html#ae23926389df672431636ef26e20f7780":[11,157,10],
"classVectorField.html#ae5421322e080a9f2ae63ff7796da6ed3":[11,157,14],
"classVectorField.html#affcf9abd0e02dde4aa553233de0b57c8":[11,157,6],
"classVectorFieldSpan.html":[11,159],
Expand Down
2 changes: 1 addition & 1 deletion search/all_15.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion search/functions_15.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion spline__foot__finder_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
<div class="ttc" id="aclassSplineFootFinder_html_a6c99a3c797b8e49db511bee6d62e051d"><div class="ttname"><a href="classSplineFootFinder.html#a6c99a3c797b8e49db511bee6d62e051d">SplineFootFinder::operator()</a></div><div class="ttdeci">void operator()(SpanRP&lt; CoordRP &gt; feet, VectorDViewRP&lt; RDimX, RDimY &gt; advection_field, double dt) const final</div><div class="ttdoc">Advect the feet over .</div><div class="ttdef"><b>Definition:</b> spline_foot_finder.hpp:97</div></div>
<div class="ttc" id="aclassVectorFieldSpan_html"><div class="ttname"><a href="classVectorFieldSpan.html">VectorFieldSpan</a></div><div class="ttdoc">Pre-declaration of VectorFieldSpan.</div><div class="ttdef"><b>Definition:</b> vector_field_span.hpp:45</div></div>
<div class="ttc" id="aclassVectorField_html"><div class="ttname"><a href="classVectorField.html">VectorField</a></div><div class="ttdoc">Pre-declaration of VectorField.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:34</div></div>
<div class="ttc" id="aclassVectorField_html_acb9821e3a1405005d7251bfbfea66f89"><div class="ttname"><a href="classVectorField.html#acb9821e3a1405005d7251bfbfea66f89">VectorField::span_view</a></div><div class="ttdeci">view_type span_view() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:192</div></div>
<div class="ttc" id="aclassVectorField_html_acb9821e3a1405005d7251bfbfea66f89"><div class="ttname"><a href="classVectorField.html#acb9821e3a1405005d7251bfbfea66f89">VectorField::span_view</a></div><div class="ttdeci">view_type span_view() const</div><div class="ttdoc">Get a constant reference to this vector field.</div><div class="ttdef"><b>Definition:</b> vector_field.hpp:182</div></div>
<div class="ttc" id="autils__tools_8hpp_html_a939e3995d29bdb32c073e38494563009"><div class="ttname"><a href="utils__tools_8hpp.html#a939e3995d29bdb32c073e38494563009">norm_inf</a></div><div class="ttdeci">KOKKOS_FUNCTION double norm_inf(ddc::Coordinate&lt; Tags... &gt; coord)</div><div class="ttdoc">Compute the infinity norm.</div><div class="ttdef"><b>Definition:</b> utils_tools.hpp:23</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
Expand Down
Loading

0 comments on commit 0ee6dbe

Please sign in to comment.