prommis.cmi_precipitator.precipitate_properties

Precipitate property package for optimization-based precipitator model.

Authors: Chris Laliwala

class prommis.cmi_precipitator.precipitate_properties.PrecipitateParameter(*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

  default_arguments

  Default arguments to use with Property Package

  precipitate_comp_list

  List of precipitate components in process.

  logkeq_dict

  Dictionary of precipitation-forming equilibrium reaction constants

  stoich_dict

  Dictionary of precipitate stoichiometry for each reaction.

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

(PrecipitateParameter) New instance

class prommis.cmi_precipitator.precipitate_properties.PrecipitateParameterData(component)

Property package for precipitate species.

This property package requires that the user pass in a list of precipitate components (precipitate_comp_list), a dictionary of the precipitate-forming equilibrium reaction constants (logkeq_dict), and a dictionary containing the precipitate stoichiometry for each reaction (stoich_dict).

build()

Callable method for block construction.

classmethod define_metadata(obj)

Define properties supported and units.

class prommis.cmi_precipitator.precipitate_properties.PrecipitateStateBlock(*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

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

(PrecipitateStateBlock) New instance

class prommis.cmi_precipitator.precipitate_properties.PrecipitateStateBlockData(*args, **kwargs)

State block for the precipitate species.

build()

General build method for StateBlockDatas.

Parameters:

None

Returns:

None

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

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