Loading docs/source_docs/user_guide/inputs/boundary_conditions.rst +9 −8 Original line number Diff line number Diff line Loading @@ -51,25 +51,26 @@ using the prefix ``bc.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+========================================================================+=============+===========+ | volfrac | Volume fraction [required if bc_region_type='mi'] | Real | 0 | | volfrac | Volume fraction [required if bc type is ``mi``] | Real | 0 | | | | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | density | Fluid density [required if bc_region_type='mi' or 'pi'] | Real | 0 | | density | Fluid density [required if bc type is ``mi`` or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | pressure | Fluid pressure [required if bc_region_type='po' or 'pi'] | Real | 0 | | pressure | Fluid pressure [required if bc type is ``po' or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc_region_type='mi' or 'pi'] | Real | 0 | | temperature | Fluid temperature [required if bc type is ``mi`` or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | | velocity | Velocity components [required if bc type is ``mi`` | Reals | 0 0 0 | | | and ``volflow`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate [required if bc_region_type='mi' | Real | 0 | | volflow | Volumetric flow rate [required if bc type is ``mi`` | Real | 0 | | | and ``velocity`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | massflow | Mass flow rate [required if bc type is ``mi`` | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1 | Real | 0 | | | and `bc_region_type`=`mi` or `pi`]. | | | | | and bc type is ``mi`` or ``pi``] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Loading docs/source_docs/user_guide/inputs/fluid_model.rst +1 −1 Original line number Diff line number Diff line Loading @@ -165,7 +165,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | molecular_weight | Constant fluid molecular weight. | Real | 0 | | | | | | | | A molecular weight should only be defined when using one | | | | | of the *ideal gas* constraints and the species equations | | | | | of the ``IdealGas`` constraints and the species equations | | | | | are not solved. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | specific_heat | Specify which specific heat model to use for the fluid. | String | None | Loading docs/source_docs/user_guide/inputs/geometry.rst +15 −5 Original line number Diff line number Diff line Loading @@ -160,19 +160,29 @@ The following inputs are defined using the prefix ``cylinder``: | | extents. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | direction | Axis the cylinder runs along. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | | | | | | | | Options: | | | | | | | | | | * ``0`` - X | | | | | * ``1`` - Y | | | | | * ``2`` - Z | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0 0 0 | | | the center value in the height ``direction`` can be any value. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation | Rotation angle in degrees of cylinder. | Real | 0. | | rotation | Rotation angle of cylinder, in degrees. | Real | 0. | | | | | | | | * Only cylinders with an undefined ``height`` (i.e., infinitely | | | | | long) can be rotated. | | | | | * Rotation is applied about the ``center`` of the cylinder. | | | | | * Rotation is applied about the center of the cylinder. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation_axe | Axis to rotate the cylinder about. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | | rotation_axis | Axis to rotate the cylinder about. | Int | 0 | | | | | | | | Options: | | | | | | | | | | * ``0`` - X | | | | | * ``1`` - Y | | | | | * ``2`` - Z | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +11 −6 Original line number Diff line number Diff line Loading @@ -20,6 +20,9 @@ The following inputs are defined using the prefix ``ic``: | | * ``Volume`` - sort by volume of each IC region | | | | | * ``Priority`` - sort by specified priority value | | | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ | [region_name].priority| Priority value for IC regions if ``ranking_type` == ``Priority`` | Int | Max | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ Fluid settings Loading @@ -35,11 +38,13 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | density | Fluid density | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name` | Real | 0 | | pressure | Fluid pressure | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of ``species_name`` | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -54,12 +59,14 @@ using the compound prefix ``ic.[region_name]``: +----------------------+------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+==================================================================+=============+===========+ | solids | Name of solid type in IC region -- only one solid is allowed in | String | None | | solids | Name of solid type in IC region. Only one solid is allowed in | String | None | | | an IC region. | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | packing | Specifies how auto-generated particles are placed in the IC | String | None | | | region: | | | | | | | | | | Options: | | | | | | | | | | * ``hcp`` - hex-centered packing | | | | | * ``pseudo_random`` -- random packing using a fixed random seed | | | | | * ``random`` -- random packing (not repeatable) | | | Loading @@ -70,8 +77,6 @@ using the compound prefix ``ic.[region_name]``: | | (NOTE: ``oneper`` is equivalent to ``1-cube`` and ``eightper`` | | | | | to ``2-cube``) | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | priority | Priority value for IC regions ranking as described above | Int | Max | +----------------------+------------------------------------------------------------------+-------------+-----------+ For each initial condition region, the solid inputs are defined using the compound prefix ``ic.[region_name].[solid_name]``: Loading docs/source_docs/user_guide/inputs/model_options.rst +0 −2 Original line number Diff line number Diff line Loading @@ -74,8 +74,6 @@ The following inputs are defined using the prefix ``mfix``: +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_coeff_in_proj_gp | Algebraically consistent p coeff in proj or (default) simplified form.| Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_in_godunov | Include a drag term in the Godunov flux. | Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | godunov_ppm | When using Godunov, use piecewise parabolic (PPM) instead of | Bool | false | | | piecewise linear (PLM) reconstruction. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading Loading
docs/source_docs/user_guide/inputs/boundary_conditions.rst +9 −8 Original line number Diff line number Diff line Loading @@ -51,25 +51,26 @@ using the prefix ``bc.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+========================================================================+=============+===========+ | volfrac | Volume fraction [required if bc_region_type='mi'] | Real | 0 | | volfrac | Volume fraction [required if bc type is ``mi``] | Real | 0 | | | | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | density | Fluid density [required if bc_region_type='mi' or 'pi'] | Real | 0 | | density | Fluid density [required if bc type is ``mi`` or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | pressure | Fluid pressure [required if bc_region_type='po' or 'pi'] | Real | 0 | | pressure | Fluid pressure [required if bc type is ``po' or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc_region_type='mi' or 'pi'] | Real | 0 | | temperature | Fluid temperature [required if bc type is ``mi`` or ``pi``] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | | velocity | Velocity components [required if bc type is ``mi`` | Reals | 0 0 0 | | | and ``volflow`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate [required if bc_region_type='mi' | Real | 0 | | volflow | Volumetric flow rate [required if bc type is ``mi`` | Real | 0 | | | and ``velocity`` or ``massflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | massflow | Mass flow rate [required if bc type is ``mi`` | Real | 0 | | | and ``velocity`` or ``volflow`` not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1 | Real | 0 | | | and `bc_region_type`=`mi` or `pi`]. | | | | | and bc type is ``mi`` or ``pi``] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Loading
docs/source_docs/user_guide/inputs/fluid_model.rst +1 −1 Original line number Diff line number Diff line Loading @@ -165,7 +165,7 @@ a single fluid; therefore, it is common to name the fluid ``fluid``. This is ill | molecular_weight | Constant fluid molecular weight. | Real | 0 | | | | | | | | A molecular weight should only be defined when using one | | | | | of the *ideal gas* constraints and the species equations | | | | | of the ``IdealGas`` constraints and the species equations | | | | | are not solved. | | | +--------------------------------------------+------------------------------------------------------------+--------+----------+ | specific_heat | Specify which specific heat model to use for the fluid. | String | None | Loading
docs/source_docs/user_guide/inputs/geometry.rst +15 −5 Original line number Diff line number Diff line Loading @@ -160,19 +160,29 @@ The following inputs are defined using the prefix ``cylinder``: | | extents. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | direction | Axis the cylinder runs along. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | | | | | | | | Options: | | | | | | | | | | * ``0`` - X | | | | | * ``1`` - Y | | | | | * ``2`` - Z | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | center | Center of cylinder. For a cylinder with an undefined ``height``, | Reals | 0 0 0 | | | the center value in the height ``direction`` can be any value. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation | Rotation angle in degrees of cylinder. | Real | 0. | | rotation | Rotation angle of cylinder, in degrees. | Real | 0. | | | | | | | | * Only cylinders with an undefined ``height`` (i.e., infinitely | | | | | long) can be rotated. | | | | | * Rotation is applied about the ``center`` of the cylinder. | | | | | * Rotation is applied about the center of the cylinder. | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | rotation_axe | Axis to rotate the cylinder about. | Int | 0 | | | (``0``: *X*, ``1``: *Y*, ``2``: *Z*) | | | | rotation_axis | Axis to rotate the cylinder about. | Int | 0 | | | | | | | | Options: | | | | | | | | | | * ``0`` - X | | | | | * ``1`` - Y | | | | | * ``2`` - Z | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ | internal_flow | Indicates that flow is *inside* the box. | Bool | true | +------------------------+-------------------------------------------------------------------+----------+---------------------+ Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +11 −6 Original line number Diff line number Diff line Loading @@ -20,6 +20,9 @@ The following inputs are defined using the prefix ``ic``: | | * ``Volume`` - sort by volume of each IC region | | | | | * ``Priority`` - sort by specified priority value | | | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ | [region_name].priority| Priority value for IC regions if ``ranking_type` == ``Priority`` | Int | Max | +-----------------------+------------------------------------------------------------------------+-------------+-----------+ Fluid settings Loading @@ -35,11 +38,13 @@ using the compound prefix ``ic.[region_name].[fluid_name]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | density | Fluid density | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components | Reals | 0 0 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name` | Real | 0 | | pressure | Fluid pressure | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of ``species_name`` | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Loading @@ -54,12 +59,14 @@ using the compound prefix ``ic.[region_name]``: +----------------------+------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+==================================================================+=============+===========+ | solids | Name of solid type in IC region -- only one solid is allowed in | String | None | | solids | Name of solid type in IC region. Only one solid is allowed in | String | None | | | an IC region. | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | packing | Specifies how auto-generated particles are placed in the IC | String | None | | | region: | | | | | | | | | | Options: | | | | | | | | | | * ``hcp`` - hex-centered packing | | | | | * ``pseudo_random`` -- random packing using a fixed random seed | | | | | * ``random`` -- random packing (not repeatable) | | | Loading @@ -70,8 +77,6 @@ using the compound prefix ``ic.[region_name]``: | | (NOTE: ``oneper`` is equivalent to ``1-cube`` and ``eightper`` | | | | | to ``2-cube``) | | | +----------------------+------------------------------------------------------------------+-------------+-----------+ | priority | Priority value for IC regions ranking as described above | Int | Max | +----------------------+------------------------------------------------------------------+-------------+-----------+ For each initial condition region, the solid inputs are defined using the compound prefix ``ic.[region_name].[solid_name]``: Loading
docs/source_docs/user_guide/inputs/model_options.rst +0 −2 Original line number Diff line number Diff line Loading @@ -74,8 +74,6 @@ The following inputs are defined using the prefix ``mfix``: +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_coeff_in_proj_gp | Algebraically consistent p coeff in proj or (default) simplified form.| Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_in_godunov | Include a drag term in the Godunov flux. | Bool | false | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | godunov_ppm | When using Godunov, use piecewise parabolic (PPM) instead of | Bool | false | | | piecewise linear (PLM) reconstruction. | | | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ Loading
