Class NonlinearPredictor.PredictionResult

java.lang.Object

neqsim.process.mpc.NonlinearPredictor.PredictionResult

All Implemented Interfaces:

Serializable

Enclosing class:

NonlinearPredictor

public static class NonlinearPredictor.PredictionResult
extends Object
implements Serializable

Result of a prediction containing CV and MV trajectories.

Since:

3.0

Version:

1.0

Author:

Even Solbraa

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String[]	cvNames
private final double[][]	cvTrajectories
private final String[]	mvNames
private final double[][]	mvTrajectories
private final double	sampleTime
private static final long	serialVersionUID
private final double[]	time

Constructor Summary

Constructors

Constructor	Description
PredictionResult(double[][] cvTrajectories, double[][] mvTrajectories, double[] time, String[] cvNames, String[] mvNames, double sampleTime)	Construct a prediction result.

Method Summary

Modifier and Type	Method	Description
String[]	getCvNames()	Get the CV names.
double	getFinalValue(String cvName)	Get the final predicted value for a CV.
int	getHorizon()	Get the prediction horizon.
double	getISE(String cvName, double setpoint)	Calculate the integrated squared error from a setpoint.
String[]	getMvNames()	Get the MV names.
double[]	getMVTrajectory(String mvName)	Get an MV trajectory by name.
double	getSampleTime()	Get the sample time.
double[]	getTime()	Get the time array.
double[]	getTrajectory(int index)	Get a CV trajectory by index.
double[]	getTrajectory(String cvName)	Get a CV trajectory by name.
String	toString()

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

cvTrajectories

private final double[][] cvTrajectories

mvTrajectories

private final double[][] mvTrajectories

time

private final double[] time

cvNames

private final String[] cvNames

mvNames

private final String[] mvNames

sampleTime

private final double sampleTime

Constructor Details

PredictionResult

public PredictionResult(double[][] cvTrajectories,
 double[][] mvTrajectories,
 double[] time,
 String[] cvNames,
 String[] mvNames,
 double sampleTime)

Construct a prediction result.

Parameters:

cvTrajectories - CV values [numCV][numSteps]

mvTrajectories - MV values [numMV][numSteps]

time - time points

cvNames - CV names

mvNames - MV names

sampleTime - sample interval

Method Details

getTrajectory

public double[] getTrajectory(String cvName)

Get a CV trajectory by name.

Parameters:

cvName - the CV name

Returns:

the trajectory array

getTrajectory

public double[] getTrajectory(int index)

Get a CV trajectory by index.

Parameters:

index - the CV index

Returns:

the trajectory array

getMVTrajectory

public double[] getMVTrajectory(String mvName)

Get an MV trajectory by name.

Parameters:

mvName - the MV name

Returns:

the trajectory array

getTime

public double[] getTime()

Get the time array.

Returns:

time points

getSampleTime

public double getSampleTime()

Get the sample time.

Returns:

sample interval in seconds

getHorizon

public int getHorizon()

Get the prediction horizon.

Returns:

number of steps

getCvNames

public String[] getCvNames()

Get the CV names.

Returns:

array of CV names

getMvNames

public String[] getMvNames()

Get the MV names.

Returns:

array of MV names

getFinalValue

public double getFinalValue(String cvName)

Get the final predicted value for a CV.

Parameters:

cvName - the CV name

Returns:

the final predicted value

getISE

public double getISE(String cvName,
 double setpoint)

Calculate the integrated squared error from a setpoint.

Parameters:

cvName - the CV name

setpoint - the target setpoint

Returns:

the ISE

toString

public String toString()

Overrides:

toString in class Object