Package com.amalgamasimulation.discreterate

Enum Class FlowRateDistributionPolicy

java.lang.Object

java.lang.Enum<FlowRateDistributionPolicy>

com.amalgamasimulation.discreterate.FlowRateDistributionPolicy

All Implemented Interfaces:

Serializable, Comparable<FlowRateDistributionPolicy>, Constable

public enum FlowRateDistributionPolicy
extends Enum<FlowRateDistributionPolicy>

Represents a policy to control the distribution of the incoming or outgoing material flow rate among several connections.

Can be applied to Merge and Split flow elements.

When the PRIORITY policy is used, the (incoming or outgoing) flow rate is distributed across the flow connections according to the connections' priorities. 'Priority' of a connection is expressed as a non-negative continuous value: the lower the value, the higher the priority of the connection. Connections with high priority are used first.

For the PROPORTIONAL policy, a rate fraction of each incoming (see Merge.setInflowRateFraction(FlowConnection, double)) or outgoing (see Split.setOutflowRateFraction(FlowConnection, double)) flow connection is additionally set, and the flow rate is distributed among connections according to the rate fraction settings.

Author:

Alexander Morozov

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PRIORITY
PROPORTIONAL

Method Summary

Modifier and Type	Method	Description
static FlowRateDistributionPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FlowRateDistributionPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRIORITY

public static final FlowRateDistributionPolicy PRIORITY

PROPORTIONAL

public static final FlowRateDistributionPolicy PROPORTIONAL

Method Details

values

public static FlowRateDistributionPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FlowRateDistributionPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null