idaes.examples.workshops.Module_3_Custom_Unit_Model package

Submodules

idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_param_VLE module

Example property package for the VLE calucations for the methanol synthesis problem from Turkay & Grossmann. The parameters and correlations are from the paper.

class idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_param_VLE.PhysicalParameterBlock(*args, **kwargs)

Parameters:

• rule (function) – A rule function or None. Default rule calls build().
• concrete (bool) – If True, make this a toplevel model. Default - False.
• ctype (str) – Pyomo ctype of the block. Default - “Block”
• default (dict) –

  Default ProcessBlockData config

  Keys

  default_arguments

  Default arguments to use with Property Package

  valid_phase

  Flag indicating the valid phase for a given set of conditions, and thus corresponding constraints should be included, default - (‘Vap’, ‘Liq’). Valid values: { ‘Liq’ - Liquid only, ‘Vap’ - Vapor only, (‘Vap’, ‘Liq’) - Vapor-liquid equilibrium, (‘Liq’, ‘Vap’) - Vapor-liquid equilibrium,}

  Cp

  Value for the constant pressure heat capacity, default = 0.035 MJ/(kgmol K)

• initialize (dict) – ProcessBlockData config for individual elements. Keys are BlockData indexes and values are dictionaries described under the “default” argument above.
• 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 overide the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(PhysicalParameterBlock) New instance

class idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_param_VLE.PhysicalParameterData(component)

Property Parameter Block Class.

build()

Callable method for Block construction.

classmethod define_metadata(obj)

Define properties supported and units.

idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_state_block_VLE module

Property package for ideal VLE calucations for the methanol synthesis problem. Correlations from Turkay and Grossmann paper. See Latex files for details.

class idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_state_block_VLE.IdealStateBlock(*args, **kwargs)

Parameters:

• rule (function) – A rule function or None. Default rule calls build().
• concrete (bool) – If True, make this a toplevel model. Default - False.
• ctype (str) – Pyomo ctype of the block. Default - “Block”
• default (dict) –

  Default ProcessBlockData config

  Keys

  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 described under the “default” argument above.
• 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 overide the default behavior of matching the BlockData index exactly to the index in initialize.

Returns:

(IdealStateBlock) New instance

class idaes.examples.workshops.Module_3_Custom_Unit_Model.methanol_state_block_VLE.StateBlockData(component)

An example property package for ideal VLE.

build()

Callable method for Block construction.

define_state_vars()

Define state vars.

get_enthalpy_density_terms(p)

Create enthalpy density terms.

get_enthalpy_flow_terms(p)

Create enthalpy flow terms [MJ/s].

get_material_density_terms(p, j)

Create material density 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.

model_check()

Model checks for property block.