bio.singa.simulation.model.simulation

Class UpdateScheduler

java.lang.Object

bio.singa.simulation.model.simulation.UpdateScheduler

public class UpdateScheduler
extends Object

Author:

cl

Constructor Summary

Constructors

Constructor and Description
UpdateScheduler(Simulation simulation)

Method Summary

Modifier and Type	Method and Description
void	addModule(UpdateModule module)
void	decreaseTimeStep()
void	evaluateGlobalNumericalAccuracy()
javax.measure.Quantity<javax.measure.quantity.Frequency>	getAccuracyGain()
CountDownLatch	getCountDownLatch()
double	getLargestGlobalError()
LocalError	getLargestLocalError()
UpdateModule	getLocalErrorModule()
double	getLocalErrorUpdate()
int	getNumberOfModules()
double	getRecalculationCutoff()
long	getTimestepsDecreased()
long	getTimestepsIncreased()
void	increaseTimeStep()
boolean	interruptAllBut(Thread callingThread, UpdateModule callingModule) Returns true if the calling module was the first to call the method, therefore being allowed to optimize the time step.
void	nextEpoch()
boolean	recalculationRequired() Recalculations are required if: the time step was rescaled during this calculation any module was interrupted during this calculation the global error was larger than the recalculation cutoff
void	resetCalculation()
void	setLargestLocalError(LocalError localError, UpdateModule associatedModule, double associatedConcentration)
void	setRecalculationCutoff(double recalculationCutoff)
boolean	timeStepWasAlteredInThisEpoch()
boolean	timeStepWasRescaled()

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateScheduler

public UpdateScheduler(Simulation simulation)

Method Detail

getRecalculationCutoff

public double getRecalculationCutoff()

setRecalculationCutoff

public void setRecalculationCutoff(double recalculationCutoff)

getTimestepsDecreased

public long getTimestepsDecreased()

getTimestepsIncreased

public long getTimestepsIncreased()

nextEpoch

public void nextEpoch()

evaluateGlobalNumericalAccuracy

public void evaluateGlobalNumericalAccuracy()

recalculationRequired

public boolean recalculationRequired()

Recalculations are required if:

• the time step was rescaled during this calculation
• any module was interrupted during this calculation
• the global error was larger than the recalculation cutoff

Returns:

true, if a recalculation is required

getLargestLocalError

public LocalError getLargestLocalError()

setLargestLocalError

public void setLargestLocalError(LocalError localError,
                                 UpdateModule associatedModule,
                                 double associatedConcentration)

getLocalErrorModule

public UpdateModule getLocalErrorModule()

getLocalErrorUpdate

public double getLocalErrorUpdate()

getLargestGlobalError

public double getLargestGlobalError()

timeStepWasRescaled

public boolean timeStepWasRescaled()

timeStepWasAlteredInThisEpoch

public boolean timeStepWasAlteredInThisEpoch()

getAccuracyGain

public javax.measure.Quantity<javax.measure.quantity.Frequency> getAccuracyGain()

increaseTimeStep

public void increaseTimeStep()

decreaseTimeStep

public void decreaseTimeStep()

getCountDownLatch

public CountDownLatch getCountDownLatch()

addModule

public void addModule(UpdateModule module)

getNumberOfModules

public int getNumberOfModules()

interruptAllBut

public boolean interruptAllBut(Thread callingThread,
                               UpdateModule callingModule)

Returns true if the calling module was the first to call the method, therefore being allowed to optimize the time step.

Parameters:

callingThread - The calling thread.

callingModule - The associated module.

Returns:

True if the calling module was the first to call the method.

resetCalculation

public void resetCalculation()