#################################################################################
# WaterTAP Copyright (c) 2020-2024, The Regents of the University of California,
# through Lawrence Berkeley National Laboratory, Oak Ridge National Laboratory,
# National Renewable Energy Laboratory, and National Energy Technology
# Laboratory (subject to receipt of any required approvals from the U.S. Dept.
# of Energy). All rights reserved.
#
# Please see the files COPYRIGHT.md and LICENSE.md for full copyright and license
# information, respectively. These files are also available online at the URL
# "https://github.com/watertap-org/watertap/"
#################################################################################
"""
Thermophysical property package to be used in conjunction with modified ASM2d
reactions for compatibility with the modified ADM1 model.
Reference:
[1] Henze, M., Gujer, W., Mino, T., Matsuo, T., Wentzel, M.C., Marais, G.v.R.,
Van Loosdrecht, M.C.M., "Activated Sludge Model No.2D, ASM2D", 1999,
Wat. Sci. Tech. Vol. 39, No. 1, pp. 165-182
"""
# Import IDAES cores
from idaes.core import (
declare_process_block_class,
Solute,
)
from pyomo.common.config import ConfigValue
import idaes.logger as idaeslog
from watertap.property_models.activated_sludge.asm2d_properties import (
ASM2dParameterData,
_ASM2dStateBlock,
ASM2dStateBlockData,
)
from idaes.core.util.exceptions import ConfigurationError
# Some more information about this module
__author__ = "Chenyu Wang"
# Set up logger
_log = idaeslog.getLogger(__name__)
[docs]@declare_process_block_class("SimpleModifiedASM2dParameterBlock")
class SimpleModifiedASM2dParameterData(ASM2dParameterData):
CONFIG = ASM2dParameterData.CONFIG()
CONFIG.declare(
"additional_solute_list",
ConfigValue(
domain=list,
description="List of additional solute species names apart from conventional ASM2D",
),
)
[docs] def build(self):
super().build()
self._state_block_class = SimpleModifiedASM2dStateBlock
# Group components into different sets
if self.config.additional_solute_list is not None:
for j in self.config.additional_solute_list:
if j == "H2O":
raise ConfigurationError(
"'H2O' is reserved as the default solvent and cannot be a solute."
)
# Add valid members of solute_list into IDAES's Solute() class.
# This triggers the addition of j into component_list and solute_set.
self.add_component(j, Solute())
class _SimpleModifiedASM2dStateBlock(_ASM2dStateBlock):
pass
[docs]@declare_process_block_class(
"SimpleModifiedASM2dStateBlock", block_class=_SimpleModifiedASM2dStateBlock
)
class SimpleModifiedASM2dStateBlockData(ASM2dStateBlockData):
pass
class ASM2dParameterBlock:
pass