FlowControl
Inherits from Object
Description
The flow control that calculates flow rates for a (sub)network of the flows in your FloWorks model.
Properties
| Property | Description |
|---|---|
| get | Gets the default flow control from the toolbox. If none exists yet, returns a null result. |
Methods
| Method | Description |
|---|---|
| create | Creates a new flow control in the model. |
| connect | Connect a FloWorks object to this flow control. |
| disconnect | Disconnect a FloWorks object from this flow control. |
| recalculate | Requests immediate recalculation of the flow control. |
Details
FlowControl.get
readonly get
Description
Gets the default flow control from the toolbox. If none exists yet, returns a null result.
Usually a flow control is created automatically as soon as the first FloWorks object is created in the model, and a model usually only has one flow control. This property returns that default flow control. If multiple controls are needed, use the constructor to get a FlowControl object for the given flow control.
FlowControl.create()
void create( string name = )
Parameters
| Parameter | Description |
|---|---|
| name | The name of the new flow control. When left empty, a name will be automatically generated. |
Description
Creates a new flow control in the model.
In most models, a single flow control is sufficient and it will be automatically created once the first FloWorks object is instantiated. However, you may want to manually created additional flow controls, for instance to manage a large disjoint subnetwork, and you can use this method to do that.
FlowControl.connect()
void connect( FlowObject object )
Parameters
| Parameter | Description |
|---|---|
| object | The object to connect to the flow control. |
Description
Connect a FloWorks object to this flow control.
This method acts the same as setting the flowControl property on the object.
FlowControl.disconnect()
void disconnect( FlowObject object )
Parameters
| Parameter | Description |
|---|---|
| object | The object to disconnect from the flow control. |
Description
Disconnect a FloWorks object from this flow control.
This method acts the same as setting the flowControl property to null n the object.
FlowControl.recalculate()
void recalculate( )
Description
Requests immediate recalculation of the flow control.
Normally FloWorks objects automatically request a recalculation when necessary. However, in very exceptional circumstances you will want to manually request a recalculation of the flowrates in the model. This method will schedule an event on the FlexSim event list that will recalculate the flows at the end of the current simulation time.