java.lang.Object
- bio.singa.simulation.model.modules.concentration.ConcentrationDeltaManager

```
public class ConcentrationDeltaManager
extends Object
```
The ConcentrationDeltaManager handles current concentrations of an updatable and the updates to those concentrations that should be applied during simulation.

Author:

cl

Constructor Summary

Constructors
Constructor Description

ConcentrationDeltaManager(ConcentrationContainer initialConcentrations)
Creates a new Concentration Delta Manager.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addPotentialDelta(ConcentrationDelta potentialDelta)`	Adds a potential delta to this updatable.
`void`	`applyDeltas()`	Applies all final deltas and clears the delta list.
`void`	`backupConcentrations()`
`void`	`clearPotentialDeltas()`	Clears the list of potential deltas.
`boolean`	`concentrationIsAtCap()`
`void`	`determineComparisionConcentrations()`
`NumericalError`	`determineGlobalNumericalError()`
`void`	`fix(ChemicalEntity chemicalEntity)`
`ConcentrationContainer`	`getConcentrationContainer()`	Returns the current concentration container.
`List<ConcentrationDelta>`	`getFinalDeltas()`	Returns all deltas that are going to be applied to this node.
`List<ChemicalEntity>`	`getFixedEntities()`
`ConcentrationContainer`	`getOriginalConcentrations()`
`List<ConcentrationDelta>`	`getPotentialDeltas()`	Returns all potential deltas that should be applied.
`boolean`	`hasDeltas()`
`boolean`	`isObserved()`	Returns true if the concentrations are observed.
`void`	`revertToOriginalConcentrations()`
`void`	`setConcentrationContainer(ConcentrationContainer concentrations)`	Sets the current concentration container.
`void`	`setInterimAndUpdateCurrentConcentrations()`
`void`	`setObserved(boolean observed)`	Sets the concentrations to be observed, this additional requires seting up a `UpdateEventListener`.
`void`	`setOriginalConcentrations(ConcentrationContainer originalConcentrations)`
`void`	`shiftDeltas()`	Shifts the deltas from the potential delta list to the final delta list.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConcentrationDeltaManager
```
public ConcentrationDeltaManager(ConcentrationContainer initialConcentrations)
```
    Creates a new Concentration Delta Manager.
    
    Parameters:
    
    initialConcentrations - The initial concentrations.
- Method Detail
  - getConcentrationContainer
```
public ConcentrationContainer getConcentrationContainer()
```
    Returns the current concentration container.
    
    Returns:
    
    The current concentration container.
  - setConcentrationContainer
```
public void setConcentrationContainer(ConcentrationContainer concentrations)
```
    Sets the current concentration container.
    
    Parameters:
    
    concentrations - The current concentration container.
  - getOriginalConcentrations
```
public ConcentrationContainer getOriginalConcentrations()
```
  - setOriginalConcentrations
```
public void setOriginalConcentrations(ConcentrationContainer originalConcentrations)
```
  - isObserved
```
public boolean isObserved()
```
    Returns true if the concentrations are observed.
    
    Returns:
    
    True if the concentrations are observed.
  - setObserved
```
public void setObserved(boolean observed)
```
    Sets the concentrations to be observed, this additional requires seting up a UpdateEventListener.
    
    Parameters:
    
    observed - True if th concentrations should be observed.
  - fix
```
public void fix(ChemicalEntity chemicalEntity)
```
  - getFixedEntities
```
public List<ChemicalEntity> getFixedEntities()
```
  - hasDeltas
```
public boolean hasDeltas()
```
  - setInterimAndUpdateCurrentConcentrations
```
public void setInterimAndUpdateCurrentConcentrations()
```
  - determineComparisionConcentrations
```
public void determineComparisionConcentrations()
```
  - concentrationIsAtCap
```
public boolean concentrationIsAtCap()
```
  - determineGlobalNumericalError
```
public NumericalError determineGlobalNumericalError()
```
  - getFinalDeltas
```
public List<ConcentrationDelta> getFinalDeltas()
```
    Returns all deltas that are going to be applied to this node.
    
    Returns:
    
    All deltas that are going to be applied to this node.
  - getPotentialDeltas
```
public List<ConcentrationDelta> getPotentialDeltas()
```
    Returns all potential deltas that should be applied.
    
    Returns:
    
    All potential deltas that should be applied.
  - addPotentialDelta
```
public void addPotentialDelta(ConcentrationDelta potentialDelta)
```
    Adds a potential delta to this updatable.
    
    Parameters:
    
    potentialDelta - The potential delta.
  - backupConcentrations
```
public void backupConcentrations()
```
  - revertToOriginalConcentrations
```
public void revertToOriginalConcentrations()
```
  - clearPotentialDeltas
```
public void clearPotentialDeltas()
```
    Clears the list of potential deltas. Usually done after shiftDeltas() or after rejecting a time step.
  - shiftDeltas
```
public void shiftDeltas()
```
    Shifts the deltas from the potential delta list to the final delta list.
  - applyDeltas
```
public void applyDeltas()
```
    Applies all final deltas and clears the delta list.

Class ConcentrationDeltaManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConcentrationDeltaManager

Method Detail

getConcentrationContainer

setConcentrationContainer

getOriginalConcentrations

setOriginalConcentrations

isObserved

setObserved

fix

getFixedEntities

hasDeltas

setInterimAndUpdateCurrentConcentrations

determineComparisionConcentrations

concentrationIsAtCap

determineGlobalNumericalError

getFinalDeltas

getPotentialDeltas

addPotentialDelta

backupConcentrations

revertToOriginalConcentrations

clearPotentialDeltas

shiftDeltas

applyDeltas