Product Block

Product Block#

Product Blocks are used to represent sinks of material in Flowsheets. These can be used as a convenient way to mark the final destination of a material stream and to view the state of that material.

Degrees of Freedom#

Product blocks generally have zero degrees of freedom.

Model Structure#

Product Blocks consists of a single StateBlock (named properties), each with one Inlet Port (named inlet). Product Blocks also contain References to the state variables defined within the StateBlock

Additional Constraints#

Product Blocks write no additional constraints to the model.

Variables#

Product blocks add no additional Variables.

Initialization#

idaes.models.unit_models.product.ProductInitializer#

alias of FeedInitializer

Product Class#

class idaes.models.unit_models.product.Product(*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. Product blocks are always steady- state.

    has_holdup

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

(Product) New instance

ProductData Class#

class idaes.models.unit_models.product.ProductData(component)[source]#

Standard Product Block Class

build()[source]#

Begin building model.

Parameters:

None

Returns:

None

default_initializer#

alias of FeedInitializer

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

This method calls the initialization method of the state 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 = None).

  • 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