Update docs

  • add some amr/eb2 keys
  • fix descriptions
  • fix LaTeX for PDF

Merge request reports

Loading
+1 −1
Changes for docs/source_docs/references/eb/EBWalls.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ the level-set creation:
|                               | has two levels (one additional level with      |
|                               | higher refinement).                            |
+-------------------------------+------------------------------------------------+
| ``mfix.levelset__refinement`` | If ``amr.max_level > 1`` this parameter is     |
| ``mfix.levelset_refinement``  | If ``amr.max_level > 1`` this parameter is     |
|                               | ignored. Otherwise it sets the maximum         |
|                               | refinement of the level-set                    |
+-------------------------------+------------------------------------------------+
+2 −2
Changes for docs/source_docs/references/size_distributions.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -707,7 +707,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr
+---------------------+-----------------------------------------------------------------------+-------------+-----------+
|                     | Description                                                           |   Type      | Default   |
+=====================+=======================================================================+=============+===========+
| custom              | File name of user-defined distribution                                | string      | N/A       |
| custom              | File name of user-defined distribution                                | String      | N/A       |
+---------------------+-----------------------------------------------------------------------+-------------+-----------+
| min                 | Minimum particle diameter. Drawn samples below ``min`` are discarded  | Real        | N/A       |
|                     | and a new sample is drawn.                                            |             |           |
@@ -715,7 +715,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr
| max                 | Maximum particle diameter. Drawn samples above ``max`` are discarded  | Real        | N/A       |
|                     | and a new sample is drawn.                                            |             |           |
+---------------------+-----------------------------------------------------------------------+-------------+-----------+
| interpolate         | Enable linear interpolation between discrete bins. This option is     | bool        | false     |
| interpolate         | Enable linear interpolation between discrete bins. This option is     | Bool        | false     |
|                     | only available when the initial distribution probability is zero.     |             |           |
+---------------------+-----------------------------------------------------------------------+-------------+-----------+

+10 −2
Changes for docs/source_docs/user_guide/inputs/advanced.rst: 10 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ The following inputs must be preceded by the prefix ``mfix``:
| only_print_grid_report |  Do not time-march the simulation. Simply generate the grid report    |   Bool      | false        |
|                        |  and exit.                                                            |             |              |
+------------------------+-----------------------------------------------------------------------+-------------+--------------+
| stop_for_unused_inputs |  Do not time-march the simulation if any keyword in the inputs file   |   Bool      | false        |
|                        |  has not been used. This is useful in catching input errors.          |             |              |
| stop_for_unused_inputs |  Do not start the simulation if any keywords in the inputs file       |   Bool      | false        |
|                        |  have not been used. This is useful for catching input errors.        |             |              |
+------------------------+-----------------------------------------------------------------------+-------------+--------------+

To assist in verifying the breakdown of fluid grids created before running a full simulation, an input option
@@ -55,6 +55,14 @@ The following inputs must be preceded by the prefix ``amrex``:
| abort_on_out_of_gpu_memory | Abort if free device memory is less than the amount an arena is       |  Int        | 0             |
|                            | asked to allocate.                                                    |             |               |
+----------------------------+-----------------------------------------------------------------------+-------------+---------------+
| use_gpu_aware_mpi          | For GPU runs,controls the memory type used for AMReX's communication  |  Bool       | false         |
|                            | buffers. When ``true``, AMReX uses GPU device memory for communication|             |               |
|                            | data in MPI function calls. When ``false``, the data is placed in     |             |               |
|                            | pinned memory. Note that this flag does not enable GPU-aware MPI by   |             |               |
|                            | itself. Enabling GPU-aware MPI is system dependent. Users should      |             |               |
|                            | consult their system's documentation for instructions on setting up   |             |               |
|                            | the environment and linking to GPU-aware MPI libraries.               |             |               |
+----------------------------+-----------------------------------------------------------------------+-------------+---------------+


Load balancing
+10 −2
Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 10 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -195,7 +195,6 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
| bins                   | Number of bins used when discretizing the diameter distribution to    | Int         | 64        |
|                        | approximate the number of particles within a boundary condition       |             |           |
|                        | region.                                                               |             |           |
|                        |                                                                       |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| constant               | Monodisperse (single valued) particle diameter.                       | Real        | 0         |
|                        | Required for ``constant`` distributions.                              |             |           |
@@ -217,6 +216,11 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
| custom                 | File name that specifies either the cumulative or probability         | String      | None      |
|                        | distribution. Required for ``custom`` distributions.                  |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| interpolate            | For ``custom`` distributions, enable linear interpolation between     | Bool        | false     |
|                        | discrete bins. This option is only available when the initial         |             |           |
|                        | distribution probability is zero.                                     |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+



The following inputs control the density distribution and are defined with
@@ -256,6 +260,10 @@ the prefix ``bc.[region_name].[solid_name].density``:
| custom                 | File name that specifies either the cumulative or probability         | String      | None      |
|                        | distribution. Required for ``custom`` distributions.                  |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+
| interpolate            | For ``custom`` distributions, enable linear interpolation between     | Bool        | false     |
|                        | discrete bins. This option is only available when the initial         |             |           |
|                        | distribution probability is zero.                                     |             |           |
+------------------------+-----------------------------------------------------------------------+-------------+-----------+


Transient boundary conditions
@@ -406,7 +414,7 @@ Below is an example for specifying a constant temperature boundary condition in

.. code-block:: none

   bc.regions = hot-wall
   bc.regions = hot-walls

   bc.hot-walls = eb
   bc.hot-walls.eb.temperature = constant
+3 −3
Changes for docs/source_docs/user_guide/inputs/domain.rst: 3 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -50,9 +50,9 @@ number of cells. The mesh spacing is required to be the same in all directions:

.. math::

   \frac{\text{prob_hi[0] - prob_lo[0]}}{\text{n_cell[0]}}
   = \frac{\text{prob_hi[1] - prob_lo[1]}}{\text{n_cell[1]}}
   = \frac{\text{prob_hi[2] - prob_lo[2]}}{\text{n_cell[2]}}
   \frac{\text{prob\_hi[0] - prob\_lo[0]}}{\text{n\_cell[0]}}
   = \frac{\text{prob\_hi[1] - prob\_lo[1]}}{\text{n\_cell[1]}}
   = \frac{\text{prob\_hi[2] - prob\_lo[2]}}{\text{n\_cell[2]}}


The inputs for defining the mesh for a single-level simulation are demonstrated in the
Loading
Loading