Add reference frame keys to docs

Merge request reports

Loading
+12 −0
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 12 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -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
+34 −0
Changes for docs/source_docs/user_guide/inputs/domain.rst: 34 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -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     |
+--------------------------+----------------------------------------------------------------------------+----------+----------+
+18 −0
Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 18 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -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
~~~~~~~~~~~~~~

Loading