idaes.examples.properties.Workshop_Module_2 package

Submodules

idaes.examples.properties.Workshop_Module_2.hda_ideal_VLE module

idaes.examples.properties.Workshop_Module_2.hda_reaction module

Property package for the hydrodealkylation of toluene to form benzene

class idaes.examples.properties.Workshop_Module_2.hda_reaction.HDAReactionBlock(*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:

(HDAReactionBlock) New instance

class idaes.examples.properties.Workshop_Module_2.hda_reaction.HDAReactionBlockData(component)[source]

An example reaction package for saponification of ethyl acetate

build()[source]

Callable method for Block construction

get_reaction_rate_basis()[source]

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

class idaes.examples.properties.Workshop_Module_2.hda_reaction.HDAReactionParameterBlock(*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:

(HDAReactionParameterBlock) New instance

class idaes.examples.properties.Workshop_Module_2.hda_reaction.HDAReactionParameterData(component)[source]

Property Parameter Block Class

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

build()[source]

Callable method for Block construction.

classmethod define_metadata(obj)[source]

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.examples.properties.Workshop_Module_2.hda_reaction.ReactionBlock(*args, **kwargs)[source]

This Class contains methods which should be applied to Reaction Blocks as a whole, rather than individual elements of indexed Reaction Blocks.

initialize(outlvl=0, **kwargs)[source]

Initialization routine for reaction package.

Keyword Arguments:
 outlvl

sets output level of initialization routine

  • 0 = no output (default)
  • 1 = report after each step
Returns:None