Commit bfb326f6 authored by Jordan Musser's avatar Jordan Musser
Browse files

Add region shape documentaiton (!161)

parent 42647a22

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+4 −1
Original line number Diff line number Diff line
@@ -12,7 +12,10 @@ The following inputs are defined using the prefix ``bc``: 
+---------------------+--------------------------------------------------------------------------+-------------+-----------+

|                     | Description                                                              |   Type      | Default   |

+=====================+==========================================================================+=============+===========+

| regions             | Regions used to define boundary conditions.                              |  Strings    | None      |

| regions             | Regions used to define boundary conditions. Supported shapes for         | Strings     | None      |

|                     | mass inflow, pressure inflow, and pressure outflow include ``plane``     |             |           |

|                     | and ``disk``. Embedded‑boundary regions support ``box``, ``cylinder``,   |             |           |

|                     | and ``sphere`` shapes.                                                   |             |           |

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

| delp_dir            | Direction for specified pressure drop. Note that this direction          |  Int        | 0         |

|                     | should also be periodic.                                                 |             |           |

docs/source_docs/user_guide/inputs/geometry.rst

+0 −51
Original line number Diff line number Diff line
@@ -287,57 +287,6 @@ The ``generic`` geometry option is used to select the user-programed embedded bo 
   the documentation may include a tutorial to better demonstrate this capability.





.. _InputsGeometry_Regions_and_BCs:



Regions and boundary conditions

-------------------------------



Simple geometries can be created by combining planar :ref:`regions<InputsRegions>` and no-slip wall

:ref:`boundary conditions<InputsBoundaryConditions>`. The ``mfix.geometry`` and ``mfix.geometry_file``

inputs should remain undefined when using this method.



In the following example, the domain is periodic in the *x-* and *z-* directions; therefore,

walls only need to cover the low and high *xz* faces. First, ``wall1`` and ``wall2`` are defined

in the ``regions`` section, then they are used to specify two no-slip wall boundary conditions.



.. code-block:: bash

   :caption: Example geometry created using regions and boundary conditions.

   :name: define_geometry_with_regions



   # Define periodicity and domain extents

   # -------------------------------------------------------------

   geometry.coord_sys   = 0

   geometry.is_periodic = 1      0      1

   geometry.prob_lo     = 0.     0.     0.

   geometry.prob_hi     = 0.01   0.01   0.005



   # Define two planar regions

   # -------------------------------------------------------------

   mfix.regions = wall1  wall2



   regions.wall1.lo       = 0.000  1.25e-6  0.000

   regions.wall1.hi       = 0.010  1.25e-6  0.005



   regions.wall2.lo       = 0.000  9.99875e-3  0.000

   regions.wall2.hi       = 0.010  9.99875e-3  0.005



   # Use the regions to define no-slip wall boundaries

   # -------------------------------------------------------------

   bc.regions = wall1  wall2



   bc.wall1 = nsw

   bc.wall1.normal = 0.0  1.0  0.0



   bc.wall2 = nsw

   bc.wall2.normal = 0.0 -1.0  0.0



.. caution::



  It is highly recommended that planar regions not be defined coincident to domain

  boundaries. It is better to specify planes slightly offset from the domain as

  demonstrated in the :ref:`above example<define_geometry_with_regions>`.





.. _InputsGeometry_CSG:



Constructive solid geometry (CSG)

docs/source_docs/user_guide/inputs/initial_conditions.rst

+2 −1
Original line number Diff line number Diff line
@@ -6,7 +6,8 @@ The following inputs are defined using the prefix ``ic``: 
+-----------------------+------------------------------------------------------------------------+-------------+-----------+

|                       | Description                                                            |   Type      | Default   |

+=======================+========================================================================+=============+===========+

| regions               | Regions used to define initial conditions.                             | Strings     | None      |

| regions               | Regions used to define initial conditions. Supported region shapes     | Strings     | None      |

|                       | include a ``box``, ``cylinder``, and ``sphere``.                       |             |           |

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

| allow_regions_overlap | If enabled, particles will be generated/initialized more than once     | Int         | 1         |

|                       | on areas where the IC regions intersect. This only applied to particle |             |           |

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

+2 −1
Original line number Diff line number Diff line
@@ -72,7 +72,8 @@ contain only solids variables in specific regions at fixed timesteps or approxim 
+--------------------------------+-----------------------------------------------------------------+-------------+-----------+

|                                | Description                                                     |   Type      | Default   |

+================================+=================================================================+=============+===========+

| regions                        | Specify regions that will be used for plotfiles.                |  Strings    |           |

| regions                        | Regions used when generating plotfiles. The only supported      | Strings     | None      |

|                                | region shape for plotfile output is ``box``.                    |             |           |

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

| [region_name]                  | Specify which solids phases will be plotted.                    |  Strings    |           |

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

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

+6 −4
Original line number Diff line number Diff line
@@ -55,11 +55,13 @@ that is output every 50 time steps. The ``right-side`` report is a PSD consistin 
   # -------------------------------------------------------------

   mfix.regions = ... left right



   regions.left.lo  = 0.00  0.00  0.00

   regions.left.hi  = 0.05  0.10  0.10

   regions.left.shape = box

   regions.left.box.lo  = 0.00  0.00  0.00

   regions.left.box.hi  = 0.05  0.10  0.10



   regions.right.lo  = 0.05  0.00  0.00

   regions.right.hi  = 0.10  0.10  0.10

   regions.right.shape = box

   regions.right.box.lo  = 0.05  0.00  0.00

   regions.right.box.hi  = 0.10  0.10  0.10



   # Define two particle size distribution reports

   # -------------------------------------------------------------