Class ProductionOptimizer.ScenarioKpi

java.lang.Object

neqsim.process.util.optimizer.ProductionOptimizer.ScenarioKpi

Enclosing class:

ProductionOptimizer

public static final class ProductionOptimizer.ScenarioKpi
extends Object

Definition of a KPI to report alongside scenario comparisons.

Version:

1.0

Author:

NeqSim Development Team

Field Summary

Fields

Modifier and Type	Field	Description
private final ToDoubleFunction<ProductionOptimizer.OptimizationResult>	metric
private final String	name
private final String	unit

Constructor Summary

Constructors

Constructor	Description
ScenarioKpi(String name, String unit, ToDoubleFunction<ProductionOptimizer.OptimizationResult> metric)

Method Summary

Modifier and Type	Method	Description
double	evaluate(ProductionOptimizer.OptimizationResult result)
String	getName()
String	getUnit()
static ProductionOptimizer.ScenarioKpi	objectiveValue(String objectiveName)	KPI that returns a specific objective value by name.
static ProductionOptimizer.ScenarioKpi	optimalRate(String unitLabel)	Convenience KPI for reporting optimal rate.
static ProductionOptimizer.ScenarioKpi	score()	Convenience KPI for reporting solver score.

Methods inherited from class Object

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

Field Details

name

private final String name

unit

private final String unit

metric

private final ToDoubleFunction<ProductionOptimizer.OptimizationResult> metric

Constructor Details

ScenarioKpi

public ScenarioKpi(String name,
 String unit,
 ToDoubleFunction<ProductionOptimizer.OptimizationResult> metric)

Method Details

getName

public String getName()

getUnit

public String getUnit()

evaluate

public double evaluate(ProductionOptimizer.OptimizationResult result)

optimalRate

public static ProductionOptimizer.ScenarioKpi optimalRate(String unitLabel)

Convenience KPI for reporting optimal rate.

score

public static ProductionOptimizer.ScenarioKpi score()

Convenience KPI for reporting solver score.

objectiveValue

public static ProductionOptimizer.ScenarioKpi objectiveValue(String objectiveName)

KPI that returns a specific objective value by name.