Ctrl+K

Phase Class

Contents

Phase Class#

class idaes.core.base.phases.Phase(*args, **kwds)#
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

    component_list

    List of components which are present in phase. This is used to construct the phase-component Set for the property package.

    equation_of_state

    A valid Python class with the necessary methods for constructing the desired equation of state (or similar model).

    equation_of_state_options

    A dict or ConfigBlock of options to be used when setting up equation of state for phase.

    parameter_data

    Dict containing initialization data for parameters

    _phase_list_exists

    Internal config argument indicating whether phase_list needs to be populated.

    therm_cond_phase

    Method to calculate thermal conductivity phase

    surf_tens_phase

    Method to calculate surface tension of phase

    visc_d_phase

    Method to calculate dynamic viscosity of phase

    transport_property_options

    Options for transport properties like viscosity, surface tension, and thermal conductivity

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

(Phase) New instance

Phase Type Enum#

In some cases, it is useful to be able to indicate a given type of phase, rather than an instance specific Phase class; an example would be indicating the set of valid phases for a given chemical species. In these cases, the PhaseType Enum can be used, which enumerates the different types of phases recognized by the IDAES framework.

The PhaseType Enum has the following possible values:

  • liquidPhase (1)

  • vaporPhase (2)

  • solidPhase (3)

Contents