From a89fef8cc50791c8f795c6a4caaa4694fbd5e249 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Thu, 10 Oct 2024 13:16:40 -0400 Subject: [PATCH 1/2] Change constraint_type to constraint --- docs/source_docs/user_guide/inputs/fluid_model.rst | 6 +++--- docs/source_docs/user_guide/inputs/model_options.rst | 2 +- docs/source_docs/user_guide/inputs/species_defs.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/fluid_model.rst b/docs/source_docs/user_guide/inputs/fluid_model.rst index 4773d82..fbf2f84 100644 --- a/docs/source_docs/user_guide/inputs/fluid_model.rst +++ b/docs/source_docs/user_guide/inputs/fluid_model.rst @@ -220,7 +220,7 @@ are not solved. .. code-block:: bash :caption: Snippet of inputs defining a simple incompressible fluid. This is not a complete input file. - mfix.constraint_type = IncompressibleFluid + mfix.constraint = IncompressibleFluid mfix.advect_density = 0 mfix.advect_enthalpy = 0 @@ -274,7 +274,7 @@ pressure when evaluating the equation of state. .. code-block:: bash :caption: Snippet of inputs defining a simple ideal gas. This is not a complete input file. - mfix.constraint_type = IdealGasOpenSystem + mfix.constraint = IdealGasOpenSystem mfix.advect_density = 1 mfix.advect_enthalpy = 0 @@ -332,7 +332,7 @@ thermodynamic pressure for the system. .. code-block:: bash :caption: Snippet of inputs defining an idea gas with energy. This is not a complete input file. - mfix.constraint_type = IdealGasOpenSystem + mfix.constraint = IdealGasOpenSystem mfix.advect_density = 1 mfix.advect_enthalpy = 1 diff --git a/docs/source_docs/user_guide/inputs/model_options.rst b/docs/source_docs/user_guide/inputs/model_options.rst index c6e3dad..fe31bfc 100644 --- a/docs/source_docs/user_guide/inputs/model_options.rst +++ b/docs/source_docs/user_guide/inputs/model_options.rst @@ -16,7 +16,7 @@ The following inputs are defined using the ``mfix`` prefix. | solve_species | Flag to enable the time evolution of fluid species mass | int | 0 | | | fractions. | | | +------------------------+----------------------------------------------------------------------------+----------+---------------------+ -| constraint_type | Select low Mach number constraint. | string | IncompressibleFluid | +| constraint | Select low Mach number constraint. | string | IncompressibleFluid | | | | | | | | * ``IncompressibleFluid`` constraint is appropriate for cold flow systems | | | | | that do not have chemical reactions. Fluid temperature and species mass | | | diff --git a/docs/source_docs/user_guide/inputs/species_defs.rst b/docs/source_docs/user_guide/inputs/species_defs.rst index 48a662c..1a60014 100644 --- a/docs/source_docs/user_guide/inputs/species_defs.rst +++ b/docs/source_docs/user_guide/inputs/species_defs.rst @@ -101,7 +101,7 @@ local species concentrations do not affect the fluid. .. code-block:: bash :caption: Snippet of inputs defining species as passive tracers. This is not a complete input file. - mfix.constraint_type = IncompressibleFluid + mfix.constraint = IncompressibleFluid mfix.advect_density = 0 mfix.advect_enthalpy = 0 @@ -175,7 +175,7 @@ outflow boundary condition pressure which is set here to 1 atmosphere. .. code-block:: bash :caption: Snippet of inputs defining fluid as a mixture with ``NASA7-poly`` specific heat model. This is not a complete input file. - mfix.constraint_type = IdealGasOpenSystem + mfix.constraint = IdealGasOpenSystem mfix.advect_density = 1 mfix.solve_species = 1 -- GitLab From 62e475138df1b3dc1cad43c39b781530a37b0a05 Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Thu, 10 Oct 2024 13:25:27 -0400 Subject: [PATCH 2/2] Remove config option causing build issues --- docs/source_docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source_docs/conf.py b/docs/source_docs/conf.py index e4bbc5f..f4b5faa 100644 --- a/docs/source_docs/conf.py +++ b/docs/source_docs/conf.py @@ -105,7 +105,6 @@ html_theme = 'sphinx_rtd_theme' # html_theme_options = { 'logo_only': False, - 'display_version': True, 'prev_next_buttons_location': 'bottom', 'style_external_links': False, 'vcs_pageview_mode': '', -- GitLab