watertap.examples.flowsheets.full_treatment_train.model_components package

Subpackages

Submodules

watertap.examples.flowsheets.full_treatment_train.model_components.property_models module

Seawater feed specifications for supported property packages

watertap.examples.flowsheets.full_treatment_train.model_components.property_models.build_prop(m, base='TDS')[source]

Builds a property package for the specified base. Includes default scaling. Bases include: ‘TDS’, ‘ion’, ‘salt’.

watertap.examples.flowsheets.full_treatment_train.model_components.property_models.specify_feed(sb, base='TDS')[source]

Fixes the state variables on the stateblock to the base seawater composition for the specified base. Bases include: ‘TDS’, ‘ion’, ‘salt’.

watertap.examples.flowsheets.full_treatment_train.model_components.seawater_ion_prop_pack module

Simple property package for Na-Ca-Mg-SO4-Cl solution represented with ions

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_ion_prop_pack.PropParameterBlock(*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

(PropParameterBlock) New instance

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_ion_prop_pack.PropParameterData(component)[source]

Bases: PhysicalParameterBlock

build()[source]

Callable method for Block construction.

classmethod define_metadata(obj)[source]

Define properties supported and units.

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_ion_prop_pack.PropStateBlock(*args, **kwds)

Bases: _PropStateBlock

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

(PropStateBlock) New instance

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_ion_prop_pack.PropStateBlockData(*args, **kwargs)[source]

Bases: StateBlockData

build()[source]

Callable method for Block construction.

define_state_vars()[source]

Define state vars.

get_enthalpy_flow_terms(p)[source]

Create enthalpy flow terms.

get_material_flow_basis()[source]

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

get_material_flow_terms(p, j)[source]

Create material flow terms for control volume.

watertap.examples.flowsheets.full_treatment_train.model_components.seawater_salt_prop_pack module

Simple property package for Na-Ca-Mg-SO4-Cl solution represented with salts

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_salt_prop_pack.PropParameterBlock(*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

(PropParameterBlock) New instance

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_salt_prop_pack.PropParameterData(component)[source]

Bases: PhysicalParameterBlock

build()[source]

Callable method for Block construction.

classmethod define_metadata(obj)[source]

Define properties supported and units.

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_salt_prop_pack.PropStateBlock(*args, **kwds)

Bases: _PropStateBlock

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

(PropStateBlock) New instance

class watertap.examples.flowsheets.full_treatment_train.model_components.seawater_salt_prop_pack.PropStateBlockData(*args, **kwargs)[source]

Bases: StateBlockData

build()[source]

Callable method for Block construction.

define_state_vars()[source]

Define state vars.

get_enthalpy_flow_terms(p)[source]

Create enthalpy flow terms.

get_material_flow_basis()[source]

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

get_material_flow_terms(p, j)[source]

Create material flow terms for control volume.

watertap.examples.flowsheets.full_treatment_train.model_components.unit_0DRO module

0D reverse osmosis examples

watertap.examples.flowsheets.full_treatment_train.model_components.unit_0DRO.build_RO(m, base='TDS', level='simple', name_str='RO')[source]

Builds a 0DRO model at a specified level (simple or detailed). Requires prop_TDS property package.

watertap.examples.flowsheets.full_treatment_train.model_components.unit_1DRO module

1D reverse osmosis examples

watertap.examples.flowsheets.full_treatment_train.model_components.unit_1DRO.build_RO(m, base='TDS', level='simple', name_str='RO')[source]

Builds a 1DRO model at a specified level (simple or detailed). Requires prop_TDS property package.

watertap.examples.flowsheets.full_treatment_train.model_components.unit_ZONF module

Zero order nanofiltration model based on specifying solvent flux and solute rejection

watertap.examples.flowsheets.full_treatment_train.model_components.unit_ZONF.build_ZONF(m, base='ion')[source]

Builds a ZONF model based on specified rejection and solvent flux. Requires prop_ion property package.

watertap.examples.flowsheets.full_treatment_train.model_components.unit_separator module

Simple zero order separator examples

watertap.examples.flowsheets.full_treatment_train.model_components.unit_separator.build_SepNF(m, base='ion')[source]

Builds NF model based on the IDAES separator for a specified property base. Requires prop_ion or prop_salt property package.

watertap.examples.flowsheets.full_treatment_train.model_components.unit_separator.build_SepRO(m, base='TDS')[source]

Builds RO model based on the IDAES separator. Requires prop_TDS property package.

Module contents