Class AdamsFieldStepInterpolator<T extends RealFieldElement<T>>
java.lang.Object
org.apache.commons.math3.ode.sampling.AbstractFieldStepInterpolator<T>
org.apache.commons.math3.ode.nonstiff.AdamsFieldStepInterpolator<T>
- Type Parameters:
T
- the type of the field elements
- All Implemented Interfaces:
FieldStepInterpolator<T>
class AdamsFieldStepInterpolator<T extends RealFieldElement<T>>
extends AbstractFieldStepInterpolator<T>
This class implements an interpolator for Adams integrators using Nordsieck representation.
This interpolator computes dense output around the current point. The interpolation equation is based on Taylor series formulas.
- Since:
- 3.6
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Array2DRowFieldMatrix
<T> Nordsieck vector.private final FieldODEStateAndDerivative
<T> Reference state.private final T[]
First scaled derivative.private T
Step size used in the first scaled derivative and Nordsieck vector. -
Constructor Summary
ConstructorsModifierConstructorDescription(package private)
AdamsFieldStepInterpolator
(T stepSize, FieldODEStateAndDerivative<T> reference, T[] scaled, Array2DRowFieldMatrix<T> nordsieck, boolean isForward, FieldODEStateAndDerivative<T> globalPreviousState, FieldODEStateAndDerivative<T> globalCurrentState, FieldEquationsMapper<T> equationsMapper) Simple constructor.private
AdamsFieldStepInterpolator
(T stepSize, FieldODEStateAndDerivative<T> reference, T[] scaled, Array2DRowFieldMatrix<T> nordsieck, boolean isForward, FieldODEStateAndDerivative<T> globalPreviousState, FieldODEStateAndDerivative<T> globalCurrentState, FieldODEStateAndDerivative<T> softPreviousState, FieldODEStateAndDerivative<T> softCurrentState, FieldEquationsMapper<T> equationsMapper) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected FieldODEStateAndDerivative
<T> computeInterpolatedStateAndDerivatives
(FieldEquationsMapper<T> equationsMapper, T time, T theta, T thetaH, T oneMinusThetaH) Compute the state and derivatives at the interpolated time.protected AdamsFieldStepInterpolator
<T> create
(boolean newForward, FieldODEStateAndDerivative<T> newGlobalPreviousState, FieldODEStateAndDerivative<T> newGlobalCurrentState, FieldODEStateAndDerivative<T> newSoftPreviousState, FieldODEStateAndDerivative<T> newSoftCurrentState, FieldEquationsMapper<T> newMapper) Create a new instance.static <S extends RealFieldElement<S>>
FieldODEStateAndDerivative<S> taylor
(FieldODEStateAndDerivative<S> reference, S time, S stepSize, S[] scaled, Array2DRowFieldMatrix<S> nordsieck) Estimate state by applying Taylor formula.Methods inherited from class org.apache.commons.math3.ode.sampling.AbstractFieldStepInterpolator
getCurrentState, getGlobalCurrentState, getGlobalPreviousState, getInterpolatedState, getPreviousState, isForward, restrictStep
-
Field Details
-
scalingH
Step size used in the first scaled derivative and Nordsieck vector. -
reference
Reference state.Sometimes, the reference state is the same as globalPreviousState, sometimes it is the same as globalCurrentState, so we use a separate field to avoid any confusion.
-
scaled
First scaled derivative. -
nordsieck
Nordsieck vector.
-
-
Constructor Details
-
AdamsFieldStepInterpolator
AdamsFieldStepInterpolator(T stepSize, FieldODEStateAndDerivative<T> reference, T[] scaled, Array2DRowFieldMatrix<T> nordsieck, boolean isForward, FieldODEStateAndDerivative<T> globalPreviousState, FieldODEStateAndDerivative<T> globalCurrentState, FieldEquationsMapper<T> equationsMapper) Simple constructor.- Parameters:
stepSize
- step size used in the scaled and Nordsieck arraysreference
- reference state from which Taylor expansion are estimatedscaled
- first scaled derivativenordsieck
- Nordsieck vectorisForward
- integration direction indicatorglobalPreviousState
- start of the global stepglobalCurrentState
- end of the global stepequationsMapper
- mapper for ODE equations primary and secondary components
-
AdamsFieldStepInterpolator
private AdamsFieldStepInterpolator(T stepSize, FieldODEStateAndDerivative<T> reference, T[] scaled, Array2DRowFieldMatrix<T> nordsieck, boolean isForward, FieldODEStateAndDerivative<T> globalPreviousState, FieldODEStateAndDerivative<T> globalCurrentState, FieldODEStateAndDerivative<T> softPreviousState, FieldODEStateAndDerivative<T> softCurrentState, FieldEquationsMapper<T> equationsMapper) Simple constructor.- Parameters:
stepSize
- step size used in the scaled and Nordsieck arraysreference
- reference state from which Taylor expansion are estimatedscaled
- first scaled derivativenordsieck
- Nordsieck vectorisForward
- integration direction indicatorglobalPreviousState
- start of the global stepglobalCurrentState
- end of the global stepsoftPreviousState
- start of the restricted stepsoftCurrentState
- end of the restricted stepequationsMapper
- mapper for ODE equations primary and secondary components
-
-
Method Details
-
create
protected AdamsFieldStepInterpolator<T> create(boolean newForward, FieldODEStateAndDerivative<T> newGlobalPreviousState, FieldODEStateAndDerivative<T> newGlobalCurrentState, FieldODEStateAndDerivative<T> newSoftPreviousState, FieldODEStateAndDerivative<T> newSoftCurrentState, FieldEquationsMapper<T> newMapper) Create a new instance.- Specified by:
create
in classAbstractFieldStepInterpolator<T extends RealFieldElement<T>>
- Parameters:
newForward
- integration direction indicatornewGlobalPreviousState
- start of the global stepnewGlobalCurrentState
- end of the global stepnewSoftPreviousState
- start of the restricted stepnewSoftCurrentState
- end of the restricted stepnewMapper
- equations mapper for the all equations- Returns:
- a new instance
-
computeInterpolatedStateAndDerivatives
protected FieldODEStateAndDerivative<T> computeInterpolatedStateAndDerivatives(FieldEquationsMapper<T> equationsMapper, T time, T theta, T thetaH, T oneMinusThetaH) Compute the state and derivatives at the interpolated time. This is the main processing method that should be implemented by the derived classes to perform the interpolation.- Specified by:
computeInterpolatedStateAndDerivatives
in classAbstractFieldStepInterpolator<T extends RealFieldElement<T>>
- Parameters:
equationsMapper
- mapper for ODE equations primary and secondary componentstime
- interpolation timetheta
- normalized interpolation abscissa within the step (theta is zero at the previous time step and one at the current time step)thetaH
- time gap between the previous time and the interpolated timeoneMinusThetaH
- time gap between the interpolated time and the current time- Returns:
- interpolated state and derivatives
-
taylor
public static <S extends RealFieldElement<S>> FieldODEStateAndDerivative<S> taylor(FieldODEStateAndDerivative<S> reference, S time, S stepSize, S[] scaled, Array2DRowFieldMatrix<S> nordsieck) Estimate state by applying Taylor formula.- Type Parameters:
S
- the type of the field elements- Parameters:
reference
- reference statetime
- time at which state must be estimatedstepSize
- step size used in the scaled and Nordsieck arraysscaled
- first scaled derivativenordsieck
- Nordsieck vector- Returns:
- estimated state
-