Loading docs/source_docs/references/units.rst +24 −22 Original line number Diff line number Diff line Loading @@ -6,46 +6,48 @@ set up accordingly. In the following table we provide a list of some of the physical quantities we can specify in the input file and their correspondent units. +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | Physical quantity | MFIX-Exa SI unit | +============================+=========================================+ +================================+=========================================+ | amount of substance | mole [:math:`mol`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | length | meter [:math:`m`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | mass | kilogram [:math:`kg`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | time | second [:math:`s`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | force | Newton [:math:`N`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | temperature | Kelvin [:math:`K`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | pressure | Pascal [:math:`Pa`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | energy | Joule [:math:`J`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | power | Watt [:math:`W`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | density | [:math:`kg \cdot m^{-3}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | velocity | [:math:`m \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | dynamic viscosity | [:math:`Pa \cdot s`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | diffusivity | [:math:`m^2 \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | specific heat capacity | [:math:`J \cdot kg^{-1} \cdot K^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | thermal conductivity | [:math:`W \cdot m^{-1} \cdot K^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | spring coefficient | [:math:`N \cdot m^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | molecular weight | [:math:`kg \cdot mol^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | heat of formation | [:math:`J \cdot kg^{-1}`] | +----------------------------+-----------------------------------------+ | chemical reaction rate | [:math:`mol \cdot m^{-3} \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | reaction rate (Euler-Euler) | [:math:`mol \cdot m^{-3} \cdot s^{-1}`] | +--------------------------------+-----------------------------------------+ | reaction rate (Euler-Lagrange) | [:math:`mol \cdot s^{-1}`] | +--------------------------------+-----------------------------------------+ docs/source_docs/user_guide/inputs/boundary_conditions.rst +22 −3 Original line number Diff line number Diff line Loading @@ -50,7 +50,14 @@ using the prefix ``bc.[region].[fluid]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc_region_type='mi' or 'pi'] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components [required if bc_region_type='mi'] | Reals | 0 0 0 | | velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | | | and volflow or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or volflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading @@ -61,6 +68,10 @@ using the prefix ``bc.[region].[fluid]``: | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Additionally, velocity can be specified as a vector or a scalar, the latter of which is applied normal to the inflow plane, as with volflow and massflow. Below is an example for specifying boundary conditions for fluid (``fluid``). .. code-block:: none Loading Loading @@ -151,15 +162,21 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | fluid.velocity | (Required if not `volflow`) Inflow fluid velocity on EB faces | Reals | 0 0 0 | | fluid.velocity | (Required if not `volflow` or `massflow`) | | | | | Inflow fluid velocity on EB faces | Reals | 0 0 0 | | | contained in the (tridimensional) region. | | | | | Note that if only one value is specified, that is assumed to | | | | | be the magnitude in the direction of the EB face's normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volflow | (Required if not `velocity`) Inflow BC for fluid volumetric flow | Real | 0 | | fluid.volflow | (Required if not `velocity` or `massflow`) | | | | | Inflow BC for fluid volumetric flow | Real | 0 | | | rate in the (tridimensional) region. The flow is assumed to be | | | | | normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.massflow | (Required if not `velocity` or `volflow`) | | | | | Inflow BC for fluid mass flow rate in the (tridimensional) region. | Real | 0 | | | The flow is assumed to be normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volfrac | (Required) Volume fraction. | Real | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | (Optional) When specified, only cells with EB face normal that is | Reals | 0 0 0 | Loading @@ -170,6 +187,8 @@ provided when appropriate. | | tolerance (in degrees) for choosing cells with a specific normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Note that only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Below is an example for specifying a normal inflow velocity magnitude for a region `eb-flow`. .. code-block:: none Loading Loading
docs/source_docs/references/units.rst +24 −22 Original line number Diff line number Diff line Loading @@ -6,46 +6,48 @@ set up accordingly. In the following table we provide a list of some of the physical quantities we can specify in the input file and their correspondent units. +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | Physical quantity | MFIX-Exa SI unit | +============================+=========================================+ +================================+=========================================+ | amount of substance | mole [:math:`mol`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | length | meter [:math:`m`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | mass | kilogram [:math:`kg`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | time | second [:math:`s`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | force | Newton [:math:`N`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | temperature | Kelvin [:math:`K`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | pressure | Pascal [:math:`Pa`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | energy | Joule [:math:`J`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | power | Watt [:math:`W`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | density | [:math:`kg \cdot m^{-3}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | velocity | [:math:`m \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | dynamic viscosity | [:math:`Pa \cdot s`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | diffusivity | [:math:`m^2 \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | specific heat capacity | [:math:`J \cdot kg^{-1} \cdot K^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | thermal conductivity | [:math:`W \cdot m^{-1} \cdot K^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | spring coefficient | [:math:`N \cdot m^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | molecular weight | [:math:`kg \cdot mol^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | heat of formation | [:math:`J \cdot kg^{-1}`] | +----------------------------+-----------------------------------------+ | chemical reaction rate | [:math:`mol \cdot m^{-3} \cdot s^{-1}`] | +----------------------------+-----------------------------------------+ +--------------------------------+-----------------------------------------+ | reaction rate (Euler-Euler) | [:math:`mol \cdot m^{-3} \cdot s^{-1}`] | +--------------------------------+-----------------------------------------+ | reaction rate (Euler-Lagrange) | [:math:`mol \cdot s^{-1}`] | +--------------------------------+-----------------------------------------+
docs/source_docs/user_guide/inputs/boundary_conditions.rst +22 −3 Original line number Diff line number Diff line Loading @@ -50,7 +50,14 @@ using the prefix ``bc.[region].[fluid]``: +------------------------+------------------------------------------------------------------------+-------------+-----------+ | temperature | Fluid temperature [required if bc_region_type='mi' or 'pi'] | Real | 0 | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | velocity | Velocity components [required if bc_region_type='mi'] | Reals | 0 0 0 | | velocity | Velocity components [required if bc_region_type='mi' | Reals | 0 0 0 | | | and volflow or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | volflow | Volumetric flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or massflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate [required if bc_region_type='mi' | Real | 0 | | | and velocity or volflow not specified] | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading @@ -61,6 +68,10 @@ using the prefix ``bc.[region].[fluid]``: | | and bc_region_type='mi' or 'pi']. | | | +------------------------+------------------------------------------------------------------------+-------------+-----------+ Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Additionally, velocity can be specified as a vector or a scalar, the latter of which is applied normal to the inflow plane, as with volflow and massflow. Below is an example for specifying boundary conditions for fluid (``fluid``). .. code-block:: none Loading Loading @@ -151,15 +162,21 @@ provided when appropriate. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | fluid.velocity | (Required if not `volflow`) Inflow fluid velocity on EB faces | Reals | 0 0 0 | | fluid.velocity | (Required if not `volflow` or `massflow`) | | | | | Inflow fluid velocity on EB faces | Reals | 0 0 0 | | | contained in the (tridimensional) region. | | | | | Note that if only one value is specified, that is assumed to | | | | | be the magnitude in the direction of the EB face's normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volflow | (Required if not `velocity`) Inflow BC for fluid volumetric flow | Real | 0 | | fluid.volflow | (Required if not `velocity` or `massflow`) | | | | | Inflow BC for fluid volumetric flow | Real | 0 | | | rate in the (tridimensional) region. The flow is assumed to be | | | | | normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.massflow | (Required if not `velocity` or `volflow`) | | | | | Inflow BC for fluid mass flow rate in the (tridimensional) region. | Real | 0 | | | The flow is assumed to be normal to the EB surface in the region. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | fluid.volfrac | (Required) Volume fraction. | Real | 0 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | eb.normal | (Optional) When specified, only cells with EB face normal that is | Reals | 0 0 0 | Loading @@ -170,6 +187,8 @@ provided when appropriate. | | tolerance (in degrees) for choosing cells with a specific normal. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Note that only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified. Below is an example for specifying a normal inflow velocity magnitude for a region `eb-flow`. .. code-block:: none Loading
