Deploying to main from @ AMReX-Codes/amrex@6c62475 🚀

amrex/docs_html/doxygen/AMReX__ParticleContainerI_8H_source.html

@@ -2672,7 +2672,7 @@
 <div class="ttc" id="aclassamrex_1_1MFIter_html"><div class="ttname"><a href="classamrex_1_1MFIter.html">amrex::MFIter</a></div><div class="ttdef"><b>Definition:</b> AMReX_MFIter.H:57</div></div>
 <div class="ttc" id="aclassamrex_1_1MFIter_html_a61b9a1d5eda39765d1db9b9b936558c7"><div class="ttname"><a href="classamrex_1_1MFIter.html#a61b9a1d5eda39765d1db9b9b936558c7">amrex::MFIter::isValid</a></div><div class="ttdeci">bool isValid() const noexcept</div><div class="ttdoc">Is the iterator valid i.e. is it associated with a FAB?</div><div class="ttdef"><b>Definition:</b> AMReX_MFIter.H:141</div></div>
 <div class="ttc" id="aclassamrex_1_1MultiFab_html"><div class="ttname"><a href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></div><div class="ttdoc">A collection (stored as an array) of FArrayBox objects.</div><div class="ttdef"><b>Definition:</b> AMReX_MultiFab.H:38</div></div>
-<div class="ttc" id="aclassamrex_1_1MultiFab_html_aa9158374809b83cfd40a8092d4e63bdd"><div class="ttname"><a href="classamrex_1_1MultiFab.html#aa9158374809b83cfd40a8092d4e63bdd">amrex::MultiFab::mult</a></div><div class="ttdeci">void mult(Real val, int comp, int num_comp, int nghost=0)</div><div class="ttdoc">Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] &lt;- a...</div><div class="ttdef"><b>Definition:</b> AMReX_MultiFab.cpp:1305</div></div>
+<div class="ttc" id="aclassamrex_1_1MultiFab_html_aa9158374809b83cfd40a8092d4e63bdd"><div class="ttname"><a href="classamrex_1_1MultiFab.html#aa9158374809b83cfd40a8092d4e63bdd">amrex::MultiFab::mult</a></div><div class="ttdeci">void mult(Real val, int comp, int num_comp, int nghost=0)</div><div class="ttdoc">Scales the value of each cell in the specified subregion of the MultiFab by the scalar val (a[i] &lt;- a...</div><div class="ttdef"><b>Definition:</b> AMReX_MultiFab.cpp:1401</div></div>
 <div class="ttc" id="aclassamrex_1_1PODVector_html"><div class="ttname"><a href="classamrex_1_1PODVector.html">amrex::PODVector</a></div><div class="ttdef"><b>Definition:</b> AMReX_PODVector.H:217</div></div>
 <div class="ttc" id="aclassamrex_1_1PODVector_html_a1cdc3c767875be38aa4e622280597347"><div class="ttname"><a href="classamrex_1_1PODVector.html#a1cdc3c767875be38aa4e622280597347">amrex::PODVector::size</a></div><div class="ttdeci">size_type size() const noexcept</div><div class="ttdef"><b>Definition:</b> AMReX_PODVector.H:545</div></div>
 <div class="ttc" id="aclassamrex_1_1PODVector_html_a52a678e008fab2346394fcad18bc90c4"><div class="ttname"><a href="classamrex_1_1PODVector.html#a52a678e008fab2346394fcad18bc90c4">amrex::PODVector::data</a></div><div class="ttdeci">T * data() noexcept</div><div class="ttdef"><b>Definition:</b> AMReX_PODVector.H:563</div></div>

amrex/docs_html/doxygen/classamrex_1_1MultiFab-members.html

@@ -482,8 +482,10 @@
  <tr><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#a5f37af40303a10e8d54e15c1931a5b8e">Subtract</a>(MultiFab &amp;dst, const MultiFab &amp;src, int srccomp, int dstcomp, int numcomp, int nghost)</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#a4f2c04ea9d0f7a551bc2263b9a63d324">Subtract</a>(MultiFab &amp;dst, const MultiFab &amp;src, int srccomp, int dstcomp, int numcomp, const IntVect &amp;nghost)</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
  <tr><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#a62669a27ec4a577f0bef72dc2a1243aa">sum</a>(int comp=0, bool local=false) const</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"></td></tr>
- <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1FabArray.html#a025b813208a188552aba514a69a3b480">FabArray&lt; FArrayBox &gt;::sum</a>(int comp, IntVect const &amp;nghost, bool local=false) const</td><td class="entry"><a class="el" href="classamrex_1_1FabArray.html">amrex::FabArray&lt; FArrayBox &gt;</a></td><td class="entry"></td></tr>
- <tr><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375">sum_unique</a>(int comp=0, bool local=false, const Periodicity &amp;period=Periodicity::NonPeriodic()) const</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#a623e2f01e2a7695e835d258d1a8067b7">sum</a>(Box const &amp;region, int comp=0, bool local=false) const</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="classamrex_1_1FabArray.html#a025b813208a188552aba514a69a3b480">FabArray&lt; FArrayBox &gt;::sum</a>(int comp, IntVect const &amp;nghost, bool local=false) const</td><td class="entry"><a class="el" href="classamrex_1_1FabArray.html">amrex::FabArray&lt; FArrayBox &gt;</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375">sum_unique</a>(int comp=0, bool local=false, const Periodicity &amp;period=Periodicity::NonPeriodic()) const</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html#a7c6f3136fca76d4f0f827c45420ca7ab">sum_unique</a>(Box const &amp;region, int comp=0, bool local=false) const</td><td class="entry"><a class="el" href="classamrex_1_1MultiFab.html">amrex::MultiFab</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1FabArray.html#a3df70423b7ec841f351f1e2b1b9cd8d4">SumBoundary</a>(const Periodicity &amp;period=Periodicity::NonPeriodic())</td><td class="entry"><a class="el" href="classamrex_1_1FabArray.html">amrex::FabArray&lt; FArrayBox &gt;</a></td><td class="entry"></td></tr>
  <tr><td class="entry"><a class="el" href="classamrex_1_1FabArray.html#a8e4f13e3c2e640f401ef8a191feafe91">SumBoundary</a>(int scomp, int ncomp, const Periodicity &amp;period=Periodicity::NonPeriodic())</td><td class="entry"><a class="el" href="classamrex_1_1FabArray.html">amrex::FabArray&lt; FArrayBox &gt;</a></td><td class="entry"></td></tr>
  <tr class="even"><td class="entry"><a class="el" href="classamrex_1_1FabArray.html#a836ec3561b05f2151a8b299a4bacbec7">SumBoundary</a>(int scomp, int ncomp, IntVect const &amp;nghost, const Periodicity &amp;period=Periodicity::NonPeriodic())</td><td class="entry"><a class="el" href="classamrex_1_1FabArray.html">amrex::FabArray&lt; FArrayBox &gt;</a></td><td class="entry"></td></tr>

amrex/docs_html/doxygen/classamrex_1_1MultiFab.html

@@ -202,9 +202,15 @@
 <tr class="memitem:a62669a27ec4a577f0bef72dc2a1243aa"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamrex_1_1MultiFab.html#a62669a27ec4a577f0bef72dc2a1243aa">sum</a> (<a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> comp=0, bool local=false) const</td></tr>
 <tr class="memdesc:a62669a27ec4a577f0bef72dc2a1243aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the sum of component "comp" over the <a class="el" href="classamrex_1_1MultiFab.html" title="A collection (stored as an array) of FArrayBox objects.">MultiFab</a> &ndash; no ghost cells are included. <a href="classamrex_1_1MultiFab.html#a62669a27ec4a577f0bef72dc2a1243aa">More...</a><br /></td></tr>
 <tr class="separator:a62669a27ec4a577f0bef72dc2a1243aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a623e2f01e2a7695e835d258d1a8067b7"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamrex_1_1MultiFab.html#a623e2f01e2a7695e835d258d1a8067b7">sum</a> (<a class="el" href="classamrex_1_1Box.html">Box</a> const &amp;region, <a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> comp=0, bool local=false) const</td></tr>
+<tr class="memdesc:a623e2f01e2a7695e835d258d1a8067b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the sum of component "comp" in the given "region". &ndash; no ghost cells are included. <a href="classamrex_1_1MultiFab.html#a623e2f01e2a7695e835d258d1a8067b7">More...</a><br /></td></tr>
+<tr class="separator:a623e2f01e2a7695e835d258d1a8067b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:afe7c47dff8cf8e0fb550d0e78c7b5375"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375">sum_unique</a> (<a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> comp=0, bool local=false, const <a class="el" href="classamrex_1_1Periodicity.html">Periodicity</a> &amp;period=<a class="el" href="classamrex_1_1Periodicity.html#a194e779bf59d1700830a35cecb5271a5">Periodicity::NonPeriodic</a>()) const</td></tr>
-<tr class="memdesc:afe7c47dff8cf8e0fb550d0e78c7b5375"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structamrex_1_1Same.html">Same</a> as sum with <code>local</code> =false, but for non-cell-centered data, this skips non-unique points that are owned by multiple boxes. <a href="classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375">More...</a><br /></td></tr>
+<tr class="memdesc:afe7c47dff8cf8e0fb550d0e78c7b5375"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structamrex_1_1Same.html">Same</a> as sum with <code>local</code> =false, but for non-cell-centered data, this only adds non-unique points that are owned by multiple boxes once. <a href="classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375">More...</a><br /></td></tr>
 <tr class="separator:afe7c47dff8cf8e0fb550d0e78c7b5375"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a7c6f3136fca76d4f0f827c45420ca7ab"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamrex_1_1MultiFab.html#a7c6f3136fca76d4f0f827c45420ca7ab">sum_unique</a> (<a class="el" href="classamrex_1_1Box.html">Box</a> const &amp;region, <a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> comp=0, bool local=false) const</td></tr>
+<tr class="memdesc:a7c6f3136fca76d4f0f827c45420ca7ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the unique sum of component "comp" in the given region. Non-unique points owned by multiple boxes in the <a class="el" href="classamrex_1_1MultiFab.html" title="A collection (stored as an array) of FArrayBox objects.">MultiFab</a> are only added once. No ghost cells are included. This function does not take periodicity into account in the determination of uniqueness of points. <a href="classamrex_1_1MultiFab.html#a7c6f3136fca76d4f0f827c45420ca7ab">More...</a><br /></td></tr>
+<tr class="separator:a7c6f3136fca76d4f0f827c45420ca7ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aafbc29a68d3c0c000fee414f76f7b79c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamrex_1_1MultiFab.html#aafbc29a68d3c0c000fee414f76f7b79c">plus</a> (Real val, <a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> comp, <a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> num_comp, <a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a> nghost=0)</td></tr>
 <tr class="memdesc:aafbc29a68d3c0c000fee414f76f7b79c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the scalar value <code>val</code> to the value of each cell in the specified subregion of the <a class="el" href="classamrex_1_1MultiFab.html" title="A collection (stored as an array) of FArrayBox objects.">MultiFab</a>. <a href="classamrex_1_1MultiFab.html#aafbc29a68d3c0c000fee414f76f7b79c">More...</a><br /></td></tr>
 <tr class="separator:aafbc29a68d3c0c000fee414f76f7b79c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -4551,10 +4557,46 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5f37af40303a10e8d54e15c1
 
 <p>Subtract src from dst including nghost ghost cells. The two MultiFabs MUST have the same underlying <a class="el" href="classamrex_1_1BoxArray.html" title="A collection of Boxes stored in an Array.">BoxArray</a>. </p>
 
+</div>
+</div>
+<a id="a623e2f01e2a7695e835d258d1a8067b7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a623e2f01e2a7695e835d258d1a8067b7">&#9670;&nbsp;</a></span>sum() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">Real amrex::MultiFab::sum </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="classamrex_1_1Box.html">Box</a> const &amp;&#160;</td>
+ <td class="paramname"><em>region</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a>&#160;</td>
+ <td class="paramname"><em>comp</em> = <code>0</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>local</em> = <code>false</code>&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Returns the sum of component "comp" in the given "region". &ndash; no ghost cells are included. </p>
+
 </div>
 </div>
 <a id="a62669a27ec4a577f0bef72dc2a1243aa"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a62669a27ec4a577f0bef72dc2a1243aa">&#9670;&nbsp;</a></span>sum()</h2>
+<h2 class="memtitle"><span class="permalink"><a href="#a62669a27ec4a577f0bef72dc2a1243aa">&#9670;&nbsp;</a></span>sum() <span class="overload">[2/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -4581,10 +4623,46 @@ <h2 class="memtitle"><span class="permalink"><a href="#a62669a27ec4a577f0bef72dc
 
 <p>Returns the sum of component "comp" over the <a class="el" href="classamrex_1_1MultiFab.html" title="A collection (stored as an array) of FArrayBox objects.">MultiFab</a> &ndash; no ghost cells are included. </p>
 
+</div>
+</div>
+<a id="a7c6f3136fca76d4f0f827c45420ca7ab"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7c6f3136fca76d4f0f827c45420ca7ab">&#9670;&nbsp;</a></span>sum_unique() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">Real amrex::MultiFab::sum_unique </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="classamrex_1_1Box.html">Box</a> const &amp;&#160;</td>
+ <td class="paramname"><em>region</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="namespaceamrex.html#ad2e8127753e9be0ebf531435c6511937">int</a>&#160;</td>
+ <td class="paramname"><em>comp</em> = <code>0</code>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool&#160;</td>
+ <td class="paramname"><em>local</em> = <code>false</code>&#160;</td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td> const</td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Returns the unique sum of component "comp" in the given region. Non-unique points owned by multiple boxes in the <a class="el" href="classamrex_1_1MultiFab.html" title="A collection (stored as an array) of FArrayBox objects.">MultiFab</a> are only added once. No ghost cells are included. This function does not take periodicity into account in the determination of uniqueness of points. </p>
+
 </div>
 </div>
 <a id="afe7c47dff8cf8e0fb550d0e78c7b5375"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#afe7c47dff8cf8e0fb550d0e78c7b5375">&#9670;&nbsp;</a></span>sum_unique()</h2>
+<h2 class="memtitle"><span class="permalink"><a href="#afe7c47dff8cf8e0fb550d0e78c7b5375">&#9670;&nbsp;</a></span>sum_unique() <span class="overload">[2/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -4615,7 +4693,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afe7c47dff8cf8e0fb550d0e7
  </table>
 </div><div class="memdoc">
 
-<p><a class="el" href="structamrex_1_1Same.html">Same</a> as sum with <code>local</code> =false, but for non-cell-centered data, this skips non-unique points that are owned by multiple boxes. </p>
+<p><a class="el" href="structamrex_1_1Same.html">Same</a> as sum with <code>local</code> =false, but for non-cell-centered data, this only adds non-unique points that are owned by multiple boxes once. </p>
 
 </div>
 </div>

amrex/docs_html/doxygen/classamrex_1_1MultiFab.js

@@ -84,7 +84,9 @@ var classamrex_1_1MultiFab =
  [ "Saxpy", "classamrex_1_1MultiFab.html#a505eb471a78f4e0f8791b10cbb1bbd75", null ],
  [ "Subtract", "classamrex_1_1MultiFab.html#a4f2c04ea9d0f7a551bc2263b9a63d324", null ],
  [ "Subtract", "classamrex_1_1MultiFab.html#a5f37af40303a10e8d54e15c1931a5b8e", null ],
+ [ "sum", "classamrex_1_1MultiFab.html#a623e2f01e2a7695e835d258d1a8067b7", null ],
  [ "sum", "classamrex_1_1MultiFab.html#a62669a27ec4a577f0bef72dc2a1243aa", null ],
+ [ "sum_unique", "classamrex_1_1MultiFab.html#a7c6f3136fca76d4f0f827c45420ca7ab", null ],
  [ "sum_unique", "classamrex_1_1MultiFab.html#afe7c47dff8cf8e0fb550d0e78c7b5375", null ],
  [ "Swap", "classamrex_1_1MultiFab.html#ac259813cd54d52b5c20cad7c0f24c246", null ],
  [ "Swap", "classamrex_1_1MultiFab.html#a2e29e28afce0aa520da5cd068cb5e96b", null ],