Commit 369049ee authored by Charles G Waldman's avatar Charles G Waldman
Browse files

update doc (!198)

parent dd5b6e24
Loading
Loading
Loading
Loading
+3 −5
Changes for docs/source_docs/references/hpc/Joule3.rst: 3 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -142,9 +142,9 @@ cmake
         export CSG_DIR=$CSG_INSTALL_DIR
         export CMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH:$CSG_DIR

         export Boost_INCLUDE_DIR="-I/nfs/apps/Libraries/Boost/1.83.0/gnu/13.2.0/openmpi/4.1.5/include/"
         export BOOST_ROOT="/nfs/apps/Libraries/Boost/1.83.0/gnu/13.2.0/openmpi/4.1.5/"

         mkdir build; cd build
         mkdir -p build; cd build

         cmake -DCMAKE_C_COMPILER=gcc \
               -DCMAKE_CXX_COMPILER=g++ \
@@ -179,12 +179,10 @@ cmake
         export CSG_DIR=$CSG_INSTALL_DIR
         export CMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH:$CSG_DIR

         module load boost/1.77.0_gnu9.3
         export BOOST_ROOT="/nfs/apps/Libraries/Boost/1.83.0/gnu/13.2.0/openmpi/4.1.5"

         cmake -DCMAKE_C_COMPILER=gcc \
               -DCMAKE_CXX_COMPILER=g++ \
               -DBoost_INCLUDE_DIR="$BOOST_ROOT/include" \
               -DMFIX_MPI=yes \
               -DMFIX_OMP=no \
               -DMFIX_CSG=yes \
@@ -414,7 +412,7 @@ prior to following any of the full build instructions above.

            module load boost/1.77.0_gnu9.3

            export Boost_INCLUDE_DIR="-I/nfs/apps/Libraries/Boost/1.83.0/gnu/13.2.0/openmpi/4.1.5/include"
            export Boost_INCLUDE_DIR="/nfs/apps/Libraries/Boost/1.83.0/gnu/13.2.0/openmpi/4.1.5/include"
            export CSG_DIR=$CSG_INSTALL_DIR
            export CMAKE_PREFIX_PATH=$CMAKE_PREFIX_PATH:$CSG_DIR

+5 −0
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 5 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -19,6 +19,11 @@ The following inputs are defined using the prefix ``bc``:
+---------------------+--------------------------------------------------------------------------+-------------+-----------+
| delp_dir            | Direction for specified pressure drop. Note that this direction          |  Int        | 0         |
|                     | should also be periodic.                                                 |             |           |
|                     |                                                                          |             |           |
|                     | Options:                                                                 |             |           |
|                     |  * ``0``: X                                                              |             |           |
|                     |  * ``1``: Y                                                              |             |           |
|                     |  * ``2``: Z                                                              |             |           |
+---------------------+--------------------------------------------------------------------------+-------------+-----------+
| delp                | Pressure drop (Pa)                                                       |  Real       | 0         |
+---------------------+--------------------------------------------------------------------------+-------------+-----------+
+11 −11
Changes for docs/source_docs/user_guide/inputs/regions.rst: 11 added lines, 11 removed lines.
Original line number Diff line number Diff line
@@ -30,9 +30,9 @@ For each box region, the inputs are defined using the compound prefix ``regions.
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  | 0 0 0     |
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| hi                       | High 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>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+

Below is an example for specifying two regions.
@@ -61,9 +61,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg
+==========================+=======================================================================+=============+===========+
| radius                   | cylinder radius                                                       |   Real      | None      |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| start                    | Coordinates of the cylinder's bottom cap                              |   Reals<3>  | 0 0 0     |
| start                    | Coordinates of the cylinder's bottom cap                              |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| end                      | Coordinates of the cylinder's top cap                                 |   Reals<3>  | 0 0 0     |
| end                      | Coordinates of the cylinder's top cap                                 |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


@@ -77,7 +77,7 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg
+==========================+=======================================================================+=============+===========+
| radius                   | Cylinder radius                                                       |   Real      | None      |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| center                   | Coordinates of the sphere's center                                    |   Reals<3>  | 0 0 0     |
| center                   | Coordinates of the sphere's center                                    |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


@@ -89,9 +89,9 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  | 0 0 0     |
| lo                       | Low corner of physical region (physical, not index space)             |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| hi                       | High 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>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


@@ -104,11 +104,11 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| radius                   | Disk radius                                                           |   Real      | None      |
| radius                   | Disk radius                                                           |   Real      |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| center                   | Coordinates of the disk's center                                      |   Reals<3>  | 0 0 0     |
| center                   | Coordinates of the disk's center                                      |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
| normal                   | Surface normal                                                        |   Reals<3>  | 0 0 0     |
| normal                   | Surface normal                                                        |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+


@@ -120,5 +120,5 @@ For each region, the inputs are defined using the compound prefix ``regions.[reg
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                          | Description                                                           |   Type      | Default   |
+==========================+=======================================================================+=============+===========+
| center                   | Coordinate of point                                                   |   Reals<3>  | 0 0 0     |
| center                   | Coordinate of point                                                   |   Reals<3>  |           |
+--------------------------+-----------------------------------------------------------------------+-------------+-----------+