org.simulator.math.odes
Class EulerMethod

java.lang.Object
  extended by org.simulator.math.odes.AbstractDESSolver
      extended by org.simulator.math.odes.EulerMethod
All Implemented Interfaces:
Serializable, Cloneable, EventHandler, DelayValueHolder, DESSolver

public class EulerMethod
extends AbstractDESSolver

In this class the Euler method for integration a differential equation system is implemented.

Since:
0.9
Version:
$Rev: 332 $
Author:
Andreas Dräger
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface org.apache.commons.math.ode.events.EventHandler
CONTINUE, RESET_DERIVATIVES, RESET_STATE, STOP
 
Constructor Summary
EulerMethod()
          default constructor
EulerMethod(double stepSize)
           
EulerMethod(double stepSize, boolean nonnegative)
           
EulerMethod(EulerMethod eulerMethod)
          clone constructor
 
Method Summary
 EulerMethod clone()
           
 double[] computeChange(DESystem DES, double[] yPrev, double t, double stepSize, double[] change, boolean steadyState)
          Computes the change for a given system at the current time with the current setting for the integration step size.
 int getKiSAOterm()
          For details about the Kinetic Simulation Algorithm Ontology (KiSAO) see http://biomodels.net/kisao/.
 String getName()
          This gives a human-readable name of this solver that can be displayed in a graphical user interface.
protected  boolean hasSolverEventProcessing()
           
 
Methods inherited from class org.simulator.math.odes.AbstractDESSolver
additionalResults, addPropertyChangeListener, computeDelayedValue, computeSteadyState, eventOccurred, firePropertyChange, g, getSerialversionuid, getStepSize, inBetweenSteps, initResultMatrix, initResultMatrix, initResultMatrix, isIncludeIntermediates, isNonnegative, isUnstable, processEvents, processEventsAndRules, processRules, removePropertyChangeListener, reset, resetState, setIncludeIntermediates, setNonnegative, setStepSize, setUnstableFlag, solve, solve, solve, solve
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EulerMethod

public EulerMethod()
default constructor


EulerMethod

public EulerMethod(double stepSize)
Parameters:
stepSize -

EulerMethod

public EulerMethod(double stepSize,
                   boolean nonnegative)
Parameters:
stepSize -
nonnegative - the nonnegative flag of the super class
See Also:
AbstractDESSolver

EulerMethod

public EulerMethod(EulerMethod eulerMethod)
clone constructor

Parameters:
eulerMethod -
Method Detail

getName

public String getName()
Description copied from class: AbstractDESSolver
This gives a human-readable name of this solver that can be displayed in a graphical user interface.

Specified by:
getName in class AbstractDESSolver
Returns:
A name that describes the underlying algorithm.

computeChange

public double[] computeChange(DESystem DES,
                              double[] yPrev,
                              double t,
                              double stepSize,
                              double[] change,
                              boolean steadyState)
                       throws DerivativeException
Description copied from class: AbstractDESSolver
Computes the change for a given system at the current time with the current setting for the integration step size.

Specified by:
computeChange in class AbstractDESSolver
Parameters:
DES - The system to be simulated.
yPrev - The current state of the system.
t - The current simulation time.
stepSize - The current integration step size.
change - The vector for the resulting change of the system.
Returns:
The change.
Throws:
DerivativeException

clone

public EulerMethod clone()
Specified by:
clone in interface DESSolver
Specified by:
clone in class AbstractDESSolver
Returns:
the cloned solver

hasSolverEventProcessing

protected boolean hasSolverEventProcessing()
Specified by:
hasSolverEventProcessing in class AbstractDESSolver
Returns:
Does the solver do the event processing itself?

getKiSAOterm

public int getKiSAOterm()
Description copied from interface: DESSolver
For details about the Kinetic Simulation Algorithm Ontology (KiSAO) see http://biomodels.net/kisao/.

Returns:
the KiSAO term of the algorithm

Generated December 13 2012