Class ProcessDerivativeCalculator.DerivativeResult

java.lang.Object

neqsim.process.mpc.ProcessDerivativeCalculator.DerivativeResult

Enclosing class:

ProcessDerivativeCalculator

public static class ProcessDerivativeCalculator.DerivativeResult
extends Object

Result container for derivative calculations with error estimates.

Version:

1.0

Author:

NeqSim Development Team

Field Summary

Fields

Modifier and Type	Field	Description
double	errorEstimate	Estimated error (if available).
String	errorMessage	Error message if not valid.
boolean	isValid	Whether calculation converged.
double	stepSize	Step size used.
double	value	The calculated derivative value.

Constructor Summary

Constructors

Constructor	Description
DerivativeResult(double value, double stepSize)	Constructor for valid result.
DerivativeResult(String errorMessage)	Constructor for invalid result.

Method Summary

Methods inherited from class Object

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

Field Details

value

public double value

The calculated derivative value.

errorEstimate

public double errorEstimate

Estimated error (if available).

stepSize

public double stepSize

Step size used.

isValid

public boolean isValid

Whether calculation converged.

errorMessage

public String errorMessage

Error message if not valid.

Constructor Details

DerivativeResult

public DerivativeResult(double value,
 double stepSize)

Constructor for valid result.

Parameters:

value - the calculated derivative value

stepSize - the step size used for calculation

DerivativeResult

public DerivativeResult(String errorMessage)

Constructor for invalid result.

Parameters:

errorMessage - the error message describing the failure