org.simulator.math.odes

Interface EventDESystem

All Superinterfaces:

DESystem, org.apache.commons.math.ode.FirstOrderDifferentialEquations, Serializable

All Known Implementing Classes:

EquationSystem, SBMLinterpreter

public interface EventDESystem
extends DESystem

This class represents an event-driven differential equation system

Since:

0.9

Version:

$Rev$

Author:

Alexander Dörr, Andreas Dräger

Method Summary

Modifier and Type	Method and Description
int	getEventCount() Counts the number of events in this system.
EventInProgress	getNextEventAssignments(double t, double previousTime, double[] Y) Returns a list with event assignments for the events triggered either by the time t or by the concentrations of the species stored in Y.
boolean	getNoDerivatives()
int	getRuleCount() Counts the number of rules to be evaluated in each time point.
boolean	processAssignmentRules(double t, double[] Y) Calculates the changes or assignments that are defined by all rules in the system at the given simulation time point.

Methods inherited from interface org.simulator.math.odes.DESystem

containsEventsOrRules, getIdentifiers, getPositiveValueCount, setDelaysIncluded

Methods inherited from interface org.apache.commons.math.ode.FirstOrderDifferentialEquations

computeDerivatives, getDimension

Method Detail

getEventCount

int getEventCount()

Counts the number of events in this system.

Returns:

The number of events that are to be checked and potentially evaluated in each time point.

getRuleCount

int getRuleCount()

Counts the number of rules to be evaluated in each time point.

Returns:

The number of rules in the system.

processAssignmentRules

boolean processAssignmentRules(double t,
                               double[] Y)
                        throws org.apache.commons.math.ode.DerivativeException

Calculates the changes or assignments that are defined by all rules in the system at the given simulation time point.

Parameters:

t - The current simulation time.

Y - The current change of the system.

Returns:

flag that is true if there has been a change in the Y vector caused by the rules.

Throws:

org.apache.commons.math.ode.DerivativeException

getNextEventAssignments

EventInProgress getNextEventAssignments(double t,
                                        double previousTime,
                                        double[] Y)
                                 throws org.apache.commons.math.ode.DerivativeException

Returns a list with event assignments for the events triggered either by the time t or by the concentrations of the species stored in Y.

Parameters:

t - The current simulation time.

Y - The current change of the system.

Returns:

Returns a list with event assignments for the events triggered

Throws:

org.apache.commons.math.ode.DerivativeException

getNoDerivatives

boolean getNoDerivatives()

Returns:

flag that is true, if the change vector is always zero in the system.