Loading docs/source_docs/user_guide/inputs/domain.rst +45 −7 Changes for docs/source_docs/user_guide/inputs/domain.rst: 45 added lines, 7 removed lines. Original line number Diff line number Diff line Loading @@ -16,8 +16,6 @@ The following inputs are defined using the prefix ``geometry``: | coord_sys | Coordinate system used in simulation. Only Cartesian coordinates | Int | 0 | | | (``coord_sys = 0``) are supported. | | | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_lo | Low corner of physical domain (physical not index space) | Reals<3> | None | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_hi | High corner of physical domain (physical not index space) | Reals<3> | None | Loading Loading @@ -52,9 +50,9 @@ number of cells. The mesh spacing is required to be the same in all directions: .. math:: \frac{\text{prob\_hi[0] - prob\_lo[0]}}{\text{n\_cell[0]}} = \frac{\text{prob\_hi[1] - prob\_lo[1]}}{\text{n\_cell[1]}} = \frac{\text{prob\_hi[2] - prob\_lo[2]}}{\text{n\_cell[2]}} \frac{\mathtt{prob\_hi[0]} - \mathtt{prob\_lo[0]}}{\mathtt{n\_cell[0]}} = \frac{\mathtt{prob\_hi[1]} - \mathtt{prob\_lo[1]}}{\mathtt{n\_cell[1]}} = \frac{\mathtt{prob\_hi[2]} - \mathtt{prob\_lo[2]}}{\mathtt{n\_cell[2]}} The inputs for defining the mesh for a single-level simulation are demonstrated in the Loading @@ -66,13 +64,13 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction .. _inputs_mesh_ex: .. code-block:: bash :caption: Snippet of inptus for mesh example. This is not a complete input file. :caption: Snippet of inputs for mesh example. This is not a complete input file. # Define periodicity and domain extents # ------------------------------------------------------------- geometry.coord_sys = 0 # Cartesian coordinates geometry.is_periodic = 0 0 0 # periodicity for each direction geometry.prob_lo = 0. 0. 0 # lo corner of physical domain. geometry.prob_lo = 0. 0. 0. # lo corner of physical domain. geometry.prob_hi = 4. 1. 1. # hi corner of physical domain # Define the maximum level of refinement and number of cells Loading @@ -93,6 +91,46 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction MFIX-Exa simulations with a non-uniform mesh will not run. Grid settings ------------- The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | max_grid_size_x | Maximum number of cells in each grid in *X*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells in each grid in *Y*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells in each grid in *Z*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Periodic domains ---------------- The following inputs are defined using the prefix ``geometry``: +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=================+=======================================================================+=============+===========+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Pressure drop ------------- Loading docs/source_docs/user_guide/inputs/gridding.rst +4 −26 Changes for docs/source_docs/user_guide/inputs/gridding.rst: 4 added lines, 26 removed lines. Original line number Diff line number Diff line .. sec:InputsMeshAndGridding: Grids and tiles =============== Grids, tiles, and tagging ========================= Grids ----- The following inputs are defined using the prefix ``amr``: Grid layout ----------- +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | max_grid_size_x | Maximum number of cells in each grid in *X*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells in each grid in *Y*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells in each grid in *Z*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z``.Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | refine_grid_layout_x | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the x axis, ensuring at least one grid per MPI process, provided this | | | Loading docs/source_docs/user_guide/inputs/regions.rst +2 −2 Changes for docs/source_docs/user_guide/inputs/regions.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -61,9 +61,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +==========================+=======================================================================+=============+===========+ | radius | cylinder radius | Real | None | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | start | Coordinates of the cylinder's bottom cap | Reals<3> | | | start | Coordinates of the center of the cylinder's bottom cap | Reals<3> | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | end | Coordinates of the cylinder's top cap | Reals<3> | | | end | Coordinates of the center of the cylinder's top cap | Reals<3> | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/run-time_inputs.rst +1 −1 Changes for docs/source_docs/user_guide/run-time_inputs.rst: 1 added line, 1 removed line. Original line number Diff line number Diff line Loading @@ -41,11 +41,11 @@ keywords such as ``mfix``, ``amr``, ``geometry``, ``nodal_proj`` etc. inputs/domain inputs/geometry inputs/regions inputs/model_options inputs/species inputs/fluid_model inputs/solids_model inputs/regions inputs/initial_conditions inputs/boundary_conditions inputs/chemical_reactions Loading Loading
docs/source_docs/user_guide/inputs/domain.rst +45 −7 Changes for docs/source_docs/user_guide/inputs/domain.rst: 45 added lines, 7 removed lines. Original line number Diff line number Diff line Loading @@ -16,8 +16,6 @@ The following inputs are defined using the prefix ``geometry``: | coord_sys | Coordinate system used in simulation. Only Cartesian coordinates | Int | 0 | | | (``coord_sys = 0``) are supported. | | | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_lo | Low corner of physical domain (physical not index space) | Reals<3> | None | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | prob_hi | High corner of physical domain (physical not index space) | Reals<3> | None | Loading Loading @@ -52,9 +50,9 @@ number of cells. The mesh spacing is required to be the same in all directions: .. math:: \frac{\text{prob\_hi[0] - prob\_lo[0]}}{\text{n\_cell[0]}} = \frac{\text{prob\_hi[1] - prob\_lo[1]}}{\text{n\_cell[1]}} = \frac{\text{prob\_hi[2] - prob\_lo[2]}}{\text{n\_cell[2]}} \frac{\mathtt{prob\_hi[0]} - \mathtt{prob\_lo[0]}}{\mathtt{n\_cell[0]}} = \frac{\mathtt{prob\_hi[1]} - \mathtt{prob\_lo[1]}}{\mathtt{n\_cell[1]}} = \frac{\mathtt{prob\_hi[2]} - \mathtt{prob\_lo[2]}}{\mathtt{n\_cell[2]}} The inputs for defining the mesh for a single-level simulation are demonstrated in the Loading @@ -66,13 +64,13 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction .. _inputs_mesh_ex: .. code-block:: bash :caption: Snippet of inptus for mesh example. This is not a complete input file. :caption: Snippet of inputs for mesh example. This is not a complete input file. # Define periodicity and domain extents # ------------------------------------------------------------- geometry.coord_sys = 0 # Cartesian coordinates geometry.is_periodic = 0 0 0 # periodicity for each direction geometry.prob_lo = 0. 0. 0 # lo corner of physical domain. geometry.prob_lo = 0. 0. 0. # lo corner of physical domain. geometry.prob_hi = 4. 1. 1. # hi corner of physical domain # Define the maximum level of refinement and number of cells Loading @@ -93,6 +91,46 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction MFIX-Exa simulations with a non-uniform mesh will not run. Grid settings ------------- The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | max_grid_size_x | Maximum number of cells in each grid in *X*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells in each grid in *Y*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells in each grid in *Z*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Periodic domains ---------------- The following inputs are defined using the prefix ``geometry``: +-----------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=================+=======================================================================+=============+===========+ | is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Pressure drop ------------- Loading
docs/source_docs/user_guide/inputs/gridding.rst +4 −26 Changes for docs/source_docs/user_guide/inputs/gridding.rst: 4 added lines, 26 removed lines. Original line number Diff line number Diff line .. sec:InputsMeshAndGridding: Grids and tiles =============== Grids, tiles, and tagging ========================= Grids ----- The following inputs are defined using the prefix ``amr``: Grid layout ----------- +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | max_grid_size_x | Maximum number of cells in each grid in *X*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells in each grid in *Y*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells in each grid in *Z*. Can be specified | Ints | 32 | | | per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y``. Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z``.Can be | Ints | 8 | | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | refine_grid_layout_x | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the x axis, ensuring at least one grid per MPI process, provided this | | | Loading
docs/source_docs/user_guide/inputs/regions.rst +2 −2 Changes for docs/source_docs/user_guide/inputs/regions.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -61,9 +61,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +==========================+=======================================================================+=============+===========+ | radius | cylinder radius | Real | None | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | start | Coordinates of the cylinder's bottom cap | Reals<3> | | | start | Coordinates of the center of the cylinder's bottom cap | Reals<3> | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | end | Coordinates of the cylinder's top cap | Reals<3> | | | end | Coordinates of the center of the cylinder's top cap | Reals<3> | | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/run-time_inputs.rst +1 −1 Changes for docs/source_docs/user_guide/run-time_inputs.rst: 1 added line, 1 removed line. Original line number Diff line number Diff line Loading @@ -41,11 +41,11 @@ keywords such as ``mfix``, ``amr``, ``geometry``, ``nodal_proj`` etc. inputs/domain inputs/geometry inputs/regions inputs/model_options inputs/species inputs/fluid_model inputs/solids_model inputs/regions inputs/initial_conditions inputs/boundary_conditions inputs/chemical_reactions Loading
