org.jscience.mathematics.analysis.ode
Interface FirstOrderIntegrator

All Known Implementing Classes:

AdaptiveStepsizeIntegrator, ClassicalRungeKuttaIntegrator, DormandPrince54Integrator, DormandPrince853Integrator, EulerIntegrator, GillIntegrator, GraggBulirschStoerIntegrator, HighamHall54Integrator, MidpointIntegrator, RungeKuttaFehlbergIntegrator, RungeKuttaIntegrator, ThreeEighthesIntegrator

public interface FirstOrderIntegrator

This interface represents a first order integrator for differential equations.

The classes which are devoted to solve first order differential equations should implement this interface. The problems which can be handled should implement the FirstOrderDifferentialEquations interface.

See Also:

FirstOrderDifferentialEquations, StepHandler, SwitchingFunction

Method Summary

void	addSwitchingFunction(SwitchingFunction function, double maxCheckInterval, double convergence) Add a switching function to the integrator.
java.lang.String	getName() Get the name of the method.
StepHandler	getStepHandler() Get the step handler for this integrator.
void	integrate(FirstOrderDifferentialEquations equations, double t0, double[] y0, double t, double[] y) Integrate the differential equations up to the given time
void	setStepHandler(StepHandler handler) Set the step handler for this integrator.

Method Detail

getName

java.lang.String getName()

Get the name of the method.

Returns:

name of the method

setStepHandler

void setStepHandler(StepHandler handler)

Set the step handler for this integrator. The handler will be called by the integrator for each accepted step.

Parameters:

handler - handler for the accepted steps

getStepHandler

StepHandler getStepHandler()

Get the step handler for this integrator.

Returns:

the step handler for this integrator

addSwitchingFunction

void addSwitchingFunction(SwitchingFunction function,
                          double maxCheckInterval,
                          double convergence)

Add a switching function to the integrator.

Parameters:

function - switching function

maxCheckInterval - maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large)

convergence - convergence threshold in the event time search

integrate

void integrate(FirstOrderDifferentialEquations equations,
               double t0,
               double[] y0,
               double t,
               double[] y)
               throws DerivativeException,
                      IntegrationException

Integrate the differential equations up to the given time

Parameters:

equations - differential equations to integrate

t0 - initial time

y0 - initial value of the state vector at t0

t - target time for the integration (can be set to a value smaller thant t0 for backward integration)

y - placeholder where to put the state vector at each successful step (and hence at the end of integration), can be the same object as y0

Throws:

DerivativeException - this exception is propagated to the caller if the underlying user function triggers one

IntegrationException - if the integrator cannot perform integration