diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 68d1c6600075877826a12dc2363bd6e409bda503..938ac052392f557a044dcb2e3aaa1cb5c66c6ae7 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -35,6 +35,18 @@ The type of the boundary conditions in the BC region must be defined with the pr | | contained EBs | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +For each boundary condition the reference frame is defined using the prefix ``bc.[region_name]``: + ++-----------------------+------------------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++=======================+========================================================================+==========+==========+ +| reference_frame | Specifies the reference frame used to interpret velocity components. | String | inertial | +| | | | | +| | Options: | | | +| | * ``inertial``: A static (laboratory) reference frame. | | | +| | * ``rotating``: Velocity is interpreted relateive to the rotating | | | +| | frame appropriately transformed when applied. | | | ++-----------------------+------------------------------------------------------------------------+----------+----------+ Fluid settings diff --git a/docs/source_docs/user_guide/inputs/domain.rst b/docs/source_docs/user_guide/inputs/domain.rst index 7d0e796d0918460a26ddd76b70c087ff503e5f76..910b7b1f86026b4602a1f2c92d0d621fbec09603 100644 --- a/docs/source_docs/user_guide/inputs/domain.rst +++ b/docs/source_docs/user_guide/inputs/domain.rst @@ -164,3 +164,37 @@ The following inputs are defined using the prefix ``mfix``: +--------------------------+----------------------------------------------------------------------------+----------+---------+ | delp | Pressure drop (Pa) | Real | 0 | +--------------------------+----------------------------------------------------------------------------+----------+---------+ + + +Reference frame +--------------- + +MFIX‑Exa supports simulations in either an inertial (laboratory) reference frame or a uniformly rotating reference frame. The +choice of reference frame affects how momentum equations are solved and whether additional pseudo‑forces (Coriolis and +centrifugal) are included in the fluid and solids momentum balances. + +The following inputs are defined using the prefix ``mfix``: + ++--------------------------+----------------------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++==========================+============================================================================+==========+==========+ +| reference_frame | Specifies the reference frame in which the governing equations are | String | inertial | +| | evaluated. | | | +| | | | | +| | Options: | | | +| | * ``inertial``: A static (laboratory) reference frame. | | | +| | * ``rotating``: A uniformly rotating frame. | | | ++--------------------------+----------------------------------------------------------------------------+----------+----------+ + + +The following inputs are defined using the prefix ``reference_frame``: + ++--------------------------+----------------------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++==========================+============================================================================+==========+==========+ +| axis | The direction of the rotation axis in physical space. | Reals<3> | None | ++--------------------------+----------------------------------------------------------------------------+----------+----------+ +| axis_point | The location through which the rotation axis passes. | Reals<3> | None | ++--------------------------+----------------------------------------------------------------------------+----------+----------+ +| angular_speed | Scalar angular speed of the rotating frame, in radians per second. | Real | None | ++--------------------------+----------------------------------------------------------------------------+----------+----------+ diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index f996a7f70075747e55ef15dec2fb61b71b928f01..5a0d30ded44def31bf271aef67fb103d99e0d6b3 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -17,6 +17,24 @@ The following inputs are defined using the prefix ``ic``: +-----------------------+------------------------------------------------------------------------+-------------+-----------+ +For each initial condition region the reference frame is defined using the prefix ``ic.[region_name]``: + ++-----------------------+------------------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++=======================+========================================================================+==========+==========+ +| reference_frame | Specifies the reference frame used to interpret velocity components | String | inertial | +| | and initialize the flow field within the given initial‑condition | | | +| | region. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``inertial``: A static (laboratory) reference frame. | | | +| | * ``rotating``: Velocity fields specified in the region are | | | +| | interpreted relative to the rotating frame, and internally applies | | | +| | the appropriate transformation. | | | ++-----------------------+------------------------------------------------------------------------+----------+----------+ + + Fluid settings ~~~~~~~~~~~~~~