Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ASM1/ADM1 Translator Documentation #1000

Merged
merged 5 commits into from
Apr 13, 2023
Merged

ASM1/ADM1 Translator Documentation #1000

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f41d2db
Add translator documentation and minor doc string corrections
MarcusHolly Apr 11, 2023
001a1e0
Fix documentation failures
MarcusHolly Apr 11, 2023
337deb7
Try to fix image failure
MarcusHolly Apr 11, 2023
28f0cc9
documentation refinement
MarcusHolly Apr 11, 2023
6c4ecde
Address Adam's comments & carry over some changes to ADM1/ASM1
MarcusHolly Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/_static/unit_models/translators/mapping_step_a.jpg
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to nitpick, but the resolution on the figures is a little low.

Copy link
Contributor

@adam-a-a adam-a-a Apr 11, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me take that back. I just went through readthedocs and it looks fine. When you click on the image to get a magnified view, it looks even better. One exception though for this figure: the dashed box was slightly cut off, so I would just replace with a snapshot of the full dashed box.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 60 additions & 1 deletion docs/technical_reference/unit_models/translators/translator_adm1_asm1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,65 @@ Sets
**Notes**
:sup:`*` Ion" is a subset of "Component" and uses the same symbol j.

ASM1 Components
---------------
Additional documentation on the ASM1 property model can be found here: `Activated Sludge Model 1 Documentation <https://watertap.readthedocs.io/en/latest/technical_reference/property_models/ASM1.html>`_

.. csv-table::
:header: "Description", "Symbol", "Variable"

"Soluble inert organic matter, S_I", ":math:`S_I`", "S_I"
"Readily biodegradable substrate S_S", ":math:`S_S`", "S_S"
"Particulate inert organic matter, X_I", ":math:`X_I`", "X_I"
"Slowly biodegradable substrate X_S", ":math:`X_S`", "X_S"
"Active heterotrophic biomass X_B,H", ":math:`X_{B,H}`", "X_BH"
"Active autotrophic biomass X_B,A", ":math:`X_{B,A}`", "X_BA"
"Particulate products arising from biomass decay, X_P", ":math:`X_P`", "X_P"
"Oxygen, S_O", ":math:`S_O`", "S_O"
"Nitrate and nitrite nitrogen, S_NO", ":math:`S_{NO}`", "S_NO"
"NH4 :math:`^{+}` + NH :math:`_{3}` Nitrogen, S_NH", ":math:`S_{NH}`", "S_NH"
"Soluble biodegradable organic nitrogen, S_ND", ":math:`S_{ND}`", "S_ND"
"Particulate biodegradable organic nitrogen, X_ND", ":math:`X_{ND}`", "X_ND"
"Alkalinity, S_ALK", ":math:`S_{ALK}`", "S_ALK"

ADM1 Components
---------------
Additional documentation on the ADM1 property model can be found here: `Anaerobic Digestion Model 1 Documentation <https://watertap.readthedocs.io/en/latest/technical_reference/property_models/ADM1.html>`_

.. csv-table::
:header: "Description", "Symbol", "Variable"

"Monosaccharides, S_su", ":math:`S_{su}`", "S_su"
"Amino acids, S_aa", ":math:`S_{aa}`", "S_aa"
"Long chain fatty acids, S_fa", ":math:`S_{fa}`", "S_fa"
"Total valerate, S_va", ":math:`S_{va}`", "S_va"
"Total butyrate, S_bu", ":math:`S_{bu}`", "S_bu"
"Total propionate, S_pro", ":math:`S_{pro}`", "S_pro"
"Total acetate, S_ac", ":math:`S_{ac}`", "S_ac"
"Hydrogen gas, S_h2", ":math:`S_{h2}`", "S_h2"
"Methane gas, S_ch4", ":math:`S_{ch4}`", "S_ch4"
"Inorganic carbon, S_IC", ":math:`S_{IC}`", "S_IC"
"Inorganic nitrogen, S_IN", ":math:`S_{IN}`", "S_IN"
"Soluble inerts, S_I", ":math:`S_I`", "S_I"
"Composites, X_c", ":math:`X_c`", "X_c"
"Carbohydrates, X_ch", ":math:`X_{ch}`", "X_ch"
"Proteins, X_pr", ":math:`X_{pr}`", "X_pr"
"Lipids, X_li", ":math:`X_{li}`", "X_li"
"Sugar degraders, X_su", ":math:`X_{su}`", "X_su"
"Amino acid degraders, X_aa", ":math:`X_{aa}`", "X_aa"
"Long chain fatty acid (LCFA) degraders, X_fa", ":math:`X_{fa}`", "X_fa"
"Valerate and butyrate degraders, X_c4", ":math:`X_{c4}`", "X_c4"
"Propionate degraders, X_pro", ":math:`X_{pro}`", "X_pro"
"Acetate degraders, X_ac", ":math:`X_{ac}`", "X_ac"
"Hydrogen degraders, X_h2", ":math:`X_{h2}`", "X_h2"
"Particulate inerts, X_I", ":math:`X_I`", "X_I"
"Total cation equivalents concentration, S_cat", ":math:`S_{cat}`", "S_cat"
"Total anion equivalents concentration, S_an", ":math:`S_{an}`", "S_an"
"Carbon dioxide, S_co2", ":math:`S_{co2}`", "S_co2"

**NOTE: S_h2 and S_ch4 have vapor phase and liquid phase, S_co2 only has vapor phase, and the other components only have liquid phase**


.. _Translator_ADM1_ASM1_equations:

Equations and Relationships
Expand Down Expand Up @@ -87,4 +146,4 @@ References
[1] Copp J. and Jeppsson, U., Rosen, C., 2006.
Towards an ASM1 - ADM1 State Variable Interface for Plant-Wide Wastewater Treatment Modeling.
Proceedings of the Water Environment Federation, 2003, pp 498-510.
https://www.accesswater.org/publications/-290550/towards-an-asm1--ndash--adm1-state-variable-interface-for-plant-wide-wastewater-treatment-modeling
https://www.accesswater.org/publications/proceedings/-290550/towards-an-asm1---adm1-state-variable-interface-for-plant-wide-wastewater-treatment-modeling
70 changes: 62 additions & 8 deletions docs/technical_reference/unit_models/translators/translator_asm1_adm1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,63 @@ Sets
**Notes**
:sup:`*` Ion" is a subset of "Component" and uses the same symbol j.

.. _Translator_ASM1_ADM1_parameters:
ASM1 Components
---------------
Additional documentation on the ASM1 property model can be found here: `Activated Sludge Model 1 Documentation <https://watertap.readthedocs.io/en/latest/technical_reference/property_models/ASM1.html>`_

.. csv-table::
:header: "Description", "Symbol", "Variable"

"Soluble inert organic matter, S_I", ":math:`S_I`", "S_I"
"Readily biodegradable substrate S_S", ":math:`S_S`", "S_S"
"Particulate inert organic matter, X_I", ":math:`X_I`", "X_I"
"Slowly biodegradable substrate X_S", ":math:`X_S`", "X_S"
"Active heterotrophic biomass X_B,H", ":math:`X_{B,H}`", "X_BH"
"Active autotrophic biomass X_B,A", ":math:`X_{B,A}`", "X_BA"
"Particulate products arising from biomass decay, X_P", ":math:`X_P`", "X_P"
"Oxygen, S_O", ":math:`S_O`", "S_O"
"Nitrate and nitrite nitrogen, S_NO", ":math:`S_{NO}`", "S_NO"
"NH4 :math:`^{+}` + NH :math:`_{3}` Nitrogen, S_NH", ":math:`S_{NH}`", "S_NH"
"Soluble biodegradable organic nitrogen, S_ND", ":math:`S_{ND}`", "S_ND"
"Particulate biodegradable organic nitrogen, X_ND", ":math:`X_{ND}`", "X_ND"
"Alkalinity, S_ALK", ":math:`S_{ALK}`", "S_ALK"

ADM1 Components
---------------
Additional documentation on the ADM1 property model can be found here: `Anaerobic Digestion Model 1 Documentation <https://watertap.readthedocs.io/en/latest/technical_reference/property_models/ADM1.html>`_

.. csv-table::
:header: "Description", "Symbol", "Variable"

"Monosaccharides, S_su", ":math:`S_{su}`", "S_su"
"Amino acids, S_aa", ":math:`S_{aa}`", "S_aa"
"Long chain fatty acids, S_fa", ":math:`S_{fa}`", "S_fa"
"Total valerate, S_va", ":math:`S_{va}`", "S_va"
"Total butyrate, S_bu", ":math:`S_{bu}`", "S_bu"
"Total propionate, S_pro", ":math:`S_{pro}`", "S_pro"
"Total acetate, S_ac", ":math:`S_{ac}`", "S_ac"
"Hydrogen gas, S_h2", ":math:`S_{h2}`", "S_h2"
"Methane gas, S_ch4", ":math:`S_{ch4}`", "S_ch4"
"Inorganic carbon, S_IC", ":math:`S_{IC}`", "S_IC"
"Inorganic nitrogen, S_IN", ":math:`S_{IN}`", "S_IN"
"Soluble inerts, S_I", ":math:`S_I`", "S_I"
"Composites, X_c", ":math:`X_c`", "X_c"
"Carbohydrates, X_ch", ":math:`X_{ch}`", "X_ch"
"Proteins, X_pr", ":math:`X_{pr}`", "X_pr"
"Lipids, X_li", ":math:`X_{li}`", "X_li"
"Sugar degraders, X_su", ":math:`X_{su}`", "X_su"
"Amino acid degraders, X_aa", ":math:`X_{aa}`", "X_aa"
"Long chain fatty acid (LCFA) degraders, X_fa", ":math:`X_{fa}`", "X_fa"
"Valerate and butyrate degraders, X_c4", ":math:`X_{c4}`", "X_c4"
"Propionate degraders, X_pro", ":math:`X_{pro}`", "X_pro"
"Acetate degraders, X_ac", ":math:`X_{ac}`", "X_ac"
"Hydrogen degraders, X_h2", ":math:`X_{h2}`", "X_h2"
"Particulate inerts, X_I", ":math:`X_I`", "X_I"
"Total cation equivalents concentration, S_cat", ":math:`S_{cat}`", "S_cat"
"Total anion equivalents concentration, S_an", ":math:`S_{an}`", "S_an"
"Carbon dioxide, S_co2", ":math:`S_{co2}`", "S_co2"

**NOTE: S_h2 and S_ch4 have vapor phase and liquid phase, S_co2 only has vapor phase, and the other components only have liquid phase**
Copy link
Member

@yalinli2 yalinli2 Apr 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adam-a-a I'm wondering where this comment is from? Do you have another component for dissolved CO2? If S_h2 and S_ch4 can have liquid phase, I'd expect S_co2 to have liquid phase as well as it's more dissoluble in the water

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do not have an explicit component for dissolved/liquid-phase CO2. Perhaps @adam-a-a or @agarciadiego can elaborate more on the rationale behind this comment.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also asked the same question either on this or a previous PR, but based on the response I recall, the answer was our model only accounts for CO2 in gas phase on not the dissolved CO2 in liquid. I am not clear on how closely our model follows the literature on this specific aspect in terms of ASM1 model implementation, despite the fact that we know in reality there would be dissolved CO2. @agarciadiego - can you provide some insight since you worked on this part of ADM1?


Parameters
----------
Expand All @@ -64,8 +120,6 @@ Parameters
"Nitrogen fraction in biomass", ":math:`i_{xb}`", "i_xb", 0.08, ":math:`\text{dimensionless}`"
"Anaerobic degradable fraction of X_I and X_P", ":math:`f_{xI}`", "f_xI", 0.05, ":math:`\text{dimensionless}`"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should either (1) include links to the components tables for ASM1 and ADM1 for people to refer to follow this, or (2) the components tables for both ASM1 and ADM1 could be included directly to more easily follow the acronyms.

Option (2) would be ideal.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, it would be good to do both: reference ASM1 and ADM1 property model documentation while also adding a single components section with tables for ASM1 and ADM1 components and descriptions (or two sections, i.e., ASM1 Components and ADM1 Components)


.. _Translator_ASM1_ADM1_equations:

Equations and Relationships
---------------------------
.. csv-table::
Expand Down Expand Up @@ -101,7 +155,7 @@ S_nd and S_s Mapping Equations
:width: 800
:align: center

Figure 1. Schematic illustration of Snd and Ss mapping
Figure 1. Schematic illustration of Snd and Ss mapping (Copp et al. 2006)

.. csv-table::
:header: "Description", "Equation"
Expand All @@ -121,7 +175,7 @@ Soluble Inert COD Mapping Equations
:width: 800
:align: center

Figure 2. Schematic illustration of soluble inert COD mapping
Figure 2. Schematic illustration of soluble inert COD mapping (Copp et al. 2006)

.. csv-table::
:header: "Description", "Equation"
Expand All @@ -142,7 +196,7 @@ Particulate Inert COD Mapping Equations
:width: 800
:align: center

Figure 3. Schematic illustration of particulate inert COD mapping.
Figure 3. Schematic illustration of particulate inert COD mapping (Copp et al. 2006)

.. csv-table::
:header: "Description", "Equation"
Expand All @@ -160,7 +214,7 @@ Final COD and TKN Mapping Equations
:width: 800
:align: center

Figure 4. Schematic illustration of final COD and TKN mapping
Figure 4. Schematic illustration of final COD and TKN mapping (Copp et al. 2006)

.. csv-table::
:header: "Description", "Equation"
Expand Down Expand Up @@ -191,4 +245,4 @@ References
[1] Copp J. and Jeppsson, U., Rosen, C., 2006.
Towards an ASM1 - ADM1 State Variable Interface for Plant-Wide Wastewater Treatment Modeling.
Proceedings of the Water Environment Federation, 2003, pp 498-510.
https://www.accesswater.org/publications/-290550/towards-an-asm1--ndash--adm1-state-variable-interface-for-plant-wide-wastewater-treatment-modeling
https://www.accesswater.org/publications/proceedings/-290550/towards-an-asm1---adm1-state-variable-interface-for-plant-wide-wastewater-treatment-modeling