Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

Chapter Contents
Chapter Introduction
NAG Toolbox

# NAG Toolbox: nag_pde_1d_parab_dae_coll (d03pj)

## Purpose

nag_pde_1d_parab_dae_coll (d03pj) integrates a system of linear or nonlinear parabolic partial differential equations (PDEs), in one space variable with scope for coupled ordinary differential equations (ODEs). The spatial discretization is performed using a Chebyshev C0${C}^{0}$ collocation method, and the method of lines is employed to reduce the PDEs to a system of ODEs. The resulting system is solved using a backward differentiation formula (BDF) method or a Theta method (switching between Newton's method and functional iteration).

## Syntax

[ts, u, x, rsave, isave, ind, user, cwsav, lwsav, iwsav, rwsav, ifail] = d03pj(npde, m, ts, tout, pdedef, bndary, u, xbkpts, npoly, npts, ncode, odedef, xi, uvinit, rtol, atol, itol, norm_p, laopt, algopt, rsave, isave, itask, itrace, ind, cwsav, lwsav, iwsav, rwsav, 'nbkpts', nbkpts, 'nxi', nxi, 'neqn', neqn, 'user', user)
[ts, u, x, rsave, isave, ind, user, cwsav, lwsav, iwsav, rwsav, ifail] = nag_pde_1d_parab_dae_coll(npde, m, ts, tout, pdedef, bndary, u, xbkpts, npoly, npts, ncode, odedef, xi, uvinit, rtol, atol, itol, norm_p, laopt, algopt, rsave, isave, itask, itrace, ind, cwsav, lwsav, iwsav, rwsav, 'nbkpts', nbkpts, 'nxi', nxi, 'neqn', neqn, 'user', user)
Note: the interface to this routine has changed since earlier releases of the toolbox:
Mark 22: lrsave, lisave have been removed from the interface
.

## Description

nag_pde_1d_parab_dae_coll (d03pj) integrates the system of parabolic-elliptic equations and coupled ODEs
 npde ∑ Pi,j( ∂ Uj)/( ∂ t) + Qi = x − m( ∂ )/( ∂ x)(xmRi),  i = 1,2, … ,npde,  a ≤ x ≤ b,t ≥ t0, j = 1
$∑j=1npdePi,j ∂Uj ∂t +Qi=x-m ∂∂x (xmRi), i=1,2,…,npde, a≤x≤b,t≥t0,$
(1)
 Fi(t,V,V.,ξ,U*,Ux * ,R*,Ut * ,Uxt * ) = 0,  i = 1,2, … ,ncode, $Fi(t,V,V.,ξ,U*,Ux*,R*,Ut*,Uxt*)=0, i=1,2,…,ncode,$ (2)
where (1) defines the PDE part and (2) generalizes the coupled ODE part of the problem.
In (1), Pi,j${P}_{i,j}$ and Ri${R}_{i}$ depend on x$x$, t$t$, U$U$, Ux${U}_{x}$, and V$V$; Qi${Q}_{i}$ depends on x$x$, t$t$, U$U$, Ux${U}_{x}$, V$V$ and linearly on V.$\stackrel{.}{V}$. The vector U$U$ is the set of PDE solution values
 U (x,t) = [ U1 (x,t) , … , Unpde (x,t) ]T , $U (x,t) = [ U 1 (x,t) ,…, U npde (x,t) ] T ,$
and the vector Ux${U}_{x}$ is the partial derivative with respect to x$x$. Note that Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ must not depend on (U)/(t) $\frac{\partial U}{\partial t}$. The vector V$V$ is the set of ODE solution values
 V(t) = [V1(t), … ,(t)]T, $V(t)=[V1(t),…,Vncode(t)]T,$
and V.$\stackrel{.}{V}$ denotes its derivative with respect to time.
In (2), ξ$\xi$ represents a vector of nξ${n}_{\xi }$ spatial coupling points at which the ODEs are coupled to the PDEs. These points may or may not be equal to some of the PDE spatial mesh points. U*${U}^{*}$, Ux * ${U}_{x}^{*}$, R*${R}^{*}$, Ut * ${U}_{t}^{*}$ and Uxt * ${U}_{xt}^{*}$ are the functions U$U$, Ux${U}_{x}$, R$R$, Ut${U}_{t}$ and Uxt${U}_{xt}$ evaluated at these coupling points. Each Fi${F}_{i}$ may only depend linearly on time derivatives. Hence the equation (2) may be written more precisely as
F = GAV.B
 ( Ut * ) Uxt *
,
$F=G-AV.-B Ut* Uxt* ,$
(3)
where F = [F1,,] T $F={\left[{F}_{1},\dots ,{F}_{{\mathbf{ncode}}}\right]}^{\mathrm{T}}$, G$G$ is a vector of length ncode, A$A$ is an ncode by ncode matrix, B$B$ is an ncode by (nξ × npde)$\left({n}_{\xi }×{\mathbf{npde}}\right)$ matrix and the entries in G$G$, A$A$ and B$B$ may depend on t$t$, ξ$\xi$, U*${U}^{*}$, Ux * ${U}_{x}^{*}$ and V$V$. In practice you need only supply a vector of information to define the ODEs and not the matrices A$A$ and B$B$. (See Section [Parameters] for the specification of odedef.)
The integration in time is from t0${t}_{0}$ to tout${t}_{\mathrm{out}}$, over the space interval axb$a\le x\le b$, where a = x1$a={x}_{1}$ and b = $b={x}_{{\mathbf{nbkpts}}}$ are the leftmost and rightmost of a user-defined set of break points x1,x2,,${x}_{1},{x}_{2},\dots ,{x}_{{\mathbf{nbkpts}}}$. The coordinate system in space is defined by the value of m$m$; m = 0$m=0$ for Cartesian coordinates, m = 1$m=1$ for cylindrical polar coordinates and m = 2$m=2$ for spherical polar coordinates.
The PDE system which is defined by the functions Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ must be specified in pdedef.
The initial values of the functions U(x,t)$U\left(x,t\right)$ and V(t)$V\left(t\right)$ must be given at t = t0$t={t}_{0}$. These values are calculated in uvinit.
The functions Ri${R}_{i}$ which may be thought of as fluxes, are also used in the definition of the boundary conditions. The boundary conditions must have the form
 βi(x,t)Ri(x,t,U,Ux,V) = γi(x,t,U,Ux,V,V.),  i = 1,2, … ,npde, $βi(x,t)Ri(x,t,U,Ux,V)=γi(x,t,U,Ux,V,V.), i=1,2,…,npde,$ (4)
where x = a$x=a$ or x = b$x=b$. The functions γi${\gamma }_{i}$ may only depend linearly on V.$\stackrel{.}{V}$.
The boundary conditions must be specified in bndary.
The algebraic-differential equation system which is defined by the functions Fi${F}_{i}$ must be specified in odedef. You must also specify the coupling points ξ$\xi$ in the array xi. Thus, the problem is subject to the following restrictions:
 (i) in (1), V.j(t)${\stackrel{.}{V}}_{\mathit{j}}\left(t\right)$, for j = 1,2, … ,ncode$\mathit{j}=1,2,\dots ,{\mathbf{ncode}}$, may only appear linearly in the functions Qi${Q}_{\mathit{i}}$, for i = 1,2, … ,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$, with a similar restriction for γ$\gamma$; (ii) Pi,j${P}_{\mathit{i},j}$ and the flux Ri${R}_{\mathit{i}}$ must not depend on any time derivatives; (iii) t0 < tout${t}_{0}<{t}_{\mathrm{out}}$, so that integration is in the forward direction; (iv) the evaluation of the functions Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ is done at both the break points and internally selected points for each element in turn, that is Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ are evaluated twice at each break point. Any discontinuities in these functions must therefore be at one or more of the mesh points; (v) at least one of the functions Pi,j${P}_{i,j}$ must be nonzero so that there is a time derivative present in the PDE problem; (vi) if m > 0$m>0$ and x1 = 0.0${x}_{1}=0.0$, which is the left boundary point, then it must be ensured that the PDE solution is bounded at this point. This can be done either by specifying the solution at x = 0.0$x=0.0$ or by specifying a zero flux there, that is βi = 1.0${\beta }_{i}=1.0$ and γi = 0.0${\gamma }_{i}=0.0$.
The parabolic equations are approximated by a system of ODEs in time for the values of Ui${U}_{i}$ at the mesh points. This ODE system is obtained by approximating the PDE solution between each pair of break points by a Chebyshev polynomial of degree npoly. The interval between each pair of break points is treated by nag_pde_1d_parab_dae_coll (d03pj) as an element, and on this element, a polynomial and its space and time derivatives are made to satisfy the system of PDEs at npoly1${\mathbf{npoly}}-1$ spatial points, which are chosen internally by the code and the break points. The user-defined break points and the internally selected points together define the mesh. The smallest value that npoly can take is one, in which case, the solution is approximated by piecewise linear polynomials between consecutive break points and the method is similar to an ordinary finite element method.
In total there are (nbkpts1) × npoly + 1$\left({\mathbf{nbkpts}}-1\right)×{\mathbf{npoly}}+1$ mesh points in the spatial direction, and npde × ((nbkpts1) × npoly + 1) + ncode${\mathbf{npde}}×\left(\left({\mathbf{nbkpts}}-1\right)×{\mathbf{npoly}}+1\right)+{\mathbf{ncode}}$ ODEs in the time direction; one ODE at each break point for each PDE component, npoly1${\mathbf{npoly}}-1$ ODEs for each PDE component between each pair of break points, and ncode coupled ODEs. The system is then integrated forwards in time using a Backward Differentiation Formula (BDF) method or a Theta method.

## References

Berzins M (1990) Developments in the NAG Library software for parabolic equations Scientific Software Systems (eds J C Mason and M G Cox) 59–72 Chapman and Hall
Berzins M and Dew P M (1991) Algorithm 690: Chebyshev polynomial software for elliptic-parabolic systems of PDEs ACM Trans. Math. Software 17 178–206
Berzins M, Dew P M and Furzeland R M (1988) Software tools for time-dependent equations in simulation and optimization of large systems Proc. IMA Conf. Simulation and Optimization (ed A J Osiadcz) 35–50 Clarendon Press, Oxford
Berzins M and Furzeland R M (1992) An adaptive theta method for the solution of stiff and nonstiff differential equations Appl. Numer. Math. 9 1–19
Zaturska N B, Drazin P G and Banks W H H (1988) On the flow of a viscous fluid driven along a channel by a suction at porous walls Fluid Dynamics Research 4

## Parameters

### Compulsory Input Parameters

1:     npde – int64int32nag_int scalar
The number of PDEs to be solved.
Constraint: npde1${\mathbf{npde}}\ge 1$.
2:     m – int64int32nag_int scalar
The coordinate system used:
m = 0${\mathbf{m}}=0$
Indicates Cartesian coordinates.
m = 1${\mathbf{m}}=1$
Indicates cylindrical polar coordinates.
m = 2${\mathbf{m}}=2$
Indicates spherical polar coordinates.
Constraint: m = 0${\mathbf{m}}=0$, 1$1$ or 2$2$.
3:     ts – double scalar
The initial value of the independent variable t$t$.
Constraint: ${\mathbf{ts}}<{\mathbf{tout}}$.
4:     tout – double scalar
The final value of t$t$ to which the integration is to be carried out.
5:     pdedef – function handle or string containing name of m-file
pdedef must compute the functions Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ which define the system of PDEs. The functions may depend on x$x$, t$t$, U$U$, Ux${U}_{x}$ and V$V$; Qi${Q}_{i}$ may depend linearly on V.$\stackrel{.}{V}$. The functions must be evaluated at a set of points.
[p, q, r, ires, user] = pdedef(npde, t, x, nptl, u, ux, ncode, v, vdot, ires, user)

Input Parameters

1:     npde – int64int32nag_int scalar
The number of PDEs in the system.
2:     t – double scalar
The current value of the independent variable t$t$.
3:     x(nptl) – double array
Contains a set of mesh points at which Pi,j${P}_{i,j}$, Qi${Q}_{i}$ and Ri${R}_{i}$ are to be evaluated. x(1)${\mathbf{x}}\left(1\right)$ and x(nptl)${\mathbf{x}}\left({\mathbf{nptl}}\right)$ contain successive user-supplied break points and the elements of the array will satisfy x(1) < x(2) < < x(nptl)${\mathbf{x}}\left(1\right)<{\mathbf{x}}\left(2\right)<\cdots <{\mathbf{x}}\left({\mathbf{nptl}}\right)$.
4:     nptl – int64int32nag_int scalar
The number of points at which evaluations are required (the value of npoly + 1${\mathbf{npoly}}+1$).
5:     u(npde,nptl) – double array
u(i,j)${\mathbf{u}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component Ui(x,t)${U}_{\mathit{i}}\left(x,t\right)$ where x = x(j)$x={\mathbf{x}}\left(\mathit{j}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nptl$\mathit{j}=1,2,\dots ,{\mathbf{nptl}}$.
6:     ux(npde,nptl) – double array
ux(i,j)${\mathbf{ux}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component (Ui(x,t))/(x) $\frac{\partial {U}_{\mathit{i}}\left(x,t\right)}{\partial x}$ where x = x(j)$x={\mathbf{x}}\left(\mathit{j}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nptl$\mathit{j}=1,2,\dots ,{\mathbf{nptl}}$.
7:     ncode – int64int32nag_int scalar
The number of coupled ODEs in the system.
8:     v(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, v(i)${\mathbf{v}}\left(\mathit{i}\right)$ contains the value of the component Vi(t)${V}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
9:     vdot(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, vdot(i)${\mathbf{vdot}}\left(\mathit{i}\right)$ contains the value of component V.i(t)${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
Note:  V.i(t)${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$, may only appear linearly in Qj${Q}_{\mathit{j}}$, for j = 1,2,,npde$\mathit{j}=1,2,\dots ,{\mathbf{npde}}$.
10:   ires – int64int32nag_int scalar
Set to 1​ or ​1$-1\text{​ or ​}1$.
11:   user – Any MATLAB object
pdedef is called from nag_pde_1d_parab_dae_coll (d03pj) with the object supplied to nag_pde_1d_parab_dae_coll (d03pj).

Output Parameters

1:     p(npde,npde,nptl) – double array
p(i,j,k)${\mathbf{p}}\left(\mathit{i},\mathit{j},\mathit{k}\right)$ must be set to the value of Pi,j(x,t,U,Ux,V)${P}_{\mathit{i},\mathit{j}}\left(x,t,U,{U}_{x},V\right)$ where x = x(k)$x={\mathbf{x}}\left(\mathit{k}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$, j = 1,2,,npde$\mathit{j}=1,2,\dots ,{\mathbf{npde}}$ and k = 1,2,,nptl$\mathit{k}=1,2,\dots ,{\mathbf{nptl}}$ .
2:     q(npde,nptl) – double array
q(i,j)${\mathbf{q}}\left(\mathit{i},\mathit{j}\right)$ must be set to the value of Qi(x,t,U,Ux,V,V.)${Q}_{\mathit{i}}\left(x,t,U,{U}_{x},V,\stackrel{.}{V}\right)$ where x = x(j)$x={\mathbf{x}}\left(\mathit{j}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nptl$\mathit{j}=1,2,\dots ,{\mathbf{nptl}}$.
3:     r(npde,nptl) – double array
r(i,j)${\mathbf{r}}\left(\mathit{i},\mathit{j}\right)$ must be set to the value of Ri(x,t,U,Ux,V)${R}_{\mathit{i}}\left(x,t,U,{U}_{x},V\right)$ where x = x(i)$x={\mathbf{x}}\left(\mathit{i}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nptl$\mathit{j}=1,2,\dots ,{\mathbf{nptl}}$.
4:     ires – int64int32nag_int scalar
Should usually remain unchanged. However, you may set ires to force the integration function to take certain actions as described below:
ires = 2${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to ${\mathbf{ifail}}={\mathbf{6}}$.
ires = 3${\mathbf{ires}}=3$
Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set ires = 3${\mathbf{ires}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ires = 3${\mathbf{ires}}=3$, then nag_pde_1d_parab_dae_coll (d03pj) returns to the calling function with the error indicator set to ${\mathbf{ifail}}={\mathbf{4}}$.
5:     user – Any MATLAB object
6:     bndary – function handle or string containing name of m-file
bndary must compute the functions βi${\beta }_{i}$ and γi${\gamma }_{i}$ which define the boundary conditions as in equation (4).
[beta, gamma, ires, user] = bndary(npde, t, u, ux, ncode, v, vdot, ibnd, ires, user)

Input Parameters

1:     npde – int64int32nag_int scalar
The number of PDEs in the system.
2:     t – double scalar
The current value of the independent variable t$t$.
3:     u(npde) – double array
u(i)${\mathbf{u}}\left(\mathit{i}\right)$ contains the value of the component Ui(x,t)${U}_{\mathit{i}}\left(x,t\right)$ at the boundary specified by ibnd, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
4:     ux(npde) – double array
ux(i)${\mathbf{ux}}\left(\mathit{i}\right)$ contains the value of the component (Ui(x,t))/(x) $\frac{\partial {U}_{\mathit{i}}\left(x,t\right)}{\partial x}$ at the boundary specified by ibnd, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
5:     ncode – int64int32nag_int scalar
The number of coupled ODEs in the system.
6:     v(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, v(i)${\mathbf{v}}\left(\mathit{i}\right)$ contains the value of the component Vi(t)${V}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
7:     vdot(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, vdot(i)${\mathbf{vdot}}\left(\mathit{i}\right)$ contains the value of component V.i(t)${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
Note:  V.i(t)${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$, may only appear linearly in Qj${Q}_{\mathit{j}}$, for j = 1,2,,npde$\mathit{j}=1,2,\dots ,{\mathbf{npde}}$.
8:     ibnd – int64int32nag_int scalar
Specifies which boundary conditions are to be evaluated.
ibnd = 0${\mathbf{ibnd}}=0$
bndary must set up the coefficients of the left-hand boundary, x = a$x=a$.
ibnd0${\mathbf{ibnd}}\ne 0$
bndary must set up the coefficients of the right-hand boundary, x = b$x=b$.
9:     ires – int64int32nag_int scalar
Set to 1​ or ​1$-1\text{​ or ​}1$.
10:   user – Any MATLAB object
bndary is called from nag_pde_1d_parab_dae_coll (d03pj) with the object supplied to nag_pde_1d_parab_dae_coll (d03pj).

Output Parameters

1:     beta(npde) – double array
beta(i)${\mathbf{beta}}\left(\mathit{i}\right)$ must be set to the value of βi(x,t)${\beta }_{\mathit{i}}\left(x,t\right)$ at the boundary specified by ibnd, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
2:     gamma(npde) – double array
gamma(i)${\mathbf{gamma}}\left(\mathit{i}\right)$ must be set to the value of γi(x,t,U,Ux,V,V.)${\gamma }_{\mathit{i}}\left(x,t,U,{U}_{x},V,\stackrel{.}{V}\right)$ at the boundary specified by ibnd, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
3:     ires – int64int32nag_int scalar
Should usually remain unchanged. However, you may set ires to force the integration function to take certain actions as described below:
ires = 2${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to ${\mathbf{ifail}}={\mathbf{6}}$.
ires = 3${\mathbf{ires}}=3$
Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set ires = 3${\mathbf{ires}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ires = 3${\mathbf{ires}}=3$, then nag_pde_1d_parab_dae_coll (d03pj) returns to the calling function with the error indicator set to ${\mathbf{ifail}}={\mathbf{4}}$.
4:     user – Any MATLAB object
7:     u(neqn) – double array
neqn, the dimension of the array, must satisfy the constraint ${\mathbf{neqn}}={\mathbf{npde}}×{\mathbf{npts}}+{\mathbf{ncode}}$.
If ind = 1${\mathbf{ind}}=1$ the value of u must be unchanged from the previous call.
8:     xbkpts(nbkpts) – double array
nbkpts, the dimension of the array, must satisfy the constraint nbkpts2${\mathbf{nbkpts}}\ge 2$.
The values of the break points in the space direction. xbkpts(1)${\mathbf{xbkpts}}\left(1\right)$ must specify the left-hand boundary, a$a$, and ${\mathbf{xbkpts}}\left({\mathbf{nbkpts}}\right)$ must specify the right-hand boundary, b$b$.
Constraint: xbkpts(1) < xbkpts(2) < < ${\mathbf{xbkpts}}\left(1\right)<{\mathbf{xbkpts}}\left(2\right)<\cdots <{\mathbf{xbkpts}}\left({\mathbf{nbkpts}}\right)$.
9:     npoly – int64int32nag_int scalar
The degree of the Chebyshev polynomial to be used in approximating the PDE solution between each pair of break points.
Constraint: 1npoly49$1\le {\mathbf{npoly}}\le 49$.
10:   npts – int64int32nag_int scalar
The number of mesh points in the interval [a,b]$\left[a,b\right]$.
Constraint: npts = (nbkpts1) × npoly + 1${\mathbf{npts}}=\left({\mathbf{nbkpts}}-1\right)×{\mathbf{npoly}}+1$.
11:   ncode – int64int32nag_int scalar
The number of coupled ODE components.
Constraint: ncode0${\mathbf{ncode}}\ge 0$.
12:   odedef – function handle or string containing name of m-file
odedef must evaluate the functions F$F$, which define the system of ODEs, as given in (3).
[f, ires, user] = odedef(npde, t, ncode, v, vdot, nxi, xi, ucp, ucpx, rcp, ucpt, ucptx, ires, user)

Input Parameters

1:     npde – int64int32nag_int scalar
The number of PDEs in the system.
2:     t – double scalar
The current value of the independent variable t$t$.
3:     ncode – int64int32nag_int scalar
The number of coupled ODEs in the system.
4:     v(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, v(i)${\mathbf{v}}\left(\mathit{i}\right)$ contains the value of the component Vi(t)${V}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
5:     vdot(ncode) – double array
If ncode > 0${\mathbf{ncode}}>0$, vdot(i)${\mathbf{vdot}}\left(\mathit{i}\right)$ contains the value of component V.i(t)${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
6:     nxi – int64int32nag_int scalar
The number of ODE/PDE coupling points.
7:     xi(nxi) – double array
If nxi > 0${\mathbf{nxi}}>0$, xi(i)${\mathbf{xi}}\left(\mathit{i}\right)$ contains the ODE/PDE coupling points, ξi${\xi }_{\mathit{i}}$, for i = 1,2,,nxi$\mathit{i}=1,2,\dots ,{\mathbf{nxi}}$.
8:     ucp(npde, : $:$) – double array
The second dimension of the array must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$
If nxi > 0${\mathbf{nxi}}>0$, ucp(i,j)${\mathbf{ucp}}\left(\mathit{i},\mathit{j}\right)$ contains the value of Ui(x,t)${U}_{\mathit{i}}\left(x,t\right)$ at the coupling point x = ξj$x={\xi }_{\mathit{j}}$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nxi$\mathit{j}=1,2,\dots ,{\mathbf{nxi}}$.
9:     ucpx(npde, : $:$) – double array
The second dimension of the array must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$
If nxi > 0${\mathbf{nxi}}>0$, ucpx(i,j)${\mathbf{ucpx}}\left(\mathit{i},\mathit{j}\right)$ contains the value of (Ui(x,t))/(x) $\frac{\partial {U}_{\mathit{i}}\left(x,t\right)}{\partial x}$ at the coupling point x = ξj$x={\xi }_{\mathit{j}}$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nxi$\mathit{j}=1,2,\dots ,{\mathbf{nxi}}$.
10:   rcp(npde, : $:$) – double array
The second dimension of the array must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$
rcp(i,j)${\mathbf{rcp}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the flux Ri${R}_{\mathit{i}}$ at the coupling point x = ξj$x={\xi }_{\mathit{j}}$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nxi$\mathit{j}=1,2,\dots ,{\mathbf{nxi}}$.
11:   ucpt(npde, : $:$) – double array
The second dimension of the array must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$
If nxi > 0${\mathbf{nxi}}>0$, ucpt(i,j)${\mathbf{ucpt}}\left(\mathit{i},\mathit{j}\right)$ contains the value of (Ui)/(t) $\frac{\partial {U}_{\mathit{i}}}{\partial t}$ at the coupling point x = ξj$x={\xi }_{\mathit{j}}$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nxi$\mathit{j}=1,2,\dots ,{\mathbf{nxi}}$.
12:   ucptx(npde, : $:$) – double array
The second dimension of the array must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$
ucptx(i,j)${\mathbf{ucptx}}\left(\mathit{i},\mathit{j}\right)$ contains the value of (2Ui)/( x t ) $\frac{{\partial }^{2}{U}_{\mathit{i}}}{\partial x\partial t}$ at the coupling point x = ξj$x={\xi }_{\mathit{j}}$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,nxi$\mathit{j}=1,2,\dots ,{\mathbf{nxi}}$.
13:   ires – int64int32nag_int scalar
The form of F$F$ that must be returned in the array f.
ires = 1${\mathbf{ires}}=1$
Equation (5) must be used.
ires = 1${\mathbf{ires}}=-1$
Equation (6) must be used.
14:   user – Any MATLAB object
odedef is called from nag_pde_1d_parab_dae_coll (d03pj) with the object supplied to nag_pde_1d_parab_dae_coll (d03pj).

Output Parameters

1:     f(ncode) – double array
f(i)${\mathbf{f}}\left(\mathit{i}\right)$ must contain the i$\mathit{i}$th component of F$F$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$, where F$F$ is defined as
F = GAV.B
 ( Ut * ) Uxt *
,
$F=G-AV.-B Ut* Uxt* ,$
(5)
or
F = AV.B
 ( Ut * ) Uxt *
.
$F=-AV.-B Ut* Uxt* .$
(6)
The definition of F$F$ is determined by the input value of ires.
2:     ires – int64int32nag_int scalar
Should usually remain unchanged. However, you may reset ires to force the integration function to take certain actions as described below:
ires = 2${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to ${\mathbf{ifail}}={\mathbf{6}}$.
ires = 3${\mathbf{ires}}=3$
Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set ires = 3${\mathbf{ires}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ires = 3${\mathbf{ires}}=3$, then nag_pde_1d_parab_dae_coll (d03pj) returns to the calling function with the error indicator set to ${\mathbf{ifail}}={\mathbf{4}}$.
3:     user – Any MATLAB object
13:   xi( : $:$) – double array
Note: the dimension of the array xi must be at least max (1,nxi)$\mathrm{max}\phantom{\rule{0.125em}{0ex}}\left(1,{\mathbf{nxi}}\right)$.
xi(i)${\mathbf{xi}}\left(\mathit{i}\right)$, for i = 1,2,,nxi$\mathit{i}=1,2,\dots ,{\mathbf{nxi}}$, must be set to the ODE/PDE coupling points.
Constraint: xbkpts(1)xi(1) < xi(2) < < xi(nxi)${\mathbf{xbkpts}}\left(1\right)\le {\mathbf{xi}}\left(1\right)<{\mathbf{xi}}\left(2\right)<\cdots <{\mathbf{xi}}\left({\mathbf{nxi}}\right)\le {\mathbf{xbkpts}}\left({\mathbf{nbkpts}}\right)$.
14:   uvinit – function handle or string containing name of m-file
uvinit must compute the initial values of the PDE and the ODE components Ui(xj,t0)${U}_{\mathit{i}}\left({x}_{\mathit{j}},{t}_{0}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,npts$\mathit{j}=1,2,\dots ,{\mathbf{npts}}$, and Vk(t0)${V}_{\mathit{k}}\left({t}_{0}\right)$, for k = 1,2,,ncode$\mathit{k}=1,2,\dots ,{\mathbf{ncode}}$.
[u, v, user] = uvinit(npde, npts, x, ncode, user)

Input Parameters

1:     npde – int64int32nag_int scalar
The number of PDEs in the system.
2:     npts – int64int32nag_int scalar
The number of mesh points in the interval [a,b]$\left[a,b\right]$.
3:     x(npts) – double array
x(i)${\mathbf{x}}\left(\mathit{i}\right)$, for i = 1,2,,npts$\mathit{i}=1,2,\dots ,{\mathbf{npts}}$, contains the current values of the space variable xi${x}_{\mathit{i}}$.
4:     ncode – int64int32nag_int scalar
The number of coupled ODEs in the system.
5:     user – Any MATLAB object
uvinit is called from nag_pde_1d_parab_dae_coll (d03pj) with the object supplied to nag_pde_1d_parab_dae_coll (d03pj).

Output Parameters

1:     u(npde,npts) – double array
If nxi > 0${\mathbf{nxi}}>0$, u(i,j)${\mathbf{u}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component Ui(xj,t0)${U}_{\mathit{i}}\left({x}_{\mathit{j}},{t}_{0}\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,npts$\mathit{j}=1,2,\dots ,{\mathbf{npts}}$.
2:     v(ncode) – double array
v(i)${\mathbf{v}}\left(\mathit{i}\right)$ contains the value of component Vi(t0)${V}_{\mathit{i}}\left({t}_{0}\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
3:     user – Any MATLAB object
15:   rtol( : $:$) – double array
Note: the dimension of the array rtol must be at least 1$1$ if itol = 1${\mathbf{itol}}=1$ or 2$2$ and at least neqn${\mathbf{neqn}}$ if itol = 3${\mathbf{itol}}=3$ or 4$4$.
The relative local error tolerance.
Constraint: rtol(i)0.0${\mathbf{rtol}}\left(i\right)\ge 0.0$ for all relevant i$i$.
16:   atol( : $:$) – double array
Note: the dimension of the array atol must be at least 1$1$ if itol = 1${\mathbf{itol}}=1$ or 3$3$ and at least neqn${\mathbf{neqn}}$ if itol = 2${\mathbf{itol}}=2$ or 4$4$.
The absolute local error tolerance.
Constraint: atol(i)0.0${\mathbf{atol}}\left(i\right)\ge 0.0$ for all relevant i$i$.
Note: corresponding elements of rtol and atol cannot both be 0.0$0.0$.
17:   itol – int64int32nag_int scalar
A value to indicate the form of the local error test. itol indicates to nag_pde_1d_parab_dae_coll (d03pj) whether to interpret either or both of rtol or atol as a vector or scalar. The error test to be satisfied is ei / wi < 1.0$‖{e}_{i}/{w}_{i}‖<1.0$, where wi${w}_{i}$ is defined as follows:
 itol rtol atol wi${w}_{i}$ 1 scalar scalar rtol(1) × |Ui| + atol(1)${\mathbf{rtol}}\left(1\right)×|{U}_{i}|+{\mathbf{atol}}\left(1\right)$ 2 scalar vector rtol(1) × |Ui| + atol(i)${\mathbf{rtol}}\left(1\right)×|{U}_{i}|+{\mathbf{atol}}\left(i\right)$ 3 vector scalar rtol(i) × |Ui| + atol(1)${\mathbf{rtol}}\left(i\right)×|{U}_{i}|+{\mathbf{atol}}\left(1\right)$ 4 vector vector rtol(i) × |Ui| + atol(i)${\mathbf{rtol}}\left(i\right)×|{U}_{i}|+{\mathbf{atol}}\left(i\right)$
In the above, ei${e}_{\mathit{i}}$ denotes the estimated local error for the i$\mathit{i}$th component of the coupled PDE/ODE system in time, u(i)${\mathbf{u}}\left(\mathit{i}\right)$, for i = 1,2,,neqn$\mathit{i}=1,2,\dots ,{\mathbf{neqn}}$.
The choice of norm used is defined by the parameter norm_p.
Constraint: 1itol4$1\le {\mathbf{itol}}\le 4$.
18:   norm_p – string (length ≥ 1)
The type of norm to be used.
norm = 'M'${\mathbf{norm}}=\text{'M'}$
Maximum norm.
norm = 'A'${\mathbf{norm}}=\text{'A'}$
Averaged L2${L}_{2}$ norm.
If unorm${{\mathbf{u}}}_{\mathrm{norm}}$ denotes the norm of the vector u of length neqn, then for the averaged L2${L}_{2}$ norm
 unorm = sqrt(1/(neqn) ∑ i = 1neqn(u(i) / wi)2), $unorm=1neqn∑i=1neqn(ui/wi)2,$
while for the maximum norm
 unorm = maxi |u(i) / wi| . $u norm = maxi| ui / wi | .$
See the description of itol for the formulation of the weight vector w$w$.
Constraint: norm = 'M'${\mathbf{norm}}=\text{'M'}$ or 'A'$\text{'A'}$.
19:   laopt – string (length ≥ 1)
The type of matrix algebra required.
laopt = 'F'${\mathbf{laopt}}=\text{'F'}$
Full matrix methods to be used.
laopt = 'B'${\mathbf{laopt}}=\text{'B'}$
Banded matrix methods to be used.
laopt = 'S'${\mathbf{laopt}}=\text{'S'}$
Sparse matrix methods to be used.
Constraint: laopt = 'F'${\mathbf{laopt}}=\text{'F'}$, 'B'$\text{'B'}$ or 'S'$\text{'S'}$.
Note: you are recommended to use the banded option when no coupled ODEs are present (i.e., ncode = 0${\mathbf{ncode}}=0$).
20:   algopt(30$30$) – double array
May be set to control various options available in the integrator. If you wish to employ all the default options, then algopt(1)${\mathbf{algopt}}\left(1\right)$ should be set to 0.0$0.0$. Default values will also be used for any other elements of algopt set to zero. The permissible values, default values, and meanings are as follows:
algopt(1)${\mathbf{algopt}}\left(1\right)$
Selects the ODE integration method to be used. If algopt(1) = 1.0${\mathbf{algopt}}\left(1\right)=1.0$, a BDF method is used and if algopt(1) = 2.0${\mathbf{algopt}}\left(1\right)=2.0$, a Theta method is used. The default value is algopt(1) = 1.0${\mathbf{algopt}}\left(1\right)=1.0$.
If algopt(1) = 2.0${\mathbf{algopt}}\left(1\right)=2.0$, then algopt(i)${\mathbf{algopt}}\left(\mathit{i}\right)$, for i = 2,3,4$\mathit{i}=2,3,4$ are not used.
algopt(2)${\mathbf{algopt}}\left(2\right)$
Specifies the maximum order of the BDF integration formula to be used. algopt(2)${\mathbf{algopt}}\left(2\right)$ may be 1.0$1.0$, 2.0$2.0$, 3.0$3.0$, 4.0$4.0$ or 5.0$5.0$. The default value is algopt(2) = 5.0${\mathbf{algopt}}\left(2\right)=5.0$.
algopt(3)${\mathbf{algopt}}\left(3\right)$
Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the BDF method. If algopt(3) = 1.0${\mathbf{algopt}}\left(3\right)=1.0$ a modified Newton iteration is used and if algopt(3) = 2.0${\mathbf{algopt}}\left(3\right)=2.0$ a functional iteration method is used. If functional iteration is selected and the integrator encounters difficulty, then there is an automatic switch to the modified Newton iteration. The default value is algopt(3) = 1.0${\mathbf{algopt}}\left(3\right)=1.0$.
algopt(4)${\mathbf{algopt}}\left(4\right)$
Specifies whether or not the Petzold error test is to be employed. The Petzold error test results in extra overhead but is more suitable when algebraic equations are present, such as Pi,j = 0.0${P}_{i,\mathit{j}}=0.0$, for j = 1,2,,npde$\mathit{j}=1,2,\dots ,{\mathbf{npde}}$, for some i$i$ or when there is no V.i(t)${\stackrel{.}{V}}_{i}\left(t\right)$ dependence in the coupled ODE system. If algopt(4) = 1.0${\mathbf{algopt}}\left(4\right)=1.0$, then the Petzold test is used. If algopt(4) = 2.0${\mathbf{algopt}}\left(4\right)=2.0$, then the Petzold test is not used. The default value is algopt(4) = 1.0${\mathbf{algopt}}\left(4\right)=1.0$.
If algopt(1) = 1.0${\mathbf{algopt}}\left(1\right)=1.0$, then algopt(i)${\mathbf{algopt}}\left(\mathit{i}\right)$, for i = 5,6,7$\mathit{i}=5,6,7$, are not used.
algopt(5)${\mathbf{algopt}}\left(5\right)$
Specifies the value of Theta to be used in the Theta integration method. 0.51algopt(5)0.99$0.51\le {\mathbf{algopt}}\left(5\right)\le 0.99$. The default value is algopt(5) = 0.55${\mathbf{algopt}}\left(5\right)=0.55$.
algopt(6)${\mathbf{algopt}}\left(6\right)$
Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the Theta method. If algopt(6) = 1.0${\mathbf{algopt}}\left(6\right)=1.0$, a modified Newton iteration is used and if algopt(6) = 2.0${\mathbf{algopt}}\left(6\right)=2.0$, a functional iteration method is used. The default value is algopt(6) = 1.0${\mathbf{algopt}}\left(6\right)=1.0$.
algopt(7)${\mathbf{algopt}}\left(7\right)$
Specifies whether or not the integrator is allowed to switch automatically between modified Newton and functional iteration methods in order to be more efficient. If algopt(7) = 1.0${\mathbf{algopt}}\left(7\right)=1.0$, then switching is allowed and if algopt(7) = 2.0${\mathbf{algopt}}\left(7\right)=2.0$, then switching is not allowed. The default value is algopt(7) = 1.0${\mathbf{algopt}}\left(7\right)=1.0$.
algopt(11)${\mathbf{algopt}}\left(11\right)$
Specifies a point in the time direction, tcrit${t}_{\mathrm{crit}}$, beyond which integration must not be attempted. The use of tcrit${t}_{\mathrm{crit}}$ is described under the parameter itask. If algopt(1)0.0${\mathbf{algopt}}\left(1\right)\ne 0.0$, a value of 0.0$0.0$ for algopt(11)${\mathbf{algopt}}\left(11\right)$, say, should be specified even if itask subsequently specifies that tcrit${t}_{\mathrm{crit}}$ will not be used.
algopt(12)${\mathbf{algopt}}\left(12\right)$
Specifies the minimum absolute step size to be allowed in the time integration. If this option is not required, algopt(12)${\mathbf{algopt}}\left(12\right)$ should be set to 0.0$0.0$.
algopt(13)${\mathbf{algopt}}\left(13\right)$
Specifies the maximum absolute step size to be allowed in the time integration. If this option is not required, algopt(13)${\mathbf{algopt}}\left(13\right)$ should be set to 0.0$0.0$.
algopt(14)${\mathbf{algopt}}\left(14\right)$
Specifies the initial step size to be attempted by the integrator. If algopt(14) = 0.0${\mathbf{algopt}}\left(14\right)=0.0$, then the initial step size is calculated internally.
algopt(15)${\mathbf{algopt}}\left(15\right)$
Specifies the maximum number of steps to be attempted by the integrator in any one call. If algopt(15) = 0.0${\mathbf{algopt}}\left(15\right)=0.0$, then no limit is imposed.
algopt(23)${\mathbf{algopt}}\left(23\right)$
Specifies what method is to be used to solve the nonlinear equations at the initial point to initialize the values of U$U$, Ut${U}_{t}$, V$V$ and V.$\stackrel{.}{V}$. If algopt(23) = 1.0${\mathbf{algopt}}\left(23\right)=1.0$, a modified Newton iteration is used and if algopt(23) = 2.0${\mathbf{algopt}}\left(23\right)=2.0$, functional iteration is used. The default value is algopt(23) = 1.0${\mathbf{algopt}}\left(23\right)=1.0$.
algopt(29)${\mathbf{algopt}}\left(29\right)$ and algopt(30)${\mathbf{algopt}}\left(30\right)$ are used only for the sparse matrix algebra option, laopt = 'S'${\mathbf{laopt}}=\text{'S'}$.
algopt(29)${\mathbf{algopt}}\left(29\right)$
Governs the choice of pivots during the decomposition of the first Jacobian matrix. It should lie in the range 0.0 < algopt(29) < 1.0$0.0<{\mathbf{algopt}}\left(29\right)<1.0$, with smaller values biasing the algorithm towards maintaining sparsity at the expense of numerical stability. If algopt(29)${\mathbf{algopt}}\left(29\right)$ lies outside this range then the default value is used. If the functions regard the Jacobian matrix as numerically singular then increasing algopt(29)${\mathbf{algopt}}\left(29\right)$ towards 1.0$1.0$ may help, but at the cost of increased fill-in. The default value is algopt(29) = 0.1${\mathbf{algopt}}\left(29\right)=0.1$.
algopt(30)${\mathbf{algopt}}\left(30\right)$
Is used as a relative pivot threshold during subsequent Jacobian decompositions (see algopt(29)${\mathbf{algopt}}\left(29\right)$) below which an internal error is invoked. If algopt(30)${\mathbf{algopt}}\left(30\right)$ is greater than 1.0$1.0$ no check is made on the pivot size, and this may be a necessary option if the Jacobian is found to be numerically singular (see algopt(29)${\mathbf{algopt}}\left(29\right)$). The default value is algopt(30) = 0.0001${\mathbf{algopt}}\left(30\right)=0.0001$.
21:   rsave(lrsave) – double array
If ind = 0${\mathbf{ind}}=0$, rsave need not be set on entry.
If ind = 1${\mathbf{ind}}=1$, rsave must be unchanged from the previous call to the function because it contains required information about the iteration.
22:   isave(lisave) – int64int32nag_int array
If ind = 0${\mathbf{ind}}=0$, isave need not be set on entry.
If ind = 1${\mathbf{ind}}=1$, isave must be unchanged from the previous call to the function because it contains required information about the iteration required for subsequent calls. In particular:
isave(1)${\mathbf{isave}}\left(1\right)$
Contains the number of steps taken in time.
isave(2)${\mathbf{isave}}\left(2\right)$
Contains the number of residual evaluations of the resulting ODE system used. One such evaluation involves computing the PDE functions at all the mesh points, as well as one evaluation of the functions in the boundary conditions.
isave(3)${\mathbf{isave}}\left(3\right)$
Contains the number of Jacobian evaluations performed by the time integrator.
isave(4)${\mathbf{isave}}\left(4\right)$
Contains the order of the ODE method last used in the time integration.
isave(5)${\mathbf{isave}}\left(5\right)$
Contains the number of Newton iterations performed by the time integrator. Each iteration involves residual evaluation of the resulting ODE system followed by a back-substitution using the LU$LU$ decomposition of the Jacobian matrix.
Specifies the task to be performed by the ODE integrator.
itask = 1${\mathbf{itask}}=1$
Normal computation of output values u at t = tout$t={\mathbf{tout}}$.
itask = 2${\mathbf{itask}}=2$
One step and return.
itask = 3${\mathbf{itask}}=3$
Stop at first internal integration point at or beyond t = tout$t={\mathbf{tout}}$.
itask = 4${\mathbf{itask}}=4$
Normal computation of output values u at t = tout$t={\mathbf{tout}}$ but without overshooting t = tcrit$t={t}_{\mathrm{crit}}$ where tcrit${t}_{\mathrm{crit}}$ is described under the parameter algopt.
itask = 5${\mathbf{itask}}=5$
Take one step in the time direction and return, without passing tcrit${t}_{\mathrm{crit}}$, where tcrit${t}_{\mathrm{crit}}$ is described under the parameter algopt.
Constraint: itask = 1${\mathbf{itask}}=1$, 2$2$, 3$3$, 4$4$ or 5$5$.
24:   itrace – int64int32nag_int scalar
The level of trace information required from nag_pde_1d_parab_dae_coll (d03pj) and the underlying ODE solver. itrace may take the value 1$-1$, 0$0$, 1$1$, 2$2$ or 3$3$.
itrace = 1${\mathbf{itrace}}=-1$
No output is generated.
itrace = 0${\mathbf{itrace}}=0$
Only warning messages from the PDE solver are printed on the current error message unit (see nag_file_set_unit_error (x04aa)).
itrace > 0${\mathbf{itrace}}>0$
Output from the underlying ODE solver is printed on the current advisory message unit (see nag_file_set_unit_advisory (x04ab)). This output contains details of Jacobian entries, the nonlinear iteration and the time integration during the computation of the ODE system.
If itrace < 1${\mathbf{itrace}}<-1$, then 1$-1$ is assumed and similarly if itrace > 3${\mathbf{itrace}}>3$, then 3$3$ is assumed.
The advisory messages are given in greater detail as itrace increases. You are advised to set itrace = 0${\mathbf{itrace}}=0$, unless you are experienced with sub-chapter D02M–N.
25:   ind – int64int32nag_int scalar
Indicates whether this is a continuation call or a new integration.
ind = 0${\mathbf{ind}}=0$
Starts or restarts the integration in time.
ind = 1${\mathbf{ind}}=1$
Continues the integration after an earlier exit from the function. In this case, only the parameters tout and ifail should be reset between calls to nag_pde_1d_parab_dae_coll (d03pj).
Constraint: ind = 0${\mathbf{ind}}=0$ or 1$1$.
26:   cwsav(10$10$) – cell array of strings
27:   lwsav(100$100$) – logical array
28:   iwsav(505$505$) – int64int32nag_int array
29:   rwsav(1100$1100$) – double array

### Optional Input Parameters

1:     nbkpts – int64int32nag_int scalar
Default: The dimension of the array xbkpts.
The number of break points in the interval [a,b]$\left[a,b\right]$.
Constraint: nbkpts2${\mathbf{nbkpts}}\ge 2$.
2:     nxi – int64int32nag_int scalar
Default: The dimension of the array xi.
The number of ODE/PDE coupling points.
Constraints:
• if ncode = 0${\mathbf{ncode}}=0$, nxi = 0${\mathbf{nxi}}=0$;
• if ncode > 0${\mathbf{ncode}}>0$, nxi0${\mathbf{nxi}}\ge 0$.
3:     neqn – int64int32nag_int scalar
Default: The dimension of the array u.
The number of ODEs in the time direction.
Constraint: ${\mathbf{neqn}}={\mathbf{npde}}×{\mathbf{npts}}+{\mathbf{ncode}}$.
4:     user – Any MATLAB object
user is not used by nag_pde_1d_parab_dae_coll (d03pj), but is passed to pdedef, bndary, odedef and uvinit. Note that for large objects it may be more efficient to use a global variable which is accessible from the m-files than to use user.

### Input Parameters Omitted from the MATLAB Interface

lrsave lisave iuser ruser

### Output Parameters

1:     ts – double scalar
The value of t$t$ corresponding to the solution values in u. Normally ${\mathbf{ts}}={\mathbf{tout}}$.
2:     u(neqn) – double array
The computed solution Ui(xj,t)${U}_{\mathit{i}}\left({x}_{\mathit{j}},t\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,npts$\mathit{j}=1,2,\dots ,{\mathbf{npts}}$, and Vk(t)${V}_{\mathit{k}}\left(t\right)$, for k = 1,2,,ncode$\mathit{k}=1,2,\dots ,{\mathbf{ncode}}$, evaluated at t = ts$t={\mathbf{ts}}$, as follows:
• u(npde × (j1) + i)${\mathbf{u}}\left({\mathbf{npde}}×\left(\mathit{j}-1\right)+\mathit{i}\right)$ contain Ui(xj,t)${U}_{\mathit{i}}\left({x}_{\mathit{j}},t\right)$, for i = 1,2,,npde$\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and j = 1,2,,npts$\mathit{j}=1,2,\dots ,{\mathbf{npts}}$, and
• u(npts × npde + i)${\mathbf{u}}\left({\mathbf{npts}}×{\mathbf{npde}}+\mathit{i}\right)$ contain Vi(t)${V}_{\mathit{i}}\left(t\right)$, for i = 1,2,,ncode$\mathit{i}=1,2,\dots ,{\mathbf{ncode}}$.
3:     x(npts) – double array
The mesh points chosen by nag_pde_1d_parab_dae_coll (d03pj) in the spatial direction. The values of x will satisfy x(1) < x(2) < < x(npts)${\mathbf{x}}\left(1\right)<{\mathbf{x}}\left(2\right)<\cdots <{\mathbf{x}}\left({\mathbf{npts}}\right)$.
4:     rsave(lrsave) – double array
If ind = 1${\mathbf{ind}}=1$, rsave must be unchanged from the previous call to the function because it contains required information about the iteration.
5:     isave(lisave) – int64int32nag_int array
If ind = 1${\mathbf{ind}}=1$, isave must be unchanged from the previous call to the function because it contains required information about the iteration required for subsequent calls. In particular:
isave(1)${\mathbf{isave}}\left(1\right)$
Contains the number of steps taken in time.
isave(2)${\mathbf{isave}}\left(2\right)$
Contains the number of residual evaluations of the resulting ODE system used. One such evaluation involves computing the PDE functions at all the mesh points, as well as one evaluation of the functions in the boundary conditions.
isave(3)${\mathbf{isave}}\left(3\right)$
Contains the number of Jacobian evaluations performed by the time integrator.
isave(4)${\mathbf{isave}}\left(4\right)$
Contains the order of the ODE method last used in the time integration.
isave(5)${\mathbf{isave}}\left(5\right)$
Contains the number of Newton iterations performed by the time integrator. Each iteration involves residual evaluation of the resulting ODE system followed by a back-substitution using the LU$LU$ decomposition of the Jacobian matrix.
6:     ind – int64int32nag_int scalar
ind = 1${\mathbf{ind}}=1$.
7:     user – Any MATLAB object
8:     cwsav(10$10$) – cell array of strings
9:     lwsav(100$100$) – logical array
10:   iwsav(505$505$) – int64int32nag_int array
11:   rwsav(1100$1100$) – double array
12:   ifail – int64int32nag_int scalar
${\mathrm{ifail}}={\mathbf{0}}$ unless the function detects an error (see [Error Indicators and Warnings]).

## Error Indicators and Warnings

Errors or warnings detected by the function:

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

ifail = 1${\mathbf{ifail}}=1$
 On entry, ${\mathbf{tout}}-{\mathbf{ts}}$ is too small, or itask ≠ 1${\mathbf{itask}}\ne 1$, 2$2$, 3$3$, 4$4$ or 5$5$, or m ≠ 0${\mathbf{m}}\ne 0$, 1$1$ or 2$2$, or at least one of the coupling point in array xi is outside the interval [xbkpts(1),${\mathbf{xbkpts}}\left(1\right),{\mathbf{xbkpts}}\left({\mathbf{nbkpts}}\right)$], or npts ≠ (nbkpts − 1) × npoly + 1${\mathbf{npts}}\ne \left({\mathbf{nbkpts}}-1\right)×{\mathbf{npoly}}+1$, or nbkpts < 2${\mathbf{nbkpts}}<2$, or npde ≤ 0${\mathbf{npde}}\le 0$, or norm ≠ 'A'${\mathbf{norm}}\ne \text{'A'}$ or 'M'$\text{'M'}$, or itol ≠ 1${\mathbf{itol}}\ne 1$, 2$2$, 3$3$ or 4$4$, or npoly < 1${\mathbf{npoly}}<1$ or npoly > 49${\mathbf{npoly}}>49$, or ncode and nxi are incorrectly defined, or ${\mathbf{neqn}}\ne {\mathbf{npde}}×{\mathbf{npts}}+{\mathbf{ncode}}$, or laopt ≠ 'F'${\mathbf{laopt}}\ne \text{'F'}$, 'B'$\text{'B'}$ or 'S'$\text{'S'}$, or ind ≠ 0${\mathbf{ind}}\ne 0$ or 1$1$, or break points xbkpts(i)${\mathbf{xbkpts}}\left(i\right)$ are badly ordered, or lrsave is too small, or lisave is too small, or the ODE integrator has not been correctly defined; check algopt parameter, or either an element of rtol or atol < 0.0${\mathbf{atol}}<0.0$, or all the elements of rtol and atol are zero.
W ifail = 2${\mathbf{ifail}}=2$
The underlying ODE solver cannot make any further progress, with the values of atol and rtol, across the integration range from the current point t = ts$t={\mathbf{ts}}$. The components of u contain the computed values at the current point t = ts$t={\mathbf{ts}}$.
W ifail = 3${\mathbf{ifail}}=3$
In the underlying ODE solver, there were repeated error test failures on an attempted step, before completing the requested task, but the integration was successful as far as t = ts$t={\mathbf{ts}}$. The problem may have a singularity, or the error requirement may be inappropriate.
ifail = 4${\mathbf{ifail}}=4$
In setting up the ODE system, the internal initialization function was unable to initialize the derivative of the ODE system. This could be due to the fact that ires was repeatedly set to 3$3$ in at least pdedef, bndary or odedef, when the residual in the underlying ODE solver was being evaluated.
ifail = 5${\mathbf{ifail}}=5$
In solving the ODE system, a singular Jacobian has been encountered. You should check your problem formulation.
W ifail = 6${\mathbf{ifail}}=6$
When evaluating the residual in solving the ODE system, ires was set to 2$2$ in at least pdedef, bndary or odedef. Integration was successful as far as t = ts$t={\mathbf{ts}}$.
ifail = 7${\mathbf{ifail}}=7$
The values of atol and rtol are so small that the function is unable to start the integration in time.
ifail = 8${\mathbf{ifail}}=8$
In one of pdedef, bndary or odedef, ires was set to an invalid value.
ifail = 9${\mathbf{ifail}}=9$ (nag_ode_ivp_stiff_imp_revcom (d02nn))
A serious error has occurred in an internal call to the specified function. Check the problem specification and all parameters and array dimensions. Setting itrace = 1${\mathbf{itrace}}=1$ may provide more information. If the problem persists, contact NAG.
W ifail = 10${\mathbf{ifail}}=10$
The required task has been completed, but it is estimated that a small change in atol and rtol is unlikely to produce any change in the computed solution. (Only applies when you are not operating in one step mode, that is when itask2${\mathbf{itask}}\ne 2$ or 5$5$.)
ifail = 11${\mathbf{ifail}}=11$
An error occurred during Jacobian formulation of the ODE system (a more detailed error description may be directed to the current error message unit).
ifail = 12${\mathbf{ifail}}=12$
In solving the ODE system, the maximum number of steps specified in algopt(15)${\mathbf{algopt}}\left(15\right)$ have been taken.
W ifail = 13${\mathbf{ifail}}=13$
Some error weights wi${w}_{i}$ became zero during the time integration (see the description of itol). Pure relative error control (atol(i) = 0.0${\mathbf{atol}}\left(i\right)=0.0$) was requested on a variable (the i$i$th) which has become zero. The integration was successful as far as t = ts$t={\mathbf{ts}}$.
ifail = 14${\mathbf{ifail}}=14$
The flux function Ri${R}_{i}$ was detected as depending on time derivatives, which is not permissible.
ifail = 15${\mathbf{ifail}}=15$
When using the sparse option, the value of lisave or lrsave was not sufficient (more detailed information may be directed to the current error message unit).

## Accuracy

nag_pde_1d_parab_dae_coll (d03pj) controls the accuracy of the integration in the time direction but not the accuracy of the approximation in space. The spatial accuracy depends on both the number of mesh points and on their distribution in space. In the time integration only the local error over a single step is controlled and so the accuracy over a number of steps cannot be guaranteed. You should therefore test the effect of varying the accuracy parameter atol and rtol.

The parameter specification allows you to include equations with only first-order derivatives in the space direction but there is no guarantee that the method of integration will be satisfactory for such systems. The position and nature of the boundary conditions in particular are critical in defining a stable problem.
The time taken depends on the complexity of the parabolic system and on the accuracy requested.

## Example

```function nag_pde_1d_parab_dae_coll_example
npde = int64(1);
m = int64(0);
ts = 0.0001;
tout = 0.2;
u = zeros(22,1);
xbkpts = [0; 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1];
npoly = int64(2);
npts = int64(21);
ncode = int64(1);
xi = [1];
rtol = [0.0001];
atol = [0.0001];
itol = int64(1);
normtype = 'A';
laopt = 'F';
algopt = zeros(30,1);
rsave = zeros(900, 1);
isave = zeros(24, 1, 'int64');
itrace = int64(0);
ind = int64(0);
cwsav = {''; ''; ''; ''; ''; ''; ''; ''; ''; ''};
lwsav = false(100, 1);
iwsav = zeros(505, 1, 'int64');
rwsav = zeros(1100, 1);
[tsOut, uOut, x, rsaveOut, isaveOut, indOut, user, ...
cwsavOut, lwsavOut, iwsavOut, rwsavOut, ifail] = ...
nag_pde_1d_parab_dae_coll(npde, m, ts, tout, @pdedef, @bndary, u, xbkpts, ...
npoly, npts, ncode, @odedef, xi, @uvinit, rtol, atol, itol, ...
normtype, laopt, algopt, rsave, isave, itask, itrace, ind, ...
cwsav, lwsav, iwsav, rwsav);
tsOut, uOut, x, ifail

function [p,q,r,ires,user] = pdedef(npde,t,x,nptl,u,ux,ncode,v,vdot,ires,user)
p = zeros(npde,npde,nptl);
q = zeros(npde,nptl);
r = zeros(npde,nptl);

for i=1:double(nptl)
p(1,1,i) = v(1)*v(1);
r(1,i) = ux(1,i);
q(1,i) = -x(i)*ux(1,i)*v(1)*vdot(1);
end
function [beta,gamma,ires,user] = bndary(npde,t,u,ux,ncode,v,vdot,ibnd,ires,user)
beta = zeros(npde,1);
gamma = zeros(npde,1);
beta(1) = 1.0;
if (ibnd == 0)
gamma(1) = -v(1)*exp(t);
else
gamma(1) = -v(1)*vdot(1);
end
function [f,ires,user] = ...
odedef(npde,t,ncode,v,vdot,nxi,xi,ucp,ucpx,rcp,ucpt,ucptx,ires,user)
f = zeros(ncode,1);
if (ires == 1)
f(1) = vdot(1) - v(1)*ucp(1,1) - ucpx(1,1) - 1.0 - t;
elseif (ires == -1)
f(1) = vdot(1);
end
function [u,v,user] = uvinit(npde,npts,x,ncode,user)
u = zeros(npde,npts);
ts = 0.1e-6;

v(1) = ts;

for i = 1:double(npts)
u(1,i) = exp(ts*(1.0-x(i))) - 1.0;
end
```
```

tsOut =

0.2000

uOut =

0.2217
0.2096
0.1975
0.1856
0.1738
0.1622
0.1506
0.1392
0.1278
0.1166
0.1055
0.0945
0.0836
0.0729
0.0622
0.0516
0.0412
0.0308
0.0206
0.0104
0.0004
0.1999

x =

0
0.0500
0.1000
0.1500
0.2000
0.2500
0.3000
0.3500
0.4000
0.4500
0.5000
0.5500
0.6000
0.6500
0.7000
0.7500
0.8000
0.8500
0.9000
0.9500
1.0000

ifail =

0

```
```function d03pj_example
npde = int64(1);
m = int64(0);
ts = 0.0001;
tout = 0.2;
u = zeros(22,1);
xbkpts = [0; 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1];
npoly = int64(2);
npts = int64(21);
ncode = int64(1);
xi = [1];
rtol = [0.0001];
atol = [0.0001];
itol = int64(1);
normtype = 'A';
laopt = 'F';
algopt = zeros(30,1);
rsave = zeros(900, 1);
isave = zeros(24, 1, 'int64');
itrace = int64(0);
ind = int64(0);
cwsav = {''; ''; ''; ''; ''; ''; ''; ''; ''; ''};
lwsav = false(100, 1);
iwsav = zeros(505, 1, 'int64');
rwsav = zeros(1100, 1);
[tsOut, uOut, x, rsaveOut, isaveOut, indOut, user, ...
cwsavOut, lwsavOut, iwsavOut, rwsavOut, ifail] = ...
d03pj(npde, m, ts, tout, @pdedef, @bndary, u, xbkpts, ...
npoly, npts, ncode, @odedef, xi, @uvinit, rtol, atol, itol, ...
normtype, laopt, algopt, rsave, isave, itask, itrace, ind, ...
cwsav, lwsav, iwsav, rwsav);
tsOut, uOut, x, ifail

function [p,q,r,ires,user] = pdedef(npde,t,x,nptl,u,ux,ncode,v,vdot,ires,user)
p = zeros(npde,npde,nptl);
q = zeros(npde,nptl);
r = zeros(npde,nptl);

for i=1:double(nptl)
p(1,1,i) = v(1)*v(1);
r(1,i) = ux(1,i);
q(1,i) = -x(i)*ux(1,i)*v(1)*vdot(1);
end
function [beta,gamma,ires,user] = bndary(npde,t,u,ux,ncode,v,vdot,ibnd,ires,user)
beta = zeros(npde,1);
gamma = zeros(npde,1);
beta(1) = 1.0;
if (ibnd == 0)
gamma(1) = -v(1)*exp(t);
else
gamma(1) = -v(1)*vdot(1);
end
function [f,ires,user] = ...
odedef(npde,t,ncode,v,vdot,nxi,xi,ucp,ucpx,rcp,ucpt,ucptx,ires,user)
f = zeros(ncode,1);
if (ires == 1)
f(1) = vdot(1) - v(1)*ucp(1,1) - ucpx(1,1) - 1.0 - t;
elseif (ires == -1)
f(1) = vdot(1);
end
function [u,v,user] = uvinit(npde,npts,x,ncode,user)
u = zeros(npde,npts);
ts = 0.1e-6;

v(1) = ts;

for i = 1:double(npts)
u(1,i) = exp(ts*(1.0-x(i))) - 1.0;
end
```
```

tsOut =

0.2000

uOut =

0.2217
0.2096
0.1975
0.1856
0.1738
0.1622
0.1506
0.1392
0.1278
0.1166
0.1055
0.0945
0.0836
0.0729
0.0622
0.0516
0.0412
0.0308
0.0206
0.0104
0.0004
0.1999

x =

0
0.0500
0.1000
0.1500
0.2000
0.2500
0.3000
0.3500
0.4000
0.4500
0.5000
0.5500
0.6000
0.6500
0.7000
0.7500
0.8000
0.8500
0.9000
0.9500
1.0000

ifail =

0

```