Update docs

minor edits

Merge request reports

Loading
+1 −1
Changes for docs/source_docs/references/hpc/Joule3.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -315,7 +315,7 @@ prior to following any of the full build instructions above.

         .. code:: bash

            git clone --branch v2.26.0 https://github.com/hypre-space/hypre.git
            git clone https://github.com/hypre-space/hypre.git
            pushd hypre/src/
            ./configure --prefix=$HYPRE_INSTALL_DIR --with-MPI
            make -j8 install
+2 −2
Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -31,6 +31,6 @@ is being included in a GPU build/run, then you must enable managed memory,i.e.,
+---------------------+-----------------------------------------------------------------------+-------------+-----------+
|                     | Description                                                           |   Type      | Default   |
+=====================+=======================================================================+=============+===========+
| actions             | yaml file of the ascent actions (ex. ascent_actions.yaml). If no file |  String     |           |
|                     | name is provided, then calls to Ascent are skipped.                   |             |           |
| actions             | Name of yaml file of the ascent actions (ex. ascent_actions.yaml). If |  String     |           |
|                     | no file name is provided, then calls to Ascent are skipped.           |             |           |
+---------------------+-----------------------------------------------------------------------+-------------+-----------+
+11 −10
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 11 added lines, 10 removed lines.
Original line number Diff line number Diff line
@@ -64,8 +64,8 @@ using the prefix ``bc.[region_name].[fluid_name]``:
| massflow               | Mass flow rate [required if bc type is ``mi``                          | Real        | None      |
|                        | and ``velocity`` or ``volflow`` not specified]                         |             |           |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| species.[species_name] | Species `species_name` mass fraction [required if `solve_species`=1    | Real        | None      |
|                        | and bc type is ``mi`` or ``pi``]                                       |             |           |
| species.[species_name] | Mass fraction of ``species_name`` [required if ``solve_species``       | Real        | None      |
|                        | is enabled and bc type is ``mi`` or ``pi``].  Must be a fluid species. |             |           |
+------------------------+------------------------------------------------------------------------+-------------+-----------+

Note that for a ``mi`` only one of ``velocity`` or ``volflow`` or ``massflow`` should be specified.
@@ -129,7 +129,7 @@ For each inflow boundary condition region, general solids inputs are defined usi
|                      | Description                                                      |   Type      | Default   |
+======================+==================================================================+=============+===========+
| solids               | Name of solid type in BC region.  Only one solid is allowed in   | String      | None      |
|                      | an BC region.                                                    |             |           |
|                      | a BC region.                                                     |             |           |
+----------------------+------------------------------------------------------------------+-------------+-----------+

.. warning::
@@ -137,20 +137,22 @@ For each inflow boundary condition region, general solids inputs are defined usi
   Mass inflow boundary conditions, ``bc.[region_name] = mi``, only support PIC parcels. EB inflow boundary conditions,
   ``bc.[region_name] = eb``, support DEM particles and PIC parcels.

For inflow boundary conditions , the solids inputs are defined using the prefix ``bc.[region_name].[solid_name]``:
For mass inflow boundary conditions, the solids inputs are defined using the prefix ``bc.[region_name].[solid_name]``:

+------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                        | Description                                                           |   Type      | Default   |
+========================+=======================================================================+=============+===========+
| volfrac                | Volume fraction                                                       | Real        | None      |
| volfrac                | Volume fraction.                                                      | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| temperature            | Temperature                                                           | Real        | None      |
| temperature            | Temperature.                                                          | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| species.[species_name] | Mass fraction of ``species_name``                                     | Real        | None      |
| species.[species_name] | Mass fraction of ``species_name``.  Must be a solid species.          | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| velocity               | Velocity components                                                   | Reals       | None      |
| velocity               | Velocity components. ``velocity`` and ``volflow`` cannot both be      | Reals       | None      |
|                        | specified.                                                            |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| volflow                | Volumetric flow rate.                                                 | Real        | None      |
| volflow                | Volumetric flow rate. ``velocity`` and ``volflow`` cannot both be     | Real        | None      |
|                        | specified.                                                            |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+


@@ -321,7 +323,6 @@ inputs defined using the prefix ``bc.[region_name].eb``.
|                      | * ``constant`` - impose a constant temperature along the EB.          |             |           |
|                      | * ``CHT-1D`` - compute a temperature for the wall using the 1D        |             |           |
|                      |   conjugate heat transfer model.                                      |             |           |
|                      |                                                                       |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+
| temperature.constant | Constant wall temperature.                                            | Real        | None      |
|                      | A valid is required for ``constant`` EB temperature model.            |             |           |
+5 −2
Changes for docs/source_docs/user_guide/inputs/domain.rst: 5 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -43,7 +43,8 @@ The following inputs are defined using the prefix ``amr``:
|                      | Description                                                           |   Type      | Default   |
|                      |                                                                       |             |           |
+======================+=======================================================================+=============+===========+
| n_cell               | Number of cells at level 0 in each coordinate direction.              |    Ints<3>  | None      |
| n_cell               | Number of cells at level 0 in each coordinate direction.  Must be     |    Ints<3>  | None      |
|                      | divisible by ``amr.blocking_factor`` in each dimension.               |             |           |
+----------------------+-----------------------------------------------------------------------+-------------+-----------+

The base mesh spacing is computed for each direction by dividing the :ref:`domain length<InputsTable_domain>` by the
@@ -92,7 +93,9 @@ The result is a uniform mesh spacing of :math:`0.125` *m* in all three direction

   MFIX-Exa simulations with a non-uniform mesh will not run.

----
Pressure drop
-------------


The following inputs are defined using the prefix ``mfix``:

+10 −10
Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 10 added lines, 10 removed lines.
Original line number Diff line number Diff line
@@ -26,17 +26,17 @@ using the compound prefix ``ic.[region_name].[fluid_name]``:
+------------------------+------------------------------------------------------------------------+-------------+-----------+
|                        | Description                                                            |   Type      | Default   |
+========================+========================================================================+=============+===========+
| volfrac                | Volume fraction [required]                                             | Real        | None      |
| volfrac                | Volume fraction [required].                                            | Real        | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| density                | Fluid density                                                          | Real        | None      |
| density                | Fluid density.                                                         | Real        | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| velocity               | Velocity components                                                    | Reals<3>    | None      |
| velocity               | Velocity components.                                                   | Reals<3>    | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| pressure               | Fluid pressure                                                         | Real        | None      |
| pressure               | Fluid pressure.                                                        | Real        | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| temperature            | Fluid temperature                                                      | Real        | None      |
| temperature            | Fluid temperature.                                                     | Real        | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+
| species.[species_name] | Mass fraction of ``species_name``.  Species must be a fluid species.   | Real        | None      |
| species.[species_name] | Mass fraction of ``species_name``.  Must be a fluid species.           | Real        | None      |
+------------------------+------------------------------------------------------------------------+-------------+-----------+


@@ -80,13 +80,13 @@ using the compound prefix ``ic.[region_name].[solid_name]``:
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
|                        | Description                                                           |   Type      | Default   |
+========================+=======================================================================+=============+===========+
| volfrac                | Volume fraction                                                       | Real        | None      |
| volfrac                | Volume fraction.                                                      | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| temperature            | Temperature                                                           | Real        | None      |
| temperature            | Temperature.                                                          | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| species.[species_name] | Mass fraction of `species_name`.  Must be a solid species.            | Real        | None      |
| species.[species_name] | Mass fraction of ``species_name``.  Must be a solid species.          | Real        | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| velocity               | Velocity components                                                   | Reals<3>    | None      |
| velocity               | Velocity components.                                                  | Reals<3>    | None      |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+

For automatically generated particles, diameter and density distributions can be specified.
Loading
Loading