Apache Commons Math 3.6.1 · org.apache.commons.math3.ode.AbstractFieldIntegrator

Modifier and Type	Field and Description
private static final double	DEFAULT_FUNCTION_VALUE_ACCURACY Default function value accuracy.
private static final double	DEFAULT_RELATIVE_ACCURACY Default relative accuracy.
private transient FieldExpandableODE<T>	equations Differential equations to integrate.
private IntegerSequence.Incrementor	evaluations Counter for number of evaluations.
private Collection<FieldEventState<T>>	eventsStates Events states.
private final Field<T>	field Field to which the time and state vector elements belong.
private boolean	isLastStep Indicator for last step.
private final String	name Name of the method.
private boolean	resetOccurred Indicator that a state or derivative reset was triggered by some event.
private boolean	statesInitialized Initialization indicator of events states.
private Collection<FieldStepHandler<T>>	stepHandlers Step handler.
private T	stepSize Current stepsize.
private FieldODEStateAndDerivative<T>	stepStart Current step start.

Access	Constructor and Description
protected	AbstractFieldIntegrator(final Field<T> field to which the time and state vector elements belong field, final String name of the method name) Build an instance.

Method Summary

Modifier and Type	Method and Description
protected FieldODEStateAndDerivative<T>	Returns: state at end of step acceptStep(final AbstractFieldStepInterpolator<T> step interpolator interpolator, final T final integration time tEnd) Accept a step, triggering events and step handlers.
public void	addEventHandler(final FieldEventHandler<T> event handler handler, final double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) maxCheckInterval, final double convergence threshold in the event time search convergence, final int upper limit of the iteration count in the event time search events. maxIterationCount) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Add an event handler to the integrator.
public void	addEventHandler(final FieldEventHandler<T> event handler handler, final double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) maxCheckInterval, final double convergence threshold in the event time search convergence, final int upper limit of the iteration count in the event time search events. maxIterationCount, final BracketedRealFieldUnivariateSolver<T> solver to use to locate the event solver) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Add an event handler to the integrator.
public void	addStepHandler(final FieldStepHandler<T> handler for the accepted steps handler) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addStepHandler. Add a step handler to this integrator.
public void	clearEventHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearEventHandlers. Remove all the event handlers that have been added to the integrator.
public void	clearStepHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearStepHandlers. Remove all the step handlers that have been added to the integrator.
public T[]	Returns: state completed with derivatives computeDerivatives(final T current value of the independent time variable t, final T[] array containing the current value of the state vector y) Compute the derivatives and check the number of evaluations.
public T	getCurrentSignedStepsize() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentSignedStepsize. Get the current signed value of the integration stepsize.
public FieldODEStateAndDerivative<T>	getCurrentStepStart() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentStepStart. Get the current value of the step start time t_i.
protected FieldExpandableODE<T>	Returns: differential equations to integrate getEquations() Get the differential equations to integrate.
public int	getEvaluations() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEvaluations. Get the number of evaluations of the differential equations function.
protected IntegerSequence.Incrementor	Returns: evaluations counter getEvaluationsCounter() Get the evaluations counter.
public Collection<FieldEventHandler<T>>	getEventHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEventHandlers. Get all the event handlers that have been added to the integrator.
public Field<T>	Returns: field to which state vector elements belong getField() Get the field to which state vector elements belong.
public int	getMaxEvaluations() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getMaxEvaluations. Get the maximal number of functions evaluations.
public String	getName() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getName. Get the name of the method.
public Collection<FieldStepHandler<T>>	getStepHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getStepHandlers. Get all the step handlers that have been added to the integrator.
protected T	Returns: current step size getStepSize() Get the current step size.
protected FieldODEStateAndDerivative<T>	Returns: current step start getStepStart() Getcurrent step start.
protected FieldODEStateAndDerivative<T>	Returns: initial state with derivatives added initIntegration(final FieldExpandableODE<T> equations to integrate eqn, final T start value of the independent time variable t0, final T[] array containing the start value of the state vector y0, final T target time for the integration t) Prepare the start of an integration.
protected boolean	Returns: true if this step is the last one isLastStep() Check if this step is the last one.
protected boolean	Returns: true if a reset occurred while last step was accepted resetOccurred() Check if a reset occurred while last step was accepted.
protected void	sanityChecks(final FieldODEState<T> set of differential equations eqn, final T target time for the integration t) Check the integration span.
protected void	setIsLastStep(final boolean if true, this step is the last one isLastStep) Set the last state flag.
public void	setMaxEvaluations(int maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations) maxEvaluations) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.setMaxEvaluations. Set the maximal number of differential equations function evaluations.
protected void	setStateInitialized(final boolean new value for the flag stateInitialized) Set the stateInitialized flag.
protected void	setStepSize(final T step size to set stepSize) Set the current step size.
protected void	setStepStart(final FieldODEStateAndDerivative<T> step start stepStart) Set current step start.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_FUNCTION_VALUE_ACCURACY	back to summary
private static final double DEFAULT_FUNCTION_VALUE_ACCURACY Default function value accuracy.

DEFAULT_RELATIVE_ACCURACY	back to summary
private static final double DEFAULT_RELATIVE_ACCURACY Default relative accuracy.

equations	back to summary
private transient FieldExpandableODE<T> equations Differential equations to integrate.

evaluations	back to summary
private IntegerSequence.Incrementor evaluations Counter for number of evaluations.

eventsStates	back to summary
private Collection<FieldEventState<T>> eventsStates Events states.

field	back to summary
private final Field<T> field Field to which the time and state vector elements belong.

isLastStep	back to summary
private boolean isLastStep Indicator for last step.

name	back to summary
private final String name Name of the method.

resetOccurred	back to summary
private boolean resetOccurred Indicator that a state or derivative reset was triggered by some event.

statesInitialized	back to summary
private boolean statesInitialized Initialization indicator of events states.

stepHandlers	back to summary
private Collection<FieldStepHandler<T>> stepHandlers Step handler.

stepSize	back to summary
private T stepSize Current stepsize.

stepStart	back to summary
private FieldODEStateAndDerivative<T> stepStart Current step start.

AbstractFieldIntegrator	back to summary
protected AbstractFieldIntegrator(final Field<T> field, final String name) Build an instance. Parameters field:Field<T> field to which the time and state vector elements belong name:String name of the method

Method Detail

acceptStep	back to summary
protected FieldODEStateAndDerivative<T> acceptStep(final AbstractFieldStepInterpolator<T> interpolator, final T tEnd) throws MaxCountExceededException, DimensionMismatchException, NoBracketingException Accept a step, triggering events and step handlers. Parameters interpolator:AbstractFieldStepInterpolator<T> step interpolator tEnd:T final integration time Returns:FieldODEStateAndDerivative<T> state at end of step Exceptions MaxCountExceededException: if the interpolator throws one because the number of functions evaluations is exceeded DimensionMismatchException: if arrays dimensions do not match equations settings NoBracketingException: if the location of an event cannot be bracketed

acceptStep

back to summary

protected FieldODEStateAndDerivative<T> acceptStep(final AbstractFieldStepInterpolator<T> interpolator, final T tEnd) throws MaxCountExceededException, DimensionMismatchException, NoBracketingException

Accept a step, triggering events and step handlers.

Parameters

interpolator:AbstractFieldStepInterpolator<T>: step interpolator
tEnd:T: final integration time

Returns:FieldODEStateAndDerivative<T>

state at end of step

Exceptions

MaxCountExceededException:: if the interpolator throws one because the number of functions evaluations is exceeded
DimensionMismatchException:: if arrays dimensions do not match equations settings
NoBracketingException:: if the location of an event cannot be bracketed

addEventHandler back to summary

addEventHandler	back to summary
public void addEventHandler(final FieldEventHandler<T> handler, final double maxCheckInterval, final double convergence, final int maxIterationCount) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Add an event handler to the integrator. The default solver is a 5^th order `org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver`. Parameters handler:FieldEventHandler<T> event handler maxCheckInterval:double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) convergence:double convergence threshold in the event time search maxIterationCount:int upper limit of the iteration count in the event time search events.

public void addEventHandler(final FieldEventHandler<T> handler, final double maxCheckInterval, final double convergence, final int maxIterationCount)

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler.

Add an event handler to the integrator.

The default solver is a 5^th order org.apache.commons.math3.analysis.solvers.FieldBracketingNthOrderBrentSolver.

Parameters

handler:FieldEventHandler<T>: event handler
maxCheckInterval:double: maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large)
convergence:double: convergence threshold in the event time search
maxIterationCount:int: upper limit of the iteration count in the event time search events.

addEventHandler	back to summary
public void addEventHandler(final FieldEventHandler<T> handler, final double maxCheckInterval, final double convergence, final int maxIterationCount, final BracketedRealFieldUnivariateSolver<T> solver) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler. Add an event handler to the integrator. Parameters handler:FieldEventHandler<T> event handler maxCheckInterval:double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) convergence:double convergence threshold in the event time search maxIterationCount:int upper limit of the iteration count in the event time search events. solver:BracketedRealFieldUnivariateSolver<T> solver to use to locate the event

addEventHandler

back to summary

public void addEventHandler(final FieldEventHandler<T> handler, final double maxCheckInterval, final double convergence, final int maxIterationCount, final BracketedRealFieldUnivariateSolver<T> solver)

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addEventHandler.

Add an event handler to the integrator.

Parameters

handler:FieldEventHandler<T>: event handler
maxCheckInterval:double: maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large)
convergence:double: convergence threshold in the event time search
maxIterationCount:int: upper limit of the iteration count in the event time search events.
solver:BracketedRealFieldUnivariateSolver<T>: solver to use to locate the event

addStepHandler	back to summary
public void addStepHandler(final FieldStepHandler<T> handler) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addStepHandler. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addStepHandler. Add a step handler to this integrator. The handler will be called by the integrator for each accepted step. Parameters handler:FieldStepHandler<T> handler for the accepted steps

addStepHandler

back to summary

public void addStepHandler(final FieldStepHandler<T> handler)

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addStepHandler.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.addStepHandler.

Add a step handler to this integrator.

The handler will be called by the integrator for each accepted step.

Parameters

handler:FieldStepHandler<T>: handler for the accepted steps

clearEventHandlers	back to summary
public void clearEventHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearEventHandlers. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearEventHandlers. Remove all the event handlers that have been added to the integrator.

clearEventHandlers

back to summary

public void clearEventHandlers()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearEventHandlers.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearEventHandlers.

Remove all the event handlers that have been added to the integrator.

clearStepHandlers	back to summary
public void clearStepHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearStepHandlers. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearStepHandlers. Remove all the step handlers that have been added to the integrator.

clearStepHandlers

back to summary

public void clearStepHandlers()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearStepHandlers.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.clearStepHandlers.

Remove all the step handlers that have been added to the integrator.

computeDerivatives back to summary

computeDerivatives	back to summary
public T[] computeDerivatives(final T t, final T[] y) throws DimensionMismatchException, MaxCountExceededException, NullPointerException Compute the derivatives and check the number of evaluations. Parameters t:T current value of the independent time variable y:T[] array containing the current value of the state vector Returns:T[] state completed with derivatives Exceptions DimensionMismatchException: if arrays dimensions do not match equations settings MaxCountExceededException: if the number of functions evaluations is exceeded NullPointerException: if the ODE equations have not been set (i.e. if this method is called outside of a call to `integrate`

public T[] computeDerivatives(final T t, final T[] y) throws DimensionMismatchException, MaxCountExceededException, NullPointerException

Compute the derivatives and check the number of evaluations.

Parameters

t:T: current value of the independent time variable
y:T[]: array containing the current value of the state vector

Returns:T[]

state completed with derivatives

Exceptions

DimensionMismatchException:: if arrays dimensions do not match equations settings
MaxCountExceededException:: if the number of functions evaluations is exceeded
NullPointerException:: if the ODE equations have not been set (i.e. if this method is called outside of a call to integrate

getCurrentSignedStepsize back to summary

getCurrentSignedStepsize	back to summary
public T getCurrentSignedStepsize() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentSignedStepsize. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentSignedStepsize. Get the current signed value of the integration stepsize. 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`. Returns:T current signed value of the stepsize

public T getCurrentSignedStepsize()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentSignedStepsize.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentSignedStepsize.

Get the current signed value of the integration stepsize.

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.

Returns:T: current signed value of the stepsize

getCurrentStepStart back to summary

getCurrentStepStart	back to summary
public FieldODEStateAndDerivative<T> getCurrentStepStart() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentStepStart. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentStepStart. Get the current value of the step start time t_i. 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`. Returns:FieldODEStateAndDerivative<T> current value of the state at step start time t_i

public FieldODEStateAndDerivative<T> getCurrentStepStart()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentStepStart.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getCurrentStepStart.

Get the current value of the step start time t_i.

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.

Returns:FieldODEStateAndDerivative<T>: current value of the state at step start time t_i

getEquations	back to summary
protected FieldExpandableODE<T> getEquations() Get the differential equations to integrate. Returns:FieldExpandableODE<T> differential equations to integrate

getEquations

back to summary

protected FieldExpandableODE<T> getEquations()

Get the differential equations to integrate.

Returns:FieldExpandableODE<T>: differential equations to integrate

getEvaluations back to summary

getEvaluations	back to summary
public int getEvaluations() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEvaluations. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEvaluations. Get the number of evaluations of the differential equations function. The number of evaluations corresponds to the last call to the `integrate` method. It is 0 if the method has not been called yet. Returns:int number of evaluations of the differential equations function

public int getEvaluations()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEvaluations.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEvaluations.

Get the number of evaluations of the differential equations function.

The number of evaluations corresponds to the last call to the integrate method. It is 0 if the method has not been called yet.

Returns:int: number of evaluations of the differential equations function

getEvaluationsCounter	back to summary
protected IntegerSequence.Incrementor getEvaluationsCounter() Get the evaluations counter. Returns:IntegerSequence.Incrementor evaluations counter

getEvaluationsCounter

back to summary

protected IntegerSequence.Incrementor getEvaluationsCounter()

Get the evaluations counter.

Returns:IntegerSequence.Incrementor: evaluations counter

getEventHandlers	back to summary
public Collection<FieldEventHandler<T>> getEventHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEventHandlers. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEventHandlers. Get all the event handlers that have been added to the integrator. Returns:Collection<FieldEventHandler<T>> an unmodifiable collection of the added events handlers

getEventHandlers

back to summary

public Collection<FieldEventHandler<T>> getEventHandlers()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEventHandlers.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getEventHandlers.

Get all the event handlers that have been added to the integrator.

Returns:Collection<FieldEventHandler<T>>: an unmodifiable collection of the added events handlers

getField	back to summary
public Field<T> getField() Get the field to which state vector elements belong. Returns:Field<T> field to which state vector elements belong

getField

back to summary

public Field<T> getField()

Get the field to which state vector elements belong.

Returns:Field<T>: field to which state vector elements belong

getMaxEvaluations	back to summary
public int getMaxEvaluations() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getMaxEvaluations. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getMaxEvaluations. Get the maximal number of functions evaluations. Returns:int maximal number of functions evaluations

getMaxEvaluations

back to summary

public int getMaxEvaluations()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getMaxEvaluations.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getMaxEvaluations.

Get the maximal number of functions evaluations.

Returns:int: maximal number of functions evaluations

getName	back to summary
public String getName() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getName. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getName. Get the name of the method. Returns:String name of the method

getName

back to summary

public String getName()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getName.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getName.

Get the name of the method.

Returns:String: name of the method

getStepHandlers	back to summary
public Collection<FieldStepHandler<T>> getStepHandlers() Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getStepHandlers. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getStepHandlers. Get all the step handlers that have been added to the integrator. Returns:Collection<FieldStepHandler<T>> an unmodifiable collection of the added events handlers

getStepHandlers

back to summary

public Collection<FieldStepHandler<T>> getStepHandlers()

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getStepHandlers.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.getStepHandlers.

Get all the step handlers that have been added to the integrator.

Returns:Collection<FieldStepHandler<T>>: an unmodifiable collection of the added events handlers

getStepSize	back to summary
protected T getStepSize() Get the current step size. Returns:T current step size

getStepSize

back to summary

protected T getStepSize()

Get the current step size.

Returns:T: current step size

getStepStart	back to summary
protected FieldODEStateAndDerivative<T> getStepStart() Getcurrent step start. Returns:FieldODEStateAndDerivative<T> current step start

getStepStart

back to summary

protected FieldODEStateAndDerivative<T> getStepStart()

Getcurrent step start.

Returns:FieldODEStateAndDerivative<T>: current step start

initIntegration	back to summary
protected FieldODEStateAndDerivative<T> initIntegration(final FieldExpandableODE<T> eqn, final T t0, final T[] y0, final T t) Prepare the start of an integration. Parameters eqn:FieldExpandableODE<T> equations to integrate t0:T start value of the independent time variable y0:T[] array containing the start value of the state vector t:T target time for the integration Returns:FieldODEStateAndDerivative<T> initial state with derivatives added

initIntegration

back to summary

protected FieldODEStateAndDerivative<T> initIntegration(final FieldExpandableODE<T> eqn, final T t0, final T[] y0, final T t)

Prepare the start of an integration.

Parameters

eqn:FieldExpandableODE<T>: equations to integrate
t0:T: start value of the independent time variable
y0:T[]: array containing the start value of the state vector
t:T: target time for the integration

Returns:FieldODEStateAndDerivative<T>

initial state with derivatives added

isLastStep	back to summary
protected boolean isLastStep() Check if this step is the last one. Returns:boolean true if this step is the last one

isLastStep

back to summary

protected boolean isLastStep()

Check if this step is the last one.

Returns:boolean: true if this step is the last one

resetOccurred	back to summary
protected boolean resetOccurred() Check if a reset occurred while last step was accepted. Returns:boolean true if a reset occurred while last step was accepted

resetOccurred

back to summary

protected boolean resetOccurred()

Check if a reset occurred while last step was accepted.

Returns:boolean: true if a reset occurred while last step was accepted

sanityChecks	back to summary
protected void sanityChecks(final FieldODEState<T> eqn, final T t) throws NumberIsTooSmallException, DimensionMismatchException Check the integration span. Parameters eqn:FieldODEState<T> set of differential equations t:T target time for the integration Exceptions NumberIsTooSmallException: if integration span is too small DimensionMismatchException: if adaptive step size integrators tolerance arrays dimensions are not compatible with equations settings

sanityChecks

back to summary

protected void sanityChecks(final FieldODEState<T> eqn, final T t) throws NumberIsTooSmallException, DimensionMismatchException

Check the integration span.

Parameters

eqn:FieldODEState<T>: set of differential equations
t:T: target time for the integration

Exceptions

NumberIsTooSmallException:: if integration span is too small
DimensionMismatchException:: if adaptive step size integrators tolerance arrays dimensions are not compatible with equations settings

setIsLastStep	back to summary
protected void setIsLastStep(final boolean isLastStep) Set the last state flag. Parameters isLastStep:boolean if true, this step is the last one

setIsLastStep

back to summary

protected void setIsLastStep(final boolean isLastStep)

Set the last state flag.

Parameters

isLastStep:boolean: if true, this step is the last one

setMaxEvaluations	back to summary
public void setMaxEvaluations(int maxEvaluations) Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.setMaxEvaluations. Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.setMaxEvaluations. Set the maximal number of differential equations function evaluations. 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. Parameters maxEvaluations:int maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations)

setMaxEvaluations

back to summary

public void setMaxEvaluations(int maxEvaluations)

Implements org.apache.commons.math3.ode.FirstOrderFieldIntegrator.setMaxEvaluations.

Doc from org.apache.commons.math3.ode.FirstOrderFieldIntegrator.setMaxEvaluations.

Set the maximal number of differential equations function evaluations.

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.

Parameters

maxEvaluations:int: maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations)

setStateInitialized back to summary

setStateInitialized	back to summary
protected void setStateInitialized(final boolean stateInitialized) Set the stateInitialized flag. 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. Parameters stateInitialized:boolean new value for the flag

protected void setStateInitialized(final boolean stateInitialized)

Set the stateInitialized flag.

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.

Parameters

stateInitialized:boolean: new value for the flag

setStepSize	back to summary
protected void setStepSize(final T stepSize) Set the current step size. Parameters stepSize:T step size to set

setStepSize

back to summary

protected void setStepSize(final T stepSize)

Set the current step size.

Parameters

stepSize:T: step size to set

setStepStart	back to summary
protected void setStepStart(final FieldODEStateAndDerivative<T> stepStart) Set current step start. Parameters stepStart:FieldODEStateAndDerivative<T> step start

setStepStart

back to summary

protected void setStepStart(final FieldODEStateAndDerivative<T> stepStart)

Set current step start.

Parameters

stepStart:FieldODEStateAndDerivative<T>: step start

public abstract Class AbstractFieldIntegrator<T extends RealFieldElement<T>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail