diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index f327480ee5cee24746fee448a11467e65cc4bd5b..dcaf2dd686ab414fd7d47338abd09f334f2827c8 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -62,7 +62,7 @@ using the prefix ``bc.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc type is ``mi`` or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components [required if bc type is ``mi`` | Reals | 0 0 0 | +| velocity | Velocity components [required if bc type is ``mi`` | Reals<3> | 0 0 0 | | | and ``volflow`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate [required if bc type is ``mi`` | Real | 0 | @@ -157,7 +157,7 @@ please refer to :ref:`ReferenceParticleDistributions | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -272,7 +272,7 @@ angular tolerance. The following inputs are defined using the prefix ``bc.[regio +--------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +====================+=======================================================================+=============+===========+ -| normal | [Optional] Specifies the target face normal direction. Only EB faces | Reals | 0 0 0 | +| normal | [Optional] Specifies the target face normal direction. Only EB faces | Reals<3> | 0 0 0 | | | whose normals are parallel (within the specified tolerance) will have | | | | | the boundary condition applied. | | | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/domain.rst b/docs/source_docs/user_guide/inputs/domain.rst index f49b9c8298db6ca40ec73a23e1610819e075221d..6d3f001255352d1a7f5a0c826adfacaf694bc3cd 100644 --- a/docs/source_docs/user_guide/inputs/domain.rst +++ b/docs/source_docs/user_guide/inputs/domain.rst @@ -16,11 +16,11 @@ 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 | 0 0 0 | +| 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 | 0 0 0 | +| prob_lo | Low corner of physical domain (physical not index space) | Reals<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ -| prob_hi | High corner of physical domain (physical not index space) | Reals | 0 0 0 | +| prob_hi | High corner of physical domain (physical not index space) | Reals<3> | 0 0 0 | +-----------------+-----------------------------------------------------------------------+-------------+-----------+ .. attention:: diff --git a/docs/source_docs/user_guide/inputs/geometry.rst b/docs/source_docs/user_guide/inputs/geometry.rst index 21b38a51646d2ae91c2150b20756d524143e5d69..55818fc7b9fcd435d1c39d71815aa99d7b35508c 100644 --- a/docs/source_docs/user_guide/inputs/geometry.rst +++ b/docs/source_docs/user_guide/inputs/geometry.rst @@ -53,9 +53,9 @@ The following inputs are defined using the prefix ``box``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===================================================================+==========+=====================+ -| Lo | Low corner of the embedded boundary box | Reals | ``prob_lo`` | +| Lo | Low corner of the embedded boundary box | Reals<3> | ``prob_lo`` | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| Hi | High corner of the embedded boundary box | Reals | ``prob_hi`` | +| Hi | High corner of the embedded boundary box | Reals<3> | ``prob_hi`` | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ @@ -164,7 +164,7 @@ The following inputs are defined using the prefix ``cylinder``: | | * ``1`` - Y | | | | | * ``2`` - Z | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0 0 0 | +| center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals<3> | 0 0 0 | | | the center value in the height ``direction`` can be any value. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation | Rotation angle of cylinder, in degrees. | Real | 0. | @@ -305,9 +305,9 @@ The following inputs are defined using the prefix ``csg``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| scaling_factor | Scale the geometry. | Reals | 1 1 1 | +| scaling_factor | Scale the geometry. | Reals<3> | 1 1 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| translation | Translate the geometry. | Reals | 0 0 0 | +| translation | Translate the geometry. | Reals<3> | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ .. note:: @@ -331,7 +331,7 @@ The following inputs are defined using the prefix ``stl``: +------------------------+-------------------------------------------------------------------+----------+---------------------+ | scaling_factor | Scale the geometry. | Real | 1 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -| translation | Translate the geometry. | Reals | 0 0 0 | +| translation | Translate the geometry. | Reals<3> | 0 0 0 | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | use_bvh | Use bounding volume optimization. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 8c85ec2cd0ed8a52b1ba6455b637217a3abf35a5..505bff8f8710f376063e754550a766871d40773d 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -30,7 +30,7 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | density | Fluid density | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ -| velocity | Velocity components | Reals | 0 0 0 | +| velocity | Velocity components | Reals<3> | 0 0 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | pressure | Fluid pressure | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ @@ -84,7 +84,7 @@ please refer to :ref:`ReferenceParticleDistributions | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter | Method to specify particle diameter in the IC region. This is | String | None | | | only used for auto-generated 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 cdd20787804f2b0110903f49febea92d49535878..7e54b0d3375d4f90e35def495df78a416bdfa557 100644 --- a/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +++ b/docs/source_docs/user_guide/inputs/mesh_and_gridding.rst @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``amr``: | max_level | Maximum level of refinement. The default value, 0, means that there | Int | 0 | | | is one cell size covering the entire domain (i.e., single-level). | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| n_cell | Number of cells at level 0 in each coordinate direction. | Ints | 0 0 0 | +| n_cell | Number of cells at level 0 in each coordinate direction. | Ints<3> | 0 0 0 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The level 0 mesh spacing is computed for each direction by dividing the :ref:`domain length` by the @@ -213,7 +213,7 @@ The following inputs are defined using the prefix ``fabarray``: +----------------------+-----------------------------------------------------------------------+----------+-------------+ | | Description | Type | Default | +======================+=======================================================================+==========+=============+ -| mfiter_tile_size | Maximum number of cells in each direction for (logical) tiles. | Ints | 1024000 8 8 | +| mfiter_tile_size | Maximum number of cells in each direction for (logical) tiles. | Ints<3> | 1024000 8 8 | +----------------------+-----------------------------------------------------------------------+----------+-------------+ The following inputs are defined using the prefix ``particles``: @@ -221,7 +221,7 @@ The following inputs are defined using the prefix ``particles``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ -| tile_size | Maximum number of cells in each direction for (logical) tiles | Ints | 1024000 8 8 | +| tile_size | Maximum number of cells in each direction for (logical) tiles | Ints<3> | 1024000 8 8 | | | in the ParticleBoxArray if ``load_balance`` is ``DualGrid`` | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 80dd9c86a03fff4a84488d49e3a0a7c86a1110de..94638dc46beec9dbb2466272099ec993037b07f1 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -7,13 +7,13 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+----------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+============================================================================+==========+=====================+ -| gravity | Gravity vector [required] | Reals | 0 0 0 | +| gravity | Gravity vector [required] | Reals<3> | 0 0 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| advect_density | Enable time evolution of fluid density. | Int | 0 | +| advect_density | Enable time evolution of fluid density. | Int | 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| advect_enthalpy | Enable time evolution of fluid temperature and enthalpy. | Int | 0 | +| advect_enthalpy | Enable time evolution of fluid temperature and enthalpy. | Int | 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| constraint | Select low Mach number constraint. | String | IncompressibleFluid | +| constraint | Select low Mach number constraint. | String | IncompressibleFluid | | | | | | | | Options (case-insensitive): | | | | | | | | diff --git a/docs/source_docs/user_guide/inputs/regions.rst b/docs/source_docs/user_guide/inputs/regions.rst index 4f0e384cb055ae6bdc400a503db7d1bec49d1a5f..07ffb7ad570bee1f4e71878a46396989a4402ab6 100644 --- a/docs/source_docs/user_guide/inputs/regions.rst +++ b/docs/source_docs/user_guide/inputs/regions.rst @@ -30,9 +30,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +==========================+=======================================================================+=============+===========+ -| lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | +| lo | Low corner of physical region (physical, not index space) | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | +| hi | High corner of physical region (physical, not index space) | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ Below is an example for specifying two regions. @@ -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 | 0 0 0 | +| start | Coordinates of the cylinder's bottom cap | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| end | Coordinates of the cylinder's top cap | Reals | 0 0 0 | +| end | Coordinates of the cylinder's top cap | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -77,7 +77,7 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +==========================+=======================================================================+=============+===========+ | radius | Cylinder radius | Real | None | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| center | Coordinates of the sphere's center | Reals | 0 0 0 | +| center | Coordinates of the sphere's center | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -89,9 +89,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +==========================+=======================================================================+=============+===========+ -| lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | +| lo | Low corner of physical region (physical, not index space) | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | +| hi | High corner of physical region (physical, not index space) | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -106,9 +106,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +==========================+=======================================================================+=============+===========+ | radius | Disk radius | Real | None | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| center | Coordinates of the disk's center | Reals | 0 0 0 | +| center | Coordinates of the disk's center | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| normal | Surface normal | Reals | 0 0 0 | +| normal | Surface normal | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -120,5 +120,5 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +==========================+=======================================================================+=============+===========+ -| center | Coordinate of point | Reals | 0 0 0 | +| center | Coordinate of point | Reals<3> | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+