d02pf is the AD Library version of the primal routine d02pff. Based (in the C++ interface) on overload resolution, d02pf can be used for primal, tangent and adjoint evaluation. It supports tangents and adjoints of first and second order.

2 Specification

Fortran Interface

Subroutine d02pf_AD_f (

ad_handle, f, n, tnow, ynow, ypnow, iuser, ruser, iwsav, rwsav, ifail)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	iuser(*), iwsav(130), ifail
ADTYPE, Intent (Inout)	::	ruser(), rwsav(32n+350)
ADTYPE, Intent (Out)	::	tnow, ynow(n), ypnow(n)
Type (c_ptr), Intent (Inout)	::	ad_handle
External	::	f

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:

when ADTYPE is	Real(kind=nag_wp)	then AD is p0w
when ADTYPE is	Type(nagad_a1w_w_rtype)	then AD is a1w
when ADTYPE is	Type(nagad_t1w_w_rtype)	then AD is t1w
when ADTYPE is	Type(nagad_a1t1w_w_rtype)	then AD is a1t1w
when ADTYPE is	Type(nagad_t2w_w_rtype)	then AD is t2w

C++ Header Interface

#include <dco.hpp>
#include <nagad.h>
namespace nag {
namespace ad {

void d02pf (

void *&ad_handle,
void (NAG_CALL f)(void *&ad_handle, const ADTYPE &t, const Integer &n, const ADTYPE y[], ADTYPE yp[], Integer iuser[], ADTYPE ruser[]),
const Integer &n, ADTYPE &tnow, ADTYPE ynow[], ADTYPE ypnow[], const Integer &liuser, Integer iuser[], const Integer &lruser, ADTYPE ruser[], Integer iwsav[], ADTYPE rwsav[], Integer &ifail)

}
}

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.

3 Description

d02pf is the AD Library version of the primal routine d02pff.

d02pff is a one-step routine for solving an initial value problem for a first-order system of ordinary differential equations using Runge–Kutta methods. For further information see Section 3 in the documentation for d02pff.

4 References

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

5 Arguments

In addition to the arguments present in the interface of the primal routine, d02pf 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.

1: ad_handle – Pointer to AD Data Input/Output

On entry: a handle to the AD configuration data object, as created by x10aa.

2: f – Subroutine External Procedure

The specification of f is:

Fortran Interface

Subroutine f (

ad_handle, t, n, y, yp, iuser, ruser)

Integer, Intent (In)	::	n
Integer, Intent (Inout)	::	iuser(*)
ADTYPE, Intent (In)	::	t, y(n)
ADTYPE, Intent (Inout)	::	ruser(*)
ADTYPE, Intent (Out)	::	yp(n)
Type (c_ptr), Intent (Inout)	::	ad_handle

C++ Header Interface

void f (

void *&ad_handle, const ADTYPE &t, const Integer &n, const ADTYPE y[], ADTYPE yp[], Integer iuser[], ADTYPE ruser[])

1: ad_handle – Pointer to AD Data Input/Output: On entry: a handle to the AD configuration data object.
2: t – ADTYPE Input
3: n – Integer Input
4: y – ADTYPE array Input
5: yp – ADTYPE array Output
6: iuser – Integer array User Workspace
7: ruser – ADTYPE array User Workspace

3: n – Integer Input

4: tnow – ADTYPE Output

5: ynow(n) – ADTYPE array Output

6: ypnow(n) – ADTYPE array Output

7: liuser Input

User workspace dimension (C++ only), see x10af to specify the dimension from Fortran.

8: iuser( $*$ ) – Integer array User Workspace

9: lruser Input

User workspace dimension (C++ only), see x10ae to specify the dimension from Fortran.

10: ruser( $*$ ) – ADTYPE array User Workspace

11: iwsav( $130$ ) – Integer array Communication Array

12: rwsav( $32 \times n + 350$ ) – ADTYPE array Communication Array

13: ifail – Integer Input/Output

6 Error Indicators and Warnings

d02pf preserves all error codes from d02pff and in addition can return:

$ifail = - 89$: An unexpected AD error has been triggered by this routine. Please contact NAG.
See Section 4.8.2 in the NAG AD Library Introduction for further information.

$ifail = - 199$: The routine was called using a mode that has not yet been implemented.

$ifail = - 443$: On entry: ad_handle is nullptr.
This check is only made if the overloaded C++ interface is used with arguments not of type double.

$ifail = - 444$: A C++ exception was thrown.
The error message will show the details of the C++ exception text.

$ifail = - 899$: Dynamic memory allocation failed for AD.
See Section 4.8.1 in the NAG AD Library Introduction for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

d02pf is not threaded in any implementation.

9 Further Comments

None.

10 Example

The following examples are variants of the example for d02pff, modified to demonstrate calling the NAG AD Library.

Description of the primal example.

This example solves the equation

y^{''} = - y, y (0) = 0, y^{'} (0) = 1

reposed as

y_{1}^{'} = y_{2}

y_{2}^{'} = - y_{1}

over the range

[0, 2 π]

with initial conditions

y_{1} = 0.0

and

y_{2} = 1.0

. We use relative error control with threshold values of

1.0E−8

for each solution component and print the solution at each integration step across the range. We use a medium order Runge–Kutta method (

method = 2

) with tolerances

tol = 1.0E−4

and

tol = 1.0E−5

in turn so that we may compare the solutions.

10.1 Adjoint modes

Language	Source File	Data	Results
Fortran	d02pf_a1w_fe.f90	d02pf_a1w_fe.d	d02pf_a1w_fe.r
C++	d02pf_a1w_hcppe.cpp	None	d02pf_a1w_hcppe.r

10.2 Tangent modes

Language	Source File	Data	Results
Fortran	d02pf_t1w_fe.f90	d02pf_t1w_fe.d	d02pf_t1w_fe.r
C++	d02pf_t1w_hcppe.cpp	None	d02pf_t1w_hcppe.r

10.3 Passive mode

Language	Source File	Data	Results
Fortran	d02pf_p0w_fe.f90	d02pf_p0w_fe.d	d02pf_p0w_fe.r
C++	d02pf_p0w_hcppe.cpp	None	d02pf_p0w_hcppe.r

NAG Library Manual, Mark 27.2

Interfaces: FL CL CPP AD

NAG AD Library Introduction

D02 (Ode) Chapter Contents

D02 (Ode) Chapter Introduction (FL)

d02pf: FL CL CPP AD

NAG AD Libraryd02pf (ivp_rkts_onestep)

▸▿ Contents

1 Purpose