From c601f181d046ee4ad9b617eaad6a9fa3f6a26324 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Mon, 18 Mar 2024 10:04:21 -0400 Subject: [PATCH] Add STL inputs to user-guide --- .../user_guide/inputs/geometry.rst | 80 ++++++++++++++----- 1 file changed, 62 insertions(+), 18 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/geometry.rst b/docs/source_docs/user_guide/inputs/geometry.rst index 1f9b21e..bdb485d 100644 --- a/docs/source_docs/user_guide/inputs/geometry.rst +++ b/docs/source_docs/user_guide/inputs/geometry.rst @@ -5,19 +5,25 @@ Specifying a geometry The following inputs are defined using the ``mfix`` prefix. -+------------------------+-------------------------------------------------------------------+----------+---------------------+ -| | Description | Type | Default | -+========================+===================================================================+==========+=====================+ -| geometry | Select a basic ``box`` or ``cylinder`` predefined EB geometry, or | String | '' | -| | the user-programed ``generic`` geometry. Details about these | | | -| | geometry options and associated additional inputs are provided | | | -| | in the following sections. | | | -+------------------------+-------------------------------------------------------------------+----------+---------------------+ -| geometry_filename | The CSG file that defines the EB geometry | String | '' | -+------------------------+-------------------------------------------------------------------+----------+---------------------+ -| levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | -| | resolution | | | -+------------------------+-------------------------------------------------------------------+----------+---------------------+ ++------------------------+-------------------------------------------------------------------------------+----------+---------------------+ +| | Description | Type | Default | ++========================+===============================================================================+==========+=====================+ +| geometry | Specify the simulation geometry. | String | '' | +| | | | | +| | * ``box`` - predefined :ref:`box geometry` | | | +| | * ``cylinder`` - predefined :ref:`cylinder geometry` | | | +| | * ``generic`` - :ref:`user-defined geometry` | | | +| | * ``csg`` - use :ref:`Constructive Solid Geometry` file | | | +| | * ``stl`` - use :ref:`Standard Triangle Language` file | | | +| | | | | +| | If left undefined, then the system should be fully periodic, or | | | +| | :ref:`planar regions` should be used to | | | +| | enclose the domain. | | | +| | | | | ++------------------------+-------------------------------------------------------------------------------+----------+---------------------+ +| levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | +| | resolution | | | ++------------------------+-------------------------------------------------------------------------------+----------+---------------------+ Most simulations require a user to specify some kind of geometry. For example, the geometry could be a basic cylinder used to model flow inside a pipe, or it may be an irregularly shaped solid to study external flow around a bluff body, or the geometry @@ -39,6 +45,7 @@ Predefined geometries The ``mfix.geometry`` input is used to choose one of the basic predefined geometries, or to select the option to use a user-defined geometry constructed from native AMReX implicit functions. +.. _InputsGeometry_box: ``box`` geometry ^^^^^^^^^^^^^^^^ @@ -135,6 +142,7 @@ the EB ``box`` are *covered* and thereby excluded from run-time calculations. ---- +.. _InputsGeometry_cylinder: ``cylinder`` geometry ^^^^^^^^^^^^^^^^^^^^^ @@ -254,6 +262,7 @@ the EB ``cylinder`` are *covered* and thereby excluded from calculations. ---- +.. _InputsGeometry_generic: ``generic`` geometry ^^^^^^^^^^^^^^^^^^^^ @@ -323,16 +332,51 @@ in the ``regions`` section, then they are used to specify two no-slip wall bound .. _InputsGeometry_CSG: -Constructive solid geometry ---------------------------- - -Use the ``mfix.geometry_filename`` input to select a *constructive solid geometry (CSG)* that defines -the system geometry. +Constructive solid geometry (CSG) +--------------------------------- * A constructive solid geometry can be created using OpenSCAD. * This option requires that the executable be built with CSG support. See the build documentation for for details. +The following inputs are defined using the ``csg`` prefix. + ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| | Description | Type | Default | ++========================+===================================================================+==========+=====================+ +| geometry_filename | The CSG file that defines the EB geometry | String | '' | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| internal_flow | Flag to indicate that flow is *inside* the box. | Bool | true | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| scaling_factor | scale the geometry | Reals | 1. 1. 1. | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| translation | translate the geometry | Reals | 0. 0. 0. | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ + +.. note:: + A full description of this feature is beyond the scope of this section. A future update to + the documentation may include a tutorial to better demonstrate this feature. + + +.. _InputsGeometry_STL: + +Standard triangle language (STL) +-------------------------------- + +* A standard triangle language (STL) geometry can be created using numerous CAD programs. + +The following inputs are defined using the ``stl`` prefix. + ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| | Description | Type | Default | ++========================+===================================================================+==========+=====================+ +| geometry_filename | The STL file that defines the EB geometry | String | '' | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| scaling_factor | scale the geometry | Real | 1. | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ +| translation | translate the geometry | Reals | 0. 0. 0. | ++------------------------+-------------------------------------------------------------------+----------+---------------------+ + .. note:: A full description of this feature is beyond the scope of this section. A future update to the documentation may include a tutorial to better demonstrate this feature. -- GitLab