watertap.property_models.unit_specific package

Subpackages

• watertap.property_models.unit_specific.activated_sludge package
  • Submodules
  • watertap.property_models.unit_specific.activated_sludge.asm1_properties module
    • ASM1ParameterBlock
    • ASM1ParameterData
      • ASM1ParameterData.build()
      • ASM1ParameterData.define_metadata()
    • ASM1StateBlock
    • ASM1StateBlockData
      • ASM1StateBlockData.build()
      • ASM1StateBlockData.define_display_vars()
      • ASM1StateBlockData.define_state_vars()
      • ASM1StateBlockData.get_energy_density_terms()
      • ASM1StateBlockData.get_enthalpy_flow_terms()
      • ASM1StateBlockData.get_material_density_terms()
      • ASM1StateBlockData.get_material_flow_basis()
      • ASM1StateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.activated_sludge.asm1_reactions module
    • ASM1ReactionBlock
    • ASM1ReactionBlockData
      • ASM1ReactionBlockData.build()
      • ASM1ReactionBlockData.get_reaction_rate_basis()
    • ASM1ReactionParameterBlock
    • ASM1ReactionParameterData
      • ASM1ReactionParameterData.build()
      • ASM1ReactionParameterData.define_metadata()
  • watertap.property_models.unit_specific.activated_sludge.asm2d_properties module
    • ASM2dParameterBlock
    • ASM2dParameterData
      • ASM2dParameterData.build()
      • ASM2dParameterData.define_metadata()
    • ASM2dStateBlock
    • ASM2dStateBlockData
      • ASM2dStateBlockData.build()
      • ASM2dStateBlockData.define_display_vars()
      • ASM2dStateBlockData.define_state_vars()
      • ASM2dStateBlockData.get_energy_density_terms()
      • ASM2dStateBlockData.get_enthalpy_flow_terms()
      • ASM2dStateBlockData.get_material_density_terms()
      • ASM2dStateBlockData.get_material_flow_basis()
      • ASM2dStateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.activated_sludge.asm2d_reactions module
    • ASM2dReactionBlock
    • ASM2dReactionBlockData
      • ASM2dReactionBlockData.build()
      • ASM2dReactionBlockData.get_reaction_rate_basis()
    • ASM2dReactionParameterBlock
    • ASM2dReactionParameterData
      • ASM2dReactionParameterData.build()
      • ASM2dReactionParameterData.define_metadata()
  • watertap.property_models.unit_specific.activated_sludge.modified_asm2d_properties module
    • ModifiedASM2dParameterBlock
    • ModifiedASM2dParameterData
      • ModifiedASM2dParameterData.build()
      • ModifiedASM2dParameterData.define_metadata()
    • ModifiedASM2dStateBlock
    • ModifiedASM2dStateBlockData
      • ModifiedASM2dStateBlockData.build()
      • ModifiedASM2dStateBlockData.define_display_vars()
      • ModifiedASM2dStateBlockData.define_state_vars()
      • ModifiedASM2dStateBlockData.get_energy_density_terms()
      • ModifiedASM2dStateBlockData.get_enthalpy_flow_terms()
      • ModifiedASM2dStateBlockData.get_material_density_terms()
      • ModifiedASM2dStateBlockData.get_material_flow_basis()
      • ModifiedASM2dStateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.activated_sludge.modified_asm2d_reactions module
    • ModifiedASM2dReactionBlock
    • ModifiedASM2dReactionBlockData
      • ModifiedASM2dReactionBlockData.build()
      • ModifiedASM2dReactionBlockData.get_reaction_rate_basis()
    • ModifiedASM2dReactionParameterBlock
    • ModifiedASM2dReactionParameterData
      • ModifiedASM2dReactionParameterData.build()
      • ModifiedASM2dReactionParameterData.define_metadata()
  • watertap.property_models.unit_specific.activated_sludge.simple_modified_asm2d_properties module
    • SimpleModifiedASM2dParameterBlock
    • SimpleModifiedASM2dParameterData
      • SimpleModifiedASM2dParameterData.build()
    • SimpleModifiedASM2dStateBlock
    • SimpleModifiedASM2dStateBlockData
  • watertap.property_models.unit_specific.activated_sludge.simple_modified_asm2d_reactions module
    • SimpleModifiedASM2dReactionBlock
    • SimpleModifiedASM2dReactionBlockData
    • SimpleModifiedASM2dReactionParameterBlock
    • SimpleModifiedASM2dReactionParameterData
      • SimpleModifiedASM2dReactionParameterData.build()
  • Module contents
• watertap.property_models.unit_specific.anaerobic_digestion package
  • Submodules
  • watertap.property_models.unit_specific.anaerobic_digestion.adm1_properties module
    • ADM1ParameterBlock
    • ADM1ParameterData
      • ADM1ParameterData.build()
      • ADM1ParameterData.define_metadata()
    • ADM1StateBlock
    • ADM1StateBlockData
      • ADM1StateBlockData.build()
      • ADM1StateBlockData.define_display_vars()
      • ADM1StateBlockData.define_state_vars()
      • ADM1StateBlockData.get_energy_density_terms()
      • ADM1StateBlockData.get_enthalpy_flow_terms()
      • ADM1StateBlockData.get_material_density_terms()
      • ADM1StateBlockData.get_material_flow_basis()
      • ADM1StateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.anaerobic_digestion.adm1_properties_vapor module
    • ADM1_vaporParameterBlock
    • ADM1_vaporParameterData
      • ADM1_vaporParameterData.build()
      • ADM1_vaporParameterData.define_metadata()
    • ADM1_vaporStateBlock
    • ADM1_vaporStateBlockData
      • ADM1_vaporStateBlockData.build()
      • ADM1_vaporStateBlockData.define_display_vars()
      • ADM1_vaporStateBlockData.define_state_vars()
      • ADM1_vaporStateBlockData.get_energy_density_terms()
      • ADM1_vaporStateBlockData.get_enthalpy_flow_terms()
      • ADM1_vaporStateBlockData.get_material_density_terms()
      • ADM1_vaporStateBlockData.get_material_flow_basis()
      • ADM1_vaporStateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.anaerobic_digestion.adm1_reactions module
    • ADM1ReactionBlock
    • ADM1ReactionBlockData
      • ADM1ReactionBlockData.build()
      • ADM1ReactionBlockData.get_reaction_rate_basis()
    • ADM1ReactionParameterBlock
    • ADM1ReactionParameterData
      • ADM1ReactionParameterData.build()
      • ADM1ReactionParameterData.define_metadata()
  • watertap.property_models.unit_specific.anaerobic_digestion.modified_adm1_properties module
    • ModifiedADM1ParameterBlock
    • ModifiedADM1ParameterData
      • ModifiedADM1ParameterData.build()
      • ModifiedADM1ParameterData.define_metadata()
    • ModifiedADM1StateBlock
    • ModifiedADM1StateBlockData
      • ModifiedADM1StateBlockData.build()
      • ModifiedADM1StateBlockData.define_display_vars()
      • ModifiedADM1StateBlockData.define_state_vars()
      • ModifiedADM1StateBlockData.get_energy_density_terms()
      • ModifiedADM1StateBlockData.get_enthalpy_flow_terms()
      • ModifiedADM1StateBlockData.get_material_density_terms()
      • ModifiedADM1StateBlockData.get_material_flow_basis()
      • ModifiedADM1StateBlockData.get_material_flow_terms()
  • watertap.property_models.unit_specific.anaerobic_digestion.modified_adm1_reactions module
    • ModifiedADM1ReactionBlock
    • ModifiedADM1ReactionBlockData
      • ModifiedADM1ReactionBlockData.build()
      • ModifiedADM1ReactionBlockData.get_reaction_rate_basis()
    • ModifiedADM1ReactionParameterBlock
    • ModifiedADM1ReactionParameterData
      • ModifiedADM1ReactionParameterData.build()
      • ModifiedADM1ReactionParameterData.define_metadata()
  • Module contents

Submodules

watertap.property_models.unit_specific.NDMA_prop_pack module

Initial property package for H2O-NDMA system

class watertap.property_models.unit_specific.NDMA_prop_pack.NDMAParameterBlock(*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

  default_arguments

  Default arguments to use with Property Package

• 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:

(NDMAParameterBlock) New instance

class watertap.property_models.unit_specific.NDMA_prop_pack.NDMAParameterData(component)

Bases: PhysicalParameterBlock

build()

Callable method for Block construction.

classmethod define_metadata(obj)

Define properties supported and units.

class watertap.property_models.unit_specific.NDMA_prop_pack.NDMAStateBlock(*args, **kwds)

Bases: _NDMAStateBlock

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

  parameters

  A reference to an instance of the Property Parameter Block associated with this property package.

  defined_state

  Flag indicating whether the state should be considered fully defined, and thus whether constraints such as sum of mass/mole fractions should be included, default - False. Valid values: { True - state variables will be fully defined, False - state variables will not be fully defined.}

  has_phase_equilibrium

  Flag indicating whether phase equilibrium constraints should be constructed in this state block, default - True. Valid values: { True - StateBlock should calculate phase equilibrium, False - StateBlock should not calculate phase equilibrium.}

• 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:

(NDMAStateBlock) New instance

class watertap.property_models.unit_specific.NDMA_prop_pack.NDMAStateBlockData(*args, **kwargs)

Bases: StateBlockData

build()

Callable method for Block construction.

define_state_vars()

Define state vars.

get_enthalpy_flow_terms(p)

Create enthalpy flow terms.

get_material_flow_basis()

Method which returns an Enum indicating the basis of the material flow term.

get_material_flow_terms(p, j)

Create material flow terms for control volume.

watertap.property_models.unit_specific.coagulation_prop_pack module

Initial property package for water treatment via a Coagulation-Flocculation process

class watertap.property_models.unit_specific.coagulation_prop_pack.CoagulationParameterBlock(*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

  default_arguments

  Default arguments to use with Property Package

• 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:

(CoagulationParameterBlock) New instance

class watertap.property_models.unit_specific.coagulation_prop_pack.CoagulationParameterData(component)

Bases: PhysicalParameterBlock

build()

Callable method for Block construction.

classmethod define_metadata(obj)

Define properties supported and units.

class watertap.property_models.unit_specific.coagulation_prop_pack.CoagulationStateBlock(*args, **kwds)

Bases: _CoagulationStateBlock

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

  parameters

  A reference to an instance of the Property Parameter Block associated with this property package.

  defined_state

  Flag indicating whether the state should be considered fully defined, and thus whether constraints such as sum of mass/mole fractions should be included, default - False. Valid values: { True - state variables will be fully defined, False - state variables will not be fully defined.}

  has_phase_equilibrium

  Flag indicating whether phase equilibrium constraints should be constructed in this state block, default - True. Valid values: { True - StateBlock should calculate phase equilibrium, False - StateBlock should not calculate phase equilibrium.}

• 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:

(CoagulationStateBlock) New instance

class watertap.property_models.unit_specific.coagulation_prop_pack.CoagulationStateBlockData(*args, **kwargs)

Bases: StateBlockData

build()

Callable method for Block construction.

define_state_vars()

Define state vars.

get_enthalpy_flow_terms(p)

Create enthalpy flow terms.

get_material_flow_basis()

Method which returns an Enum indicating the basis of the material flow term.

get_material_flow_terms(p, j)

Create material flow terms for control volume.

watertap.property_models.unit_specific.cryst_prop_pack module

Initial crystallization property package for H2O-NaCl system

class watertap.property_models.unit_specific.cryst_prop_pack.HeatOfCrystallizationModel(value)

Bases: Enum

An enumeration.

class watertap.property_models.unit_specific.cryst_prop_pack.NaClParameterBlock(*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

  default_arguments

  Default arguments to use with Property Package

  heat_of_crystallization_model

  Options to account for heat of crystallization value for NaCl.

  default - HeatOfCrystallizationModel.constant

  Configuration Options	Description
  HeatOfCrystallizationModel.constant	Fixed heat of crystallization for NaCl based on literature
  HeatOfCrystallizationModel.zero	Zero heat of crystallization assumption
  HeatOfCrystallizationModel.temp_dependent	Temperature-dependent heat of crystallization for NaCl

• 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:

(NaClParameterBlock) New instance

class watertap.property_models.unit_specific.cryst_prop_pack.NaClParameterData(component)

Bases: PhysicalParameterBlock

build()

General build method for PropertyParameterBlocks. Inheriting models should call super().build.

Parameters:

None –

Returns:

None

classmethod define_metadata(obj)

Set all the metadata for properties and units.

This method should be implemented by subclasses. In the implementation, they should set information into the object provided as an argument.

Parameters:

pcm (PropertyClassMetadata) – Add metadata to this object.

Returns:

None

class watertap.property_models.unit_specific.cryst_prop_pack.NaClStateBlock(*args, **kwds)

Bases: _NaClStateBlock

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

  parameters

  A reference to an instance of the Property Parameter Block associated with this property package.

  defined_state

  Flag indicating whether the state should be considered fully defined, and thus whether constraints such as sum of mass/mole fractions should be included, default - False. Valid values: { True - state variables will be fully defined, False - state variables will not be fully defined.}

  has_phase_equilibrium

  Flag indicating whether phase equilibrium constraints should be constructed in this state block, default - True. Valid values: { True - StateBlock should calculate phase equilibrium, False - StateBlock should not calculate phase equilibrium.}

• 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:

(NaClStateBlock) New instance

class watertap.property_models.unit_specific.cryst_prop_pack.NaClStateBlockData(*args, **kwargs)

Bases: StateBlockData

build()

Callable method for Block construction.

define_state_vars()

Define state vars.

get_enthalpy_flow_terms(p)

Create enthalpy flow terms.

get_material_flow_basis()

Method which returns an Enum indicating the basis of the material flow term.

get_material_flow_terms(p, j)

Create material flow terms for control volume.

Module contents