agi.foundation.numericalmethods.advanced

(agi.foundation.core-2024r3.jar)

Class MultipleStepIntegrator

java.lang.Object

agi.foundation.numericalmethods.NumericalIntegrator

agi.foundation.numericalmethods.advanced.MultipleStepIntegrator

All Implemented Interfaces:

ICloneWithContext, IThreadAware

Direct Known Subclasses:

GaussJacksonIntegrator

public abstract class MultipleStepIntegrator
extends NumericalIntegrator

A subtype of integrator which saves multiple steps of derivative data for more accurate integration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultipleStepIntegrator() Initializes a new instance.
protected	MultipleStepIntegrator(MultipleStepIntegrator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
abstract void	updateSavedDerivatives(double[] derivativeCorrections) This method is used in order to update the last step's derivatives with any post integration corrections.

Methods inherited from class agi.foundation.numericalmethods.NumericalIntegrator

clone, getCurrentStepSize, getDimension, getDirection, getFinalDependentVariableValues, getFinalIndependentVariableValue, getInitialDependentVariableValues, getInitialIndependentVariableValue, getInitialStepSize, getIsThreadSafe, getPreviousStepSize, getStepSizeInformation, getSystemOfEquations, initialize, integrate, integrate, reintegrate, setDirection, setFinalDependentVariableValues, setFinalIndependentVariableValue, setInitialDependentVariableValues, setInitialIndependentVariableValue, setInitialStepSize, setStepSizeInformation, setSystemOfEquations, startNextStep

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleStepIntegrator

protected MultipleStepIntegrator()

Initializes a new instance.

MultipleStepIntegrator

protected MultipleStepIntegrator(@Nonnull
                                 MultipleStepIntegrator existingInstance,
                                 @Nonnull
                                 CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

updateSavedDerivatives

public abstract void updateSavedDerivatives(@Nonnull
                                            double[] derivativeCorrections)

This method is used in order to update the last step's derivatives with any post integration corrections.

Parameters:

derivativeCorrections - The corrections to the last step's derivatives.