bio.singa.simulation.model.modules.concentration

Class LocalError

java.lang.Object

bio.singa.simulation.model.modules.concentration.LocalError

public class LocalError
extends Object

The LocalError object stores the error as an result of the currently applied time step. Additionally it stores in which node and for which chemical entity it occurred. The local error is calculated according to the midpoint method: E = abs(1 - (fullDelta / 2.0 * halfDelta))

Author:

cl

Field Summary

Fields

Modifier and Type	Field and Description
static LocalError	MINIMAL_EMPTY_ERROR The minimal possible error not assigned to any node or chemical entity.

Constructor Summary

Constructors

Constructor and Description
LocalError(Updatable updatable, ChemicalEntity entity, double value) Creates a new LocalError.

Method Summary

Modifier and Type	Method and Description
ChemicalEntity	getChemicalEntity() Returns the chemical entity where the error occurred.
Updatable	getUpdatable() Returns the node where the error occurred.
double	getValue() Returns the actual value of the error.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MINIMAL_EMPTY_ERROR

public static final LocalError MINIMAL_EMPTY_ERROR

The minimal possible error not assigned to any node or chemical entity.

Constructor Detail

LocalError

public LocalError(Updatable updatable,
                  ChemicalEntity entity,
                  double value)

Creates a new LocalError.

Parameters:

updatable - The node where the error occurred.

entity - The chemical entity where the error occurred.

value - The actual value of the error.

Method Detail

getUpdatable

public Updatable getUpdatable()

Returns the node where the error occurred.

Returns:

The node where the error occurred.

getChemicalEntity

public ChemicalEntity getChemicalEntity()

Returns the chemical entity where the error occurred.

Returns:

The chemical entity where the error occurred.

getValue

public double getValue()

Returns the actual value of the error.

Returns:

The actual value of the error.

toString

public String toString()

Overrides:

toString in class Object