BSM2 Anoxic CSTR Costing

watertap/costing/costing_base.py

@@ -13,12 +13,13 @@
 import pyomo.environ as pyo
 from idaes.core import declare_process_block_class
 from idaes.core.base.costing_base import FlowsheetCostingBlockData
-from idaes.models.unit_models import Mixer, HeatExchanger
+from idaes.models.unit_models import Mixer, HeatExchanger, CSTR
 
 from watertap.core.util.misc import is_constant_up_to_units
 
 from watertap.costing.unit_models.mixer import cost_mixer
 from watertap.costing.unit_models.heat_exchanger import cost_heat_exchanger
+from watertap.costing.unit_models.cstr import cost_cstr
 
 
 @declare_process_block_class("WaterTAPCostingBlock")
@@ -33,6 +34,7 @@ class WaterTAPCostingBlockData(FlowsheetCostingBlockData):
     unit_mapping = {
         Mixer: cost_mixer,
         HeatExchanger: cost_heat_exchanger,
+        CSTR: cost_cstr,
     }
 
     def build(self):

watertap/costing/unit_models/cstr.py

@@ -0,0 +1,45 @@
+#################################################################################
+# WaterTAP Copyright (c) 2020-2023, 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/"
+#################################################################################
+
+import pyomo.environ as pyo
+from ..util import (
+    register_costing_parameter_block,
+    cost_by_flow_volume,
+)
+
+
+def build_cstr_cost_param_block(blk):
+    # Source: https://www.fwrj.com/articles/9812.pdf
+    blk.sizing_cost = pyo.Var(
+        initialize=0.34,
+        doc="Reactor sizing cost",
+        units=pyo.units.USD_1998 / pyo.units.m**3,
+    )
+
+
+@register_costing_parameter_block(
+    build_rule=build_cstr_cost_param_block,
+    parameter_block_name="cstr",
+)
+def cost_cstr(blk):
+    """
+    CSTR costing method
+    """
+    cost_by_flow_volume(
+        blk,
+        blk.unit_model.hydraulic_retention_time[0]
+        * blk.costing_package.cstr.sizing_cost,
+        pyo.units.convert(
+            blk.unit_model.control_volume.properties_in[0].flow_vol,
+            (pyo.units.meter**3 / pyo.units.hours),
+        ),
+    )

watertap/unit_models/__init__.py

@@ -29,4 +29,5 @@
 from .thickener import Thickener
 from .dewatering import DewateringUnit
 from .electroNP_ZO import ElectroNPZO
+from .cstr import CSTR
 from .clarifier import Clarifier

watertap/unit_models/cstr.py

@@ -0,0 +1,84 @@
+###############################################################################
+# WaterTAP Copyright (c) 2021, 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/"
+#
+###############################################################################
+"""
+CSTR unit model for BSM2 and plant-wide wastewater treatment modeling.
+This unit inherits from the IDAES CSTR unit.
+"""
+
+# Import IDAES cores
+from idaes.core import (
+    declare_process_block_class,
+)
+from idaes.models.unit_models.cstr import CSTRData as CSTRIDAESData
+
+import idaes.logger as idaeslog
+
+from pyomo.environ import (
+    Constraint,
+    NonNegativeReals,
+    Var,
+    units as pyunits,
+)
+
+from watertap.costing.unit_models.cstr import cost_cstr
+
+__author__ = "Marcus Holly"
+
+
+# Set up logger
+_log = idaeslog.getLogger(__name__)
+
+
+@declare_process_block_class("CSTR")
+class CSTRData(CSTRIDAESData):
+    """
+    CSTR unit block for BSM2
+    """
+
+    CONFIG = CSTRIDAESData.CONFIG()
+
+    def build(self):
+        """
+        Begin building model.
+        Args:
+            None
+        Returns:
+            None
+        """
+
+        # Call UnitModel.build to set up dynamics
+        super(CSTRData, self).build()
+
+        self.hydraulic_retention_time = Var(
+            self.flowsheet().time,
+            initialize=4,
+            domain=NonNegativeReals,
+            units=pyunits.s,
+            doc="Hydraulic retention time",
+        )
+
+        def CSTR_retention_time_rule(self, t):
+            return (
+                self.hydraulic_retention_time[t]
+                == self.volume[t] / self.control_volume.properties_in[t].flow_vol
+            )
+
+        self.CSTR_retention_time = Constraint(
+            self.flowsheet().time,
+            rule=CSTR_retention_time_rule,
+            doc="Total CSTR retention time",
+        )
+
+    @property
+    def default_costing_method(self):
+        return cost_cstr