Integration Functions

Integration Functions

Table 2 lists the available Integration functions. These are functions which cause the integrator to perform the actual integration, and report when it is complete. Note that if the integrator has already reached the final requested output time and you try to perform another integration step with any of these functions, an error will be generated, which can only be cleared by introducing more output times using AppendTOut().

Table 2 Integration Functions.

Usage

pInteg->TakeOneStep();

Arguments

None.

Return Value

None.

Notes

This command causes the integrator to perform one step at the current step size. This is the lowest-level integration command, and is called by all of the other Integration Commands to perform each step.

Usage

pInteg->StepToNextTOut();

Arguments

None.

Return Value

None.

Notes

This command tells the integrator to step until it reaches the next requested output time. Note that when using a method with dense output (such as DOPRI5) it is possible for a single integrator step to encompass several successive output times. In this case, the integrator will output values at all of the requested output times within that step. For fixed-step methods and methods using Richardson Extrapolation, integration will be halted at the next requested time, regardless of step size.

Usage

pInteg->StepToTFinal();

Arguments

None.

Return Value

None.

Notes

This function causes the integrator to integrate until it reaches the final requested output time.

Usage

pInteg->Integrate();

Arguments

None.

Return Value

None.

Notes

This function is a synonym for StepToTFinal( , and will also integrate until the final output time is reached.

Usage

if ( pInteg->IntegrationComplete() ) .

Arguments

None.

Return Value

Notes

This function returns true if the integration is finished, a terminal event has been reached, or if there is an error such that integration cannot continue. If you suspect errors can occur, you should check the error state using IntegratorHasError( . Note that the integration is considered to be complete when the final requested output time has been passed. You can continue integration by adding additional output times using AppendTOut( .