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

Method Summary

Modifier and Type	Method and Description
public void	addEventHandler(FieldEventHandler<T> event handler handler, double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) maxCheckInterval, double convergence threshold in the event time search convergence, int upper limit of the iteration count in the event time search events. maxIterationCount) Add an event handler to the integrator.
public void	addEventHandler(FieldEventHandler<T> event handler handler, double maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large) maxCheckInterval, double convergence threshold in the event time search convergence, int upper limit of the iteration count in the event time search events. maxIterationCount, BracketedRealFieldUnivariateSolver<T> solver to use to locate the event solver) Add an event handler to the integrator.
public void	addStepHandler(FieldStepHandler<T> handler for the accepted steps handler) Add a step handler to this integrator.
public void	clearEventHandlers() Remove all the event handlers that have been added to the integrator.
public void	clearStepHandlers() Remove all the step handlers that have been added to the integrator.
public T	Returns: current signed value of the stepsize getCurrentSignedStepsize() Get the current signed value of the integration stepsize.
public FieldODEStateAndDerivative<T>	Returns: current value of the state at step start time t_i getCurrentStepStart() Get the current value of the step start time t_i.
public int	Returns: number of evaluations of the differential equations function getEvaluations() Get the number of evaluations of the differential equations function.
public Collection<FieldEventHandler<T>>	Returns: an unmodifiable collection of the added events handlers getEventHandlers() Get all the event handlers that have been added to the integrator.
public int	Returns: maximal number of functions evaluations getMaxEvaluations() Get the maximal number of functions evaluations.
public String	Returns: name of the method getName() Get the name of the method.
public Collection<FieldStepHandler<T>>	Returns: an unmodifiable collection of the added events handlers getStepHandlers() Get all the step handlers that have been added to the integrator.
public FieldODEStateAndDerivative<T>	Returns: final state, its time will be the same as `finalTime` if integration reached its target, but may be different if some `org.apache.commons.math3.ode.events.FieldEventHandler` stops it at some point. integrate(FieldExpandableODE<T> differential equations to integrate equations, FieldODEState<T> initial state (time, primary and secondary state vectors) initialState, T target time for the integration (can be set to a value smaller than `t0` for backward integration) finalTime) Integrate the differential equations up to the given time.
public void	setMaxEvaluations(int maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations) maxEvaluations) Set the maximal number of differential equations function evaluations.

Method Detail

addEventHandler back to summary

addEventHandler	back to summary
public void addEventHandler(FieldEventHandler<T> handler, double maxCheckInterval, double convergence, int maxIterationCount) 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. See Also `addEventHandler(FieldEventHandler, double, double, int, org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)`, `getEventHandlers()`, `clearEventHandlers()`

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

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.

See Also

addEventHandler(FieldEventHandler, double, double, int, org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)

, getEventHandlers(), clearEventHandlers()

addEventHandler back to summary

addEventHandler	back to summary
public void addEventHandler(FieldEventHandler<T> handler, double maxCheckInterval, double convergence, int maxIterationCount, BracketedRealFieldUnivariateSolver<T> solver) 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 See Also `addEventHandler(FieldEventHandler, double, double, int)`, `getEventHandlers()`, `clearEventHandlers()`

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

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

addStepHandler	back to summary
public void addStepHandler(FieldStepHandler<T> handler) 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 See Also `getStepHandlers()`, `clearStepHandlers()`

public void addStepHandler(FieldStepHandler<T> handler)

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

clearEventHandlers	back to summary
public void clearEventHandlers() Remove all the event handlers that have been added to the integrator. See Also `addEventHandler(FieldEventHandler, double, double, int)`, `getEventHandlers()`

public void clearEventHandlers()

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

See Also: addEventHandler(FieldEventHandler, double, double, int), getEventHandlers()

clearStepHandlers back to summary

clearStepHandlers	back to summary
public void clearStepHandlers() Remove all the step handlers that have been added to the integrator. See Also `addStepHandler(FieldStepHandler)`, `getStepHandlers()`

public void clearStepHandlers()

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

See Also: addStepHandler(FieldStepHandler), getStepHandlers()

getCurrentSignedStepsize back to summary

getCurrentSignedStepsize	back to summary
public T 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()

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() 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()

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

getEvaluations back to summary

getEvaluations	back to summary
public int 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()

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

getEventHandlers back to summary

getEventHandlers	back to summary
public Collection<FieldEventHandler<T>> 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 See Also `addEventHandler(FieldEventHandler, double, double, int)`, `clearEventHandlers()`

public Collection<FieldEventHandler<T>> 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
See Also: addEventHandler(FieldEventHandler, double, double, int), clearEventHandlers()

getMaxEvaluations	back to summary
public int getMaxEvaluations() Get the maximal number of functions evaluations. Returns:int maximal number of functions evaluations

getMaxEvaluations

back to summary

public int getMaxEvaluations()

Get the maximal number of functions evaluations.

Returns:int: maximal number of functions evaluations

getName	back to summary
public String getName() Get the name of the method. Returns:String name of the method

getName

back to summary

public String getName()

Get the name of the method.

Returns:String: name of the method

getStepHandlers back to summary

getStepHandlers	back to summary
public Collection<FieldStepHandler<T>> 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 See Also `addStepHandler(FieldStepHandler)`, `clearStepHandlers()`

public Collection<FieldStepHandler<T>> 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
See Also: addStepHandler(FieldStepHandler), clearStepHandlers()

integrate back to summary

integrate	back to summary
public FieldODEStateAndDerivative<T> integrate(FieldExpandableODE<T> equations, FieldODEState<T> initialState, T finalTime) throws NumberIsTooSmallException, 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 (`getCurrentSignedStepsize()`), it is not thread-safe. Parameters equations:FieldExpandableODE<T> differential equations to integrate initialState:FieldODEState<T> initial state (time, primary and secondary state vectors) finalTime:T target time for the integration (can be set to a value smaller than `t0` for backward integration) Returns:FieldODEStateAndDerivative<T> final state, its time will be the same as `finalTime` if integration reached its target, but may be different if some `org.apache.commons.math3.ode.events.FieldEventHandler` stops it at some point. Exceptions NumberIsTooSmallException: if integration step is too small MaxCountExceededException: if the number of functions evaluations is exceeded NoBracketingException: if the location of an event cannot be bracketed

public FieldODEStateAndDerivative<T> integrate(FieldExpandableODE<T> equations, FieldODEState<T> initialState, T finalTime) throws NumberIsTooSmallException, 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 (getCurrentSignedStepsize()), it is not thread-safe.

Parameters

equations:FieldExpandableODE<T>: differential equations to integrate
initialState:FieldODEState<T>: initial state (time, primary and secondary state vectors)
finalTime:T: target time for the integration (can be set to a value smaller than t0 for backward integration)

Returns:FieldODEStateAndDerivative<T>

final state, its time will be the same as finalTime if integration reached its target, but may be different if some org.apache.commons.math3.ode.events.FieldEventHandler stops it at some point.

Exceptions

NumberIsTooSmallException:: if integration step is too small
MaxCountExceededException:: if the number of functions evaluations is exceeded
NoBracketingException:: if the location of an event cannot be bracketed

setMaxEvaluations	back to summary
public void setMaxEvaluations(int maxEvaluations) 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)

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)

public Interface FirstOrderFieldIntegrator<T extends RealFieldElement<T>>

Method Summary

Method Detail