FlowControl

Inherits from Object

Description

The flow control that calculates flow rates for a (sub)network of the flows in your FloWorks model.

The FlowControl is responsible for optimizing the flow through a network. Every object that is connected to the FlowControl is part of the network the FlowControl will optimize. Every flow object must be part of a FlowControl. The controller will calculate all rates throughout the network. After the flows have been established a new event will be created to recalculate the flow. This happens for instance when a tank becomes full or empty.

Methods

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.

Static Properties

get Gets the default flow control from the toolbox. If none exists yet, returns a null result.

Static Methods

create Creates a new flow control in the model.

Details

Do no remove, this fixes the anchor on doc.flexsim.com

FlowControl.connect()

void connect( FlowObject object )

Parameters

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.

Do no remove, this fixes the anchor on doc.flexsim.com

FlowControl.disconnect()

void disconnect( FlowObject object )

Parameters

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.

Do no remove, this fixes the anchor on doc.flexsim.com

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.

Do no remove, this fixes the anchor on doc.flexsim.com

FlowControl.get

static readonly FlowControl 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.

Do no remove, this fixes the anchor on doc.flexsim.com

FlowControl.create()

static void create( string name = )

Parameters

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.