d02ps
is the AD Library version of the primal routine
d02psf.
Based (in the C++ interface) on overload resolution,
d02ps can be used for primal, tangent and adjoint
evaluation. It supports tangents and adjoints of first and second order.
Corresponding to the overloaded C++ function, the Fortran interface provides five routines with names reflecting the type used for active real arguments. The actual subroutine and type names are formed by replacing AD and ADTYPE in the above as follows:
The function is overloaded on ADTYPE which represents the type of active arguments. ADTYPE may be any of the following types: double, dco::ga1s<double>::type, dco::gt1s<double>::type, dco::gt1s<dco::gt1s<double>::type>::type, dco::ga1s<dco::gt1s<double>::type>::type,
Note: this function can be used with AD tools other than dco/c++. For details, please contact NAG.
3Description
d02ps
is the AD Library version of the primal routine
d02psf.
d02psf computes the solution of a system of ordinary differential equations using interpolation anywhere on an integration step taken by d02pff.
For further information see Section 3 in the documentation for d02psf.
4References
Brankin R W, Gladwell I and Shampine L F (1991) RKSUITE: A suite of Runge–Kutta codes for the initial value problems for ODEs SoftReport 91-S1 Southern Methodist University
5Arguments
In addition to the arguments present in the interface of the primal routine,
d02ps includes some arguments specific to AD.
A brief summary of the AD specific arguments is given below. For the remainder, links are provided to the corresponding argument from the primal routine.
A tooltip popup for all arguments can be found by hovering over the argument name in Section 2 and in this section.
On entry: a configuration object that holds information on the differentiation strategy. Details on setting the AD strategy are described in AD handle object in the NAG AD Library Introduction.
f
needs to be callable with the specification listed below. This can be a C++ lambda, a functor or a (static member) function pointer.
If using a lambda, parameters can be captured safely by reference. No copies of the callable are made internally.
d02ps preserves all error codes from d02psf and in addition can return:
An unexpected AD error has been triggered by this routine. Please
contact NAG.
See Error Handling in the NAG AD Library Introduction for further information.
The routine was called using a strategy that has not yet been implemented.
See AD Strategies in the NAG AD Library Introduction for further information.
A C++ exception was thrown.
The error message will show the details of the C++ exception text.
Dynamic memory allocation failed for AD.
See Error Handling in the NAG AD Library Introduction for further information.
7Accuracy
Not applicable.
8Parallelism and Performance
d02ps
is not threaded in any implementation.
9Further Comments
None.
10Example
The following examples are variants of the example for
d02psf,
modified to demonstrate calling the NAG AD Library.
Description of the primal example.
This example solves the equation
reposed as
over the range with initial conditions and . Relative error control is used with threshold values of for each solution component. d02pf is used to integrate the problem one step at a time and d02ps is used to compute the first component of the solution and its derivative at intervals of length across the range whenever these points lie in one of those integration steps. A low order Runge–Kutta method () is also used with tolerances and in turn so that solutions may be compared.