Deploying to main from @ AMReX-Codes/amrex@b3f6738 🚀

Author: WeiqunZhang

amrex/docs_html/_downloads/008eb6dbfab802633dff40122ece848c/amrex.pdf

@@ -111,9 +111,11 @@
 <code>#include &lt;<a class="el" href="AMReX__DataAllocator_8H_source.html">AMReX_DataAllocator.H</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="AMReX__DistributionMapping_8H_source.html">AMReX_DistributionMapping.H</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="AMReX__Enum_8H_source.html">AMReX_Enum.H</a>&gt;</code><br />
+<code>#include &lt;<a class="el" href="AMReX__FabArray_8H_source.html">AMReX_FabArray.H</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="AMReX__Gpu_8H_source.html">AMReX_Gpu.H</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="AMReX__GpuComplex_8H_source.html">AMReX_GpuComplex.H</a>&gt;</code><br />
 <code>#include &lt;<a class="el" href="AMReX__Math_8H_source.html">AMReX_Math.H</a>&gt;</code><br />
+<code>#include &lt;<a class="el" href="AMReX__Periodicity_8H_source.html">AMReX_Periodicity.H</a>&gt;</code><br />
 <code>#include &lt;cufft.h&gt;</code><br />
 <code>#include &lt;cuComplex.h&gt;</code><br />
 <code>#include &lt;algorithm&gt;</code><br />
@@ -140,6 +142,8 @@
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structamrex_1_1FFT_1_1RotateBwd.html">amrex::FFT::RotateBwd</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structamrex_1_1FFT_1_1detail_1_1SubHelper.html">amrex::FFT::detail::SubHelper</a></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
 Namespaces</h2></td></tr>

amrex/docs_html/doxygen/AMReX__FFT__Helper_8H.html

@@ -6,6 +6,7 @@ var AMReX__FFT__Helper_8H =
     [ "Swap02", "structamrex_1_1FFT_1_1Swap02.html", "structamrex_1_1FFT_1_1Swap02" ],
     [ "RotateFwd", "structamrex_1_1FFT_1_1RotateFwd.html", "structamrex_1_1FFT_1_1RotateFwd" ],
     [ "RotateBwd", "structamrex_1_1FFT_1_1RotateBwd.html", "structamrex_1_1FFT_1_1RotateBwd" ],
+    [ "SubHelper", "structamrex_1_1FFT_1_1detail_1_1SubHelper.html", "structamrex_1_1FFT_1_1detail_1_1SubHelper" ],
     [ "Key", "AMReX__FFT__Helper_8H.html#a07ebd4aab8904819a3bbc7009e06ce97", null ],
     [ "PlanD", "AMReX__FFT__Helper_8H.html#a65fad3db3b9fe3b85174dc3a4ba8330e", null ],
     [ "PlanF", "AMReX__FFT__Helper_8H.html#a5e2fe5e29b662f9d24d3a4b769acde11", null ],

amrex/docs_html/doxygen/AMReX__FFT__Helper_8H.js

@@ -399,7 +399,7 @@
 <div class="ttc" id="aclassamrex_1_1Gpu_1_1Device_html_aae61fa0d560ee3c25d7deca229a31f60"><div class="ttname"><a href="classamrex_1_1Gpu_1_1Device.html#aae61fa0d560ee3c25d7deca229a31f60">amrex::Gpu::Device::resetStreamIndex</a></div><div class="ttdeci">static void resetStreamIndex() noexcept</div><div class="ttdef"><b>Definition:</b> AMReX_GpuDevice.H:76</div></div>
 <div class="ttc" id="aclassamrex_1_1IntVectND_html"><div class="ttname"><a href="classamrex_1_1IntVectND.html">amrex::IntVectND</a></div><div class="ttdef"><b>Definition:</b> AMReX_IntVect.H:48</div></div>
 <div class="ttc" id="anamespaceamrex_1_1FFT_html"><div class="ttname"><a href="namespaceamrex_1_1FFT.html">amrex::FFT</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT.cpp:7</div></div>
-<div class="ttc" id="anamespaceamrex_1_1FFT_html_a28c4d0ce41c89d0d14f83d98b45375c0"><div class="ttname"><a href="namespaceamrex_1_1FFT.html#a28c4d0ce41c89d0d14f83d98b45375c0">amrex::FFT::Direction</a></div><div class="ttdeci">Direction</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:46</div></div>
+<div class="ttc" id="anamespaceamrex_1_1FFT_html_a28c4d0ce41c89d0d14f83d98b45375c0"><div class="ttname"><a href="namespaceamrex_1_1FFT.html#a28c4d0ce41c89d0d14f83d98b45375c0">amrex::FFT::Direction</a></div><div class="ttdeci">Direction</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:48</div></div>
 <div class="ttc" id="anamespaceamrex_1_1FFT_html_a28c4d0ce41c89d0d14f83d98b45375c0a195fe59b6f103787a914aead0f3db502"><div class="ttname"><a href="namespaceamrex_1_1FFT.html#a28c4d0ce41c89d0d14f83d98b45375c0a195fe59b6f103787a914aead0f3db502">amrex::FFT::Direction::backward</a></div><div class="ttdeci">@ backward</div></div>
 <div class="ttc" id="anamespaceamrex_1_1FFT_html_a28c4d0ce41c89d0d14f83d98b45375c0a965dbaac085fc891bfbbd4f9d145bbc8"><div class="ttname"><a href="namespaceamrex_1_1FFT.html#a28c4d0ce41c89d0d14f83d98b45375c0a965dbaac085fc891bfbbd4f9d145bbc8">amrex::FFT::Direction::forward</a></div><div class="ttdeci">@ forward</div></div>
 <div class="ttc" id="anamespaceamrex_1_1FFT_html_a28c4d0ce41c89d0d14f83d98b45375c0af6cb3e816496528d4187db53bc66567f"><div class="ttname"><a href="namespaceamrex_1_1FFT.html#a28c4d0ce41c89d0d14f83d98b45375c0af6cb3e816496528d4187db53bc66567f">amrex::FFT::Direction::both</a></div><div class="ttdeci">@ both</div></div>
@@ -409,7 +409,7 @@
 <div class="ttc" id="anamespaceamrex_html_a2b273526dd4d27047e455ab7a5a8dcd3a4b43b0aee35624cd95b910189b3dc231"><div class="ttname"><a href="namespaceamrex.html#a2b273526dd4d27047e455ab7a5a8dcd3a4b43b0aee35624cd95b910189b3dc231">amrex::CurlCurlStateType::r</a></div><div class="ttdeci">@ r</div></div>
 <div class="ttc" id="anamespaceamrex_html_a3e08759747455ff96c8f68e8673c2b19"><div class="ttname"><a href="namespaceamrex.html#a3e08759747455ff96c8f68e8673c2b19">amrex::gpuStream_t</a></div><div class="ttdeci">cudaStream_t gpuStream_t</div><div class="ttdef"><b>Definition:</b> AMReX_GpuControl.H:77</div></div>
 <div class="ttc" id="anamespaceamrex_html_a95b1159ba3a5494abd49dc9b3d34eacf"><div class="ttname"><a href="namespaceamrex.html#a95b1159ba3a5494abd49dc9b3d34eacf">amrex::ignore_unused</a></div><div class="ttdeci">AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void ignore_unused(const Ts &amp;...)</div><div class="ttdoc">This shuts up the compiler about unused variables.</div><div class="ttdef"><b>Definition:</b> AMReX.H:111</div></div>
-<div class="ttc" id="astructamrex_1_1FFT_1_1Plan_html"><div class="ttname"><a href="structamrex_1_1FFT_1_1Plan.html">amrex::FFT::Plan</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:111</div></div>
+<div class="ttc" id="astructamrex_1_1FFT_1_1Plan_html"><div class="ttname"><a href="structamrex_1_1FFT_1_1Plan.html">amrex::FFT::Plan</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:113</div></div>
 <div class="ttc" id="astructamrex_1_1GpuComplex_html"><div class="ttname"><a href="structamrex_1_1GpuComplex.html">amrex::GpuComplex</a></div><div class="ttdoc">A host / device complex number type, because std::complex doesn't work in device code with Cuda yet.</div><div class="ttdef"><b>Definition:</b> AMReX_GpuComplex.H:29</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->

amrex/docs_html/doxygen/AMReX__FFT__Helper_8H_source.html

@@ -111,7 +111,7 @@
 <div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classamrex_1_1FFT_1_1OpenBCSolver.html">   10</a></span>&#160;<span class="keyword">class </span><a class="code" href="classamrex_1_1FFT_1_1OpenBCSolver.html">OpenBCSolver</a></div>
 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;{</div>
 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="keyword">public</span>:</div>
-<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a198bbf163fe0dc2eea190a0892e14e94">   13</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a198bbf163fe0dc2eea190a0892e14e94">MF</a> = <span class="keyword">typename</span> <a class="code" href="classamrex_1_1FFT_1_1R2C.html#aa078479f5563108a286fc9f2c34589cb">R2C&lt;T&gt;::MF</a>;</div>
+<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a198bbf163fe0dc2eea190a0892e14e94">   13</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a198bbf163fe0dc2eea190a0892e14e94">MF</a> = <span class="keyword">typename</span> <a class="code" href="classamrex_1_1FFT_1_1R2C.html#a25b155706f2ea86b20ea78baf9f5ce20">R2C&lt;T&gt;::MF</a>;</div>
 <div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a8d98406d48ab4df7be623d138af4fb05">   14</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="classamrex_1_1FFT_1_1OpenBCSolver.html#a8d98406d48ab4df7be623d138af4fb05">cMF</a> = <span class="keyword">typename</span> <a class="code" href="classamrex_1_1FabArray.html">R2C&lt;T&gt;::cMF</a>;</div>
 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160; </div>
 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;    <span class="keyword">explicit</span> <a class="code" href="classamrex_1_1FFT_1_1OpenBCSolver.html#ab2103845433bc9ebfa7dd6ab40a48fad">OpenBCSolver</a> (<a class="code" href="classamrex_1_1BoxND.html">Box</a> <span class="keyword">const</span>&amp; domain, <a class="code" href="structamrex_1_1FFT_1_1Info.html">Info</a> <span class="keyword">const</span>&amp; info = <a class="code" href="structamrex_1_1FFT_1_1Info.html">Info</a>{});</div>
@@ -338,10 +338,10 @@
 <div class="ttc" id="aclassamrex_1_1FFT_1_1OpenBCSolver_html_ab2103845433bc9ebfa7dd6ab40a48fad"><div class="ttname"><a href="classamrex_1_1FFT_1_1OpenBCSolver.html#ab2103845433bc9ebfa7dd6ab40a48fad">amrex::FFT::OpenBCSolver::OpenBCSolver</a></div><div class="ttdeci">OpenBCSolver(Box const &amp;domain, Info const &amp;info=Info{})</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_OpenBCSolver.H:48</div></div>
 <div class="ttc" id="aclassamrex_1_1FFT_1_1OpenBCSolver_html_ae717df8cd0a4c8b5831f4bee098875f9"><div class="ttname"><a href="classamrex_1_1FFT_1_1OpenBCSolver.html#ae717df8cd0a4c8b5831f4bee098875f9">amrex::FFT::OpenBCSolver::Domain</a></div><div class="ttdeci">Box const  &amp; Domain() const</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_OpenBCSolver.H:23</div></div>
 <div class="ttc" id="aclassamrex_1_1FFT_1_1R2C_html"><div class="ttname"><a href="classamrex_1_1FFT_1_1R2C.html">amrex::FFT::R2C</a></div><div class="ttdoc">Parallel Discrete Fourier Transform.</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_R2C.H:36</div></div>
-<div class="ttc" id="aclassamrex_1_1FFT_1_1R2C_html_aa078479f5563108a286fc9f2c34589cb"><div class="ttname"><a href="classamrex_1_1FFT_1_1R2C.html#aa078479f5563108a286fc9f2c34589cb">amrex::FFT::R2C::MF</a></div><div class="ttdeci">std::conditional_t&lt; std::is_same_v&lt; T, Real &gt;, MultiFab, FabArray&lt; BaseFab&lt; T &gt; &gt; &gt; MF</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_R2C.H:39</div></div>
+<div class="ttc" id="aclassamrex_1_1FFT_1_1R2C_html_a25b155706f2ea86b20ea78baf9f5ce20"><div class="ttname"><a href="classamrex_1_1FFT_1_1R2C.html#a25b155706f2ea86b20ea78baf9f5ce20">amrex::FFT::R2C::MF</a></div><div class="ttdeci">std::conditional_t&lt; std::is_same_v&lt; T, Real &gt;, MultiFab, FabArray&lt; BaseFab&lt; T &gt; &gt; &gt; MF</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_R2C.H:39</div></div>
 <div class="ttc" id="aclassamrex_1_1FabArray_html"><div class="ttname"><a href="classamrex_1_1FabArray.html">amrex::FabArray</a></div><div class="ttdoc">An Array of FortranArrayBox(FAB)-like Objects.</div><div class="ttdef"><b>Definition:</b> AMReX_FabArray.H:344</div></div>
 <div class="ttc" id="aclassamrex_1_1IntVectND_html"><div class="ttname"><a href="classamrex_1_1IntVectND.html">amrex::IntVectND&lt; AMREX_SPACEDIM &gt;</a></div></div>
-<div class="ttc" id="anamespaceamrex_1_1FFT_1_1detail_html_a1ade0d84620e8faa51f7bac69806a0d8"><div class="ttname"><a href="namespaceamrex_1_1FFT_1_1detail.html#a1ade0d84620e8faa51f7bac69806a0d8">amrex::FFT::detail::get_fab</a></div><div class="ttdeci">FA::FABType::value_type * get_fab(FA &amp;fa)</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:1303</div></div>
+<div class="ttc" id="anamespaceamrex_1_1FFT_1_1detail_html_a1ade0d84620e8faa51f7bac69806a0d8"><div class="ttname"><a href="namespaceamrex_1_1FFT_1_1detail.html#a1ade0d84620e8faa51f7bac69806a0d8">amrex::FFT::detail::get_fab</a></div><div class="ttdeci">FA::FABType::value_type * get_fab(FA &amp;fa)</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:1305</div></div>
 <div class="ttc" id="anamespaceamrex_1_1FFT_html"><div class="ttname"><a href="namespaceamrex_1_1FFT.html">amrex::FFT</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT.cpp:7</div></div>
 <div class="ttc" id="anamespaceamrex_1_1Gpu_html_a00026ef5f8505586ed52acbbc11fdf91"><div class="ttname"><a href="namespaceamrex_1_1Gpu.html#a00026ef5f8505586ed52acbbc11fdf91">amrex::Gpu::dtod_memcpy_async</a></div><div class="ttdeci">void dtod_memcpy_async(void *p_d_dst, const void *p_d_src, const std::size_t sz) noexcept</div><div class="ttdef"><b>Definition:</b> AMReX_GpuDevice.H:279</div></div>
 <div class="ttc" id="anamespaceamrex_1_1Gpu_html_a90ff215e828e9192dbd196a78cacf083"><div class="ttname"><a href="namespaceamrex_1_1Gpu.html#a90ff215e828e9192dbd196a78cacf083">amrex::Gpu::memcpy</a></div><div class="ttdeci">AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void * memcpy(void *dest, const void *src, std::size_t count)</div><div class="ttdef"><b>Definition:</b> AMReX_GpuUtility.H:214</div></div>
@@ -352,9 +352,9 @@
 <div class="ttc" id="anamespaceamrex_html_a222089e49ba211b37cf7a4a8ae7eb186"><div class="ttname"><a href="namespaceamrex.html#a222089e49ba211b37cf7a4a8ae7eb186">amrex::Box</a></div><div class="ttdeci">BoxND&lt; AMREX_SPACEDIM &gt; Box</div><div class="ttdef"><b>Definition:</b> AMReX_BaseFwd.H:27</div></div>
 <div class="ttc" id="anamespaceamrex_html_a95b1159ba3a5494abd49dc9b3d34eacf"><div class="ttname"><a href="namespaceamrex.html#a95b1159ba3a5494abd49dc9b3d34eacf">amrex::ignore_unused</a></div><div class="ttdeci">AMREX_GPU_HOST_DEVICE AMREX_FORCE_INLINE void ignore_unused(const Ts &amp;...)</div><div class="ttdoc">This shuts up the compiler about unused variables.</div><div class="ttdef"><b>Definition:</b> AMReX.H:111</div></div>
 <div class="ttc" id="anamespaceamrex_html_ad26f2328bf66aa9678347a6055a25431"><div class="ttname"><a href="namespaceamrex.html#ad26f2328bf66aa9678347a6055a25431">amrex::Abort</a></div><div class="ttdeci">void Abort(const std::string &amp;msg)</div><div class="ttdoc">Print out message to cerr and exit via abort().</div><div class="ttdef"><b>Definition:</b> AMReX.cpp:225</div></div>
-<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html">amrex::FFT::Info</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:56</div></div>
-<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html_a7b525db9e23d007bf069ca7a2e420523"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html#a7b525db9e23d007bf069ca7a2e420523">amrex::FFT::Info::batch_mode</a></div><div class="ttdeci">bool batch_mode</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:60</div></div>
-<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html_ad5f4264ae4f5dad78b49e35d187156c7"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html#ad5f4264ae4f5dad78b49e35d187156c7">amrex::FFT::Info::nprocs</a></div><div class="ttdeci">int nprocs</div><div class="ttdoc">Max number of processes to use.</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:63</div></div>
+<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html">amrex::FFT::Info</a></div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:58</div></div>
+<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html_a7b525db9e23d007bf069ca7a2e420523"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html#a7b525db9e23d007bf069ca7a2e420523">amrex::FFT::Info::batch_mode</a></div><div class="ttdeci">bool batch_mode</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:62</div></div>
+<div class="ttc" id="astructamrex_1_1FFT_1_1Info_html_ad5f4264ae4f5dad78b49e35d187156c7"><div class="ttname"><a href="structamrex_1_1FFT_1_1Info.html#ad5f4264ae4f5dad78b49e35d187156c7">amrex::FFT::Info::nprocs</a></div><div class="ttdeci">int nprocs</div><div class="ttdoc">Max number of processes to use.</div><div class="ttdef"><b>Definition:</b> AMReX_FFT_Helper.H:65</div></div>
 <div class="ttc" id="astructamrex_1_1GpuArray_html"><div class="ttname"><a href="structamrex_1_1GpuArray.html">amrex::GpuArray&lt; int, 3 &gt;</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->