Docs @ b70292f

Author: MFC Action

documentation/md_case.html

@@ -1118,19 +1118,22 @@ <h2><a class="anchor" id="autotoc_md28"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><code>relativity</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Enable relativistic MHD simulation    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><code>powell</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Enable Powell's method for solenoidal constraint    </td></tr>
+<td class="markdownTableBodyRight"><code>hyper_cleaning</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Enable hyperbolic (GLM) divergence cleaning for <code>div B</code>    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><code>fd_order</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Finite difference order for Powell's method    </td></tr>
+<td class="markdownTableBodyRight"><code>hyper_cleaning_speed</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">Cleaning wave speed <code>c_h</code>    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><code>Bx[y,z]</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">Initial magnetic field in the x[y,z] direction    </td></tr>
+<td class="markdownTableBodyRight"><code>hyper_cleaning_tau</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">Cleaning damping timescale <code>tau</code>    </td></tr>
 <tr class="markdownTableRowEven">
+<td class="markdownTableBodyRight"><code>Bx[y,z]</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">Initial magnetic field in the x[y,z] direction    </td></tr>
+<tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><code>Bx0</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">Constant magnetic field in the x direction (1D only)   </td></tr>
 </table>
 <ul>
 <li><code>mhd</code> is currently only available for single-component flows and 5-equation model. Its compatibility with most other features is work in progress.</li>
 <li><code>relativity</code> only works for <code>mhd</code> enabled and activates relativistic MHD (RMHD) simulation.</li>
-<li><code>powell</code> activates Powell's eight-wave method to impose the solenoidal constraint in the MHD simulation <a class="el" href="md_references.html">Powell (1994)</a>. It should not be used in conjunction with HLLD (<code>riemann_solver = 4</code>).</li>
-<li><code>fd_order</code> specifies the finite difference order for computing the RHS of the Powell's method. <code>fd_order = 1</code>, <code>2</code>, and <code>4</code> are allowed.</li>
+<li><code>hyper_cleaning</code> <a class="el" href="md_references.html">Dedner et al., 2002</a> only works with <code>mhd</code> in 2D/3D and reduces numerical <code>div B</code> errors by propagation and damping. Currently not compatible with HLLD (<code>riemann_solver = 4</code>).</li>
+<li><code>hyper_cleaning_speed</code> sets the propagation speed of divergence-cleaning waves.</li>
+<li><code>hyper_cleaning_tau</code> sets the decay timescale for divergence-cleaning.</li>
 <li><code>Bx0</code> is only used in 1D simulations to specify the constant magnetic field in the x direction. It must be specified in 1D simulations. <code>Bx</code> must not be used in 1D simulations.</li>
 <li><code>Bx</code>, <code>By</code>, and <code>Bz</code> are used to specify the initial magnetic field in the x, y, and z directions, respectively. They must be specified in all 1D/2D/3D MHD simulations, with the exception of <code>Bx</code> in 1D simulations.</li>
 </ul>

documentation/md_case__constraints.html

@@ -581,7 +581,7 @@ <h1><a class="anchor" id="autotoc_md53"></a>
 <p></p>
 <p><b>Requirements:</b></p><ul>
 <li>relativity requires mhd to be enabled</li>
-<li>Powell's method requires mhd to be enabled</li>
+<li>Hyperbolic cleaning requires mhd to be enabled</li>
 </ul>
 <p><b>Incompatibilities:</b></p><ul>
 <li>Bx0 must not be set if MHD is not enabled</li>

documentation/md_references.html

@@ -236,7 +236,7 @@
 <li><a class="anchor" id="Miyoshi05"></a>Miyoishi, T., and Kusano, K. (2005). A multi-state HLL approximate Riemann solver for ideal magnetohydrodynamics. Journal of Computational Physics, 208(1), 315-344.</li>
 </ul>
 <ul>
-<li><a class="anchor" id="Powell94"></a>Powell, K. G. (1994). An approximate Riemann solver for magnetohydrodynamics: (That works in more than one dimension). In Upwind and high-resolution schemes (pp. 570-583). Springer.</li>
+<li><a class="anchor" id="Dedner02"></a>Dedner, A., Kemm, F., Kröner, D., Munz, C. D., Schnitzer, T., &amp; Wesenberg, M. (2002). Hyperbolic divergence cleaning for the MHD equations. Journal of Computational Physics, 175(2), 645-673.</li>
 </ul>
 <ul>
 <li><a class="anchor" id="Cao19"></a>Cao, S., Zhang, Y., Liao, D., Zhong, P., and Wang, K. G. (2019). Shock-induced damage and dynamic fracture in cylindrical bodies submerged in liquid. International Journal of Solids and Structures, 169:55–71. Elsevier.</li>

post_process/doxygen_crawl.html

@@ -476,6 +476,7 @@
 <a href="namespacem__global__parameters.html#a9909e93a618d47198fd0f80246c25a3e"/>
 <a href="namespacem__global__parameters.html#a9a425d1bd91d1765043adf8410b98bf7"/>
 <a href="namespacem__global__parameters.html#a9b62d10b1daae13c7f40d7bf39a5c1c3"/>
+<a href="namespacem__global__parameters.html#a9d5c347a1035e6cdd5349086076b2360"/>
 <a href="namespacem__global__parameters.html#a9eb3789b90381530338a223c99cf1090"/>
 <a href="namespacem__global__parameters.html#a9efba3343251f7bc76bf9c7c6613b41e"/>
 <a href="namespacem__global__parameters.html#a9fcbb358a7122d321eb26e015377ff6f"/>
@@ -536,6 +537,7 @@
 <a href="namespacem__global__parameters.html#adc35ba450a192812db36f1d6659d64e6"/>
 <a href="namespacem__global__parameters.html#addf7564fc01940adad44defd2c6b65ba"/>
 <a href="namespacem__global__parameters.html#ae007ab80021e18ba6db79f9261322293"/>
+<a href="namespacem__global__parameters.html#ae0d82f5269edb0154da89723fd3f7e98"/>
 <a href="namespacem__global__parameters.html#ae239167395de41a328b0d69c717a85a6"/>
 <a href="namespacem__global__parameters.html#ae3a8a13b274ed1d409f89868ae1c8b7d"/>
 <a href="namespacem__global__parameters.html#ae4ab7caa7dee5e616b217437f7f2b87f"/>

post_process/m__global__parameters_8fpp_8f90.html

@@ -424,6 +424,9 @@
 <tr class="memitem:a1012302521370c3471fda3dfc059aab8" id="r_a1012302521370c3471fda3dfc059aab8"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1012302521370c3471fda3dfc059aab8">m_global_parameters::cont_damage</a></td></tr>
 <tr class="memdesc:a1012302521370c3471fda3dfc059aab8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuum damage modeling.  <br /></td></tr>
 <tr class="separator:a1012302521370c3471fda3dfc059aab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9d5c347a1035e6cdd5349086076b2360" id="r_a9d5c347a1035e6cdd5349086076b2360"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a9d5c347a1035e6cdd5349086076b2360">m_global_parameters::hyper_cleaning</a></td></tr>
+<tr class="memdesc:a9d5c347a1035e6cdd5349086076b2360"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hyperbolic cleaning for MHD.  <br /></td></tr>
+<tr class="separator:a9d5c347a1035e6cdd5349086076b2360"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1106201db32843ef3bcd5e170d3de86a" id="r_a1106201db32843ef3bcd5e170d3de86a"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1106201db32843ef3bcd5e170d3de86a">m_global_parameters::igr</a></td></tr>
 <tr class="memdesc:a1106201db32843ef3bcd5e170d3de86a"><td class="mdescLeft">&#160;</td><td class="mdescRight">enable IGR  <br /></td></tr>
 <tr class="separator:a1106201db32843ef3bcd5e170d3de86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -485,6 +488,9 @@
 <tr class="memitem:a9b62d10b1daae13c7f40d7bf39a5c1c3" id="r_a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a9b62d10b1daae13c7f40d7bf39a5c1c3">m_global_parameters::damage_idx</a></td></tr>
 <tr class="memdesc:a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of damage state variable (D) for continuum damage model.  <br /></td></tr>
 <tr class="separator:a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae0d82f5269edb0154da89723fd3f7e98" id="r_ae0d82f5269edb0154da89723fd3f7e98"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#ae0d82f5269edb0154da89723fd3f7e98">m_global_parameters::psi_idx</a></td></tr>
+<tr class="memdesc:ae0d82f5269edb0154da89723fd3f7e98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of hyperbolic cleaning state variable for MHD.  <br /></td></tr>
+<tr class="separator:ae0d82f5269edb0154da89723fd3f7e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr><td colspan="2"><div class="groupHeader">Boundary conditions in the x-, y- and z-coordinate directions</div></td></tr>
 <tr class="memitem:a91304734742c36abcb4dbf0712545344" id="r_a91304734742c36abcb4dbf0712545344"><td class="memItemLeft" align="right" valign="top">type(<a class="el" href="structm__derived__types_1_1int__bounds__info.html">int_bounds_info</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">m_global_parameters::bc_x</a></td></tr>
 <tr class="separator:a91304734742c36abcb4dbf0712545344"><td class="memSeparator" colspan="2">&#160;</td></tr>

post_process/m__global__parameters_8fpp_8f90.js

@@ -420,6 +420,9 @@
 <tr class="memitem:a1012302521370c3471fda3dfc059aab8" id="r_a1012302521370c3471fda3dfc059aab8"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1012302521370c3471fda3dfc059aab8">cont_damage</a></td></tr>
 <tr class="memdesc:a1012302521370c3471fda3dfc059aab8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Continuum damage modeling.  <br /></td></tr>
 <tr class="separator:a1012302521370c3471fda3dfc059aab8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9d5c347a1035e6cdd5349086076b2360" id="r_a9d5c347a1035e6cdd5349086076b2360"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d5c347a1035e6cdd5349086076b2360">hyper_cleaning</a></td></tr>
+<tr class="memdesc:a9d5c347a1035e6cdd5349086076b2360"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hyperbolic cleaning for MHD.  <br /></td></tr>
+<tr class="separator:a9d5c347a1035e6cdd5349086076b2360"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1106201db32843ef3bcd5e170d3de86a" id="r_a1106201db32843ef3bcd5e170d3de86a"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1106201db32843ef3bcd5e170d3de86a">igr</a></td></tr>
 <tr class="memdesc:a1106201db32843ef3bcd5e170d3de86a"><td class="mdescLeft">&#160;</td><td class="mdescRight">enable IGR  <br /></td></tr>
 <tr class="separator:a1106201db32843ef3bcd5e170d3de86a"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -481,6 +484,9 @@
 <tr class="memitem:a9b62d10b1daae13c7f40d7bf39a5c1c3" id="r_a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b62d10b1daae13c7f40d7bf39a5c1c3">damage_idx</a></td></tr>
 <tr class="memdesc:a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of damage state variable (D) for continuum damage model.  <br /></td></tr>
 <tr class="separator:a9b62d10b1daae13c7f40d7bf39a5c1c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae0d82f5269edb0154da89723fd3f7e98" id="r_ae0d82f5269edb0154da89723fd3f7e98"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0d82f5269edb0154da89723fd3f7e98">psi_idx</a></td></tr>
+<tr class="memdesc:ae0d82f5269edb0154da89723fd3f7e98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Index of hyperbolic cleaning state variable for MHD.  <br /></td></tr>
+<tr class="separator:ae0d82f5269edb0154da89723fd3f7e98"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr><td colspan="2"><div class="groupHeader">Boundary conditions in the x-, y- and z-coordinate directions</div></td></tr>
 <tr class="memitem:a91304734742c36abcb4dbf0712545344" id="r_a91304734742c36abcb4dbf0712545344"><td class="memItemLeft" align="right" valign="top">type(<a class="el" href="structm__derived__types_1_1int__bounds__info.html">int_bounds_info</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a91304734742c36abcb4dbf0712545344">bc_x</a></td></tr>
 <tr class="separator:a91304734742c36abcb4dbf0712545344"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -1949,6 +1955,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad9c6ef3b20d42a8c3dababd6
       </table>
 </div><div class="memdoc">
 
+</div>
+</div>
+<a id="a9d5c347a1035e6cdd5349086076b2360" name="a9d5c347a1035e6cdd5349086076b2360"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a9d5c347a1035e6cdd5349086076b2360">&#9670;&#160;</a></span>hyper_cleaning</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">logical m_global_parameters::hyper_cleaning</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Hyperbolic cleaning for MHD. </p>
+
 </div>
 </div>
 <a id="a6fe63b247d95292a893cfc1a49bff915" name="a6fe63b247d95292a893cfc1a49bff915"></a>
@@ -3423,6 +3445,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#a383c6ff025d4ea09ddd4e235
 
 <p>Rank of the local processor. </p>
 
+</div>
+</div>
+<a id="ae0d82f5269edb0154da89723fd3f7e98" name="ae0d82f5269edb0154da89723fd3f7e98"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae0d82f5269edb0154da89723fd3f7e98">&#9670;&#160;</a></span>psi_idx</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">integer m_global_parameters::psi_idx</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Index of hyperbolic cleaning state variable for MHD. </p>
+
 </div>
 </div>
 <a id="ae3a8a13b274ed1d409f89868ae1c8b7d" name="ae3a8a13b274ed1d409f89868ae1c8b7d"></a>

post_process/namespacem__global__parameters.html

@@ -140,6 +140,7 @@ <h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
 <li>heat_ratio_wrt&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#ad9c6ef3b20d42a8c3dababd60c20cca3">m_global_parameters</a></li>
 <li>hi_offset&#160;:&#160;<a class="el" href="namespacem__data__output.html#a1a779679774e1161511609f18e8d9c27">m_data_output</a></li>
 <li>hp&#160;:&#160;<a class="el" href="namespacem__precision__select.html#aae1265756d05d3113702b0a0383a50c9">m_precision_select</a></li>
+<li>hyper_cleaning&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a9d5c347a1035e6cdd5349086076b2360">m_global_parameters</a></li>
 <li>hyperelasticity&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a6fe63b247d95292a893cfc1a49bff915">m_global_parameters</a></li>
 <li>hypoelasticity&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a138f81f8ff7d760956ffcf281e928f9b">m_global_parameters</a></li>
 </ul>

post_process/namespacemembers_h.html

@@ -166,6 +166,7 @@ <h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
 <li>proc_rank13&#160;:&#160;<a class="el" href="namespacem__start__up.html#afc5a1516886711c23c62d07443f53895">m_start_up</a></li>
 <li>proc_rank_dir&#160;:&#160;<a class="el" href="namespacem__data__output.html#ac9711cb2f20dace017da2bf94fd68118">m_data_output</a></li>
 <li>ps_inf&#160;:&#160;<a class="el" href="namespacem__variables__conversion.html#a20eddf4f73253831dcf2b48f4997c781">m_variables_conversion</a></li>
+<li>psi_idx&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#ae0d82f5269edb0154da89723fd3f7e98">m_global_parameters</a></li>
 <li>pv&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#ae3a8a13b274ed1d409f89868ae1c8b7d">m_global_parameters</a></li>
 </ul>
 </div><!-- contents -->

post_process/namespacemembers_p.html

@@ -140,6 +140,7 @@ <h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
 <li>heat_ratio_wrt&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#ad9c6ef3b20d42a8c3dababd60c20cca3">m_global_parameters</a></li>
 <li>hi_offset&#160;:&#160;<a class="el" href="namespacem__data__output.html#a1a779679774e1161511609f18e8d9c27">m_data_output</a></li>
 <li>hp&#160;:&#160;<a class="el" href="namespacem__precision__select.html#aae1265756d05d3113702b0a0383a50c9">m_precision_select</a></li>
+<li>hyper_cleaning&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a9d5c347a1035e6cdd5349086076b2360">m_global_parameters</a></li>
 <li>hyperelasticity&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a6fe63b247d95292a893cfc1a49bff915">m_global_parameters</a></li>
 <li>hypoelasticity&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a138f81f8ff7d760956ffcf281e928f9b">m_global_parameters</a></li>
 </ul>