Merge branch 'cgw-array-size' into 'main' (5695573c) · Commits · Janine Carney / docs

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+3 −3

Original line number	Diff line number	Diff line
		@@ -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 <ReferenceParticleDistribut
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Mass fraction of ``species_name`` \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| velocity \| Velocity components \| Reals \| 0 0 0 \|
		\| velocity \| Velocity components \| Reals<3> \| 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. \| \| \|
		+--------------------+-----------------------------------------------------------------------+-------------+-----------+

docs/source_docs/user_guide/inputs/domain.rst

+3 −3

Original line number	Diff line number	Diff line
		@@ -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::

docs/source_docs/user_guide/inputs/geometry.rst

+6 −6

Original line number	Diff line number	Diff line
		@@ -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 \|
		+------------------------+-------------------------------------------------------------------+----------+---------------------+

docs/source_docs/user_guide/inputs/initial_conditions.rst

+2 −2

Original line number	Diff line number	Diff line
		@@ -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 <ReferenceParticleDistribut
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Mass fraction of `species_name`. Must be a solid species. \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| velocity \| Velocity components \| Reals \| 0 0 0 \|
		\| velocity \| Velocity components \| Reals<3> \| 0 0 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| diameter \| Method to specify particle diameter in the IC region. This is \| String \| None \|
		\| \| only used for auto-generated particles. \| \| \|

docs/source_docs/user_guide/inputs/mesh_and_gridding.rst

+3 −3

Original line number	Diff line number	Diff line
		@@ -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<InputsTable_domain>` 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`` \| \| \|
		+----------------------+-----------------------------------------------------------------------+-------------+--------------+