Update docs (!162) · Merge requests · exa / docs

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

+21 −21

Changes for docs/source_docs/user_guide/inputs/output/checkpointing.rst: 21 added lines, 21 removed lines.
Original line number	Diff line number	Diff line
		@@ -5,29 +5,29 @@ Checkpointing

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

		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| \| Description \| Type \| Default \|
		+=========================+=======================================================================+=============+============+
		\| restart \| If present, then the name of file to restart from \| String \| None \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_int \| Frequency of checkpoint output in number of timesteps; \| Int \| -1 \|
		\| \| if -1 then no checkpoints will be written \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_per_approx \| Frequency of checkpoint output in simulation time; \| Real \| 0 \|
		\| \| if 0 then no checkpoints will be written \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_walltime_interval \| Frequency of checkpoint output in runtime (HH:MM:SS) \| String \| None \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_file \| Prefix to use for checkpoint output \| String \| chk \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+=========================+========================================================================+=============+==================+
		\| restart \| If present, the name of file to restart from. \| String \| None \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_file \| Prefix to use for checkpoint output file name. \| String \| chk \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_int \| Checkpoint output interval in number of timesteps (0 to disable). \| Int \| 0 \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_per_approx \| Approximate checkpoint output interval in simulation time (0 to \| Real \| 0 \|
		\| \| disable). \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_walltime_interval \| Checkpoint output interval in elapsed run time (HH:MM:SS). Only one \| String \| None \|
		\| \| of ``check_int``, ``check_per_approx``, or ``check_walltime_interval`` \| \| \|
		\| \| may be specified. \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_chk_write \| Write the EB geometry data into ``geom_chk_file`` and additionally, \| Bool \| false \|
		\| \| ``geom_levelset_chk_file`` if levelset refinement is enabled. \| \| \|
		\| \| refinement is enabled. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom_chk \|
		\| \| the unrefined geometry. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| geom_levelset_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom\_ \|
		\| \| the refined geometry, i.e. when levelset refinement is enabled. \| \| levelset\_ \|
		\| \| \| \| chk \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_levelset_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom_levelset_chk\|
		\| \| the refined geometry, i.e. when levelset refinement is enabled. \| \| \|
		\| \| \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+

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

+161 −168

File changed.

Preview size limit exceeded, changes collapsed.

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

+93 −80

File changed.

Preview size limit exceeded, changes collapsed.

docs/source_docs/user_guide/inputs/geometry.rst

+2 −2

Changes for docs/source_docs/user_guide/inputs/geometry.rst: 2 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``:
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+
		\| \| Description \| Type \| Default \|
		+========================+===============================================================================+==========+=====================+
		\| geometry \| Simulation geometry type. \| String \| 'box' \|
		\| geometry \| Simulation geometry type. \| String \| \|
		\| \| Options (case-insensitive): \| \| \|
		\| \| \| \| \|
		\| \| * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` \| \| \|
		@@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``None`` - no embedded boundary -- all domain faces must be specified \| \| \|
		\| \| \| \| \|
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+
		\| levelset__refinement \| Refinement factor of levelset resolution relative to level 0 \| Int \| 1 \|
		\| levelset_refinement \| Refinement factor of levelset resolution relative to level 0 \| Int \| 1 \|
		\| \| resolution \| \| \|
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+

docs/source_docs/user_guide/inputs/initial_conditions.rst

+1 −1

Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -88,7 +88,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		+========================+=======================================================================+=============+===========+
		\| volfrac \| Volume fraction \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| temperature \| temperature \| Real \| 0 \|
		\| temperature \| Temperature \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| species.[species_name] \| Mass fraction of `species_name`. Must be a solid species. \| Real \| 0 \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+

Original line number	Diff line number	Diff line
		@@ -5,29 +5,29 @@ Checkpointing

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

		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| \| Description \| Type \| Default \|
		+=========================+=======================================================================+=============+============+
		\| restart \| If present, then the name of file to restart from \| String \| None \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_int \| Frequency of checkpoint output in number of timesteps; \| Int \| -1 \|
		\| \| if -1 then no checkpoints will be written \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_per_approx \| Frequency of checkpoint output in simulation time; \| Real \| 0 \|
		\| \| if 0 then no checkpoints will be written \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_walltime_interval \| Frequency of checkpoint output in runtime (HH:MM:SS) \| String \| None \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| check_file \| Prefix to use for checkpoint output \| String \| chk \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+=========================+========================================================================+=============+==================+
		\| restart \| If present, the name of file to restart from. \| String \| None \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_file \| Prefix to use for checkpoint output file name. \| String \| chk \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_int \| Checkpoint output interval in number of timesteps (0 to disable). \| Int \| 0 \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_per_approx \| Approximate checkpoint output interval in simulation time (0 to \| Real \| 0 \|
		\| \| disable). \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| check_walltime_interval \| Checkpoint output interval in elapsed run time (HH:MM:SS). Only one \| String \| None \|
		\| \| of ``check_int``, ``check_per_approx``, or ``check_walltime_interval`` \| \| \|
		\| \| may be specified. \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_chk_write \| Write the EB geometry data into ``geom_chk_file`` and additionally, \| Bool \| false \|
		\| \| ``geom_levelset_chk_file`` if levelset refinement is enabled. \| \| \|
		\| \| refinement is enabled. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom_chk \|
		\| \| the unrefined geometry. \| \| \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		\| geom_levelset_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom\_ \|
		\| \| the refined geometry, i.e. when levelset refinement is enabled. \| \| levelset\_ \|
		\| \| \| \| chk \|
		+-------------------------+-----------------------------------------------------------------------+-------------+------------+
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+
		\| geom_levelset_chk_file \| Name of the EB checkpoint file that is used to store or read \| String \| geom_levelset_chk\|
		\| \| the refined geometry, i.e. when levelset refinement is enabled. \| \| \|
		\| \| \| \| \|
		+-------------------------+------------------------------------------------------------------------+-------------+------------------+

Original line number	Diff line number	Diff line
		@@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``:
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+
		\| \| Description \| Type \| Default \|
		+========================+===============================================================================+==========+=====================+
		\| geometry \| Simulation geometry type. \| String \| 'box' \|
		\| geometry \| Simulation geometry type. \| String \| \|
		\| \| Options (case-insensitive): \| \| \|
		\| \| \| \| \|
		\| \| * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` \| \| \|
		@@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix``:
		\| \| * ``None`` - no embedded boundary -- all domain faces must be specified \| \| \|
		\| \| \| \| \|
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+
		\| levelset__refinement \| Refinement factor of levelset resolution relative to level 0 \| Int \| 1 \|
		\| levelset_refinement \| Refinement factor of levelset resolution relative to level 0 \| Int \| 1 \|
		\| \| resolution \| \| \|
		+------------------------+-------------------------------------------------------------------------------+----------+---------------------+

Update docs

Merge request reports