Class ColumnMeshResidual

java.lang.Object

neqsim.process.equipment.distillation.ColumnMeshResidual

All Implemented Interfaces:

Serializable

final class ColumnMeshResidual
extends Object
implements Serializable

Immutable residual vector for distillation column MESH diagnostics.

Residuals are scaled to dimensionless values where possible. The object stores equation type, tray index, and optional component labels so tests and future solvers can inspect the structure without reparsing the column state.

Version:

1.0

Author:

esol

Field Summary

Fields

Modifier and Type	Field	Description
private final String[]	componentNames	Component label per residual; null for non-component equations.
private final ColumnMeshEquationType[]	equationTypes	Equation type per residual.
private static final long	serialVersionUID	Serialization version UID.
private final int[]	trayIndices	Tray index per residual; -1 for column-level equations.
private final double[]	values	Residual values.

Constructor Summary

Constructors

Constructor	Description
ColumnMeshResidual(double[] values, ColumnMeshEquationType[] equationTypes, int[] trayIndices, String[] componentNames)	Create a residual vector.

Method Summary

Modifier and Type	Method	Description
(package private) int	count(ColumnMeshEquationType type)	Count residuals of a given equation type.
(package private) String[]	getComponentNames()	Get component names for the residual entries.
(package private) ColumnMeshEquationType[]	getEquationTypes()	Get equation types for the residual entries.
(package private) double	getInfinityNorm()	Get the infinity norm of all residuals.
(package private) double	getInfinityNorm(ColumnMeshEquationType type)	Get the infinity norm for a subset of residuals.
(package private) double	getL2Norm()	Get the Euclidean norm of all residuals.
(package private) int[]	getTrayIndices()	Get tray indices for the residual entries.
(package private) double[]	getValues()	Get a copy of the residual vector.
(package private) boolean	isFinite()	Check whether all residuals are finite numbers.
(package private) int	size()	Get the number of residual equations.
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

Serialization version UID.

See Also:

• Constant Field Values

values

private final double[] values

Residual values.

equationTypes

private final ColumnMeshEquationType[] equationTypes

Equation type per residual.

trayIndices

private final int[] trayIndices

Tray index per residual; -1 for column-level equations.

componentNames

private final String[] componentNames

Component label per residual; null for non-component equations.

Constructor Details

ColumnMeshResidual

ColumnMeshResidual(double[] values,
 ColumnMeshEquationType[] equationTypes,
 int[] trayIndices,
 String[] componentNames)

Create a residual vector.

Parameters:

values - residual values

equationTypes - equation type per residual

trayIndices - tray index per residual

componentNames - component label per residual

Method Details

getValues

double[] getValues()

Get a copy of the residual vector.

Returns:

residual values

getEquationTypes

ColumnMeshEquationType[] getEquationTypes()

Get equation types for the residual entries.

Returns:

equation type metadata

getTrayIndices

int[] getTrayIndices()

Get tray indices for the residual entries.

Returns:

tray index metadata

getComponentNames

String[] getComponentNames()

Get component names for the residual entries.

Returns:

component label metadata

size

int size()

Get the number of residual equations.

Returns:

residual count

isFinite

boolean isFinite()

Check whether all residuals are finite numbers.

Returns:

true if every residual is finite

getInfinityNorm

double getInfinityNorm()

Get the infinity norm of all residuals.

Returns:

maximum absolute residual

getInfinityNorm

double getInfinityNorm(ColumnMeshEquationType type)

Get the infinity norm for a subset of residuals.

Parameters:

type - equation type to include

Returns:

maximum absolute residual for the requested type

getL2Norm

double getL2Norm()

Get the Euclidean norm of all residuals.

Returns:

L2 norm

count

int count(ColumnMeshEquationType type)

Count residuals of a given equation type.

Parameters:

type - equation type to count

Returns:

number of residuals with the requested type

toString

public String toString()

Overrides:

toString in class Object