.. _InputsRegions:

Region definitions
==================

Regions are used to define sections of the domain and are used in defining initial and boundary conditions.

+-----------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                             | Description                                                           |   Type      | Default   |
+=============================+=======================================================================+=============+===========+
| regions                     | Names given to regions.                                               | Strings     | None      |
+-----------------------------+-----------------------------------------------------------------------+-------------+-----------+
| regions.[region_name].shape | Region shape:                                                         | String      | None      |
|                             | Options:                                                              |             |           |
|                             |                                                                       |             |           |
|                             | * ``box``                                                             |             |           |
|                             | * ``cylinder``                                                        |             |           |
|                             | * ``sphere``                                                          |             |           |
|                             | * ``plane``                                                           |             |           |
|                             | * ``disk``                                                            |             |           |
|                             | * ``point``                                                           |             |           |
+-----------------------------+-----------------------------------------------------------------------+-------------+-----------+


Box
~~~

For each box region, the inputs are defined using the compound prefix ``regions.[region_name].box``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| hi                       | High corner of physical region (physical, not index space)            |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+

Below is an example for specifying two regions.

.. code-block:: none

   regions  = full-domain   riser

   regions.full-domain.shape = box
   regions.full-domain.box.lo = 0.0000  0.0000  0.0000
   regions.full-domain.box.hi = 3.7584  0.2784  0.2784

   regions.riser.shape = box
   regions.riser.box.lo = 0.0000  0.0000  0.0000
   regions.riser.box.hi = 0.1000  0.2784  0.2784



Cylinder
~~~~~~~~

For each region, the inputs are defined using the compound prefix ``regions.[region_name].cylinder``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| radius                   | cylinder radius                                                       |   Real      | None      |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| start                    | Coordinates of the cylinder's bottom cap                              |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| end                      | Coordinates of the cylinder's top cap                                 |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


Sphere
~~~~~~

For each region, the inputs are defined using the compound prefix ``regions.[region_name].sphere``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| radius                   | Cylinder radius                                                       |   Real      | None      |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| center                   | Coordinates of the sphere's center                                    |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


Plane
~~~~~

For each region, the inputs are defined using the compound prefix ``regions.[region_name].plane``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| hi                       | High corner of physical region (physical, not index space)            |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+



Disk
~~~~

For each region, the inputs are defined using the compound prefix ``regions.[region_name].disk``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| radius                   | Disk radius                                                           |   Real      | None      |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| center                   | Coordinates of the disk's center                                      |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| normal                   | Surface normal                                                        |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


Point
~~~~~

For each region, the inputs are defined using the compound prefix ``regions.[region_name].point``:

+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| center                   | Coordinate of point                                                   |   Reals<3>  | 0 0 0     |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+