org.spaceroots.mantissa.ode

Interface SecondOrderIntegrator

public interface SecondOrderIntegrator

This interface represents a second order integrator for differential equations.

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

See Also:

SecondOrderDifferentialEquations

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name of the method.
StepHandler	getStepHandler() Get the step handler for this integrator.
void	integrate(SecondOrderDifferentialEquations equations, double t0, double[] y0, double[] yDot0, double t, double[] y, double[] yDot) 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

integrate

void integrate(SecondOrderDifferentialEquations equations,
               double t0,
               double[] y0,
               double[] yDot0,
               double t,
               double[] y,
               double[] yDot)
        throws DerivativeException,
               IntegratorException

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

yDot0 - initial value of the first derivative 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

yDot - placeholder where to put the first derivative of the state vector at time t, can be the same object as yDot0

Throws:

IntegratorException - if the integrator cannot perform integration

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