T - the type of the field elementspublic abstract class AbstractFieldIntegrator<T extends RealFieldElement<T>> extends Object implements FirstOrderFieldIntegrator<T>
| Modifier | Constructor and Description | 
|---|---|
| protected  | AbstractFieldIntegrator(Field<T> field,
                       String name)Build an instance. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected FieldODEStateAndDerivative<T> | acceptStep(AbstractFieldStepInterpolator<T> interpolator,
          T tEnd)Accept a step, triggering events and step handlers. | 
| void | addEventHandler(FieldEventHandler<T> handler,
               double maxCheckInterval,
               double convergence,
               int maxIterationCount)Add an event handler to the integrator. | 
| void | addEventHandler(FieldEventHandler<T> handler,
               double maxCheckInterval,
               double convergence,
               int maxIterationCount,
               BracketedRealFieldUnivariateSolver<T> solver)Add an event handler to the integrator. | 
| void | addStepHandler(FieldStepHandler<T> handler)Add a step handler to this integrator. | 
| void | clearEventHandlers()Remove all the event handlers that have been added to the integrator. | 
| void | clearStepHandlers()Remove all the step handlers that have been added to the integrator. | 
| T[] | computeDerivatives(T t,
                  T[] y)Compute the derivatives and check the number of evaluations. | 
| T | getCurrentSignedStepsize()Get the current signed value of the integration stepsize. | 
| FieldODEStateAndDerivative<T> | getCurrentStepStart()Get the current value of the step start time ti. | 
| protected FieldExpandableODE<T> | getEquations()Get the differential equations to integrate. | 
| int | getEvaluations()Get the number of evaluations of the differential equations function. | 
| protected IntegerSequence.Incrementor | getEvaluationsCounter()Get the evaluations counter. | 
| Collection<FieldEventHandler<T>> | getEventHandlers()Get all the event handlers that have been added to the integrator. | 
| Field<T> | getField()Get the field to which state vector elements belong. | 
| int | getMaxEvaluations()Get the maximal number of functions evaluations. | 
| String | getName()Get the name of the method. | 
| Collection<FieldStepHandler<T>> | getStepHandlers()Get all the step handlers that have been added to the integrator. | 
| protected T | getStepSize()Get the current step size. | 
| protected FieldODEStateAndDerivative<T> | getStepStart()Getcurrent step start. | 
| protected FieldODEStateAndDerivative<T> | initIntegration(FieldExpandableODE<T> eqn,
               T t0,
               T[] y0,
               T t)Prepare the start of an integration. | 
| protected boolean | isLastStep()Check if this step is the last one. | 
| protected boolean | resetOccurred()Check if a reset occurred while last step was accepted. | 
| protected void | sanityChecks(FieldODEState<T> eqn,
            T t)Check the integration span. | 
| protected void | setIsLastStep(boolean isLastStep)Set the last state flag. | 
| void | setMaxEvaluations(int maxEvaluations)Set the maximal number of differential equations function evaluations. | 
| protected void | setStateInitialized(boolean stateInitialized)Set the stateInitialized flag. | 
| protected void | setStepSize(T stepSize)Set the current step size. | 
| protected void | setStepStart(FieldODEStateAndDerivative<T> stepStart)Set current step start. | 
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitintegratepublic Field<T> getField()
public String getName()
getName in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>public void addStepHandler(FieldStepHandler<T> handler)
The handler will be called by the integrator for each accepted step.
addStepHandler in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>handler - handler for the accepted stepsFirstOrderFieldIntegrator.getStepHandlers(), 
FirstOrderFieldIntegrator.clearStepHandlers()public Collection<FieldStepHandler<T>> getStepHandlers()
getStepHandlers in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>FirstOrderFieldIntegrator.addStepHandler(FieldStepHandler), 
FirstOrderFieldIntegrator.clearStepHandlers()public void clearStepHandlers()
clearStepHandlers in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>FirstOrderFieldIntegrator.addStepHandler(FieldStepHandler), 
FirstOrderFieldIntegrator.getStepHandlers()public void addEventHandler(FieldEventHandler<T> handler, double maxCheckInterval, double convergence, int maxIterationCount)
 The default solver is a 5th order FieldBracketingNthOrderBrentSolver.
 
addEventHandler in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>handler - event handlermaxCheckInterval - maximal time interval between switching
 function checks (this interval prevents missing sign changes in
 case the integration steps becomes very large)convergence - convergence threshold in the event time searchmaxIterationCount - upper limit of the iteration count in
 the event time search events.FirstOrderFieldIntegrator.addEventHandler(FieldEventHandler, double, double, int,
 org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver), 
FirstOrderFieldIntegrator.getEventHandlers(), 
FirstOrderFieldIntegrator.clearEventHandlers()public void addEventHandler(FieldEventHandler<T> handler, double maxCheckInterval, double convergence, int maxIterationCount, BracketedRealFieldUnivariateSolver<T> solver)
addEventHandler in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>handler - event handlermaxCheckInterval - maximal time interval between switching
 function checks (this interval prevents missing sign changes in
 case the integration steps becomes very large)convergence - convergence threshold in the event time searchmaxIterationCount - upper limit of the iteration count in
 the event time search events.solver - solver to use to locate the eventFirstOrderFieldIntegrator.addEventHandler(FieldEventHandler, double, double, int), 
FirstOrderFieldIntegrator.getEventHandlers(), 
FirstOrderFieldIntegrator.clearEventHandlers()public Collection<FieldEventHandler<T>> getEventHandlers()
getEventHandlers in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>FirstOrderFieldIntegrator.addEventHandler(FieldEventHandler, double, double, int), 
FirstOrderFieldIntegrator.clearEventHandlers()public void clearEventHandlers()
clearEventHandlers in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>FirstOrderFieldIntegrator.addEventHandler(FieldEventHandler, double, double, int), 
FirstOrderFieldIntegrator.getEventHandlers()public FieldODEStateAndDerivative<T> getCurrentStepStart()
This method can be called during integration (typically by
 the object implementing the differential equations problem) if the value of the current step that
 is attempted is needed.
The result is undefined if the method is called outside of
 calls to integrate.
getCurrentStepStart in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>public T getCurrentSignedStepsize()
This method can be called during integration (typically by
 the object implementing the differential equations problem) if the signed value of the current stepsize
 that is tried is needed.
The result is undefined if the method is called outside of
 calls to integrate.
getCurrentSignedStepsize in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>public void setMaxEvaluations(int maxEvaluations)
The purpose of this method is to avoid infinite loops which can occur for example when stringent error constraints are set or when lots of discrete events are triggered, thus leading to many rejected steps.
setMaxEvaluations in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>maxEvaluations - maximal number of function evaluations (negative
 values are silently converted to maximal integer value, thus representing
 almost unlimited evaluations)public int getMaxEvaluations()
getMaxEvaluations in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>public int getEvaluations()
 The number of evaluations corresponds to the last call to the
 integrate method. It is 0 if the method has not been called yet.
 
getEvaluations in interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>protected FieldODEStateAndDerivative<T> initIntegration(FieldExpandableODE<T> eqn, T t0, T[] y0, T t)
eqn - equations to integratet0 - start value of the independent time variabley0 - array containing the start value of the state vectort - target time for the integrationprotected FieldExpandableODE<T> getEquations()
protected IntegerSequence.Incrementor getEvaluationsCounter()
public T[] computeDerivatives(T t, T[] y) throws DimensionMismatchException, MaxCountExceededException, NullPointerException
t - current value of the independent time variabley - array containing the current value of the state vectorDimensionMismatchException - if arrays dimensions do not match equations settingsMaxCountExceededException - if the number of functions evaluations is exceededNullPointerException - if the ODE equations have not been set (i.e. if this method
 is called outside of a call to integrateprotected void setStateInitialized(boolean stateInitialized)
This method must be called by integrators with the value
 false before they start integration, so a proper lazy
 initialization is done automatically on the first step.
stateInitialized - new value for the flagprotected FieldODEStateAndDerivative<T> acceptStep(AbstractFieldStepInterpolator<T> interpolator, T tEnd) throws MaxCountExceededException, DimensionMismatchException, NoBracketingException
interpolator - step interpolatortEnd - final integration timeMaxCountExceededException - if the interpolator throws one because
 the number of functions evaluations is exceededNoBracketingException - if the location of an event cannot be bracketedDimensionMismatchException - if arrays dimensions do not match equations settingsprotected void sanityChecks(FieldODEState<T> eqn, T t) throws NumberIsTooSmallException, DimensionMismatchException
eqn - set of differential equationst - target time for the integrationNumberIsTooSmallException - if integration span is too smallDimensionMismatchException - if adaptive step size integrators
 tolerance arrays dimensions are not compatible with equations settingsprotected boolean resetOccurred()
protected void setStepSize(T stepSize)
stepSize - step size to setprotected T getStepSize()
protected void setStepStart(FieldODEStateAndDerivative<T> stepStart)
stepStart - step startprotected FieldODEStateAndDerivative<T> getStepStart()
protected void setIsLastStep(boolean isLastStep)
isLastStep - if true, this step is the last oneprotected boolean isLastStep()
Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.