StateJunction Block

StateJunction Block#

The IDAES StateJunction block represents a pass-through unit or simple pipe with no holdup. The primary use for this unit is in conceptual design applications for linking Arcs to/from different process alternatives.

Degrees of Freedom#

StateJunctions have no degrees of freedom.

Model Structure#

A StateJunction consists of a single StateBlock with two Ports (inlet and outlet), where the state variables in the state block are simultaneously connected to both Ports.

Additional Constraints#

StateJunctions write no additional constraints beyond those in the StateBlock.

Variables#

StateJunctions have no additional variables.

Initialization#

idaes.models.unit_models.statejunction.StateJunctionInitializer#

alias of FeedInitializer

StateJunction Class#

class idaes.models.unit_models.statejunction.StateJunction(*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 unit will be dynamic or not, default = False.

    has_holdup

    Indicates whether holdup terms should be constructed or not. default - False. StateJunctions do not have defined volume, thus this must be False.

    property_package

    Property parameter object used to define property state block, default - useDefault. Valid values: { useDefault - use default package from parent model or flowsheet, PhysicalParameterObject - a PhysicalParameterBlock 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:

(StateJunction) New instance

StateJunctionData Class#

class idaes.models.unit_models.statejunction.StateJunctionData(component)[source]#

Standard StateJunction Unit Model Class

build()[source]#

Begin building model. :param None:

Returns:

None

default_initializer#

alias of FeedInitializer

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

This method initializes the StateJunction block by calling the initialize method on the property block.

Keyword Arguments:

  • state_args – a dict of arguments to be passed to the property package(s) to provide an initial state for initialization (see documentation of the specific property package) (default = {}).

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

Returns:

None

Contents