Class ColumnSolveResult

java.lang.Object

neqsim.process.equipment.distillation.ColumnSolveResult

final class ColumnSolveResult
extends Object

Immutable summary of a distillation column solve.

The result captures convergence metrics immediately after a solver strategy completes. It is an internal boundary object used by ColumnSolver; public callers should continue to use the existing metric getters on DistillationColumn.

Version:

1.0

Author:

esol

Field Summary

Fields

Modifier and Type	Field	Description
private final double	energyResidual	Latest relative energy residual.
private final int	iterationCount	Number of outer iterations run by the solver.
private final double	massResidual	Latest relative mass residual.
private final boolean	solved	Whether the column satisfies its convergence contract.
private final DistillationColumn.SolverType	solverType	Solver used for the run.
private final double	solveTimeSeconds	Solver wall time in seconds.
private final double	temperatureResidual	Latest temperature residual in Kelvin.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ColumnSolveResult(DistillationColumn.SolverType solverType, boolean solved, int iterationCount, double temperatureResidual, double massResidual, double energyResidual, double solveTimeSeconds)	Create a solve result.

Method Summary

Modifier and Type	Method	Description
(package private) static ColumnSolveResult	from(DistillationColumn column, DistillationColumn.SolverType solverType)	Build a result from the current column diagnostics.
(package private) double	getEnergyResidual()	Get the latest relative energy residual.
(package private) int	getIterationCount()	Get the iteration count.
(package private) double	getMassResidual()	Get the latest relative mass residual.
(package private) DistillationColumn.SolverType	getSolverType()	Get the solver type used for this result.
(package private) double	getSolveTimeSeconds()	Get the solver wall time.
(package private) double	getTemperatureResidual()	Get the latest temperature residual.
(package private) boolean	isSolved()	Check whether the column satisfied its convergence contract.

Methods inherited from class Object

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

Field Details

solverType

private final DistillationColumn.SolverType solverType

Solver used for the run.

solved

private final boolean solved

Whether the column satisfies its convergence contract.

iterationCount

private final int iterationCount

Number of outer iterations run by the solver.

temperatureResidual

private final double temperatureResidual

Latest temperature residual in Kelvin.

massResidual

private final double massResidual

Latest relative mass residual.

energyResidual

private final double energyResidual

Latest relative energy residual.

solveTimeSeconds

private final double solveTimeSeconds

Solver wall time in seconds.

Constructor Details

ColumnSolveResult

private ColumnSolveResult(DistillationColumn.SolverType solverType,
 boolean solved,
 int iterationCount,
 double temperatureResidual,
 double massResidual,
 double energyResidual,
 double solveTimeSeconds)

Create a solve result.

Parameters:

solverType - solver used for the run

solved - whether the column satisfies its convergence contract

iterationCount - number of iterations used

temperatureResidual - latest temperature residual in Kelvin

massResidual - latest relative mass residual

energyResidual - latest relative energy residual

solveTimeSeconds - solver wall time in seconds

Method Details

from

static ColumnSolveResult from(DistillationColumn column,
 DistillationColumn.SolverType solverType)

Build a result from the current column diagnostics.

Parameters:

column - solved column to summarize

solverType - solver used for the run

Returns:

immutable solve result

getSolverType

DistillationColumn.SolverType getSolverType()

Get the solver type used for this result.

Returns:

solver type

isSolved

boolean isSolved()

Check whether the column satisfied its convergence contract.

Returns:

true if the solve converged

getIterationCount

int getIterationCount()

Get the iteration count.

Returns:

number of solver iterations

getTemperatureResidual

double getTemperatureResidual()

Get the latest temperature residual.

Returns:

residual in Kelvin

getMassResidual

double getMassResidual()

Get the latest relative mass residual.

Returns:

mass residual

getEnergyResidual

double getEnergyResidual()

Get the latest relative energy residual.

Returns:

energy residual

getSolveTimeSeconds

double getSolveTimeSeconds()

Get the solver wall time.

Returns:

solve time in seconds