diff --git a/docs/source_docs/references/size_distributions.rst b/docs/source_docs/references/size_distributions.rst index 649c7b9a1c72dcabba767c9e465a5e8fd1c69cb3..c051ddf44cc260aaf34ce401bb2a33b1b9f83506 100644 --- a/docs/source_docs/references/size_distributions.rst +++ b/docs/source_docs/references/size_distributions.rst @@ -62,7 +62,7 @@ density. The initial condition region volume is 0.001 m\ :sup:`3`, and it has a # Regions for defining ICs and BCs # ----------------------------------------------------------------------- - mfix.regions = full-domain + regions = full-domain regions.full-domain.lo = 0.0 0.0 0.0 regions.full-domain.hi = 0.1 0.1 0.1 @@ -141,7 +141,7 @@ and 1.75 mm, respectively. # Regions for defining ICs and BCs # ----------------------------------------------------------------------- - mfix.regions = full-domain + regions = full-domain regions.full-domain.lo = 0.0 0.0 0.0 regions.full-domain.hi = 0.1 0.1 0.1 @@ -383,7 +383,7 @@ and 3.00 mm, respectively. # Regions for defining ICs and BCs # ----------------------------------------------------------------------- - mfix.regions = full-domain + regions = full-domain regions.full-domain.lo = 0.0 0.0 0.0 regions.full-domain.hi = 0.1 0.1 0.1 @@ -528,7 +528,7 @@ The minimum and maximum particle diameters are 0.25 mm and 1.75 mm, respectively # Regions for defining ICs and BCs # ----------------------------------------------------------------------- - mfix.regions = full-domain + regions = full-domain regions.full-domain.lo = 0.0 0.0 0.0 regions.full-domain.hi = 0.1 0.1 0.1 @@ -740,7 +740,7 @@ distribution is a 50/50 mixture of two particle sizes. # Regions for defining ICs and BCs # ----------------------------------------------------------------------- - mfix.regions = full-domain + regions = full-domain regions.full-domain.lo = 0.0 0.0 0.0 regions.full-domain.hi = 0.1 0.1 0.1 diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index 94638dc46beec9dbb2466272099ec993037b07f1..01c0e89955c0134a759581a9e68d14e1a70a03ad 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -7,7 +7,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+----------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+============================================================================+==========+=====================+ -| gravity | Gravity vector [required] | Reals<3> | 0 0 0 | +| gravity | Gravity vector. | Reals<3> | 0 0 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ | advect_density | Enable time evolution of fluid density. | Int | 0 | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ diff --git a/docs/source_docs/user_guide/inputs/output/monitors.rst b/docs/source_docs/user_guide/inputs/output/monitors.rst index e38fa77e824497360fcd9ad75708dac188b3e4bb..3ebec562105fd609b01fb3df2de6dca82f6700a9 100644 --- a/docs/source_docs/user_guide/inputs/output/monitors.rst +++ b/docs/source_docs/user_guide/inputs/output/monitors.rst @@ -22,7 +22,7 @@ Region selection ---------------- To define a monitor, a region must already be defined in the regions -inputs ``mfix.regions``. A monitor region is a single point, plane, or volume. +inputs ``regions``. A monitor region is a single point, plane, or volume. Multiple regions cannot be combined for a monitor. The following input must be preceded by the prefix ``mfix.monitors``: diff --git a/docs/source_docs/user_guide/inputs/output/reports.rst b/docs/source_docs/user_guide/inputs/output/reports.rst index 0f58bb897cc4b4046087a2281ebc40df93b718c9..f13f86934dbbb0da8a069a4afc050be1db7017d6 100644 --- a/docs/source_docs/user_guide/inputs/output/reports.rst +++ b/docs/source_docs/user_guide/inputs/output/reports.rst @@ -53,7 +53,7 @@ that is output every 50 time steps. The ``right-side`` report is a PSD consistin # Define two regions for collecting report data # ------------------------------------------------------------- - mfix.regions = ... left right + regions = ... left right regions.left.shape = box regions.left.box.lo = 0.00 0.00 0.00 diff --git a/docs/source_docs/user_guide/inputs/regions.rst b/docs/source_docs/user_guide/inputs/regions.rst index 07ffb7ad570bee1f4e71878a46396989a4402ab6..73f981fb35deac905fc5ce453073f73397cc8779 100644 --- a/docs/source_docs/user_guide/inputs/regions.rst +++ b/docs/source_docs/user_guide/inputs/regions.rst @@ -8,7 +8,7 @@ Regions are used to define sections of the domain and are used in defining initi +-----------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=============================+=======================================================================+=============+===========+ -| mfix.regions | Names given to regions. | Strings | None | +| regions | Names given to regions. | Strings | None | +-----------------------------+-----------------------------------------------------------------------+-------------+-----------+ | regions.[region_name].shape | Region shape: | String | None | | | Options: | | | @@ -25,7 +25,7 @@ Regions are used to define sections of the domain and are used in defining initi Box ~~~ -For each region, the inputs are defined using the compound prefix ``regions.[region_name].box``: +For each box region, the inputs are defined using the compound prefix ``regions.[region_name].box``: +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -39,7 +39,7 @@ Below is an example for specifying two regions. .. code-block:: none - mfix.regions = full-domain riser + regions = full-domain riser regions.full-domain.shape = box regions.full-domain.box.lo = 0.0000 0.0000 0.0000