ASM3: start documenting parameters

Author: cbix

doc/interface/reaction/activated_sludge_model.rst

@@ -0,0 +1,184 @@
+.. _activated_sludge_model_config:
+
+Activated Sludge Model (ASM3h)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Group /input/model/unit_XXX/reaction - REACTION_MODEL = ACTIVATED_SLUDGE_MODEL3**
+
+For information on model equations, refer to :ref:`activated_sludge_model`.
+
+``ASM3_KH20``
+
+   Hydrolysis rate constant :math:`k_H` at 20 °C.
+   
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_T``
+
+   Temperature :math:`T`
+   
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_IO2``
+
+   Aeration rate :math:`iO_2`
+   
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\ge 0`       **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_V``
+
+   Aeration volume :math:`V`
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\gt 0`       **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KSTO20``
+
+   Saturation constant :math:`K_{STO}` at 20 °C
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\gt 0`       **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KX``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHO2``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHSS``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHNO3``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_ETA_HNO3``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHNH4``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHALK``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KHSTO``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_MU_H20``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_ETAH_END``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_BH20``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_MU_AUT20``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KNO2``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KNNH4``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_KNALK``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_BAUT20``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================
+
+``ASM3_ETAN_END``
+
+   
+
+   ================  =============================  ========================================================
+   **Type:** double  **Range:** :math:`\mathbb{R}`  **Length:** 1
+   ================  =============================  ========================================================

doc/interface/reaction/index.rst

@@ -8,6 +8,7 @@ Reaction models
 
     mass_action_law
     michaelis_menten_kinetics
+    activated_sludge_model
 
 Externally dependent reaction models
 ------------------------------------

doc/modelling/reaction/activated_sludge_model.rst

@@ -0,0 +1,11 @@
+.. _activated_sludge_model:
+
+Activated Sludge Model (ASM3h)
+-------------------------
+
+Activated Sludge Models are a group of reaction models published by the International Water Association (IWA)
+and mostly used for modelling biological processes in wastewater treatment plants.
+
+The ASM3h model implemented in CADET is a variant of the ASM3 model and documented in the SIMBA# software suite.
+
+For more information on model parameters required to define in CADET file format, see :ref:`activated_sludge_model_config`.

doc/modelling/reaction/index.rst

@@ -16,6 +16,10 @@ Historically, a chromatography system is modeled as a reaction system without co
  - :ref:`thomas_model`
  - :ref:`rate_constant_distribution_theory`
 
+More specialized models are also implemented:
+
+ - :ref:`activated_sludge_model`
+
 .. _dependence-on-external-function_react:
 
 Dependence on external function