idaes.property_models.examples package

Submodules

idaes.property_models.examples.methane_combustion_ideal module

Example property package for the combustion of methane in air using Gibbs energy minimisation.

class idaes.property_models.examples.methane_combustion_ideal.MethaneCombustionParameterBlock(*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

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

(MethaneCombustionParameterBlock) New instance

class idaes.property_models.examples.methane_combustion_ideal.MethaneCombustionStateBlock(*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:

(MethaneCombustionStateBlock) New instance

class idaes.property_models.examples.methane_combustion_ideal.MethaneCombustionStateBlockData(component)

An example property package for ideal gas properties with Gibbs energy

build()

Callable method for Block construction

define_state_vars()

Method that returns a dictionary of state variables used in property package. Implement a placeholder method which returns an Exception to force users to overload this.

get_enthalpy_density_terms(p)

Method which returns a valid expression for enthalpy density to use in the energy balances.

get_enthalpy_flow_terms(p)

Method which returns a valid expression for enthalpy flow to use in the energy balances.

get_material_density_terms(p, j)

Method which returns a valid expression for material density to use in the material balances .

get_material_flow_terms(p, j)

Method which returns a valid expression for material flow to use in the material balances.

model_check()

Model checks for property block

class idaes.property_models.examples.methane_combustion_ideal.PhysicalParameterData(component)

Property Parameter Block Class

Contains parameters and indexing sets associated with properties for superheated steam.

build()

Callable method for Block construction.

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

idaes.property_models.examples.saponification_reactions module

Example property package for the saponification of Ethyl Acetate with NaOH Assumes dilute solutions with properties of H2O.

class idaes.property_models.examples.saponification_reactions.ReactionBlock(*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 Reaction Parameter Block associated with this property package.

  state_block

  A reference to an instance of a StateBlock with which this reaction block should be associated.

  has_equilibrium

  Flag indicating whether equilibrium constraints should be constructed in this reaction block, default - True. Valid values: { True - ReactionBlock should enforce equilibrium constraints, False - ReactionBlock should not enforce equilibrium constraints.}

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

(ReactionBlock) New instance

class idaes.property_models.examples.saponification_reactions.ReactionBlockData(component)

An example reaction package for saponification of ethyl acetate

build()

Callable method for Block construction

get_reaction_rate_basis()

Method which returns an Enum indicating the basis of the reaction rate term.

model_check()

Model checks for property block

class idaes.property_models.examples.saponification_reactions.ReactionParameterData(component)

Property Parameter Block Class

Contains parameters and indexing sets associated with properties for superheated steam.

build()

Callable method for Block construction.

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 idaes.property_models.examples.saponification_reactions.SaponificationReactionParameterBlock(*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

  property_package

  Reference to associated PropertyPackageParameter object

  default_arguments

  Default arguments to use with Property Package

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

(SaponificationReactionParameterBlock) New instance

idaes.property_models.examples.saponification_thermo module

Example property package for the saponification of Ethyl Acetate with NaOH Assumes dilute solutions with properties of H2O.

class idaes.property_models.examples.saponification_thermo.PhysicalParameterData(component)

Property Parameter Block Class

Contains parameters and indexing sets associated with properties for superheated steam.

build()

Callable method for Block construction.

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 idaes.property_models.examples.saponification_thermo.SaponificationParameterBlock(*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

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

(SaponificationParameterBlock) New instance

class idaes.property_models.examples.saponification_thermo.SaponificationStateBlock(*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:

(SaponificationStateBlock) New instance

class idaes.property_models.examples.saponification_thermo.SaponificationStateBlockData(component)

An example property package for properties for saponification of ethyl acetate

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()

Method that returns a dictionary of state variables used in property package. Implement a placeholder method which returns an Exception to force users to overload this.

get_enthalpy_density_terms(p)

Method which returns a valid expression for enthalpy density to use in the energy balances.

get_enthalpy_flow_terms(p)

Method which returns a valid expression for enthalpy flow to use in the energy balances.

get_material_density_terms(p, j)

Method which returns a valid expression for material density to use in the material balances .

get_material_flow_basis()

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

get_material_flow_terms(p, j)

Method which returns a valid expression for material flow to use in the material balances.

model_check()

Model checks for property block