Class ProcessSimulationEvaluator.ParameterDefinition

java.lang.Object

neqsim.process.util.optimizer.ProcessSimulationEvaluator.ParameterDefinition

All Implemented Interfaces:

Serializable

Enclosing class:

ProcessSimulationEvaluator

public static class ProcessSimulationEvaluator.ParameterDefinition
extends Object
implements Serializable

Definition of a decision variable (parameter) for optimization.

Version:

1.0

Author:

NeqSim Development Team

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	equipmentName
private double	initialValue
private double	lowerBound
private String	name
private String	propertyName
private static final long	serialVersionUID
private BiConsumer<ProcessSystem, Double>	setter
private String	unit
private double	upperBound

Constructor Summary

Constructors

Constructor	Description
ParameterDefinition()	Default constructor.
ParameterDefinition(String name, String equipmentName, String propertyName, double lowerBound, double upperBound, String unit)	Constructor with all fields.

Method Summary

Modifier and Type	Method	Description
double	clamp(double value)	Clamps value to bounds.
String	getEquipmentName()
double	getInitialValue()
double	getLowerBound()
String	getName()
String	getPropertyName()
BiConsumer<ProcessSystem, Double>	getSetter()
String	getUnit()
double	getUpperBound()
boolean	isWithinBounds(double value)	Checks if value is within bounds.
void	setEquipmentName(String equipmentName)
void	setInitialValue(double initialValue)
void	setLowerBound(double lowerBound)
void	setName(String name)
void	setPropertyName(String propertyName)
void	setSetter(BiConsumer<ProcessSystem, Double> setter)
void	setUnit(String unit)
void	setUpperBound(double upperBound)

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

private String name

equipmentName

private String equipmentName

propertyName

private String propertyName

lowerBound

private double lowerBound

upperBound

private double upperBound

unit

private String unit

initialValue

private double initialValue

setter

private transient BiConsumer<ProcessSystem, Double> setter

Constructor Details

ParameterDefinition

public ParameterDefinition()

Default constructor.

ParameterDefinition

public ParameterDefinition(String name,
 String equipmentName,
 String propertyName,
 double lowerBound,
 double upperBound,
 String unit)

Constructor with all fields.

Parameters:

name - parameter name

equipmentName - equipment name

propertyName - property name

lowerBound - lower bound

upperBound - upper bound

unit - unit of measurement

Method Details

getName

public String getName()

setName

public void setName(String name)

getEquipmentName

public String getEquipmentName()

setEquipmentName

public void setEquipmentName(String equipmentName)

getPropertyName

public String getPropertyName()

setPropertyName

public void setPropertyName(String propertyName)

getLowerBound

public double getLowerBound()

setLowerBound

public void setLowerBound(double lowerBound)

getUpperBound

public double getUpperBound()

setUpperBound

public void setUpperBound(double upperBound)

getUnit

public String getUnit()

setUnit

public void setUnit(String unit)

getInitialValue

public double getInitialValue()

setInitialValue

public void setInitialValue(double initialValue)

getSetter

public BiConsumer<ProcessSystem, Double> getSetter()

setSetter

public void setSetter(BiConsumer<ProcessSystem, Double> setter)

isWithinBounds

public boolean isWithinBounds(double value)

Checks if value is within bounds.

Parameters:

value - value to check

Returns:

true if within bounds

clamp

public double clamp(double value)

Clamps value to bounds.

Parameters:

value - value to clamp

Returns:

clamped value