Doc update

Add keys from AMReX-Hydro

Merge request reports

Loading
+15 −4
Changes for docs/source_docs/user_guide/inputs/gridding.rst: 15 added lines, 4 removed lines.
Original line number Diff line number Diff line
@@ -147,7 +147,6 @@ mesh refinement algorithm and are only applicable when ``amr.max_level > 0``.
|                      | 1/2, 2/3, and 3/4, respectively.                                      |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+


.. caution::

   **Mesh refinement limitations:**
@@ -158,14 +157,26 @@ See the `AMReX documentation <https://amrex-codes.github.io/amrex/docs_html/inde
for details on the adaptive mesh refinement algorithms.


The following inputs are defined using the prefix ``mfix``. These inputs control the automatic
mesh refinement algorithm and are only applicable when ``amr.max_level > 0``.
The following input is defined using the prefix ``mfix``.  It only applies to  AMR level 0.

+----------------------+-----------------------------------------------------------------------+-------------+-----------+
|                      | Description                                                           |   Type      | Default   |
+======================+=======================================================================+=============+===========+
| grid_pruning         | Remove fully covered grids from the box array to avoid allocating     |  Bool       | false     |
|                      | memory to them or looping over them.                                  |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+



The following input is defined using the prefix ``mfix``. This inputs controls the automatic
mesh refinement algorithm and is only applicable when ``amr.max_level > 0``.

+----------------------+-----------------------------------------------------------------------+-------------+-----------+
|                      | Description                                                           |   Type      | Default   |
+======================+=======================================================================+=============+===========+
| regrid_int           | How often to regrid (in number of steps at level 0).                  |  Int        | 0         |
|                      | If regrid_int <= 0 then no regridding will occur.                     |             |           |
|                      | If regrid_int <= 0 then no regridding will occur. Only applies when   |             |           |
|                      | ``amr.max_level > 0``.                                                |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+


+36 −3
Changes for docs/source_docs/user_guide/inputs/multigrid_solvers.rst: 36 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@
Multigrid solvers
=================


Nodal projection
----------------

@@ -17,8 +18,13 @@ The following inputs are defined using the prefix ``nodal_proj``:
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| mg_rtol                 | Relative tolerance in nodal projection.                               |  Real       |   1.e-11     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_rtol             | Relative tolerance of bottom solver.                                  |   Real      |   1.0e-4     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| mg_atol                 | Absolute tolerance in nodal projection.                               |  Real       |   1.e-14     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_atol             | Absolute tolerance of bottom solver, a negative number means it won't |   Real      |   -1.0       |
|                         | be used.                                                              |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| maxiter                 | Maximum number of iterations in the nodal projection.                 |  Int        |   100        |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_maxiter          | Maximum number of iterations in the nodal projection                  |  Int        |   100        |
@@ -44,12 +50,16 @@ The following inputs are defined using the prefix ``nodal_proj``:
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| hypre_interface         | Which interface to use in the nodal projection when using ``hypre``.  |  String     |   ij         |
|                         |                                                                       |             |              |
|                         |                                                                       |             |              |
|                         | Options:                                                              |             |              |
|                         |                                                                       |             |              |
|                         | * ``ij``                                                              |             |              |
|                         | * ``semi-structured``                                                 |             |              |
|                         | * ``structured``                                                      |             |              |
|                         |                                                                       |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| num_pre_smooth          |  Number of smoother iterations when going down the V-cycle            |    Int      |   2          |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| num_post_smooth         |  Number of smoother iterations when going up the V-cycle              |    Int      |   2          |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+


@@ -67,14 +77,31 @@ The following inputs are defined using the prefix ``mac_proj``:
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| mg_rtol                 | Relative tolerance in MAC projection.                                 |    Real     |   1.e-11     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_rtol             | Relative tolerance of bottom solver.                                  |   Real      |   1.0e-4     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| mg_atol                 | Absolute tolerance in MAC projection.                                 |    Real     |   1.e-14     |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_atol             | Absolute tolerance of bottom solver, a negative number means it won't |   Real      |   -1.0       |
|                         | be used.                                                              |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| maxiter                 | Maximum number of iterations in the MAC projection.                   |    Int      |   200        |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| maxorder                | Sets the order of the cell-centered linear operator stencil at        |    Int      |   3          |
|                         | physical boundaries with Dirichlet boundary conditions and at         |             |              |
|                         | coarse-fine boundaries.  In both of these cases, the boundary value is|             |              |
|                         | not defined at the center of the ghost cell.  The order determines the|             |              |
|                         | number of interior cells that are used in the extrapolation of the    |             |              |
|                         | boundary value from the cell face to the center of the ghost cell,    |             |              |
|                         | where the extrapolated value is then used in the regular stencil.  For|             |              |
|                         | example, ``maxorder = 2`` uses the boundary value and the first       |             |              |
|                         | interior value to extrapolate to the ghost cell center and            |             |              |
|                         | ``maxorder = 3`` uses the boundary value and the first two interior   |             |              |
|                         | values.                                                               |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_maxiter          | Maximum number of iterations in the MAC projection                    |    Int      |   200        |
|                         | bottom solver if using ``bicg``, ``cg``, ``bicgcg``, or ``cgbicg``.   |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| mg_max_coarsening_level |  Maximum number of coarser levels to allow in the MAC projection      |    Int      |   100        |
| mg_max_coarsening_level | aximum number of coarser levels to allow in the MAC projection        |    Int      |   100        |
|                         |  If set to 0, the bottom solver will be called at the current level.  |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| bottom_solver           | Which bottom solver to use in the MAC projection.                     |  String     |   bicgcg     |
@@ -87,6 +114,7 @@ The following inputs are defined using the prefix ``mac_proj``:
|                         | * ``cgbicg``                                                          |             |              |
|                         | * ``hypre``                                                           |             |              |
|                         | * ``smoother``                                                        |             |              |
|                         |                                                                       |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| hypre_namespace         | Namespace to use in the MAC projection when using ``hypre``           |  String     |   hypre      |
|                         | to control hypre specific settings. It can be any string.             |             |              |
@@ -98,8 +126,12 @@ The following inputs are defined using the prefix ``mac_proj``:
|                         | * ``ij``                                                              |             |              |
|                         | * ``semi-structured``                                                 |             |              |
|                         | * ``structured``                                                      |             |              |
|                         |                                                                       |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| num_pre_smooth          | Number of smoother iterations when going down the V-cycle             |    Int      |   2          |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+
| num_post_smooth         | Number of smoother iterations when going up the V-cycle               |    Int      |   2          |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+



Diffusion
@@ -135,6 +167,7 @@ The following inputs are defined using the prefix ``diffusion``:
|                         | * ``cg``                                                              |             |              |
|                         | * ``cgbigc``                                                          |             |              |
|                         | * ``smoother``                                                        |             |              |
|                         |                                                                       |             |              |
+-------------------------+-----------------------------------------------------------------------+-------------+--------------+


+0 −1
Changes for undocumented-keys.txt: 0 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -31,7 +31,6 @@ mfix.ascent_on_restart
mfix.checkpoint_files_output
mfix.constraint.include_depdt
mfix.geom_chk_ccse_regtest
mfix.grid_pruning
mfix.monitors.[monitor_name].count
mfix.overstep_end_time
mfix.particle_sorting_bin
Loading