watertap.unit_models.zero_order package

Submodules

watertap.unit_models.zero_order.CANDOP_zo module

This module contains a zero-order representation of a CANDO+P reactor unit.

class watertap.unit_models.zero_order.CANDOP_zo.CANDOPData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a CANDO+P reactor unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_CANDOP(blk)

General method for costing CANDO+P reactor.

class watertap.unit_models.zero_order.CANDOP_zo.CANDOPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CANDOPZO) New instance

watertap.unit_models.zero_order.aeration_basin_zo module

This module contains a zero-order representation of an aeration basin unit operation.

class watertap.unit_models.zero_order.aeration_basin_zo.AerationBasinZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(AerationBasinZO) New instance

class watertap.unit_models.zero_order.aeration_basin_zo.AerationBasinZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an aeration basin unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.air_flotation_zo module

This module contains a zero-order representation of an air flotation unit operation.

class watertap.unit_models.zero_order.air_flotation_zo.AirFlotationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(AirFlotationZO) New instance

class watertap.unit_models.zero_order.air_flotation_zo.AirFlotationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Air Flotation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.anaerobic_digestion_oxidation_zo module

This module contains a zero-order representation of an anaerobic digestion oxidation unit operation.

class watertap.unit_models.zero_order.anaerobic_digestion_oxidation_zo.AnaerobicDigestionOxidationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(AnaerobicDigestionOxidationZO) New instance

class watertap.unit_models.zero_order.anaerobic_digestion_oxidation_zo.AnaerobicDigestionOxidationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Anaerobic Digestion Oxidation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.anaerobic_digestion_reactive_zo module

This module contains a zero-order representation of a reactive anaerobic digestion unit operation.

class watertap.unit_models.zero_order.anaerobic_digestion_reactive_zo.AnaerobicDigestionReactiveZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(AnaerobicDigestionReactiveZO) New instance

class watertap.unit_models.zero_order.anaerobic_digestion_reactive_zo.AnaerobicDigestionReactiveZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a reactive anaerobic digestion unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.anaerobic_mbr_mec_zo module

This module contains a zero-order representation of an integrated anaerobic membrane bioreactor with microbial electrolysis cell (anaerobic MBR-MEC).

class watertap.unit_models.zero_order.anaerobic_mbr_mec_zo.AnaerobicMBRMECZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(AnaerobicMBRMECZO) New instance

class watertap.unit_models.zero_order.anaerobic_mbr_mec_zo.AnaerobicMBRMECZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an anaerobic MBR-MEC unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_anaerobic_mbr_mec(blk)

Method for costing anaerobic membrane bioreactor integrated with microbial electrolysis cell.

watertap.unit_models.zero_order.aop_addition_zo module

This module contains a zero-order representation of a AOP addition

watertap.unit_models.zero_order.autothermal_hydrothermal_liquefaction_zo module

This module contains a zero-order representation of an autothermal hydrothermal liquefaction unit.

class watertap.unit_models.zero_order.autothermal_hydrothermal_liquefaction_zo.ATHTLZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ATHTLZO) New instance

class watertap.unit_models.zero_order.autothermal_hydrothermal_liquefaction_zo.ATHTLZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an autothermal hydrothermal liquefaction (AT-HTL) unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_autothermal_hydrothermal_liquefaction(blk)

General method for costing autothermal-hydrothermal liquefaction unit. Capital cost is based on the HTL reactor, booster pump, solid filter, other equipment, and heat oil system.

watertap.unit_models.zero_order.backwash_solids_handling_zo module

This module contains a zero-order representation of a backwash solids handling unit.

class watertap.unit_models.zero_order.backwash_solids_handling_zo.BackwashSolidsHandlingZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BackwashSolidsHandlingZO) New instance

class watertap.unit_models.zero_order.backwash_solids_handling_zo.BackwashSolidsHandlingZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Backwash Solids Handling unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.bio_active_filtration_zo module

This module contains a zero-order representation of a biologically active filtration unit operation.

class watertap.unit_models.zero_order.bio_active_filtration_zo.BioActiveFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BioActiveFiltrationZO) New instance

class watertap.unit_models.zero_order.bio_active_filtration_zo.BioActiveFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Biologically Active Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.bioreactor_zo module

This module contains a zero-order representation of a bioreactor unit operation.

class watertap.unit_models.zero_order.bioreactor_zo.BioreactorZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BioreactorZO) New instance

class watertap.unit_models.zero_order.bioreactor_zo.BioreactorZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a bioreactor unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.blending_reservoir_zo module

This module contains a zero-order representation of a blending reservoir unit.

class watertap.unit_models.zero_order.blending_reservoir_zo.BlendingReservoirZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BlendingReservoirZO) New instance

class watertap.unit_models.zero_order.blending_reservoir_zo.BlendingReservoirZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Blending Reservoir unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.brine_concentrator_zo module

This module contains a zero-order representation of a brine concentrator unit.

class watertap.unit_models.zero_order.brine_concentrator_zo.BrineConcentratorZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BrineConcentratorZO) New instance

class watertap.unit_models.zero_order.brine_concentrator_zo.BrineConcentratorZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a brine concentrator unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_brine_concentrator(blk)

General method for costing brine concentration processes. Capital cost is based on the volumetirc flowrate and TDS of the incoming stream and the water recovery. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.buffer_tank_zo module

This module contains a zero-order representation of a buffer tank unit operation.

class watertap.unit_models.zero_order.buffer_tank_zo.BufferTankZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(BufferTankZO) New instance

class watertap.unit_models.zero_order.buffer_tank_zo.BufferTankZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Buffer Tank unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.cartridge_filtration_zo module

This module contains a zero-order representation of a cartridge filtration unit operation.

class watertap.unit_models.zero_order.cartridge_filtration_zo.CartridgeFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CartridgeFiltrationZO) New instance

class watertap.unit_models.zero_order.cartridge_filtration_zo.CartridgeFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Cartridge Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.centrifuge_zo module

This module contains a zero-order representation of a centrifuge unit.

class watertap.unit_models.zero_order.centrifuge_zo.CentrifugeZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CentrifugeZO) New instance

class watertap.unit_models.zero_order.centrifuge_zo.CentrifugeZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a centrifuge reactor unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_centrifuge(blk)

Method for costing centrifuge unit.

watertap.unit_models.zero_order.chemical_addition_zo module

This module contains a zero-order representation of a chemical addition unit operation.

class watertap.unit_models.zero_order.chemical_addition_zo.ChemicalAdditionZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ChemicalAdditionZO) New instance

class watertap.unit_models.zero_order.chemical_addition_zo.ChemicalAdditionZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a chemical addition unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_chemical_addition(blk, number_of_parallel_units=1)

General method for costing chemical addition processes. Capital cost is based on the mass flow rate of chemical added. This method also registers the chemical flow and electricity demand as costed flows. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.chlorination_zo module

This module contains a zero-order representation of a Chlorination unit.

class watertap.unit_models.zero_order.chlorination_zo.ChlorinationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ChlorinationZO) New instance

class watertap.unit_models.zero_order.chlorination_zo.ChlorinationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Chlorination unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_chlorination(blk)

General method for costing chlorination units. Capital cost is based on the both inlet flow and dosage of chlorine. This method also registers the chemical flow and electricity demand as costed flows.

watertap.unit_models.zero_order.clarifier_zo module

This module contains a zero-order representation of a clarifier unit operation.

class watertap.unit_models.zero_order.clarifier_zo.ClarifierZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ClarifierZO) New instance

class watertap.unit_models.zero_order.clarifier_zo.ClarifierZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Clarifier unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_HRCS_clarifier(blk)

Method for costing a clarifier unit in a high-rate contact stabilization (HRCS) process.

static cost_clarifier(blk, number_of_parallel_units=1)

General method for costing clarifiers. Costing is carried out using either the general_power_law form or the standard form which computes HRT, sizing costs, and chemical input costs. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.cloth_media_filtration_zo module

This module contains a zero-order representation of a cloth media filtration water treatment unit.

class watertap.unit_models.zero_order.cloth_media_filtration_zo.ClothMediaFiltrationData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a cloth media filtration water treatment unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_cloth_media_filtration(blk)

General method for costing cloth media filtration unit.

class watertap.unit_models.zero_order.cloth_media_filtration_zo.ClothMediaFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ClothMediaFiltrationZO) New instance

watertap.unit_models.zero_order.co2_addition_zo module

This module contains a zero-order representation of a CO2 addition unit.

class watertap.unit_models.zero_order.co2_addition_zo.CO2AdditionZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CO2AdditionZO) New instance

class watertap.unit_models.zero_order.co2_addition_zo.CO2AdditionZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a CO2 addition unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.coag_and_floc_zo module

This module contains a zero-order representation of a coagulation/flocculation unit operation.

class watertap.unit_models.zero_order.coag_and_floc_zo.CoagulationFlocculationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CoagulationFlocculationZO) New instance

class watertap.unit_models.zero_order.coag_and_floc_zo.CoagulationFlocculationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Coagulation/Flocculation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_coag_and_floc(blk)

General method for costing coagulation/flocculation processes. Capital cost is based on the alum flowrate and the polymer flowrate of the incoming stream. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.cofermentation_zo module

This module contains a zero-order representation of cofermentation for wastewater resource recovery flowsheets.

class watertap.unit_models.zero_order.cofermentation_zo.CofermentationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CofermentationZO) New instance

class watertap.unit_models.zero_order.cofermentation_zo.CofermentationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for cofermentation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_cofermentation(blk)

Method for costing cofermentation unit.

watertap.unit_models.zero_order.constructed_wetlands_zo module

This module contains a zero-order representation of constructed wetlands for wastewater resource recovery flowsheets.

class watertap.unit_models.zero_order.constructed_wetlands_zo.ConstructedWetlandsZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ConstructedWetlandsZO) New instance

class watertap.unit_models.zero_order.constructed_wetlands_zo.ConstructedWetlandsZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for constructed wetlands.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_constructed_wetlands(blk)

Method for costing constructed wetlands.

watertap.unit_models.zero_order.conventional_activated_sludge_zo module

This module contains a zero-order representation of the conventional activated sludge process.

class watertap.unit_models.zero_order.conventional_activated_sludge_zo.CASZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CASZO) New instance

class watertap.unit_models.zero_order.conventional_activated_sludge_zo.CASZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for the conventional activated sludge process.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.cooling_supply_zo module

This module contains a zero-order representation of a cooling supply unit operation.

class watertap.unit_models.zero_order.cooling_supply_zo.CoolingSupplyZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CoolingSupplyZO) New instance

class watertap.unit_models.zero_order.cooling_supply_zo.CoolingSupplyZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Cooling Supply unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.cooling_tower_zo module

This module contains a zero-order representation of a cooling tower unit.

class watertap.unit_models.zero_order.cooling_tower_zo.CoolingTowerZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(CoolingTowerZO) New instance

class watertap.unit_models.zero_order.cooling_tower_zo.CoolingTowerZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a cooling tower unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.decarbonator_zo module

This module contains a zero-order representation of a decarbonator unit operation.

class watertap.unit_models.zero_order.decarbonator_zo.DecarbonatorZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(DecarbonatorZO) New instance

class watertap.unit_models.zero_order.decarbonator_zo.DecarbonatorZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Decarbonator unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.deep_well_injection_zo module

This module contains a zero-order representation of a deep well injection unit.

class watertap.unit_models.zero_order.deep_well_injection_zo.DeepWellInjectionZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(DeepWellInjectionZO) New instance

class watertap.unit_models.zero_order.deep_well_injection_zo.DeepWellInjectionZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a deep well injection unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_deep_well_injection(blk, number_of_parallel_units=1)

General method for costing deep well injection processes. Capital cost is based on the cost of pump and pipe. This method also registers the electricity demand as a costed flow. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.dissolved_air_flotation_zo module

This module contains a zero-order representation of a dissolved air flotation unit.

class watertap.unit_models.zero_order.dissolved_air_flotation_zo.DissolvedAirFlotationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(DissolvedAirFlotationZO) New instance

class watertap.unit_models.zero_order.dissolved_air_flotation_zo.DissolvedAirFlotationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Dissolved Air Flotation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.dmbr_zo module

This module contains a zero-order representation of recirculating dynamic membrane bioreactor unit.

class watertap.unit_models.zero_order.dmbr_zo.DMBRZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(DMBRZO) New instance

class watertap.unit_models.zero_order.dmbr_zo.DMBRZOOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a DMBR unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_dmbr(blk)

General method for costing dynamic membrane bioreactor. Capital cost is based on the cost of membrane area. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.dual_media_filtration_zo module

This module contains a zero-order representation of a dual media filtration unit operation.

class watertap.unit_models.zero_order.dual_media_filtration_zo.DualMediaFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(DualMediaFiltrationZO) New instance

class watertap.unit_models.zero_order.dual_media_filtration_zo.DualMediaFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Dual Media Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.electrochemical_nutrient_removal_zo module

This module contains a zero-order representation of an electrochemical nutrient recovery unit.

class watertap.unit_models.zero_order.electrochemical_nutrient_removal_zo.ElectroNPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ElectroNPZO) New instance

class watertap.unit_models.zero_order.electrochemical_nutrient_removal_zo.ElectroNPZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an electrochemical nutrient recovery unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_electrochemical_nutrient_removal(blk)

General method for costing electrochemical nutrient recovery. Capital cost is based on the volumetirc flowrate and HRT of the incoming stream. Chemical dosing cost is based on MgCl2 cost. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.electrocoagulation_zo module

This module contains a zero-order representation of an electrocoagulation unit.

class watertap.unit_models.zero_order.electrocoagulation_zo.ElectrocoagulationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

  electrode_material

  Electrode material

  reactor_material

  Reactor material

  overpotential_calculation

  Determination of overpotential

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ElectrocoagulationZO) New instance

class watertap.unit_models.zero_order.electrocoagulation_zo.ElectrocoagulationZOData(component)

Bases: ZeroOrderBaseData

Zero-order model for an electrocoagulation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

calculate_scaling_factors()

Placeholder scaling routine, should be overloaded by derived classes

static cost_electrocoagulation(blk)

General method for costing electrocoagulation.

class watertap.unit_models.zero_order.electrocoagulation_zo.ElectrodeMaterial(value)

Bases: StrEnum

Electrode material can be aluminum or iron. Default is aluminum. To run the model with iron electrodes, use ElectrocoagulationZO(electrode_material="iron"); otherwise ElectrocoagulationZO() will default to aluminum electrodes.

class watertap.unit_models.zero_order.electrocoagulation_zo.OverpotentialCalculation(value)

Bases: StrEnum

An enumeration.

class watertap.unit_models.zero_order.electrocoagulation_zo.ReactorMaterial(value)

Bases: StrEnum

Reactor material can be PVC or stainless steel. Default is PVC. To run the model with stainless steel, use ElectrocoagulationZO(reactor_material="stainless_steel"); otherwise, ElectrocoagulationZO() will default to PVC.

watertap.unit_models.zero_order.electrodialysis_reversal_zo module

This module contains a zero-order representation of an electrodialysis reversal unit.

class watertap.unit_models.zero_order.electrodialysis_reversal_zo.ElectrodialysisReversalZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ElectrodialysisReversalZO) New instance

class watertap.unit_models.zero_order.electrodialysis_reversal_zo.ElectrodialysisReversalZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an electrodialysis reversal unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.energy_recovery_zo module

This module contains a zero-order representation of an energy recovery unit.

class watertap.unit_models.zero_order.energy_recovery_zo.EnergyRecoveryZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(EnergyRecoveryZO) New instance

class watertap.unit_models.zero_order.energy_recovery_zo.EnergyRecoveryZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Energy Recovery unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.evaporation_pond_zo module

This module contains a zero-order representation of an evaporation pond unit model.

class watertap.unit_models.zero_order.evaporation_pond_zo.EvaporationPondZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(EvaporationPondZO) New instance

class watertap.unit_models.zero_order.evaporation_pond_zo.EvaporationPondZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a evaporation pond unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_evaporation_pond(blk)

General method for costing evaporation pond. Capital cost is based on the pond area and other pond construction parameters.

watertap.unit_models.zero_order.feed_water_tank_zo module

This module contains a zero-order representation of a feed water tank unit operation.

class watertap.unit_models.zero_order.feed_water_tank_zo.FeedWaterTankZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(FeedWaterTankZO) New instance

class watertap.unit_models.zero_order.feed_water_tank_zo.FeedWaterTankZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Feed Water Tank unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.feed_zo module

Feed block for zero-order flowsheets with methods for getting concentration data from database.

class watertap.unit_models.zero_order.feed_zo.FeedZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  Indicates whether this model will be dynamic or not, default = False. Feed blocks are always steady-state.

  has_holdup

  Feed blocks do not contain holdup, thus this must be False.

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: { see property package for documentation.}

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(FeedZO) New instance

class watertap.unit_models.zero_order.feed_zo.FeedZOData(component)

Bases: InitializationMixin, FeedData

Zero-Order feed block.

build()

Begin building model.

Parameters:

None –

Returns:

None

initialize_build(state_args=None, outlvl=0, solver=None, optarg=None)

This method calls the initialization method of the Feed state block.

Keyword Arguments:

• state_args – a dict of arguments to be passed to the property package(s) to provide an initial state for initialization (see documentation of the specific property package) (default = None).

• outlvl – sets output level of initialization routine

• optarg – solver options dictionary object (default=None, use default solver options)

• solver – str indicating which solver to use during initialization (default = None, use default solver)

Returns:

None

load_feed_data_from_database(overwrite=False)

Method to load initial flowrate and concentrations from database.

Parameters:

- (overwrite) – should be overwritten by values from database or not.

Returns:

None

Raises:

KeyError if flowrate or concentration values not defined in data –

watertap.unit_models.zero_order.filter_press_zo module

This module contains a zero-order representation of a filter press unit operation.

class watertap.unit_models.zero_order.filter_press_zo.FilterPressZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(FilterPressZO) New instance

class watertap.unit_models.zero_order.filter_press_zo.FilterPressZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a filter press unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_filter_press(blk)

General method for costing belt filter press. Capital cost is a function of flow in gal/hr.

watertap.unit_models.zero_order.fixed_bed_zo module

This module contains a zero-order representation of a fixed bed unit operation.

class watertap.unit_models.zero_order.fixed_bed_zo.FixedBedZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(FixedBedZO) New instance

class watertap.unit_models.zero_order.fixed_bed_zo.FixedBedZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Ion exchange unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_fixed_bed(blk, number_of_parallel_units=1)

General method for costing fixed bed units. This primarily calls the cost_power_law_flow method. This method also registers demand for a number of additional material flows. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.gac_zo module

This module contains a zero-order representation of a granular activated carbon unit operation.

class watertap.unit_models.zero_order.gac_zo.GACZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(GACZO) New instance

class watertap.unit_models.zero_order.gac_zo.GACZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a granular activated carbon unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_gac(blk, number_of_parallel_units=5)

Adapted from core GAC costing model initially released in v0.6.0

3 equation capital cost estimation for GAC systems with: (i), contactor/pressure vessel cost by polynomial as a function of individual contactor volume; (ii), initial charge of GAC adsorbent cost by exponential as a function of required mass of GAC adsorbent; and (iii), other process costs (vessels, pipes, instrumentation, and controls) calculated by power law as a function of total contactor(s) volume. Operating costs calculated as the required makeup and regeneration of GAC adsorbent. Energy for backwash and booster pumps considered negligible compared to regeneration costs :param number_of_parallel_units: number_of_parallel_units parallel units in operation (default: 5) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.gas_sparged_membrane_zo module

This module contains a zero-order representation of a gas-sparged membrane unit.

class watertap.unit_models.zero_order.gas_sparged_membrane_zo.GasSpargedMembraneZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(GasSpargedMembraneZO) New instance

class watertap.unit_models.zero_order.gas_sparged_membrane_zo.GasSpargedMembraneZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a gas-sparged membrane. This unit is similar to a SIDO, but there is technically a third outlet for gas extraction. Three StateBlocks are added with corresponding Ports:

• properties_inlet

• properties_treated

• properties_byproduct

Two additional variables are added:

• recovery_vol (indexed by time)

• removal_frac_mass_comp (indexed by time and component)

Four additional constraints are added to represent the material balances, with modifications to account for gas extraction.

• water_recovery_equation (indexed by time)

• flow_balance (indexed by time)

• solute_removal_equation (indexed by time and solute)

• solute_treated_equation (indexed by time and solute)

The build method also sets private attributes on the unit model with references to the appropriate initialization and scaling methods to use and to return the inlet volumetric flow rate.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.hrcs_zo module

This module contains a zero-order representation of a high-rate contact stabilization unit.

class watertap.unit_models.zero_order.hrcs_zo.HRCSZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(HRCSZO) New instance

class watertap.unit_models.zero_order.hrcs_zo.HRCSZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a high-rate contact stabilization (HR-CS) unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_hrcs(blk)

Method for costing high-rate contact stabilization unit.

watertap.unit_models.zero_order.hydrothermal_gasification_zo module

This module contains a zero-order representation of a hydrothermal gasification unit.

class watertap.unit_models.zero_order.hydrothermal_gasification_zo.HTGZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(HTGZO) New instance

class watertap.unit_models.zero_order.hydrothermal_gasification_zo.HTGZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a hydrothermal gasification (HTG) unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_hydrothermal_gasification(blk)

General method for costing hydrothermal gasification unit. Capital cost is based on the CHG reactor and other wastewater treatment equipment including a feed pump, a booster pump, a feed/product exchanger, a fired heater, a hydrocyclone, and a product air fin cooler.

watertap.unit_models.zero_order.injection_well_disposal_zo module

This module contains a zero-order representation of an injection well disposal unit operation.

class watertap.unit_models.zero_order.injection_well_disposal_zo.InjectionWellDisposalZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(InjectionWellDisposalZO) New instance

class watertap.unit_models.zero_order.injection_well_disposal_zo.InjectionWellDisposalZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a injection well disposal unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.intrusion_mitigation_zo module

This module contains a zero-order representation of an intrusion mitigation unit operation.

class watertap.unit_models.zero_order.intrusion_mitigation_zo.IntrusionMitigationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(IntrusionMitigationZO) New instance

class watertap.unit_models.zero_order.intrusion_mitigation_zo.IntrusionMitigationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a intrusion mitigation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.ion_exchange_zo module

This module contains a zero-order representation of an ion exchange unit operation.

class watertap.unit_models.zero_order.ion_exchange_zo.IonExchangeZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(IonExchangeZO) New instance

class watertap.unit_models.zero_order.ion_exchange_zo.IonExchangeZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Ion exchange unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_ion_exchange(blk)

Two methods for costing ion exchange: (1) General method for costing ion exchange units. Capital cost is based on the both inlet flow and TDS. This method also registers the NaCl demand, resin replacement and electricity demand as costed flows. (2) General method using unit capex and unit opex cost parameters, tailored for AMO wastewater resource recovery (process subtype: clinoptilolite)

watertap.unit_models.zero_order.iron_and_manganese_removal_zo module

This module contains a zero-order representation of an iron and manganese removal unit.

class watertap.unit_models.zero_order.iron_and_manganese_removal_zo.IronManganeseRemovalZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(IronManganeseRemovalZO) New instance

class watertap.unit_models.zero_order.iron_and_manganese_removal_zo.IronManganeseRemovalZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an iron and manganese removal unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_iron_and_manganese_removal(blk, number_of_parallel_units=1)

General method for costing iron and manganese removal processes. Capital cost is based on the cost of air blower, backwash and dual media filter. This method also registers the electricity demand as a costed flow. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.landfill_zo module

This module contains a zero-order representation of a landfill unit.

class watertap.unit_models.zero_order.landfill_zo.LandfillZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(LandfillZO) New instance

class watertap.unit_models.zero_order.landfill_zo.LandfillZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a landfill unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_landfill(blk, number_of_parallel_units=1)

General method for costing landfill. Capital cost is based on the total mass and capacity basis. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.mabr_zo module

This module contains a zero-order representation of a membrane aerated biofilm reactor unit.

class watertap.unit_models.zero_order.mabr_zo.MABRZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MABRZO) New instance

class watertap.unit_models.zero_order.mabr_zo.MABRZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a MABR unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_mabr(blk)

General method for costing membrane aerated biofilm reactor. Capital cost is based on the cost of reactor and blower. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.magprex_zo module

This module contains a zero-order representation of a Magprex reactor unit for struvite precipitation.

class watertap.unit_models.zero_order.magprex_zo.MagprexZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MagprexZO) New instance

class watertap.unit_models.zero_order.magprex_zo.MagprexZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Magprex reactor unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_magprex(blk)

Method for costing Magprex reactor unit.

watertap.unit_models.zero_order.mbr_zo module

This module contains a zero-order representation of a membrane bioreactor unit.

class watertap.unit_models.zero_order.mbr_zo.MBRZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MBRZO) New instance

class watertap.unit_models.zero_order.mbr_zo.MBRZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a membrane bioreactor unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.media_filtration_zo module

This module contains a zero-order representation of a media filtration unit operation.

class watertap.unit_models.zero_order.media_filtration_zo.MediaFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MediaFiltrationZO) New instance

class watertap.unit_models.zero_order.media_filtration_zo.MediaFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Dual Media Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.membrane_evaporator_zo module

This module contains a zero-order representation of a membrane evaporation.

class watertap.unit_models.zero_order.membrane_evaporator_zo.MembraneEvaporatorData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a membrane evaporator.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_membrane_evaporator(blk)

General method for costing membrane evaporator unit.

class watertap.unit_models.zero_order.membrane_evaporator_zo.MembraneEvaporatorZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MembraneEvaporatorZO) New instance

watertap.unit_models.zero_order.metab_zo module

This module contains a zero-order representation of a METAB bioreactor with simple reactions (i.e., conversion fractions for key reagents and conversion ratios for other reactive species).

class watertap.unit_models.zero_order.metab_zo.MetabZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MetabZO) New instance

class watertap.unit_models.zero_order.metab_zo.MetabZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a METAB bioreactor

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_metab(blk)

General method for costing the metab reactor. Capital cost is based on the cost of reactor, mixer, METAB beads, membrane, and vacuum pump. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.microbial_battery_zo module

This module contains a zero-order representation of a microbial battery water treatment unit.

class watertap.unit_models.zero_order.microbial_battery_zo.MicrobialBatteryData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a microbial battery water treatment unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_microbial_battery(blk)

General method for costing microbial battery treatment unit.

class watertap.unit_models.zero_order.microbial_battery_zo.MicrobialBatteryZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MicrobialBatteryZO) New instance

watertap.unit_models.zero_order.microfiltration_zo module

This module contains a zero-order representation of a microfiltration unit.

class watertap.unit_models.zero_order.microfiltration_zo.MicroFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MicroFiltrationZO) New instance

class watertap.unit_models.zero_order.microfiltration_zo.MicroFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a microfiltration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.microscreen_filtration_zo module

This module contains a zero-order representation of a microscreen filtration unit.

class watertap.unit_models.zero_order.microscreen_filtration_zo.MicroscreenFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MicroscreenFiltrationZO) New instance

class watertap.unit_models.zero_order.microscreen_filtration_zo.MicroscreenFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a microscreen filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.municipal_drinking_zo module

This module contains a zero-order representation of municipal drinking water unit.

class watertap.unit_models.zero_order.municipal_drinking_zo.MunicipalDrinkingZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MunicipalDrinkingZO) New instance

class watertap.unit_models.zero_order.municipal_drinking_zo.MunicipalWaterZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for municipal drinking unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.municipal_wwtp_zo module

This module contains a zero-order representation of a municipal wastewater treatment plant.

class watertap.unit_models.zero_order.municipal_wwtp_zo.MunicipalWWTPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(MunicipalWWTPZO) New instance

class watertap.unit_models.zero_order.municipal_wwtp_zo.MunicipalWWTPZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a municipal wastewater treatment plant.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.nanofiltration_zo module

This module contains a zero-order representation of a nanofiltration unit operation.

class watertap.unit_models.zero_order.nanofiltration_zo.NanofiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(NanofiltrationZO) New instance

class watertap.unit_models.zero_order.nanofiltration_zo.NanofiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Nanofiltration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_membrane(blk)

Get membrane cost based on membrane area and unit membrane costs as well as fixed operating cost for membrane replacement.

static cost_nanofiltration(blk, number_of_parallel_units=1)

General method for costing nanofiltration. Costing is carried out using either the general_power_law form or the standard form which computes membrane cost and replacement rate. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.ozone_aop_zo module

This module contains a zero-order representation of a Ozone-AOP unit operation.

class watertap.unit_models.zero_order.ozone_aop_zo.OzoneAOPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(OzoneAOPZO) New instance

class watertap.unit_models.zero_order.ozone_aop_zo.OzoneAOPZOData(component)

Bases: OzoneZOData, AOPAdditionMixin

Zero-Order model for a Ozone-AOP unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_ozonation_aop(blk)

General method for costing ozonation with AOP. Capital cost is based on the inlet flowrate, dosage of ozone and flow rate of H2O2.

watertap.unit_models.zero_order.ozone_zo module

This module contains a zero-order representation of a Ozone reactor unit.

class watertap.unit_models.zero_order.ozone_zo.OzoneZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(OzoneZO) New instance

class watertap.unit_models.zero_order.ozone_zo.OzoneZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Ozone unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_ozonation(blk)

General method for costing ozone addition. Capital cost is based on the inlet flowrate and dosage of ozone.

watertap.unit_models.zero_order.peracetic_acid_disinfection_zo module

This module contains a zero-order representation of a peracetic acid (PAA) water disinfection unit.

class watertap.unit_models.zero_order.peracetic_acid_disinfection_zo.PeraceticAcidDisinfectionData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a peracetic acid water disinfection unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_peracetic_acid(blk)

General method for costing peracetic acid water disinfection.

class watertap.unit_models.zero_order.peracetic_acid_disinfection_zo.PeraceticAcidDisinfectionZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PeraceticAcidDisinfectionZO) New instance

watertap.unit_models.zero_order.photothermal_membrane_zo module

This module contains a zero-order representation of a photothermal membrane unit.

class watertap.unit_models.zero_order.photothermal_membrane_zo.PhotothermalMembraneData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a photothermal membrane unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_photothermal_membrane(blk)

General method for costing photothermal membrane.

class watertap.unit_models.zero_order.photothermal_membrane_zo.PhotothermalMembraneZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PhotothermalMembraneZO) New instance

watertap.unit_models.zero_order.primary_separator_zo module

This module contains a zero-order representation of a primary separator unit operation.

class watertap.unit_models.zero_order.primary_separator_zo.PrimarySeparatorZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PrimarySeparatorZO) New instance

class watertap.unit_models.zero_order.primary_separator_zo.PrimarySeparatorZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a primary separator unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.pump_electricity_zo module

This module contains a zero-order representation of a low pressure pump unit

class watertap.unit_models.zero_order.pump_electricity_zo.PumpElectricityZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PumpElectricityZO) New instance

class watertap.unit_models.zero_order.pump_electricity_zo.PumpElectricityZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a low pressure pump unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_pump_electricity(blk)

General method for costing low pressure pump. Capital cost is based on the cost of inlet flow rate. This method also registers the electricity demand as a costed flow.

watertap.unit_models.zero_order.pump_zo module

This module contains a zero-order representation of a pump unit operation.

class watertap.unit_models.zero_order.pump_zo.PumpZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PumpZO) New instance

class watertap.unit_models.zero_order.pump_zo.PumpZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a pump unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.screen_zo module

This module contains a zero-order representation of a screen unit operation.

class watertap.unit_models.zero_order.screen_zo.ScreenZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(ScreenZO) New instance

class watertap.unit_models.zero_order.screen_zo.ScreenZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Screen unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.secondary_treatment_wwtp_zo module

This module contains a zero-order representation of a WWTP with secondary treatment.

class watertap.unit_models.zero_order.secondary_treatment_wwtp_zo.SecondaryTreatmentWWTPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SecondaryTreatmentWWTPZO) New instance

class watertap.unit_models.zero_order.secondary_treatment_wwtp_zo.SecondaryTreatmentWWTPZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a WWTP with secondary treatment.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.sedimentation_zo module

This module contains a zero-order representation of a sedimentation unit operation.

class watertap.unit_models.zero_order.sedimentation_zo.SedimentationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SedimentationZO) New instance

class watertap.unit_models.zero_order.sedimentation_zo.SedimentationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Sedimentation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_sedimentation(blk, number_of_parallel_units=1)

General method for costing sedimentaion processes. Capital cost is based on the surface area of the basin. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.settling_pond_zo module

This module contains a zero-order representation of a settling pond unit operation.

class watertap.unit_models.zero_order.settling_pond_zo.SettlingPondZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SettlingPondZO) New instance

class watertap.unit_models.zero_order.settling_pond_zo.SettlingPondZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a settling pond unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.sludge_tank_zo module

This module contains a zero-order representation of a sludge tank unit.

class watertap.unit_models.zero_order.sludge_tank_zo.SludgeTankZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SludgeTankZO) New instance

class watertap.unit_models.zero_order.sludge_tank_zo.SludgeTankZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a sludge tank unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.smp_zo module

This module contains a zero-order representation of an smp unit operation.

class watertap.unit_models.zero_order.smp_zo.SMPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SMPZO) New instance

class watertap.unit_models.zero_order.smp_zo.SMPZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an smp unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.static_mixer_zo module

This module contains a zero-order representation of a static mixer unit operation.

class watertap.unit_models.zero_order.static_mixer_zo.StaticMixerZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(StaticMixerZO) New instance

class watertap.unit_models.zero_order.static_mixer_zo.StaticMixerZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a static mixer unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.storage_tank_zo module

This module contains a zero-order representation of a storage tank unit.

class watertap.unit_models.zero_order.storage_tank_zo.StorageTankZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(StorageTankZO) New instance

class watertap.unit_models.zero_order.storage_tank_zo.StorageTankZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a storage tank unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_storage_tank(blk, number_of_parallel_units=1)

General method for costing storage tanks. Capital cost is based on the volume of the tank. :param number_of_parallel_units: number_of_parallel_units parallel units (default: 1) :type number_of_parallel_units: int, optional

watertap.unit_models.zero_order.struvite_classifier_zo module

This module contains a zero-order representation of a struvite classifier unit.

class watertap.unit_models.zero_order.struvite_classifier_zo.StruviteClassifierZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(StruviteClassifierZO) New instance

class watertap.unit_models.zero_order.struvite_classifier_zo.StruviteClassifierZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a struvite classifier unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_struvite_classifier(blk)

Method for costing struvite classifier unit.

watertap.unit_models.zero_order.suboxic_activated_sludge_process_zo module

This module contains a zero-order representation of a suboxic activated sludge process unit operation.

class watertap.unit_models.zero_order.suboxic_activated_sludge_process_zo.SuboxicASMZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SuboxicASMZO) New instance

class watertap.unit_models.zero_order.suboxic_activated_sludge_process_zo.SuboxicASMZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a suboxic activated sludge process unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_suboxic_asm(blk)

General method for costing suboxic activated sludge process unit. Capital cost is based on the aeration basin, other equipments including mixers, blowers, MLR pumps, RAS pumps and automated valves, and instrumentation and control system including probes (dissolved oxygen, nitrate and ammonia), phosphorus analyzer and air flowmeter.

watertap.unit_models.zero_order.supercritical_salt_precipitation_zo module

This module contains a zero-order representation of a supercritical salt precipitation unit.

class watertap.unit_models.zero_order.supercritical_salt_precipitation_zo.SaltPrecipitationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SaltPrecipitationZO) New instance

class watertap.unit_models.zero_order.supercritical_salt_precipitation_zo.SaltPrecipitationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a supercritical salt precipitation unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_supercritical_salt_precipitation(blk)

General method for costing supercritical salt precipitation unit.

watertap.unit_models.zero_order.surface_discharge_zo module

This module contains a zero-order representation of a surface discharge unit operation.

class watertap.unit_models.zero_order.surface_discharge_zo.SurfaceDischargeData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a surface discharge unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_surface_discharge(blk)

General method for costing surface discharge. Capital cost is based on construction and pipe costs.

class watertap.unit_models.zero_order.surface_discharge_zo.SurfaceDischargeZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SurfaceDischargeZO) New instance

watertap.unit_models.zero_order.sw_onshore_intake_zo module

This module contains a zero-order representation of seawater onshore intake unit operation.

class watertap.unit_models.zero_order.sw_onshore_intake_zo.SWOnshoreIntakeZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(SWOnshoreIntakeZO) New instance

class watertap.unit_models.zero_order.sw_onshore_intake_zo.SWOnshoreIntakeZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for SW onshore intake operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.tramp_oil_tank_zo module

This module contains a zero-order representation of a tramp oil tank unit operation.

class watertap.unit_models.zero_order.tramp_oil_tank_zo.TrampOilTankZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(TrampOilTankZO) New instance

class watertap.unit_models.zero_order.tramp_oil_tank_zo.TrampOilTankZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a tramp oil tank unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.tri_media_filtration_zo module

This module contains a zero-order representation of a tri media filtration unit operation.

class watertap.unit_models.zero_order.tri_media_filtration_zo.TriMediaFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(TriMediaFiltrationZO) New instance

class watertap.unit_models.zero_order.tri_media_filtration_zo.TriMediaFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Tri Media Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.ultra_filtration_zo module

This module contains a zero-order representation of an ultra filtration unit operation.

class watertap.unit_models.zero_order.ultra_filtration_zo.UltraFiltrationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(UltraFiltrationZO) New instance

class watertap.unit_models.zero_order.ultra_filtration_zo.UltraFiltrationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for an Ultra Filtration unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.uv_aop_zo module

This module contains a zero-order representation of a UV-AOP unit operation.

class watertap.unit_models.zero_order.uv_aop_zo.UVAOPZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(UVAOPZO) New instance

class watertap.unit_models.zero_order.uv_aop_zo.UVAOPZOData(component)

Bases: UVZOData, AOPAdditionMixin

Zero-Order model for a UV-AOP unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.uv_zo module

This module contains a zero-order representation of a UV reactor unit operation.

class watertap.unit_models.zero_order.uv_zo.UVZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(UVZO) New instance

class watertap.unit_models.zero_order.uv_zo.UVZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a UV unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_uv(blk)

General method for costing UV reactor units. Capital cost is based on the inlet flow, UV reduced equivalent dosage, and UV transmittance at the inlet.

watertap.unit_models.zero_order.vfa_recovery_zo module

This module contains a zero-order representation of a general unit that recovers volatile fatty acids (VFAs).

class watertap.unit_models.zero_order.vfa_recovery_zo.VFARecoveryZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(VFARecoveryZO) New instance

class watertap.unit_models.zero_order.vfa_recovery_zo.VFARecoveryZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a VFA recovery unit.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_vfa_recovery(blk)

Method for costing VFA recovery unit.

watertap.unit_models.zero_order.waiv_zo module

This module contains a zero-order representation of a wind-aided intensified evaporation unit operation.

class watertap.unit_models.zero_order.waiv_zo.WAIVZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(WAIVZO) New instance

class watertap.unit_models.zero_order.waiv_zo.WAIVZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Wind-Aided Intensified Evaporation unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.walnut_shell_filter_zo module

This module contains a zero-order representation of a walnut shell filter unit operation.

class watertap.unit_models.zero_order.walnut_shell_filter_zo.WalnutShellFilterZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(WalnutShellFilterZO) New instance

class watertap.unit_models.zero_order.walnut_shell_filter_zo.WalnutShellFilterZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a Walnut Shell Filter unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.water_pumping_station_zo module

This module contains a zero-order representation of a water pumping station.

class watertap.unit_models.zero_order.water_pumping_station_zo.WaterPumpingStationZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

  fix_pump_power

  Indicates whether pump power should be fixed by the user or not. default - True. Valid values: { True - pump power (variable name “electricity”) will be fixed by user and lift_height will not be fixed, False - pump power (variable name “electricity”) is left unfixed and lift_height will be fixed,}

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(WaterPumpingStationZO) New instance

class watertap.unit_models.zero_order.water_pumping_station_zo.WaterPumpingStationZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for SW onshore intake operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

watertap.unit_models.zero_order.well_field_zo module

This module contains a zero-order representation of a well field unit operation.

class watertap.unit_models.zero_order.well_field_zo.WellFieldZO(*args, **kwds)

Bases: ProcessBlock

Parameters:

• rule (function) – A rule function or None. Default rule calls build().

• concrete (bool) – If True, make this a toplevel model. Default - False.

• ctype (class) –

  Pyomo ctype of the block. Default - pyomo.environ.Block

  Config args

  dynamic

  All zero-order models are steady-state only

  has_holdup

  Zero order models do not include holdup

  property_package

  Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock object.}

  property_package_args

  A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: {see property package for documentation.}

  database

  An instance of a WaterTAP Database to use for parameters.

  process_subtype

  Process subtype to use when looking up parameters from database.

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries with config arguments as keys.

• idx_map (function) – Function to take the index of a BlockData element and return the index in the initialize dict from which to read arguments. This can be provided to override the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(WellFieldZO) New instance

class watertap.unit_models.zero_order.well_field_zo.WellFieldZOData(component)

Bases: ZeroOrderBaseData

Zero-Order model for a well field unit operation.

build()

General build method for UnitModelBlockData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None –

Returns:

None

static cost_well_field(blk)

General method for costing well fields. Capital cost is based on well field construction and pipe costs.

Module contents