Table of Contents

Table of Contents

Sink

Flow Sink

Overview and Key Concepts

The flow sink is used to destroy material at the boundary of the model. The sink has a maximum input rate at which it will accept material. This rate can be set in the properties window, or changed dynamically during the model run. By default, the maximum input rate is infinite.

Events

The sink uses the standard events that are common to almost all FloWorks objects. See FloWorks Triggers for an explanation of these events.

Note that the sink only accepts flow input so all events and properties that are related to the output flow, such as the On Output trigger, are not available for this object.

States

For statistical purposes, the sink's FloWorks state profile will be in one of the following states at various points during a simulation run:

  • Idle - The sink is not receiving any flow. This may be because its own input is closed, upstream objects are blocked, or the maximum inflow rate is set to zero.
  • Collecting - The sink is receiving a non-zero flow from upstream.

Properties

The sink object has five tabs with various properties. The first three tabs are standard tabs that are common to all flow objects. For more information about the properties on these tabs, see:

The last two tabs are the standard tabs that are common to all fixed resources. For more information about the properties on these tabs, see:

Custom coding

You may control the behavior of the flow sink dynamically by writing FlexScript, for example in a Script window or by changing the code behind one of the options in an object trigger.

The flow sink is an instance of the FlowObject class, see the class reference for information about its properties.