Product Block

Product Blocks are used to represent sinks of material in Flowsheets. These can be used as a conventient way to mark the final destination of a matieral 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 HoldupStatic Block (named holdup), each with one Inlet Port (named inlet).

Construction Arguments

The Product model has the following construction arguments:

  • property_package - property package to use when constructing Property Block for the Product Block (default = ‘use_parent_value’). This is provided as a Property Parameter Block by the Flowsheet when creating the model. If a value is not provided, the Holdup Block will try to use the default property package if one is defined.
  • property_package_args - set of arguments to be passed to the Property Block when they are created.
  • inlet_list - list of names to be passed to the build_inlets method (default = None).
  • num_inlets - number of inlets argument to be passed to the build_inlets method (default = None).

Additionally, Product Blocks have the following construction arguments which are passed to the Holdup Block for determining which terms to construct in the balance equations. Product Blocks do not support dynamic = True.

Argument Default Value
material_balance_type ‘component_phase’
energy_balance_type ‘enthalpy_total’
momentum_balance_type ‘pressure’
dynamic False (cannot be True)
include_holdup False
has_rate_reactions False
has_equilibrium_reactions False
has_phase_equilibrium False
has_mass_transfer False
has_heat_transfer False
has_work_transfer False
has_pressure_change False

Additional Methods

Product Blocks define an additional display() method to output the state of the product material. This method is documented below in the ProductData Class section.

Additional Constraints

Product Blocks write no additional constraints to the model.

Variables

Product blocks add no additional Variables.

ProductData Class

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

Standard Product Block Class

build()[source]

Begin building model (pre-DAE transformation).

Parameters:None
Returns:None
display(display_block=False, ostream=None, prefix='')[source]

Display the contents of Product unit.

Parameters:
  • display_block – indicates whether to display the entire Block
  • object (default = False) –
  • ostream – output stream (default = None)
  • prefix – str to append to each line of output (default = ‘’)
Returns:

None

post_transform_build()[source]

Continue model construction after DAE transformation.

Parameters:None
Returns:None