diff --git a/docs/source_docs/user_guide/inputs/advanced.rst b/docs/source_docs/user_guide/inputs/advanced.rst index f46b22c46c57675b0dc5978e76d4f9047adbe186..3a55d2eb3ed0d497dbf925a9c08271bdbb583cd8 100644 --- a/docs/source_docs/user_guide/inputs/advanced.rst +++ b/docs/source_docs/user_guide/inputs/advanced.rst @@ -19,6 +19,10 @@ The following inputs must be preceded by the prefix ``mfix``: | | and exit. | | | +------------------------+-----------------------------------------------------------------------+-------------+--------------+ +To assist in verifying the breakdown of fluid grids created before running a full simulation, an input option +``mfix.only_print_grid_report`` is supported. By default, it is ``false``. When set to ``true``, the run uses +minimal memory to print the grid coverage report and exits immediately after that. + The following inputs must be preceded by the prefix ``amrex``: @@ -63,9 +67,6 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | | 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. | | | -+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ | | Grid type. | String | SingleGrid | | | | | | | | Options: | | | @@ -96,10 +97,6 @@ The following inputs must be preceded by the prefix ``mfix`` and control load ba | | disjoined grids | | | +----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+ -To allow a user to verify the breakdown of fluid grids created before running a full simulation, an input option, -``mfix.only_print_grid_report`` is supported. By default, it is ``False``. When set to ``True``, the run uses -minimal memory to print the grid coverage report and exits immediately after that. - The following inputs are defined using the prefix ``particles``: diff --git a/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst b/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst index 7cc5164e30044d6b6b88be31774d2d84a5a7baaf..cdd20787804f2b0110903f49febea92d49535878 100644 --- a/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +++ b/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst @@ -23,7 +23,7 @@ The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The level 0 mesh spacing is computed for each direction by dividing the :ref:`domain length` by the -number of cells. The mesh spacing is **required** to be the same in all directions: +number of cells. The mesh spacing is required to be the same in all directions: .. math:: @@ -128,17 +128,13 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | grad_rho.less_than | Tag cells for refinement when the difference in fluid density between | Bool | false | | | two adjacent cells is **less than** the specified value. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| vel | Tag cells for refinement when the difference in any fluid velocity | Reals | None | -| | component between two adjacent cells is **greater than** the | | | -| | specified value. | | | +| vel | Tag cells for refinement when the magnitude of fluid velocity | Reals | None | +| | is **greater than** the specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.tag.vel.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | -| | | | | -| | Tag cells for refinement when the fluid velocity magnitude is | | | -| | *greater than* the specified value. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | vel.less_than | Tag cells for refinement when fluid velocity magnitude is | Bool | false | | | **less than** the specified value. | | | @@ -187,10 +183,14 @@ The following inputs are defined using the prefix ``amr``: | | ensuring at least one grid per MPI process, provided this does not | | | | | violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ +| regrid_int | How often to regrid (in number of steps at level 0). | Int | 0 | +| | If regrid_int <= 0 then no regridding will occur. | | | ++----------------------+-----------------------------------------------------------------------+-------------+-----------+ + Note, the default for ``max_grid_size`` is 64 for GPU runs. -The domain is decomposed into *grids* by dividing the number of cells by the max grid size +The domain is decomposed into grids by dividing the number of cells by the max grid size for each direction (e.g., ``n_cells[0]/max_grid_size_x``). The blocking factor ensures that the grids will be sufficiently coarsenable for good multigrid performance; therefore, the ``max_grid_size`` must be divisible by the corresponding ``blocking_factor``. @@ -198,7 +198,7 @@ the grids will be sufficiently coarsenable for good multigrid performance; there .. note:: The `AMReX documentation `_ contains a significant - amount of information on grid creation and load balancing. Users are **strongly** encouraged to + amount of information on grid creation and load balancing. Users are strongly encouraged to read the relevant sections. diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 707778cf6ad94724ad9b1e97efea4640d12870a8..80dd9c86a03fff4a84488d49e3a0a7c86a1110de 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -50,8 +50,9 @@ The following inputs are defined using the prefix ``mfix``: | | | | | | | Options: | | | | | | | | -| | * ``MOL``- Predictor-Corrector Method of Lines. MAC velocities and | | | -| | edge states are extrapolated in space. | | | +| | * ``MOL``- Predictor-Corrector Method of Lines. MAC | | | +| | (Marker-and-Cell) velocities and edge states are extrapolated in | | | +| | space. | | | | | | | | | | * ``Godunov`` - Godunov. MAC velocities and edge states are | | | | | extrapolated in space and time using a second-order Taylor series | | | diff --git a/docs/source_docs/user_guide/inputs/multigrid_solvers.rst b/docs/source_docs/user_guide/inputs/multigrid_solvers.rst index 682b6ac65d7ee604276fd4cea85cfd39f435688d..97bb5e5d12c9372ffef68ec25bab7db90ca78820 100644 --- a/docs/source_docs/user_guide/inputs/multigrid_solvers.rst +++ b/docs/source_docs/user_guide/inputs/multigrid_solvers.rst @@ -53,8 +53,8 @@ The following inputs are defined using the prefix ``nodal_proj``: +-------------------------+-----------------------------------------------------------------------+-------------+--------------+ -MAC projection --------------- +MAC (Marker-and-Cell) projection +-------------------------------- The following inputs are defined using the prefix ``mac_proj``: