idaes.property_models.cubic_eos package

Submodules

idaes.property_models.cubic_eos.BT_PR module

Example Peng-Robinson parameter block for the VLE calucations for a benzene-toluene system.

Unless otherwise noted, parameters are from: “The Properties of Gases and Liquids, 4th Edition”, Reid, Prausnitz and Poling, McGraw-Hill, 1987

class idaes.property_models.cubic_eos.BT_PR.BTParameterBlock(*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,}

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

(BTParameterBlock) New instance

class idaes.property_models.cubic_eos.BT_PR.BTParameterData(component)

build()

Callable method for Block construction.

idaes.property_models.cubic_eos.cubic_prop_pack module

General Cubic Equation of State property package with VLE calucations. Cubic formulation and pure component property correlations from: “The Properties of Gases and Liquids, 4th Edition”, Reid, Prausnitz and Poling, McGraw-Hill, 1987

Smooth Vapor-Liquid Equilibrium formulation from: “A Smooth, Square Flash Formulation for Equation-Oriented Flowsheet Optimization”, Burgard et al., Proceedings of the 13 the International Symposium on Process Systems Engineering – PSE 2018, July 1-5, 2018, San Diego

All results have been cross-referenced against other sources.

class idaes.property_models.cubic_eos.cubic_prop_pack.CubicEoS

An enumeration.

class idaes.property_models.cubic_eos.cubic_prop_pack.CubicParameterBlock(*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,}

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

(CubicParameterBlock) New instance

class idaes.property_models.cubic_eos.cubic_prop_pack.CubicParameterData(component)

General Property Parameter Block Class

build()

Callable method for Block construction.

classmethod define_metadata(obj)

Define properties supported and units.

class idaes.property_models.cubic_eos.cubic_prop_pack.CubicStateBlock(*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:

(CubicStateBlock) New instance

class idaes.property_models.cubic_eos.cubic_prop_pack.CubicStateBlockData(component)

An general property package for cubic equations of state with VLE.

build()

Callable method for Block construction.

define_display_vars()

Method used to specify components to use to generate stream tables and other outputs. Defaults to define_state_vars, and developers should overload as required.

define_state_vars()

Define state vars.

get_energy_density_terms(p)

Create energy density terms.

get_enthalpy_flow_terms(p)

Create enthalpy flow terms.

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.

idaes.property_models.cubic_eos.cubic_prop_pack.cubic_roots_available()

Make sure the compiled cubic root functions are available. Yes, in Windows the .so extention is still used.