Loading docs/source_docs/user_guide/inputs/advanced.rst +4 −7 Original line number Diff line number Diff line Loading @@ -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``: Loading Loading @@ -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: | | | Loading Loading @@ -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``: Loading docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +9 −9 Original line number Diff line number Diff line Loading @@ -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<InputsTable_domain>` 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:: Loading Loading @@ -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. | | | Loading Loading @@ -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``. Loading @@ -198,7 +198,7 @@ the grids will be sufficiently coarsenable for good multigrid performance; there .. note:: The `AMReX documentation <https://amrex-codes.github.io/amrex/docs_html/index.html>`_ 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. Loading docs/source_docs/user_guide/inputs/model_options.rst +3 −2 Original line number Diff line number Diff line Loading @@ -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 | | | Loading docs/source_docs/user_guide/inputs/multigrid_solvers.rst +2 −2 Original line number Diff line number Diff line Loading @@ -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``: Loading Loading
docs/source_docs/user_guide/inputs/advanced.rst +4 −7 Original line number Diff line number Diff line Loading @@ -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``: Loading Loading @@ -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: | | | Loading Loading @@ -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``: Loading
docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +9 −9 Original line number Diff line number Diff line Loading @@ -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<InputsTable_domain>` 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:: Loading Loading @@ -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. | | | Loading Loading @@ -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``. Loading @@ -198,7 +198,7 @@ the grids will be sufficiently coarsenable for good multigrid performance; there .. note:: The `AMReX documentation <https://amrex-codes.github.io/amrex/docs_html/index.html>`_ 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. Loading
docs/source_docs/user_guide/inputs/model_options.rst +3 −2 Original line number Diff line number Diff line Loading @@ -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 | | | Loading
docs/source_docs/user_guide/inputs/multigrid_solvers.rst +2 −2 Original line number Diff line number Diff line Loading @@ -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``: Loading
