Package pulse.problem.schemes.rte

Enum RTECalculationStatus

java.lang.Object

java.lang.Enum<RTECalculationStatus>

pulse.problem.schemes.rte.RTECalculationStatus

All Implemented Interfaces:

Serializable, Comparable<RTECalculationStatus>

public enum RTECalculationStatus
extends Enum<RTECalculationStatus>

A measure of health for radiative transfer calculations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
GRID_TOO_LARGE	The grid density required to reach the error threshold was too large.
INTEGRATOR_TIMEOUT	The integrator took too long to finish.
INVALID_FLUXES	The radiative fluxes contain illegal values.
ITERATION_LIMIT_REACHED	The iterative solver took too long to finish.
NORMAL	The current calculation step finished normally.

Method Summary

Modifier and Type	Method	Description
static RTECalculationStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RTECalculationStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final RTECalculationStatus NORMAL

The current calculation step finished normally.

INTEGRATOR_TIMEOUT

public static final RTECalculationStatus INTEGRATOR_TIMEOUT

The integrator took too long to finish.

ITERATION_LIMIT_REACHED

public static final RTECalculationStatus ITERATION_LIMIT_REACHED

The iterative solver took too long to finish.

GRID_TOO_LARGE

public static final RTECalculationStatus GRID_TOO_LARGE

The grid density required to reach the error threshold was too large.

INVALID_FLUXES

public static final RTECalculationStatus INVALID_FLUXES

The radiative fluxes contain illegal values.

Method Detail

values

public static RTECalculationStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RTECalculationStatus c : RTECalculationStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RTECalculationStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null