Clean up docs

Charles G Waldmanrequested to merge
cgw-doc-cleanup into main
  • Consistent formatting for keyword prefix - this makes the doc more uniform and also helps with automatic scanning (gui/doc_scanner.py)
  • Fix dem.rolling_friction_coeff -> dem.rolling_friction_coefficient
  • Fix a few grammar and spelling issues
  • Remove blank table rows
Edited by Charles G Waldman

Merge request reports

docs/source_docs/user_guide/inputs/output/ascent.rst

+3 −2
Changes for docs/source_docs/user_guide/inputs/output/ascent.rst: 3 added lines, 2 removed lines.
Original line number Diff line number Diff line 
Ascent

------



The following inputs must be preceded by "mfix." and control frequency and naming of plotfile generation as well

The following inputs must be preceded by the prefix ``mfix`` and control frequency and naming of plotfile generation as well

as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii

format (for debugging).
@@ -17,7 +17,8 @@ format (for debugging). 




`Ascent <ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization.

For codes that have been built with Ascent support, the following inputs must be preceded by "ascent."

For codes that have been built with Ascent support, the following input must be preceded by the prefix

``ascent``,

and specifies the ascent actions for fluid and/or particles. The frequency which these are called

is controlled by `ascent_int` or `ascent_per_approx`, see above. Note that if an ascent pipeline

is being included in a GPU build/run, then you must enable managed memory,

docs/source_docs/user_guide/inputs/output/checkpointing.rst

+1 −1
Changes for docs/source_docs/user_guide/inputs/output/checkpointing.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
Checkpointing

=============



The following inputs must be preceded by "mfix." and control checkpoint/restart.

The following inputs must be preceded by the prefix ``mfix`` and control checkpoint/restart:



+-------------------------+-----------------------------------------------------------------------+-------------+------------+

|                         | Description                                                           |   Type      | Default    |

docs/source_docs/user_guide/inputs/output/monitors.rst

+1 −1
Changes for docs/source_docs/user_guide/inputs/output/monitors.rst: 1 added line, 1 removed line.
Original line number Diff line number Diff line
@@ -644,7 +644,7 @@ Flow rates 
For Lagrangian monitors of type FlowRate, the flow plane must be specified in

the inputs and it must be defined by one of the regions defined in the regions

inputs. The following input for a monitor [monitor] of type FlowRate can be

used, preceded by the "mfix.monitors" prefix.

used, preceded by the prefix ``mfix.monitors``:



+------------------+-----------------------------------------------------------------------+-------------+-----------+

|                  | Description                                                           |   Type      | Default   |

docs/source_docs/user_guide/inputs/output/plotfiles.rst

+5 −5
Changes for docs/source_docs/user_guide/inputs/output/plotfiles.rst: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
Plotfiles and Other Output

==========================



The following inputs must be preceded by "mfix." and control frequency and naming of plotfile generation as well

The following inputs must be preceded by the prefix ``mfix`` and control frequency and naming of plotfile generation as well

as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii

format (for debugging).
@@ -86,7 +86,7 @@ The following inputs must be preceded by "mfix." and control what variables will 
+---------------------+-----------------------------------------------------------------------+-------------+-----------+





The following inputs must be preceded by "mfix." and control whether the EB geometry or level set should be written out.

The following inputs must be preceded by the prefix ``mfix`` and control whether the EB geometry or level set should be written out:



+----------------------+-----------------------------------------------------------------------+-------------+-----------+

|                      | Description                                                           |   Type      | Default   |
@@ -103,7 +103,8 @@ The following inputs must be preceded by "mfix." and control whether the EB geom 




`Ascent <ascent.readthedocs.io>`_ has been integrated into MFIX-Exa for *in situ* visualization.

For codes that have been built with Ascent support, the following inputs must be preceded by "ascent."

For codes that have been built with Ascent support, the following input must be preceded by the prefix

``ascent``

and specifies the ascent actions for fluid and/or particles. The frequency which these are called

is controlled by `ascent_int` or `ascent_per_approx`, see above. Note that if an ascent pipeline

is being included in a GPU build/run, then you must enable managed memory,
@@ -112,13 +113,12 @@ i.e., set `amrex.the_arena_is_managed = true`. 
+---------------------+-----------------------------------------------------------------------+-------------+-----------+

|                     | 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.                   |             |           |

+---------------------+-----------------------------------------------------------------------+-------------+-----------+





The following inputs must be preceded by "mfix.solids." and allow to write additional plotfiles which

The following inputs must be preceded by the prefix ``mfix.solids`` and allow to write additional plotfiles which

contain only solids variables in specific regions at fixed timesteps or approximated simulation times.

All these parameters are user-defined.

docs/source_docs/user_guide/inputs/advanced.rst

+5 −5
Changes for docs/source_docs/user_guide/inputs/advanced.rst: 5 added lines, 5 removed lines.
Original line number Diff line number Diff line
@@ -35,15 +35,15 @@ The following inputs must be preceded by "amrex." 
GPU memory

----------



The following inputs must be preceded by "amrex."

The following inputs must be preceded by the prefix ``amrex``:



+----------------------------+-----------------------------------------------------------------------+-------------+---------------+

|                            | Description                                                           |   Type      | Default       |

+============================+=======================================================================+=============+===============+

| the_arena_is_managed       | Use managed memory for the main arena.                                |  Int        | 0             |

+----------------------------+-----------------------------------------------------------------------+-------------+---------------+

| the_arena_init_size        | Main memory arena's initial size in bytes.                            |  Int        | 3/4 of system |

|                            |                                                                       |             | device memory |

| the_arena_init_size        | Initial size of main memory arena (bytes).  If not specified, use     |  Int        | Unspecified   |

|                            | 3/4 of system device memory.                                          |             |               |

+----------------------------+-----------------------------------------------------------------------+-------------+---------------+

| abort_on_out_of_gpu_memory | Abort if free device memory is less than the amount an arena is       |  Int        | 0             |

|                            | asked to allocate.                                                    |             |               |
@@ -58,7 +58,7 @@ the ``particles.max_grid_size`` (in each direction) have no meaning. Therefore t 
sizes should be set for particle load balancing. It may also be necessary to set the blocking factors to 1.





The following inputs must be preceded by ``mfix`` and determine how we load balance:

The following inputs must be preceded by the prefix ``mfix`` and control load balancing:



+----------------------------------+-----------------------------------------------------------------------+-------------+-------------------+

|                                  | Description                                                           |   Type      | Default           |
@@ -88,7 +88,7 @@ To allow a user to verify the breakdown of fluid grids created before running a 
minimal memory to print the grid coverage report and exits immediately after that.





The following inputs are defined using the ``particles`` prefix.

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



+----------------------+-----------------------------------------------------------------------+-------------+--------------+

|                      | Description                                                           |   Type      | Default      |