Getting Started

6 • THE FLOW PROCESS PANEL
The flow rate of the entity is regulated according to the maximum rate(s) of the
source regulator and/or destination regulator. Additionally, the flow rate may be
further constrained due to starvation or blocking from empty or full tanks. The initial
maximum rate of a regulator is specified in the Tank module. A regulator’s maximum
rate may be changed during a run using the Regulate module. The
RegulatorMaxRate(Regulator ID) function returns the current maximum rate of a
regulator. The RegulatorRate(Regulator ID) function returns the current rate of a
regulator.
The actual quantity transferred by an entity in the Flow module may be stored in the
Quantity Save Attribute when the entity exits the module.
TYPICAL USES
• Adding material to a tank
• Removing material from a tank
• Transferring material between two tanks
PROMPTS
Prompt
Description
Name
Type
Flow Destination/
Source:
The module’s identifier.
The flow type, which may be Transfer, Add, or Remove.
Source Regulator Type Indicates how the source regulator will be specified; as
Regulator, Regulator Set, Attribute, Expression.
Regulator Name
Regulator Set Name
Set Index
Attribute Name
Expression
Destination Regulator
Type
Regulator Name
Name of the source regulator.
Name of the regulator set that contains the source regulator
name.
Index into the regulator set.
Name of the attribute that stores the source regulator name.
Expression that evaluates to the source regulator name.
Indicates how the destination regulator will be specified; as
Regulator, Regulator Set, Attribute, Expression.
Name of the destination regulator.
113