Stream Scaler Block

Stream Scaler Block#

Stream Scaler Blocks are used to adjust size of streams to represent, for example, a stream being split across several identical units, which are then all modeled as a single IDAES unit

Degrees of Freedom#

Stream Scaler blocks have one degree of freedom (beyond the state variables in the StateBlock properties), a Var called multiplier. It is the factor by which extensive state variables (defined as those having “flow” in their name) are scaled, with output_var = multiplier * input_var.

Model Structure#

Stream Scaler Blocks consists of a single StateBlock (named properties), each with an inlet and outlet port.

Additional Constraints#

Stream Scaler Blocks write no additional constraints* (besides those naturally occurring in StateBlocks).

Variables#

Stream Scaler blocks add no additional Variables.

Initialization#

idaes.models.unit_models.stream_scaler.StreamScalerInitializer#

alias of FeedInitializer

StreamScaler Class#

class idaes.models.unit_models.stream_scaler.StreamScaler(*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

    dynamic

    Indicates whether this model will be dynamic or not, default = False. Scaler blocks are always steady- state.

    has_holdup

    Scaler blocks do not contain holdup, thus this must be False.

    property_package

    Property parameter object used to define property calculations, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PropertyParameterObject - a PropertyParameterBlock object.}

    property_package_args

    A ConfigBlock with arguments to be passed to a property block(s) and used when constructing these, default - None. Valid values: { see property package for documentation.}

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

(StreamScaler) New instance

StreamScalerData Class#

class idaes.models.unit_models.stream_scaler.StreamScalerData(component)[source]#

Unit model to adjust size of streams to represent, for example, a stream being split across several identical units, which are then all modeled as a single IDAES unit

build()[source]#

General build method for StreamScalerData. This method calls a number of sub-methods which automate the construction of expected attributes of unit models.

Inheriting models should call super().build.

Parameters:

None

Returns:

None

default_initializer#

alias of FeedInitializer

initialize_build(outlvl=0, optarg=None, solver=None, hold_state=False)[source]#

Initialization routine for StreamScaler.

Keyword Arguments:

  • outlvl – sets output level of initialization routine

  • optarg – solver options dictionary object (default=None, use default solver options)

  • solver – str indicating which solver to use during initialization (default = None, use default solver)

  • hold_state – flag indicating whether the initialization routine should unfix any state variables fixed during initialization, default - False. Valid values: True - states variables are not unfixed, and a dict of returned containing flags for which states were fixed during initialization, False - state variables are unfixed after initialization by calling the release_state method.

Returns:

If hold_states is True, returns a dict containing flags for which states were fixed during initialization.

release_state(flags, outlvl=0)[source]#

Method to release state variables fixed during initialization.

Keyword Arguments:

  • flags – dict containing information of which state variables were fixed during initialization, and should now be unfixed. This dict is returned by initialize if hold_state = True.

  • outlvl – sets output level of logging

Returns:

None