Package com.amalgamasimulation.discreterate

Class Split<T>

java.lang.Object

com.amalgamasimulation.discreterate.FlowElement<T>

com.amalgamasimulation.discreterate.Split<T>

Type Parameters:

T - type (class or interface) whose instances represent types of material

public class Split<T>
extends FlowElement<T>

Split is a flow element that receives material from exactly one input and can divide it into several outputs.

Split has no storage capacity.

Split can have at most one incoming flow connection and many outflow connections.

The proportions of materials in the outflow mixture are not changed.

The behavior of a Split with its upstream element's outflow rate less than sum of max possible output flow rates of defined by its FlowRateDistributionPolicy:

• In a PRIORITY Split, the material is sent to the top priority outputs first until the upstream element's outflow rate limit is reached. For instance, if the upstream flow element can deliver material at the max rate of 12 and the Split has five outflow connections, with their respective max possible rates and priorities (see setOutflowPriority(FlowConnection, double)) being from 1 to 5 (1 is the highest priority), then connections 1-4 will be used at their full rates (for a total rate of 10), and the 5th connection will only be used at its partial rate of 2 (12 - (1+2+3+4) = 2).
• In a PROPORTIONAL Split, material is sent to all outflow connections. For each connection, a 'rate fraction' parameter is set (see setOutflowRateFraction(FlowConnection, double)) indicating the fraction of that connection's rate in the overall outflow rate of the Split. Rate limits of each incoming connection are respected. For instance, if the upstream flow element can deliver material at the max rate of 5 and the Split has four outflow connections, with their respective max rates being 1 to 4 and 'rate fractions' being 0.25, then the actual outflow rate via each of the outflow connections will be equal to 1, for a total outflow rate of 4. On the other hand, if rate fractions are set to be 0.1, 0.2, 0.3, and 0.4 - then the outflow connections will have respective actual rates of 0.5, 1.0, 1.5, and 2.0, for a total of 5 (this is the rate limit of the upstream element).

Constructor Summary

Constructors

Constructor	Description
Split(FlowEnvironment<T> flowEnvironment, FlowRateDistributionPolicy policy)	Creates a new Split instance.
Split(FlowEnvironment<T> flowEnvironment, String name, FlowRateDistributionPolicy policy)	Creates a new instance of the split.

Method Summary

Modifier and Type	Method	Description
double	getContentsAmount()	Returns the current sum of all amounts of all materials contained inside this flow element.
double	getContentsAmount(T material)	Returns the current amount of the specified material contained inside this flow element.
Accumulator<T>	getContentsDescriptor()	Returns the current stock contained inside this flow element as an Accumulator instance.
FlowRateDistributionPolicy	getFlowRateDistributionPolicy()	Returns the FlowRateDistributionPolicy of this Split.
double	getInflowRate()	Returns the current flow rate of all materials at the input of this flow element.
Accumulator<T>	getInflowRateDescriptor()	Returns an Accumulator instance that describes the flow rate at the input of this flow element.
Accumulator<T>	getInflowRateProportions()	Returns an Accumulator instance that contains rate proportions of materials in the material inflow of this flow element.
double	getOutflowPriority(FlowConnection<T> outflowConnection)	Returns the priority of the specified output outflowConnection.
double	getOutflowRate()	Returns the current flow rate at the output of this flow element.
Accumulator<T>	getOutflowRateDescriptor()	Returns an Accumulator instance that describes the flow rate at the output of this flow element.
Accumulator<T>	getOutflowRateDescriptor(FlowConnection<T> outflowConnection)	Returns an Accumulator instance that describes the flow rate of material at the specified outflow connection.
double	getOutflowRateFraction(FlowConnection<T> outflowConnection)	Returns the ratio of current outflowConnection flow rate to the overall outflow rate of this Split.
Accumulator<T>	getOutflowRateProportions(FlowConnection<T> outflowConnection)	Returns an Accumulator instance that contains flow rate proportions of materials exported through the outflowConnection outflow connection.
double	getPassedAmount()	Returns the total amount of all materials that have passed through this Split since the beginning of simulation.
double	getTotalInflowAmount()	Returns the total amount of all materials that have entered this flow element.
double	getTotalInflowAmount(T material)	Returns the total amount of the specified material that has entered this flow element.
Accumulator<T>	getTotalInflowDescriptor()	Returns an Accumulator instance that contains the total quantity of each material that has entered this flow element.
double	getTotalOutflowAmount()	Returns the total quantity of materials that have left this flow element.
double	getTotalOutflowAmount(T material)	Returns the total quantity of the specified material that has left this flow element.
Accumulator<T>	getTotalOutflowDescriptor()	Returns an Accumulator instance that holds the total amounts of each material that has left this flow element.
void	setOutflowFractionSupplier(Function<FlowConnection<T>,Double> outflowFractionSupplier)	Sets the supplier of the fraction of outflowConnection's actual flow rate in the overall outflow rate of this Split.
void	setOutflowPriority(FlowConnection<T> outflowConnection, double priority)	Sets the priority of the output outflowConnection.
void	setOutflowRateFraction(FlowConnection<T> outflowConnection, double rateFraction)	Sets the fraction of outflowConnection's actual flow rate in the overall outflow rate of this Split.
void	setOutflowRateProportionsSupplier(Function<FlowConnection<T>,Accumulator<T>> outflowRateProportionsSupplier)	Sets the supplier of the rate proportions of outflowConnection's actual flow rate in the overall outflow rate of this Split.

Methods inherited from class com.amalgamasimulation.discreterate.FlowElement

addInflowElementConnectedHandler, addInflowElementDisconnectedHandler, addOutflowElementConnectedHandler, addOutflowElementDisconnectedHandler, connectToElement, disconnectFrom, getFlowEnvironment, getInflowConnections, getName, getOutflowConnections, inflowConnectionExists, isConnectedWith, outflowConnectionExists, removeInflowElementConnectedHandler, removeInflowElementDisconnectedHandler, removeOutflowElementConnectedHandler, removeOutflowElementDisconnectedHandler, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Split

public Split(FlowEnvironment<T> flowEnvironment,
 FlowRateDistributionPolicy policy)

Creates a new Split instance.

Parameters:

flowEnvironment - FlowEnvironment which this Split instance belongs to

policy - flow rate distribution policy of the new Split, can be FlowRateDistributionPolicy.PROPORTIONAL or FlowRateDistributionPolicy.PRIORITY

See Also:

• FlowRateDistributionPolicy

Split

public Split(FlowEnvironment<T> flowEnvironment,
 String name,
 FlowRateDistributionPolicy policy)

Creates a new instance of the split.

Parameters:

flowEnvironment - FlowEnvironment which this Split instance belongs to

name - name of the new Split

policy - flow rate distribution policy of the new Split, can be FlowRateDistributionPolicy.PROPORTIONAL or FlowRateDistributionPolicy.PRIORITY

Method Details

setOutflowFractionSupplier

public void setOutflowFractionSupplier(Function<FlowConnection<T>,Double> outflowFractionSupplier)

Sets the supplier of the fraction of outflowConnection's actual flow rate in the overall outflow rate of this Split. Can only be called for a Split with FlowRateDistributionPolicy.PROPORTIONAL policy.

See Also:

• setOutflowRateFraction(FlowConnection, double)

setOutflowRateProportionsSupplier

public void setOutflowRateProportionsSupplier(Function<FlowConnection<T>,Accumulator<T>> outflowRateProportionsSupplier)

Sets the supplier of the rate proportions of outflowConnection's actual flow rate in the overall outflow rate of this Split.

getPassedAmount

public double getPassedAmount()

Returns the total amount of all materials that have passed through this Split since the beginning of simulation.

Returns:

total amount of passed materials

setOutflowPriority

public void setOutflowPriority(FlowConnection<T> outflowConnection,
 double priority)

Sets the priority of the output outflowConnection. Can only be called for a Split with FlowRateDistributionPolicy.PRIORITY policy.

Parameters:

outflowConnection - the output flow connection for which the priority is being set

priority - new priority of the output outflowConnection, must be non-negative

See Also:

• getFlowRateDistributionPolicy()

getOutflowPriority

public double getOutflowPriority(FlowConnection<T> outflowConnection)

Returns the priority of the specified output outflowConnection. The lower the returned value, the higher the priority.

Parameters:

outflowConnection - output flow connection

Returns:

priority of the output outflowConnection

setOutflowRateFraction

public void setOutflowRateFraction(FlowConnection<T> outflowConnection,
 double rateFraction)

Sets the fraction of outflowConnection's actual flow rate in the overall outflow rate of this Split. Can only be called for a Split with FlowRateDistributionPolicy.PROPORTIONAL policy.

Parameters:

outflowConnection - output flow connection

rateFraction - a number in the closed interval [0..1] representing the ratio of outflowConnection flow rate to the overall outflow rate of this Split

Throws:

IllegalStateException - if called for a Split with flow distribution policy other than FlowRateDistributionPolicy.PROPORTIONAL

IllegalArgumentException - if the outflowConnection is not related to this Split

IllegalArgumentException - if rateFraction is not in the closed interval [0..1]

See Also:

• getOutflowRateFraction(FlowConnection)

getOutflowRateFraction

public double getOutflowRateFraction(FlowConnection<T> outflowConnection)

Returns the ratio of current outflowConnection flow rate to the overall outflow rate of this Split.

The returned value belongs to a closed interval [0..1].

Parameters:

outflowConnection - output flow connection

Returns:

fraction of the outflowConnection flow rate in the overall outflow rate of the Split

Throws:

IllegalStateException - if called for a Split with flow distribution policy other than FlowRateDistributionPolicy.PROPORTIONAL

IllegalStateException - if the outflow rate fraction has not been configured for this outflowConnection and this Split

IllegalArgumentException - if the outflowConnection is not related to this Split

See Also:

• setOutflowRateFraction(FlowConnection, double)

getFlowRateDistributionPolicy

public FlowRateDistributionPolicy getFlowRateDistributionPolicy()

Returns the FlowRateDistributionPolicy of this Split. The policy is applied to the outflow rate.

Returns:

FlowRateDistributionPolicy of this Split

getContentsAmount

public double getContentsAmount()

Returns the current sum of all amounts of all materials contained inside this flow element. Always zero for any Split because Splits do not contain any material.

Specified by:

getContentsAmount in class FlowElement<T>

Returns:

current total amount of all materials inside this flow element

See Also:

• getContentsAmount(material)
• getContentsDescriptor()

getContentsAmount

public double getContentsAmount(T material)

Returns the current amount of the specified material contained inside this flow element. Always zero for any Split because Splits do not contain any material.

Specified by:

getContentsAmount in class FlowElement<T>

Parameters:

material - material

Returns:

current amount of the specified material contained inside this flow element

See Also:

• getContentsAmount()
• getContentsDescriptor()

getContentsDescriptor

public Accumulator<T> getContentsDescriptor()

Returns the current stock contained inside this flow element as an Accumulator instance. Always returns an empty Accumulator for any Split because Splits do not contain any material.

Specified by:

getContentsDescriptor in class FlowElement<T>

Returns:

empty Accumulator

See Also:

• getContentsAmount()
• getContentsAmount(element)

getInflowRate

public double getInflowRate()

Description copied from class: FlowElement

Returns the current flow rate of all materials at the input of this flow element.

Specified by:

getInflowRate in class FlowElement<T>

Returns:

current flow rate of all materials at this flow element's input

See Also:

• FlowElement.getInflowRateDescriptor()

getInflowRateDescriptor

public Accumulator<T> getInflowRateDescriptor()

Description copied from class: FlowElement

Returns an Accumulator instance that describes the flow rate at the input of this flow element.

The returned Accumulator instance contains the respective rates of all materials currently entering the flow element. The sum of values in the Accumulator is equal to 1.

Specified by:

getInflowRateDescriptor in class FlowElement<T>

Returns:

descriptor of the current inflow rate

See Also:

• FlowElement.getInflowRate()

getOutflowRate

public double getOutflowRate()

Description copied from class: FlowElement

Returns the current flow rate at the output of this flow element.

Specified by:

getOutflowRate in class FlowElement<T>

Returns:

current flow rate at the output of this flow element

See Also:

• FlowElement.getOutflowRateDescriptor()

getOutflowRateDescriptor

public Accumulator<T> getOutflowRateDescriptor()

Description copied from class: FlowElement

Returns an Accumulator instance that describes the flow rate at the output of this flow element.

The returned Accumulator instance contains the respective rates of all materials currently leaving the flow element. The sum of values in the Accumulator is equal to 1.

Specified by:

getOutflowRateDescriptor in class FlowElement<T>

Returns:

descriptor of the current outflow rate

See Also:

• FlowElement.getOutflowRate()

getOutflowRateDescriptor

public Accumulator<T> getOutflowRateDescriptor(FlowConnection<T> outflowConnection)

Returns an Accumulator instance that describes the flow rate of material at the specified outflow connection.

The returned Accumulator instance contains the respective rates of all materials currently leaving the Split through the specified connection.

Parameters:

outflowConnection - output flow connection

Returns:

current material flow rate at specified outflow connection

Throws:

IllegalArgumentException - if the outflowConnection is not related to this Split

getOutflowRateProportions

public Accumulator<T> getOutflowRateProportions(FlowConnection<T> outflowConnection)

Description copied from class: FlowElement

Returns an Accumulator instance that contains flow rate proportions of materials exported through the outflowConnection outflow connection.

Each element of the returned Accumulator corresponds to a material in the current material flow of outflowConnection. The value of each element in the Accumulator is the ratio of the rate of that material's partial flow to the overall flow rate of outflowConnection. The sum of values in the Accumulator is equal to 1.

Specified by:

getOutflowRateProportions in class FlowElement<T>

Parameters:

outflowConnection - an outflow connection

Returns:

material proportions in the outflow connection

getInflowRateProportions

public Accumulator<T> getInflowRateProportions()

Returns an Accumulator instance that contains rate proportions of materials in the material inflow of this flow element.

Each element of the returned Accumulator corresponds to a material in the current material inflow. The value of each element in the Accumulator is the ratio of the rate of that material's partial flow to the overall inflow rate of the flow element. The sum of amounts in the Accumulator is equal to 1.

Returns:

Accumulator that contains the current incoming flow rate proportions.

See Also:

• getOutflowRateProportions(FlowConnection)

getTotalInflowAmount

public double getTotalInflowAmount()

Description copied from class: FlowElement

Returns the total amount of all materials that have entered this flow element.

Specified by:

getTotalInflowAmount in class FlowElement<T>

Returns:

total amount of all arrived materials

getTotalInflowAmount

public double getTotalInflowAmount(T material)

Description copied from class: FlowElement

Returns the total amount of the specified material that has entered this flow element.

Specified by:

getTotalInflowAmount in class FlowElement<T>

Parameters:

material - material

Returns:

total amount of the specified material that has arrived to this flow element

See Also:

• FlowElement.getTotalInflowAmount()
• FlowElement.getTotalInflowDescriptor()

getTotalInflowDescriptor

public Accumulator<T> getTotalInflowDescriptor()

Description copied from class: FlowElement

Returns an Accumulator instance that contains the total quantity of each material that has entered this flow element.

The values of each element in the returned Accumulator match the quantities of the respective materials that have entered the flow element. The sum of values in the Accumulator is equal to the value returned by the FlowElement.getTotalInflowAmount() method.

Specified by:

getTotalInflowDescriptor in class FlowElement<T>

Returns:

Accumulator containing total amounts of materials that have entered this flow element

See Also:

• FlowElement.getTotalInflowAmount()
• FlowElement.getTotalInflowAmount(material)

getTotalOutflowAmount

public double getTotalOutflowAmount()

Description copied from class: FlowElement

Returns the total quantity of materials that have left this flow element.

Specified by:

getTotalOutflowAmount in class FlowElement<T>

Returns:

total quantity of exported materials

See Also:

• FlowElement.getTotalOutflowAmount(material)
• FlowElement.getTotalOutflowDescriptor()

getTotalOutflowAmount

public double getTotalOutflowAmount(T material)

Description copied from class: FlowElement

Returns the total quantity of the specified material that has left this flow element.

Specified by:

getTotalOutflowAmount in class FlowElement<T>

Parameters:

material - material

Returns:

total quantity of the specified material that has left this flow element

See Also:

• FlowElement.getTotalOutflowAmount()
• FlowElement.getTotalOutflowDescriptor()

getTotalOutflowDescriptor

public Accumulator<T> getTotalOutflowDescriptor()

Description copied from class: FlowElement

Returns an Accumulator instance that holds the total amounts of each material that has left this flow element.

The values of each element in the returned Accumulator match the quantities of the respective materials that have left the flow element. The sum of values in the Accumulator is equal to the value returned by the FlowElement.getTotalOutflowAmount() method.

Specified by:

getTotalOutflowDescriptor in class FlowElement<T>

Returns:

Accumulator containing total amounts of materials that have left this flow element

See Also:

• FlowElement.getTotalOutflowAmount()
• FlowElement.getTotalOutflowAmount(material)