Commit 9bda253b authored by Charles G Waldman's avatar Charles G Waldman
Browse files

Merge branch 'cgw-mfix-regions' into 'main' 

mfix.regions -> regions

See merge request !167
parents 75f170fc 98c1d549

docs/source_docs/references/size_distributions.rst

+5 −5
Original line number Diff line number Diff line
@@ -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

docs/source_docs/user_guide/inputs/model_options.rst

+1 −1
Original line number Diff line number Diff line
@@ -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                   |

+------------------------+----------------------------------------------------------------------------+----------+---------------------+

docs/source_docs/user_guide/inputs/output/monitors.rst

+1 −1
Original line number Diff line number Diff line
@@ -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``:

docs/source_docs/user_guide/inputs/output/reports.rst

+1 −1
Original line number Diff line number Diff line
@@ -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

docs/source_docs/user_guide/inputs/regions.rst

+3 −3
Original line number Diff line number Diff line
@@ -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