From b9faed3e65cb485b9f2cfc975a35201aa0a716d3 Mon Sep 17 00:00:00 2001 From: cgilet Date: Tue, 9 Apr 2024 13:41:14 -0400 Subject: [PATCH] Update docs to include non-conservative scalars. --- Docs/sphinx_documentation/source/FluidEquations.rst | 8 ++++++-- Docs/sphinx_documentation/source/InputsAlgorithm.rst | 2 ++ Docs/sphinx_documentation/source/index.rst | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/Docs/sphinx_documentation/source/FluidEquations.rst b/Docs/sphinx_documentation/source/FluidEquations.rst index 03a8e470..d6e74a2d 100644 --- a/Docs/sphinx_documentation/source/FluidEquations.rst +++ b/Docs/sphinx_documentation/source/FluidEquations.rst @@ -35,9 +35,13 @@ Incompressibility constraint: .. math:: \nabla \cdot U = 0 -Tracer(s): +Tracer(s): for conservative, .. math:: \frac{\partial \rho s}{\partial t} + \nabla \cdot (\rho U s) = \nabla \cdot \mu_s \nabla s + \rho H_s +or, for non-conservative, + +.. math:: \frac{\partial s}{\partial t} + U \cdot \nabla s = \nabla \cdot \mu_s \nabla s + H_s + By default, :math:`H_s = 0` and :math:`{\bf H}_U = {\bf 0}`. -If gravity is set during runtime, then :math:`{\bf H}_U` defaults to :math:`\rho {\bf g}` +If gravity is set during runtime, then :math:`{\bf H}_U` defaults to :math:`\rho {\bf g}`. diff --git a/Docs/sphinx_documentation/source/InputsAlgorithm.rst b/Docs/sphinx_documentation/source/InputsAlgorithm.rst index 29ee6c54..f3713113 100644 --- a/Docs/sphinx_documentation/source/InputsAlgorithm.rst +++ b/Docs/sphinx_documentation/source/InputsAlgorithm.rst @@ -14,6 +14,8 @@ The following inputs must be preceded by "incflo." +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | advect_tracer | evolve the tracer equation(s)? | bool | false | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| trac_is_conservative| Is tracer conserved? If specified, one entry required per tracer | int | 1 | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ | ntrac | number of tracers | int | 1 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | constant_density | Only evolve the continuity equation if false | bool | true | diff --git a/Docs/sphinx_documentation/source/index.rst b/Docs/sphinx_documentation/source/index.rst index fda3f269..77dc9f98 100644 --- a/Docs/sphinx_documentation/source/index.rst +++ b/Docs/sphinx_documentation/source/index.rst @@ -8,7 +8,7 @@ the variable density incompressible Navier-Stokes equations in the presence of complex geometries. It includes adaptive mesh refinement (AMR) but without subcycling in time. -For an AMReX-based incompressible flow code with subcycling in time, please see `IAMR `_ +For an AMReX-based incompressible flow code with subcycling in time, please see :ref:`IAMR `. Active development in incflo is ongoing in the development branch.