Class AdamsFieldIntegrator<T extends RealFieldElement<T>>
java.lang.Object
org.apache.commons.math3.ode.AbstractFieldIntegrator<T>
org.apache.commons.math3.ode.nonstiff.AdaptiveStepsizeFieldIntegrator<T>
org.apache.commons.math3.ode.MultistepFieldIntegrator<T>
org.apache.commons.math3.ode.nonstiff.AdamsFieldIntegrator<T>
- Type Parameters:
T- the type of the field elements
- All Implemented Interfaces:
FirstOrderFieldIntegrator<T>
- Direct Known Subclasses:
AdamsBashforthFieldIntegrator,AdamsMoultonFieldIntegrator
public abstract class AdamsFieldIntegrator<T extends RealFieldElement<T>>
extends MultistepFieldIntegrator<T>
Base class for
Adams-Bashforth and
Adams-Moulton integrators.- Since:
- 3.6
-
Field Summary
Fields inherited from class org.apache.commons.math3.ode.MultistepFieldIntegrator
nordsieck, scaledFields inherited from class org.apache.commons.math3.ode.nonstiff.AdaptiveStepsizeFieldIntegrator
mainSetDimension, scalAbsoluteTolerance, scalRelativeTolerance, vecAbsoluteTolerance, vecRelativeTolerance -
Constructor Summary
ConstructorsConstructorDescriptionAdamsFieldIntegrator(Field<T> field, String name, int nSteps, int order, double minStep, double maxStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance) Build an Adams integrator with the given order and step control parameters.AdamsFieldIntegrator(Field<T> field, String name, int nSteps, int order, double minStep, double maxStep, double scalAbsoluteTolerance, double scalRelativeTolerance) Build an Adams integrator with the given order and step control parameters. -
Method Summary
Modifier and TypeMethodDescriptionprotected Array2DRowFieldMatrix<T> initializeHighOrderDerivatives(T h, T[] t, T[][] y, T[][] yDot) Initialize the high order scaled derivatives at step start.abstract FieldODEStateAndDerivative<T> integrate(FieldExpandableODE<T> equations, FieldODEState<T> initialState, T finalTime) Integrate the differential equations up to the given time.updateHighOrderDerivativesPhase1(Array2DRowFieldMatrix<T> highOrder) Update the high order scaled derivatives for Adams integrators (phase 1).voidupdateHighOrderDerivativesPhase2(T[] start, T[] end, Array2DRowFieldMatrix<T> highOrder) Update the high order scaled derivatives Adams integrators (phase 2).Methods inherited from class org.apache.commons.math3.ode.MultistepFieldIntegrator
computeStepGrowShrinkFactor, getMaxGrowth, getMinReduction, getNSteps, getSafety, getStarterIntegrator, rescale, setMaxGrowth, setMinReduction, setSafety, setStarterIntegrator, startMethods inherited from class org.apache.commons.math3.ode.nonstiff.AdaptiveStepsizeFieldIntegrator
filterStep, getMaxStep, getMinStep, initializeStep, resetInternalState, sanityChecks, setInitialStepSize, setStepSizeControl, setStepSizeControlMethods inherited from class org.apache.commons.math3.ode.AbstractFieldIntegrator
acceptStep, addEventHandler, addEventHandler, addStepHandler, clearEventHandlers, clearStepHandlers, computeDerivatives, getCurrentSignedStepsize, getCurrentStepStart, getEquations, getEvaluations, getEvaluationsCounter, getEventHandlers, getField, getMaxEvaluations, getName, getStepHandlers, getStepSize, getStepStart, initIntegration, isLastStep, resetOccurred, setIsLastStep, setMaxEvaluations, setStateInitialized, setStepSize, setStepStart
-
Constructor Details
-
AdamsFieldIntegrator
public AdamsFieldIntegrator(Field<T> field, String name, int nSteps, int order, double minStep, double maxStep, double scalAbsoluteTolerance, double scalRelativeTolerance) throws NumberIsTooSmallException Build an Adams integrator with the given order and step control parameters.- Parameters:
field- field to which the time and state vector elements belongname- name of the methodnSteps- number of steps of the method excluding the one being computedorder- order of the methodminStep- minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than thismaxStep- maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than thisscalAbsoluteTolerance- allowed absolute errorscalRelativeTolerance- allowed relative error- Throws:
NumberIsTooSmallException- if order is 1 or less
-
AdamsFieldIntegrator
public AdamsFieldIntegrator(Field<T> field, String name, int nSteps, int order, double minStep, double maxStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance) throws IllegalArgumentException Build an Adams integrator with the given order and step control parameters.- Parameters:
field- field to which the time and state vector elements belongname- name of the methodnSteps- number of steps of the method excluding the one being computedorder- order of the methodminStep- minimal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than thismaxStep- maximal step (sign is irrelevant, regardless of integration direction, forward or backward), the last step can be smaller than thisvecAbsoluteTolerance- allowed absolute errorvecRelativeTolerance- allowed relative error- Throws:
IllegalArgumentException- if order is 1 or less
-
-
Method Details
-
integrate
public abstract FieldODEStateAndDerivative<T> integrate(FieldExpandableODE<T> equations, FieldODEState<T> initialState, T finalTime) throws NumberIsTooSmallException, DimensionMismatchException, MaxCountExceededException, NoBracketingException Integrate the differential equations up to the given time.This method solves an Initial Value Problem (IVP).
Since this method stores some internal state variables made available in its public interface during integration (
FirstOrderFieldIntegrator.getCurrentSignedStepsize()), it is not thread-safe.- Parameters:
equations- differential equations to integrateinitialState- initial state (time, primary and secondary state vectors)finalTime- target time for the integration (can be set to a value smaller thant0for backward integration)- Returns:
- final state, its time will be the same as
finalTimeif integration reached its target, but may be different if someFieldEventHandlerstops it at some point. - Throws:
NumberIsTooSmallException- if integration step is too smallMaxCountExceededException- if the number of functions evaluations is exceededNoBracketingException- if the location of an event cannot be bracketedDimensionMismatchException
-
initializeHighOrderDerivatives
Initialize the high order scaled derivatives at step start.- Specified by:
initializeHighOrderDerivativesin classMultistepFieldIntegrator<T extends RealFieldElement<T>>- Parameters:
h- step size to use for scalingt- first steps timesy- first steps statesyDot- first steps derivatives- Returns:
- Nordieck vector at first step (h2/2 y''n, h3/6 y'''n ... hk/k! y(k)n)
-
updateHighOrderDerivativesPhase1
public Array2DRowFieldMatrix<T> updateHighOrderDerivativesPhase1(Array2DRowFieldMatrix<T> highOrder) Update the high order scaled derivatives for Adams integrators (phase 1).The complete update of high order derivatives has a form similar to:
rn+1 = (s1(n) - s1(n+1)) P-1 u + P-1 A P rn
this method computes the P-1 A P rn part.- Parameters:
highOrder- high order scaled derivatives (h2/2 y'', ... hk/k! y(k))- Returns:
- updated high order derivatives
- See Also:
-
updateHighOrderDerivativesPhase2
public void updateHighOrderDerivativesPhase2(T[] start, T[] end, Array2DRowFieldMatrix<T> highOrder) Update the high order scaled derivatives Adams integrators (phase 2).The complete update of high order derivatives has a form similar to:
rn+1 = (s1(n) - s1(n+1)) P-1 u + P-1 A P rn
this method computes the (s1(n) - s1(n+1)) P-1 u part.Phase 1 of the update must already have been performed.
- Parameters:
start- first order scaled derivatives at step startend- first order scaled derivatives at step endhighOrder- high order scaled derivatives, will be modified (h2/2 y'', ... hk/k! y(k))- See Also:
-