fr.cnes.sirius.patrius.math.ode.nonstiff

Class HighamHall54Integrator

java.lang.Object

java.util.Observable

fr.cnes.sirius.patrius.math.ode.AbstractIntegrator

fr.cnes.sirius.patrius.math.ode.nonstiff.AdaptiveStepsizeIntegrator

fr.cnes.sirius.patrius.math.ode.nonstiff.EmbeddedRungeKuttaIntegrator

fr.cnes.sirius.patrius.math.ode.nonstiff.HighamHall54Integrator

All Implemented Interfaces:

FirstOrderIntegrator, ODEIntegrator

public class HighamHall54Integrator
extends EmbeddedRungeKuttaIntegrator

This class implements the 5(4) Higham and Hall integrator for Ordinary Differential Equations.

This integrator is an embedded Runge-Kutta integrator of order 5(4) used in local extrapolation mode (i.e. the solution is computed using the high order formula) with stepsize control (and automatic step initialization) and continuous output. This method uses 7 functions evaluations per step.

Since:

1.2

Version:

$Id: HighamHall54Integrator.java 18108 2017-10-04 06:45:27Z bignon $

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.math.ode.nonstiff.EmbeddedRungeKuttaIntegrator

estimateError

Fields inherited from class fr.cnes.sirius.patrius.math.ode.nonstiff.AdaptiveStepsizeIntegrator

mainSetDimension, scalAbsoluteTolerance, scalRelativeTolerance, vecAbsoluteTolerance, vecRelativeTolerance

Fields inherited from class fr.cnes.sirius.patrius.math.ode.AbstractIntegrator

isLastStep, lastStepHandle, resetOccurred, stepHandlers, stepSize, stepStart

Constructor Summary

Constructors

Constructor and Description
HighamHall54Integrator(double minStep, double maxStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance) Simple constructor.
HighamHall54Integrator(double minStep, double maxStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance, boolean acceptSmall) Simple constructor.
HighamHall54Integrator(double minStep, double maxStep, double scalAbsoluteTolerance, double scalRelativeTolerance) Simple constructor.
HighamHall54Integrator(double minStep, double maxStep, double scalAbsoluteTolerance, double scalRelativeTolerance, boolean acceptSmall) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected double	estimateError(double[][] yDotK, double[] y0, double[] y1, double h) Compute the error ratio.
int	getOrder() Get the order of the method.

Methods inherited from class fr.cnes.sirius.patrius.math.ode.nonstiff.EmbeddedRungeKuttaIntegrator

getMaxGrowth, getMinReduction, getSafety, initIntegration, integrate, setMaxGrowth, setMinReduction, setSafety

Methods inherited from class fr.cnes.sirius.patrius.math.ode.nonstiff.AdaptiveStepsizeIntegrator

filterStep, getCurrentStepStart, getMaxStep, getMinStep, initializeStep, resetInternalState, sanityChecks, setInitialStepSize, setStepSizeControl, setStepSizeControl

Methods inherited from class fr.cnes.sirius.patrius.math.ode.AbstractIntegrator

acceptStep, addEventHandler, addEventHandler, addStepHandler, clearEventHandlers, clearStepHandlers, computeDerivatives, getCurrentSignedStepsize, getEvaluations, getEventHandlers, getMaxEvaluations, getName, getStepHandlers, handleLastStep, integrate, removeEventState, setEquations, setMaxEvaluations, setStateInitialized

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

HighamHall54Integrator

public HighamHall54Integrator(double minStep,
                              double maxStep,
                              double scalAbsoluteTolerance,
                              double scalRelativeTolerance)

Simple constructor. Build a fifth order Higham and Hall integrator with the given step bounds

Parameters:

minStep - minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

maxStep - maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

scalAbsoluteTolerance - allowed absolute error

scalRelativeTolerance - allowed relative error

HighamHall54Integrator

public HighamHall54Integrator(double minStep,
                              double maxStep,
                              double[] vecAbsoluteTolerance,
                              double[] vecRelativeTolerance)

Simple constructor. Build a fifth order Higham and Hall integrator with the given step bounds

Parameters:

minStep - minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

maxStep - maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

vecAbsoluteTolerance - allowed absolute error

vecRelativeTolerance - allowed relative error

HighamHall54Integrator

public HighamHall54Integrator(double minStep,
                              double maxStep,
                              double scalAbsoluteTolerance,
                              double scalRelativeTolerance,
                              boolean acceptSmall)

Simple constructor. Build a fifth order Higham and Hall integrator with the given step bounds

Parameters:

minStep - minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

maxStep - maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

scalAbsoluteTolerance - allowed absolute error

scalRelativeTolerance - allowed relative error

acceptSmall - if true, steps smaller than the minimal value are silently increased up to this value, if false such small steps generate an exception

HighamHall54Integrator

public HighamHall54Integrator(double minStep,
                              double maxStep,
                              double[] vecAbsoluteTolerance,
                              double[] vecRelativeTolerance,
                              boolean acceptSmall)

Simple constructor. Build a fifth order Higham and Hall integrator with the given step bounds

Parameters:

minStep - minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

maxStep - maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than this

vecAbsoluteTolerance - allowed absolute error

vecRelativeTolerance - allowed relative error

acceptSmall - if true, steps smaller than the minimal value are silently increased up to this value, if false such small steps generate an exception

Method Detail

getOrder

public int getOrder()

Get the order of the method.

Specified by:

getOrder in class EmbeddedRungeKuttaIntegrator

Returns:

order of the method

estimateError

protected double estimateError(double[][] yDotK,
                               double[] y0,
                               double[] y1,
                               double h)

Compute the error ratio.

Specified by:

estimateError in class EmbeddedRungeKuttaIntegrator

Parameters:

yDotK - derivatives computed during the first stages

y0 - estimate of the step at the start of the step

y1 - estimate of the step at the end of the step

h - current step

Returns:

error ratio, greater than 1 if step should be rejected