diff --git a/docs/source_docs/user_guide/inputs/chemical_reactions.rst b/docs/source_docs/user_guide/inputs/chemical_reactions.rst index 5cdfdf6e95cf677133180f2cf55a167cade8db3d..be1ad1e4eb85bab972e97c5f9854d24e26c3da5d 100644 --- a/docs/source_docs/user_guide/inputs/chemical_reactions.rst +++ b/docs/source_docs/user_guide/inputs/chemical_reactions.rst @@ -1,3 +1,6 @@ + +.. _InputsChem: + Defining chemical reactions =========================== @@ -5,48 +8,53 @@ Defining chemical reactions The following inputs are defined using the prefix ``chemistry``: -+--------------------------+---------------------------------------------------------+----------+----------------+ -| | Description | Type | Default | -+==========================+=========================================================+==========+================+ -| solve | Specify the name(s) of the chemical reactions or set | String | | -| | to None to disable the chemistry solver. The name(s) | | | -| | assigned to the chemistry solver are used to specify | | | -| | the chemical reactions equations. | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| [reaction0].reaction | Chemical formula for the given reaction. The string | String | | -| | given as input must not contain white space and | | | -| | the reaction direction has to be specified as '\-\->' | | | -| | or '<\-\-'. Chemical species phases must be defined as | | | -| | '(g)' for the fluid phase or '(s)' for the solid phase. | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| mass_balance_tolerance | Tolerance used to test chemical formula conserves mass. | Real | 1e-12 | -| | | | | -| | |tol_eq| | | | -| | | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| solids.update_type | How to update solids quantities due to chemical | | ConstantVolume | -| | reactions. | | | -| | | | | -| | Options: | | | -| | | | | -| | * ``ConstantVolume`` - keep particle volume constant | | | -| | * ``ConstantDensity`` - keep particle density constant | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| solids.mass_threshold | Sets a threshold value for the particles' mass. When | Real | 0 | -| | updating the solids quantities in chemistry, check | | | -| | whether the solids mass is below the threshold, and in | | | -| | that case set the particle as invalid and remove it. | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| solids.radius_threshold | Sets a threshold value for the particles' radius. When | Real | 0 | -| | updating the solids quantities in chemistry, check | | | -| | whether the solids radius is below the threshold, and | | | -| | in that case set the particle as invalid and remove it. | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ -| solids.density_threshold | Sets a threshold value for the particles' density. When | Real | 0 | -| | updating the solids quantities in chemistry, check | | | -| | whether the solids density is below the threshold, and | | | -| | in that case set the particle as invalid and remove it. | | | -+--------------------------+---------------------------------------------------------+----------+----------------+ ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| | Description | Type | Default | ++==========================+=========================================================+==========+=================+ +| solve | Specify the name(s) of the chemical reactions or set | String | | +| | to None to disable the chemistry solver. The name(s) | | | +| | assigned to the chemistry solver are used to specify | | | +| | the chemical reactions equations. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| [reaction0].reaction | Chemical formula for the given reaction. The string | String | | +| | given as input must not contain white space and | | | +| | the reaction direction has to be specified as '\-\->' | | | +| | or '<\-\-'. Chemical species phases must be defined as | | | +| | '(g)' for the fluid phase or '(s)' for the solid phase. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| mass_balance_tolerance | Tolerance used to test chemical formula conserves mass. | Real | 1e-12 | +| | | | | +| | |tol_eq| | | | +| | | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| solids.update_type | How to update solids quantities due to chemical | | Constant_Volume | +| | reactions. | | | +| | | | | +| | Options: | | | +| | | | | +| | * ``Constant_Volume`` keep particle volume constant | | | +| | * ``Constant_Density`` keep particle density constant | | | +| | * ``Constant_Species_Densities`` compute volume and | | | +| | density from | | | +| | :ref:`solid species densities`. | | | +| | It requires :ref:`solids density model` | | | +| | to be set to ``mixture``. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| solids.mass_threshold | Sets a threshold value for the particles' mass. When | Real | 0 | +| | updating the solids quantities in chemistry, check | | | +| | whether the solids mass is below the threshold, and in | | | +| | that case set the particle as invalid and remove it. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| solids.radius_threshold | Sets a threshold value for the particles' radius. When | Real | 0 | +| | updating the solids quantities in chemistry, check | | | +| | whether the solids radius is below the threshold, and | | | +| | in that case set the particle as invalid and remove it. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ +| solids.density_threshold | Sets a threshold value for the particles' density. When | Real | 0 | +| | updating the solids quantities in chemistry, check | | | +| | whether the solids density is below the threshold, and | | | +| | in that case set the particle as invalid and remove it. | | | ++--------------------------+---------------------------------------------------------+----------+-----------------+ Choosing the integrator type for the chemistry ODE integration operation that is performed to determine the fluid and solids phases transfer quantities due to diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index c3ec6cb402739b33c309537de49008c705d29fee..de552441627f9057b3627a1277699a3a5144df01 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -1,6 +1,8 @@ Solids model ============ +.. _InputsSolids: + Solids settings --------------- @@ -16,6 +18,18 @@ models. The following inputs are defined with the prefix ``solids``: +------------------------------------------+-------------------------------------------------------------+----------+----------+ | molecular_weight | Value of constant solid molecular weight. | Real | 0 | +------------------------------------------+-------------------------------------------------------------+----------+----------+ +| density | Specify which density model to use for solids. | String | None | +| | | | | +| | Options: | | | +| | | | | +| | * ``none`` - solids density specified through initial and | | | +| | boundary conditions; | | | +| | * ``mixture`` - solids density computed as a weighted | | | +| | average of the solid phase species densities. It requires | | | +| | constant :ref:`species densities` to | | | +| | be defined by the user. | | | +| | | | | ++------------------------------------------+-------------------------------------------------------------+----------+----------+ | specific_heat | Specify which specific heat model to use for solids. | String | constant | | | | | | | | Options: | | | diff --git a/docs/source_docs/user_guide/inputs/species.rst b/docs/source_docs/user_guide/inputs/species.rst index dd04b4c5ae838a90a4a839382158043e695ecb38..14a9898b3a3c106f93b902fcc667c4790f868398 100644 --- a/docs/source_docs/user_guide/inputs/species.rst +++ b/docs/source_docs/user_guide/inputs/species.rst @@ -137,7 +137,13 @@ The following inputs are defined for each species using the prefix ``species.[sp | viscosity.molecular.Reid.C | Values are required for ``Reid`` species viscosity model. | | | | viscosity.molecular.Reid.D | | | | +---------------------------------------+------------------------------------------------------------------------+----------+-----------+ - +| density | Constant species density (only used for solid phase species). | Real | 0. | +| | | | | +| | Needed for all solid species if | | | +| | :ref:`solids density` is set to ``mixture`` or | | | +| | :ref:`density updates` is set to | | | +| | ``Constant_Species_Densities`` | | | ++---------------------------------------+------------------------------------------------------------------------+----------+-----------+ Example inputs