diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index 322adba17c14c10814199ef695372a8e0c7c1dca..f327480ee5cee24746fee448a11467e65cc4bd5b 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -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. | | | diff --git a/docs/source_docs/user_guide/inputs/geometry.rst b/docs/source_docs/user_guide/inputs/geometry.rst index 63582d8bf0fd2ac8f43be27fbbdf461a29c1766f..21b38a51646d2ae91c2150b20756d524143e5d69 100644 --- a/docs/source_docs/user_guide/inputs/geometry.rst +++ b/docs/source_docs/user_guide/inputs/geometry.rst @@ -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` and no-slip wall -:ref:`boundary conditions`. 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`. - - .. _InputsGeometry_CSG: Constructive solid geometry (CSG) diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index b9273d87fec39962a008fec87cc535394452d0bf..8c85ec2cd0ed8a52b1ba6455b637217a3abf35a5 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -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 | | | diff --git a/docs/source_docs/user_guide/inputs/output/plotting.rst b/docs/source_docs/user_guide/inputs/output/plotting.rst index 60216b94a6a691f004f98442caa6bfdfb1e33016..c23f8cee24f58d9230694066f659cca67824f0f2 100644 --- a/docs/source_docs/user_guide/inputs/output/plotting.rst +++ b/docs/source_docs/user_guide/inputs/output/plotting.rst @@ -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 | | +--------------------------------+-----------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/output/reports.rst b/docs/source_docs/user_guide/inputs/output/reports.rst index f69bc6388a50b3b9c1b05050972f1043f8d02341..0f58bb897cc4b4046087a2281ebc40df93b718c9 100644 --- a/docs/source_docs/user_guide/inputs/output/reports.rst +++ b/docs/source_docs/user_guide/inputs/output/reports.rst @@ -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 # ------------------------------------------------------------- diff --git a/docs/source_docs/user_guide/inputs/porous_media.rst b/docs/source_docs/user_guide/inputs/porous_media.rst index 6ab3c1f6c0b59ee4c546c15a10043d7f76d1dad6..41a19357bd8f5453375cc99f315e9ffbc63c3b54 100644 --- a/docs/source_docs/user_guide/inputs/porous_media.rst +++ b/docs/source_docs/user_guide/inputs/porous_media.rst @@ -18,7 +18,8 @@ The following inputs are defined using the prefix ``pm``: +-------------------------------+------------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +===============================+==============================================================================+==========+===========+ -| regions | Regions used to define porous media. | Strings | None | +| regions | Regions used to define porous media. Supported region shapes include | Strings | None | +| | ``box``, ``cylinder``, and ``sphere``. | | | +-------------------------------+------------------------------------------------------------------------------+----------+-----------+ | [region_name].volfrac | Solids volume fraction of the porous media region. | Real | None | +-------------------------------+------------------------------------------------------------------------------+----------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/regions.rst b/docs/source_docs/user_guide/inputs/regions.rst index 5b5cfef1b42372c901c32f8f0aa4f8b31f779f5b..4f0e384cb055ae6bdc400a503db7d1bec49d1a5f 100644 --- a/docs/source_docs/user_guide/inputs/regions.rst +++ b/docs/source_docs/user_guide/inputs/regions.rst @@ -3,16 +3,36 @@ Region definitions ================== -Regions are used to define sections of the domain. They may be either boxes, planes or points. They are used in defining initial and boundary conditions. +Regions are used to define sections of the domain and are used in defining initial and boundary conditions. + ++-----------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++=============================+=======================================================================+=============+===========+ +| mfix.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 region, the inputs are defined using the compound prefix ``regions.[region_name].box``: +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +==========================+=======================================================================+=============+===========+ -| mfix.regions | Names given to regions. | Strings | None | +| lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| regions.[region_name].lo | Low corner of physical region (physical, not index space) | Reals | 0 0 0 | -+--------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| regions.[region_name].hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | +| hi | High corner of physical region (physical, not index space) | Reals | 0 0 0 | +--------------------------+-----------------------------------------------------------------------+-------------+-----------+ Below is an example for specifying two regions. @@ -21,8 +41,84 @@ Below is an example for specifying two regions. mfix.regions = full-domain riser - regions.full-domain.lo = 0.0000 0.0000 0.0000 - regions.full-domain.hi = 3.7584 0.2784 0.2784 + 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 | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| end | Coordinates of the cylinder's top cap | Reals | 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 | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ + - regions.riser.lo = 0.0000 0.0000 0.0000 - regions.riser.hi = 0.1000 0.2784 0.2784 +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 | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| hi | High corner of physical region (physical, not index space) | Reals | 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 | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| normal | Surface normal | Reals | 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 | 0 0 0 | ++--------------------------+-----------------------------------------------------------------------+-------------+-----------+