Update docs

gyselax · Mar 15, 2024 · 8d59868 · 8d59868
1 parent 1ddd33b
commit 8d59868
Show file tree

Hide file tree

Showing 10 changed files with 82 additions and 118 deletions.
diff --git a/bsl__predcorr__second__order__explicit_8hpp_source.html b/bsl__predcorr__second__order__explicit_8hpp_source.html
@@ -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:157</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:153</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 -->

diff --git a/bsl__predcorr__second__order__implicit_8hpp_source.html b/bsl__predcorr__second__order__implicit_8hpp_source.html
@@ -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:147</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:143</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 -->

diff --git a/classVectorField-members.html b/classVectorField-members.html
@@ -112,7 +112,7 @@
   <tr><td class="entry"><a class="el" href="classVectorField.html#a7df5bf4cd762372ba4ae06c99b6ed478">memory_space</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 class="even"><td class="entry"><a class="el" href="classVectorField.html#acb1058aa8ea2bd2cc6e2449c3b5c3eb6">operator()</a>(ddc::DiscreteElement&lt; ODDims &gt; const &amp;... delems) const noexcept</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><td class="entry"><a class="el" href="classVectorField.html#a06536f7ec56093a9b87f4ee0c1d5b64c">operator()</a>(ddc::DiscreteElement&lt; ODDims... &gt; const &amp;delems) const noexcept</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#a31bf11f64d085382acf099a2454fa9bf">operator=</a>(VectorField const &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 class="even"><td class="entry"><a class="el" href="classVectorField.html#ae367dbe4c6643fb0fed766b1157b85a0">operator=</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><td class="entry"><a class="el" href="classVectorField.html#a4b839128727925cdffed6fbfca8da63e">operator=</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 class="even"><td class="entry"><a class="el" href="classVectorField.html#a925526e030fc6967c04e66771fc13e2a">operator[]</a>(ddc::DiscreteElement&lt; QueryDDims... &gt; const &amp;slice_spec) const</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><td class="entry"><a class="el" href="classVectorField.html#a86ea12473bc7ea9364085826a7c5d512">operator[]</a>(ddc::DiscreteElement&lt; QueryDDims... &gt; const &amp;slice_spec)</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>

diff --git a/classVectorField.html b/classVectorField.html
@@ -163,9 +163,10 @@
 <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>
+<tr class="memitem:ae367dbe4c6643fb0fed766b1157b85a0"><td class="memItemLeft" align="right" valign="top"><a id="ae367dbe4c6643fb0fed766b1157b85a0"></a>
+<a class="el" href="classVectorField.html">VectorField</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVectorField.html#ae367dbe4c6643fb0fed766b1157b85a0">operator=</a> (<a class="el" href="classVectorField.html">VectorField</a> const &amp;other)=delete</td></tr>
+<tr class="memdesc:ae367dbe4c6643fb0fed766b1157b85a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted: use deepcopy instead. <br /></td></tr>
+<tr class="separator:ae367dbe4c6643fb0fed766b1157b85a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4b839128727925cdffed6fbfca8da63e"><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#a4b839128727925cdffed6fbfca8da63e">operator=</a> (<a class="el" href="classVectorField.html">VectorField</a> &amp;&amp;other)=default</td></tr>
 <tr class="memdesc:a4b839128727925cdffed6fbfca8da63e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assigns a new value to this <a class="el" href="classVectorFieldSpan.html" title="Pre-declaration of VectorFieldSpan.">VectorFieldSpan</a>.  <a href="classVectorField.html#a4b839128727925cdffed6fbfca8da63e">More...</a><br /></td></tr>
 <tr class="separator:a4b839128727925cdffed6fbfca8da63e"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -295,45 +296,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae23926389df672431636ef26
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a id="a31bf11f64d085382acf099a2454fa9bf"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a31bf11f64d085382acf099a2454fa9bf">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
-
-<div class="memitem">
-<div class="memproto">
-<div class="memtemplate">
-template&lt;class ElementType , class Domain , class NDTag , class Allocator &gt; </div>
-<table class="mlabels">
-  <tr>
-  <td class="mlabels-left">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="classVectorField.html">VectorField</a>&amp; <a class="el" href="classVectorField.html">VectorField</a>&lt; ElementType, Domain, NDTag, Allocator &gt;::operator= </td>
-          <td>(</td>
-          <td class="paramtype"><a class="el" href="classVectorField.html">VectorField</a>&lt; ElementType, Domain, NDTag, Allocator &gt; const &amp;&#160;</td>
-          <td class="paramname"><em>other</em></td><td>)</td>
-          <td></td>
-        </tr>
-      </table>
-  </td>
-  <td class="mlabels-right">
-<span class="mlabels"><span class="mlabel">default</span></span>  </td>
-  </tr>
-</table>
-</div><div class="memdoc">
-
-<p>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. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">other</td><td>the <a class="el" href="classVectorFieldSpan.html" title="Pre-declaration of VectorFieldSpan.">VectorFieldSpan</a> to copy </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>*this </dd></dl>
-
-</div>
-</div>
 <a id="a4b839128727925cdffed6fbfca8da63e"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a4b839128727925cdffed6fbfca8da63e">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
+<h2 class="memtitle"><span class="permalink"><a href="#a4b839128727925cdffed6fbfca8da63e">&#9670;&nbsp;</a></span>operator=()</h2>
 
 <div class="memitem">
 <div class="memproto">

diff --git a/classVectorField.js b/classVectorField.js
@@ -11,7 +11,7 @@ var classVectorField =
     [ "VectorField", "classVectorField.html#a4838971fca188dc404dc50d8af9ef3d9", null ],
     [ "VectorField", "classVectorField.html#ae23926389df672431636ef26e20f7780", null ],
     [ "~VectorField", "classVectorField.html#a0a1908a2429ba38ef8d891567cbc22c9", null ],
-    [ "operator=", "classVectorField.html#a31bf11f64d085382acf099a2454fa9bf", null ],
+    [ "operator=", "classVectorField.html#ae367dbe4c6643fb0fed766b1157b85a0", null ],
     [ "operator=", "classVectorField.html#a4b839128727925cdffed6fbfca8da63e", null ],
     [ "span_cview", "classVectorField.html#ae5421322e080a9f2ae63ff7796da6ed3", null ],
     [ "span_view", "classVectorField.html#acb9821e3a1405005d7251bfbfea66f89", null ],

diff --git a/navtreeindex3.js b/navtreeindex3.js
@@ -210,7 +210,6 @@ var NAVTREEINDEX3 =
 "classVectorField.html#a06536f7ec56093a9b87f4ee0c1d5b64c":[11,157,17],
 "classVectorField.html#a0a1908a2429ba38ef8d891567cbc22c9":[11,157,10],
 "classVectorField.html#a17028a562655b6e58926450f8849b066":[11,157,0],
-"classVectorField.html#a31bf11f64d085382acf099a2454fa9bf":[11,157,11],
 "classVectorField.html#a3ec69912b7bbe42bf8302013b4ee3bcd":[11,157,3],
 "classVectorField.html#a40800a9ffc0b36a09ae8154aac00759b":[11,157,15],
 "classVectorField.html#a4838971fca188dc404dc50d8af9ef3d9":[11,157,8],
@@ -227,6 +226,7 @@ var NAVTREEINDEX3 =
 "classVectorField.html#acb1058aa8ea2bd2cc6e2449c3b5c3eb6":[11,157,16],
 "classVectorField.html#acb9821e3a1405005d7251bfbfea66f89":[11,157,14],
 "classVectorField.html#ae23926389df672431636ef26e20f7780":[11,157,9],
+"classVectorField.html#ae367dbe4c6643fb0fed766b1157b85a0":[11,157,11],
 "classVectorField.html#ae5421322e080a9f2ae63ff7796da6ed3":[11,157,13],
 "classVectorField.html#affcf9abd0e02dde4aa553233de0b57c8":[11,157,6],
 "classVectorFieldSpan.html":[11,159],