From ab698ea0d74ac4402833a2ea5050108991be18e8 Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan Date: Thu, 29 Aug 2024 17:06:50 +0000 Subject: [PATCH] add missing godunov options (exa/docs!86) --- docs/source_docs/user_guide/inputs/model_options.rst | 12 ++++++++++++ .../user_guide/inputs/multigrid-solvers.rst | 2 ++ 2 files changed, 14 insertions(+) diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index d00510b..8057e4a 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -73,6 +73,18 @@ The following inputs are defined using the ``mfix`` prefix. +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | use_drag_in_godunov | Include a drag term in the Godunov flux or (default) not | Bool | False | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ +| godunov_ppm | When using Godunov, use piecewise parabolic (PPM) instead of | Bool | False | +| | piecewise linear (PLM) reconstruction | | | ++---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ +| godunov_include_diff_in_forcing | When using Godunov, include viscous/diffusive terms in forcing terms | Bool | True | ++---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ +| godunov_use_forces_in_trans | When using Godunov, add forcing terms in the construction of `trans` | Bool | False | +| | velocities | | | ++---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ +| use_mac_phi_in_godunov | When using Godunov, don't include the pressure gradient in the | Bool | False | +| | forcing term passed into the godunov routine; instead use gradient of | | | +| | mac phi which contains the full pressure | | | ++---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | correction_small_volfrac | Threshold volume fraction for correcting small cell velocity | | | | | at the end of the predictor and corrector | Real | 1.e-4 | +---------------------------------+-----------------------------------------------------------------------+-------------+--------------+ diff --git a/docs/source_docs/user_guide/inputs/multigrid-solvers.rst b/docs/source_docs/user_guide/inputs/multigrid-solvers.rst index c8d2485..4eea804 100644 --- a/docs/source_docs/user_guide/inputs/multigrid-solvers.rst +++ b/docs/source_docs/user_guide/inputs/multigrid-solvers.rst @@ -226,6 +226,8 @@ The following inputs are valid when using ``BoomerAMG`` as a preconditioner or s +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ | overwrite_existing_matrix_files | Over-write existing matrix files | Bool | false | +-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ +| write_matrix_files | Write out matrix into text files | Bool | false | ++-----------------------------------+-----------------------------------------------------------------------+-------------+--------------+ .. note:: -- GitLab