broadwick.odesolver

Class OdeSolver

java.lang.Object

broadwick.odesolver.OdeSolver

Direct Known Subclasses:

RungeKutta4

public abstract class OdeSolver
extends Object

A base class for all ODE solvers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OdeSolver.ThetaQueue Manages the registered theta events.

Field Summary

Fields

Modifier and Type	Field and Description
private OdeController	controller
protected double	currentTime
protected List<Double>	dependentVariables
private Double	independentVariableEnd
private Double	independentVariableStart
private Set<Observer>	observers
private Ode	ode
protected double	stepSize
private OdeSolver.ThetaQueue	thetaQueue

Constructor Summary

Constructors

Constructor and Description
OdeSolver(Ode ode, double tStart, double tEnd, double stepSize) Create the solver object with initial consitions.

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer observer) Add an observer to the engines list of observers.
protected void	doThetaEvent() Gets called when the simulator reaches the predetermined time of a theta event.
List<Double>	getDependentVariables() Get the dependent variables.
String	getDependetVariablesAsCsv() Get a csv representation of the current state of the dependent variables.
double	getNextThetaEventTime() Theta defines a moment, where the simulator has to invoke theta of a observers.
void	registerNewTheta(Observer obs, double thetaTime, Object event) Register a new theta event that is triggered at a given time.
abstract void	run() Solve the system of ODEs.

Methods inherited from class java.lang.Object

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

Field Detail

dependentVariables

protected final List<Double> dependentVariables

stepSize

protected final double stepSize

independentVariableStart

private final Double independentVariableStart

independentVariableEnd

private final Double independentVariableEnd

ode

private final Ode ode

currentTime

protected double currentTime

controller

private OdeController controller

observers

private final Set<Observer> observers

thetaQueue

private OdeSolver.ThetaQueue thetaQueue

Constructor Detail

OdeSolver

public OdeSolver(Ode ode,
                 double tStart,
                 double tEnd,
                 double stepSize)

Create the solver object with initial consitions.

Parameters:

ode - the ode object containing the specification of the ode.

tStart - the start time (the independent variable is assumed to be time)

tEnd - the end time (the independent variable is assumed to be time)

stepSize - the size of the step to be used in the solver.

Method Detail

addObserver

public final void addObserver(Observer observer)

Add an observer to the engines list of observers.

Parameters:

observer - the observer.

registerNewTheta

public final void registerNewTheta(Observer obs,
                                   double thetaTime,
                                   Object event)

Register a new theta event that is triggered at a given time.

Parameters:

obs - the observers which is registering.

thetaTime - the time the theta event occurs.

event - the theta event.

doThetaEvent

protected final void doThetaEvent()

Gets called when the simulator reaches the predetermined time of a theta event. All the observers for the events that are configured for this time are notified and given a list of events that are triggered.

getNextThetaEventTime

public final double getNextThetaEventTime()

Theta defines a moment, where the simulator has to invoke theta of a observers. It is used e.g. to determine the amounts of species at one moments. Extending class just have to call Simulator#doThetaEvent() which basically calls the observers.

Returns:

the theta

getDependetVariablesAsCsv

public final String getDependetVariablesAsCsv()

Get a csv representation of the current state of the dependent variables.

Returns:

a csv string.

getDependentVariables

public final List<Double> getDependentVariables()

Get the dependent variables.

Returns:

an array of the dependent variables.

run

public abstract void run()

Solve the system of ODEs.