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)[source]

Bases: ZeroOrderBaseData

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

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an aeration basin unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an Air Flotation unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a reactive anaerobic digestion unit.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a bioreactor unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Blending Reservoir unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a brine concentrator unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Buffer Tank unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Cartridge Filtration unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a centrifuge reactor unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a chemical addition unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Chlorination unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Clarifier unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a CO2 addition unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for cofermentation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for constructed wetlands.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for the conventional activated sludge process.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Cooling Supply unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a cooling tower unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Decarbonator unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a DMBR unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an electrochemical nutrient recovery unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an electrodialysis reversal unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an Energy Recovery unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a evaporation pond unit.

build()[source]

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_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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: InitializationMixin, FeedData

Zero-Order feed block.

build()[source]

Begin building model.

Parameters: None –
Returns: None

initialize_build(state_args=None, outlvl=0, solver=None, optarg=None)[source]

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)[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a filter press unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an Ion exchange unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

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()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a intrusion mitigation unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an Ion exchange unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a landfill unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a MABR unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Magprex reactor unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a membrane bioreactor unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a membrane evaporator.

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a METAB bioreactor

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a microfiltration unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a microscreen filtration unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for municipal drinking unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a municipal wastewater treatment plant.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Nanofiltration unit operation.

build()[source]

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.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)[source]

Bases: OzoneZOData

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

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Ozone unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a photothermal membrane unit.

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a primary separator unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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_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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a pump unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Screen unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a WWTP with secondary treatment.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Sedimentation unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a settling pond unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a sludge tank unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an smp unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a static mixer unit.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a storage tank unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a struvite classifier unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a suboxic activated sludge process unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a supercritical salt precipitation unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a surface discharge unit operation.

build()[source]

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

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for SW onshore intake operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a tramp oil tank unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for an Ultra Filtration unit operation.

build()[source]

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)[source]

Bases: UVZOData

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

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a UV unit operation.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a VFA recovery unit.

build()[source]

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.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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Wind-Aided Intensified Evaporation unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a Walnut Shell Filter unit operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for SW onshore intake operation.

build()[source]

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)[source]

Bases: ZeroOrderBaseData

Zero-Order model for a well field unit operation.

build()[source]

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