Documentation Update

doxygen/Cabana__Grid__FastFourierTransform_8hpp__incl.md5

@@ -1 +1 @@
-6f6f6b62e3184ad557564d0ba1e487dd
+9f2eee653489ef5ac215105e005f1e27

doxygen/Cabana__Utils_8hpp__dep__incl.md5

@@ -1 +1 @@
-f7cc4eee8efd23c3259428dc566b3edd
+0c769da5518f88c4cae643d0e2bbff05

doxygen/classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams-members.html

@@ -94,12 +94,13 @@
 
 <p>This is the complete list of members for <a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a7e77f9fc7f28d76f0177f14791659b7a">getAllToAll</a>() const</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a54451157fb4508593f970c74af7265ff">getAlltoAll</a>() const</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a698a5ac7a6fd88c1df48a1413ad8b102">getPencils</a>() const</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a1d45cdec3e252b9357dcb3144211a927">getReorder</a>() const</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a114959cfad08c059c6dbfa1b72299ae3">setAllToAll</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#af386733ead1c7f2fc7976ed0e4a0c93e">setPencils</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#aafcbd802bbd221dbbb8c35740fbd0b81">setReorder</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#ad560626bf539c85a7373f953a1b14ec4">setAlltoAll</a>(FFTCommPattern value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#a4c2918f63aa057e38eb3f4576dac82e7">setAlltoAll</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#af386733ead1c7f2fc7976ed0e4a0c93e">setPencils</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html#aafcbd802bbd221dbbb8c35740fbd0b81">setReorder</a>(bool value)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html">Cabana::Grid::Experimental::FastFourierTransformParams</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

doxygen/classCabana_1_1Grid_1_1Experimental_1_1FastFourierTransformParams.html

@@ -102,18 +102,21 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
-<tr class="memitem:a114959cfad08c059c6dbfa1b72299ae3" id="r_a114959cfad08c059c6dbfa1b72299ae3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a114959cfad08c059c6dbfa1b72299ae3">setAllToAll</a> (bool value)</td></tr>
-<tr class="memdesc:a114959cfad08c059c6dbfa1b72299ae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set MPI communication strategy.  <br /></td></tr>
-<tr class="separator:a114959cfad08c059c6dbfa1b72299ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad560626bf539c85a7373f953a1b14ec4" id="r_ad560626bf539c85a7373f953a1b14ec4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad560626bf539c85a7373f953a1b14ec4">setAlltoAll</a> (<a class="el" href="Cabana__Grid__FastFourierTransform_8hpp.html#aae3cd95c90c3006b596b231709d286b6">FFTCommPattern</a> value)</td></tr>
+<tr class="memdesc:ad560626bf539c85a7373f953a1b14ec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set MPI communication strategy.  <br /></td></tr>
+<tr class="separator:ad560626bf539c85a7373f953a1b14ec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4c2918f63aa057e38eb3f4576dac82e7" id="r_a4c2918f63aa057e38eb3f4576dac82e7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4c2918f63aa057e38eb3f4576dac82e7">setAlltoAll</a> (bool value)</td></tr>
+<tr class="memdesc:a4c2918f63aa057e38eb3f4576dac82e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set MPI communication strategy.  <br /></td></tr>
+<tr class="separator:a4c2918f63aa057e38eb3f4576dac82e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af386733ead1c7f2fc7976ed0e4a0c93e" id="r_af386733ead1c7f2fc7976ed0e4a0c93e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af386733ead1c7f2fc7976ed0e4a0c93e">setPencils</a> (bool value)</td></tr>
 <tr class="memdesc:af386733ead1c7f2fc7976ed0e4a0c93e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set data exchange type (pencil or slab).  <br /></td></tr>
 <tr class="separator:af386733ead1c7f2fc7976ed0e4a0c93e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aafcbd802bbd221dbbb8c35740fbd0b81" id="r_aafcbd802bbd221dbbb8c35740fbd0b81"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aafcbd802bbd221dbbb8c35740fbd0b81">setReorder</a> (bool value)</td></tr>
 <tr class="memdesc:aafcbd802bbd221dbbb8c35740fbd0b81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set data handling (contiguous or strided memory).  <br /></td></tr>
 <tr class="separator:aafcbd802bbd221dbbb8c35740fbd0b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7e77f9fc7f28d76f0177f14791659b7a" id="r_a7e77f9fc7f28d76f0177f14791659b7a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e77f9fc7f28d76f0177f14791659b7a">getAllToAll</a> () const</td></tr>
-<tr class="memdesc:a7e77f9fc7f28d76f0177f14791659b7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get MPI communication strategy.  <br /></td></tr>
-<tr class="separator:a7e77f9fc7f28d76f0177f14791659b7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a54451157fb4508593f970c74af7265ff" id="r_a54451157fb4508593f970c74af7265ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Cabana__Grid__FastFourierTransform_8hpp.html#aae3cd95c90c3006b596b231709d286b6">FFTCommPattern</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a54451157fb4508593f970c74af7265ff">getAlltoAll</a> () const</td></tr>
+<tr class="memdesc:a54451157fb4508593f970c74af7265ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get MPI communication strategy.  <br /></td></tr>
+<tr class="separator:a54451157fb4508593f970c74af7265ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a698a5ac7a6fd88c1df48a1413ad8b102" id="r_a698a5ac7a6fd88c1df48a1413ad8b102"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a698a5ac7a6fd88c1df48a1413ad8b102">getPencils</a> () const</td></tr>
 <tr class="memdesc:a698a5ac7a6fd88c1df48a1413ad8b102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get data exchange type (pencil or slab).  <br /></td></tr>
 <tr class="separator:a698a5ac7a6fd88c1df48a1413ad8b102"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -124,8 +127,8 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Parameters controlling details for fast Fourier transforms. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
-<a id="a7e77f9fc7f28d76f0177f14791659b7a" name="a7e77f9fc7f28d76f0177f14791659b7a"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a7e77f9fc7f28d76f0177f14791659b7a">&#9670;&#160;</a></span>getAllToAll()</h2>
+<a id="a54451157fb4508593f970c74af7265ff" name="a54451157fb4508593f970c74af7265ff"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a54451157fb4508593f970c74af7265ff">&#9670;&#160;</a></span>getAlltoAll()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -134,7 +137,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7e77f9fc7f28d76f0177f147
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">bool Cabana::Grid::Experimental::FastFourierTransformParams::getAllToAll </td>
+          <td class="memname"><a class="el" href="Cabana__Grid__FastFourierTransform_8hpp.html#aae3cd95c90c3006b596b231709d286b6">FFTCommPattern</a> Cabana::Grid::Experimental::FastFourierTransformParams::getAlltoAll </td>
           <td>(</td>
           <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
           <td> const</td>
@@ -208,8 +211,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1d45cdec3e252b9357dcb314
 
 </div>
 </div>
-<a id="a114959cfad08c059c6dbfa1b72299ae3" name="a114959cfad08c059c6dbfa1b72299ae3"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a114959cfad08c059c6dbfa1b72299ae3">&#9670;&#160;</a></span>setAllToAll()</h2>
+<a id="a4c2918f63aa057e38eb3f4576dac82e7" name="a4c2918f63aa057e38eb3f4576dac82e7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4c2918f63aa057e38eb3f4576dac82e7">&#9670;&#160;</a></span>setAlltoAll() <span class="overload">[1/2]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -218,7 +221,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a114959cfad08c059c6dbfa1b
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">void Cabana::Grid::Experimental::FastFourierTransformParams::setAllToAll </td>
+          <td class="memname">void Cabana::Grid::Experimental::FastFourierTransformParams::setAlltoAll </td>
           <td>(</td>
           <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
           <td></td>
@@ -239,6 +242,39 @@ <h2 class="memtitle"><span class="permalink"><a href="#a114959cfad08c059c6dbfa1b
   </dd>
 </dl>
 
+</div>
+</div>
+<a id="ad560626bf539c85a7373f953a1b14ec4" name="ad560626bf539c85a7373f953a1b14ec4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad560626bf539c85a7373f953a1b14ec4">&#9670;&#160;</a></span>setAlltoAll() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Cabana::Grid::Experimental::FastFourierTransformParams::setAlltoAll </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="Cabana__Grid__FastFourierTransform_8hpp.html#aae3cd95c90c3006b596b231709d286b6">FFTCommPattern</a></td>          <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Set MPI communication strategy. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">value</td><td>Use all to all MPI communication. </td></tr>
+  </table>
+  </dd>
+</dl>
+
 </div>
 </div>
 <a id="af386733ead1c7f2fc7976ed0e4a0c93e" name="af386733ead1c7f2fc7976ed0e4a0c93e"></a>

doxygen/classCabana_1_1Grid_1_1Experimental_1_1HeffteFastFourierTransform.html

@@ -265,8 +265,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa9c092b9f264b4fa00f4dfc8
 <b>Initial value:</b><div class="fragment"><div class="line"> </div>
 <div class="line">        <span class="keyword">typename</span> Impl::HeffteBackendTraits&lt;<a class="code hl_typedef" href="#a0a3ecac356bc07d79ae650eda23d345b">execution_space</a>,</div>
 <div class="line">                                           <a class="code hl_typedef" href="#aef1b52da90830d5c9dba54c1aaf6fe0f">backend_type</a>&gt;<a class="code hl_typedef" href="#aef1b52da90830d5c9dba54c1aaf6fe0f">::backend_type</a></div>
-<div class="ttc" id="aclassCabana_1_1Grid_1_1Experimental_1_1HeffteFastFourierTransform_html_a0a3ecac356bc07d79ae650eda23d345b"><div class="ttname"><a href="#a0a3ecac356bc07d79ae650eda23d345b">Cabana::Grid::Experimental::HeffteFastFourierTransform::execution_space</a></div><div class="ttdeci">ExecSpace execution_space</div><div class="ttdoc">Kokkos execution space.</div><div class="ttdef"><b>Definition</b> Cabana_Grid_FastFourierTransform.hpp:498</div></div>
-<div class="ttc" id="aclassCabana_1_1Grid_1_1Experimental_1_1HeffteFastFourierTransform_html_aef1b52da90830d5c9dba54c1aaf6fe0f"><div class="ttname"><a href="#aef1b52da90830d5c9dba54c1aaf6fe0f">Cabana::Grid::Experimental::HeffteFastFourierTransform::backend_type</a></div><div class="ttdeci">BackendType backend_type</div><div class="ttdoc">FFT backend type.</div><div class="ttdef"><b>Definition</b> Cabana_Grid_FastFourierTransform.hpp:504</div></div>
+<div class="ttc" id="aclassCabana_1_1Grid_1_1Experimental_1_1HeffteFastFourierTransform_html_a0a3ecac356bc07d79ae650eda23d345b"><div class="ttname"><a href="#a0a3ecac356bc07d79ae650eda23d345b">Cabana::Grid::Experimental::HeffteFastFourierTransform::execution_space</a></div><div class="ttdeci">ExecSpace execution_space</div><div class="ttdoc">Kokkos execution space.</div><div class="ttdef"><b>Definition</b> Cabana_Grid_FastFourierTransform.hpp:518</div></div>
+<div class="ttc" id="aclassCabana_1_1Grid_1_1Experimental_1_1HeffteFastFourierTransform_html_aef1b52da90830d5c9dba54c1aaf6fe0f"><div class="ttname"><a href="#aef1b52da90830d5c9dba54c1aaf6fe0f">Cabana::Grid::Experimental::HeffteFastFourierTransform::backend_type</a></div><div class="ttdeci">BackendType backend_type</div><div class="ttdoc">FFT backend type.</div><div class="ttdef"><b>Definition</b> Cabana_Grid_FastFourierTransform.hpp:524</div></div>
 </div><!-- fragment -->
 <p>heFFTe backend type. </p>