NAG Library Function Document
nag_pde_parab_1d_fd (d03pcc)
1
Purpose
nag_pde_parab_1d_fd (d03pcc) integrates a system of linear or nonlinear parabolic partial differential equations (PDEs) in one space variable. The spatial discretization is performed using finite differences, and the method of lines is employed to reduce the PDEs to a system of ordinary differential equations (ODEs). The resulting system is solved using a backward differentiation formula method.
2
Specification
#include <nag.h> |
#include <nagd03.h> |
void |
nag_pde_parab_1d_fd (Integer npde,
Integer m,
double *ts,
double tout,
void |
(*pdedef)(Integer npde,
double t,
double x,
const double u[],
const double ux[],
double p[],
double q[],
double r[],
Integer *ires,
Nag_Comm *comm),
|
|
double u[],
Integer npts,
const double x[],
double acc,
double rsave[],
Integer lrsave,
Integer isave[],
Integer lisave,
Integer itask,
Integer itrace,
const char *outfile,
Integer *ind,
Nag_Comm *comm, Nag_D03_Save *saved,
NagError *fail) |
|
3
Description
nag_pde_parab_1d_fd (d03pcc) integrates the system of parabolic equations:
where
,
and
depend on
,
,
,
and the vector
is the set of solution values
and the vector
is its partial derivative with respect to
. Note that
,
and
must not depend on
.
The integration in time is from to , over the space interval , where and are the leftmost and rightmost points of a user-defined mesh . The coordinate system in space is defined by the value of ;
for Cartesian coordinates,
for cylindrical polar coordinates and for spherical polar coordinates. The mesh should be chosen in accordance with the expected behaviour of the solution.
The system is defined by the functions
,
and
which must be specified in
pdedef.
The initial values of the functions
must be given at
. The functions
, for
, which may be thought of as fluxes, are also used in the definition of the boundary conditions for each equation. The boundary conditions must have the form
where
or
.
The boundary conditions must be specified in
bndary.
The problem is subject to the following restrictions:
(i) |
, so that integration is in the forward direction; |
(ii) |
,
and the flux must not depend on any time derivatives; |
(iii) |
the evaluation of the functions ,
and is done at the mid-points of the mesh intervals by calling the pdedef for each mid-point in turn. Any discontinuities in these functions must therefore be at one or more of the mesh points ; |
(iv) |
at least one of the functions must be nonzero so that there is a time derivative present in the problem; and |
(v) |
if and , which is the left boundary point, then it must be ensured that the PDE solution is bounded at this point. This can be done by either specifying the solution at or by specifying a zero flux there, that is and . See also Section 9. |
The parabolic equations are approximated by a system of ODEs in time for the values of at mesh points. For simple problems in Cartesian coordinates, this system is obtained by replacing the space derivatives by the usual central, three-point finite difference formula. However, for polar and spherical problems, or problems with nonlinear coefficients, the space derivatives are replaced by a modified three-point formula which maintains second-order accuracy. In total there are ODEs in the time direction. This system is then integrated forwards in time using a backward differentiation formula method.
4
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, Dew P M and Furzeland R M (1989) Developing software for time-dependent problems using the method of lines and differential-algebraic integrators Appl. Numer. Math. 5 375–397
Dew P M and Walsh J (1981) A set of library routines for solving parabolic equations in one space variable ACM Trans. Math. Software 7 295–314
Skeel R D and Berzins M (1990) A method for the spatial discretization of parabolic equations in one space variable SIAM J. Sci. Statist. Comput. 11(1) 1–32
5
Arguments
- 1:
– IntegerInput
-
On entry: the number of PDEs in the system to be solved.
Constraint:
.
- 2:
– IntegerInput
-
On entry: the coordinate system used:
- Indicates Cartesian coordinates.
- Indicates cylindrical polar coordinates.
- Indicates spherical polar coordinates.
Constraint:
, or .
- 3:
– double *Input/Output
-
On entry: the initial value of the independent variable .
On exit: the value of
corresponding to the solution values in
u. Normally
.
Constraint:
.
- 4:
– doubleInput
-
On entry: the final value of to which the integration is to be carried out.
- 5:
– function, supplied by the userExternal Function
-
pdedef must compute the functions
,
and
which define the system of PDEs.
pdedef is called approximately midway between each pair of mesh points in turn by
nag_pde_parab_1d_fd (d03pcc).
The specification of
pdedef is:
void |
pdedef (Integer npde,
double t,
double x,
const double u[],
const double ux[],
double p[],
double q[],
double r[],
Integer *ires,
Nag_Comm *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of PDEs in the system.
- 2:
– doubleInput
-
On entry: the current value of the independent variable .
- 3:
– doubleInput
-
On entry: the current value of the space variable .
- 4:
– const doubleInput
-
On entry: contains the value of the component , for .
- 5:
– const doubleInput
-
On entry: contains the value of the component , for .
- 6:
– doubleOutput
-
Note: the th element of the matrix is stored in .
On exit: must be set to the value of , for and .
- 7:
– doubleOutput
-
On exit: must be set to the value of , for .
- 8:
– doubleOutput
-
On exit: must be set to the value of , for .
- 9:
– Integer *Input/Output
-
On entry: set to .
On exit: should usually remain unchanged. However, you may set
ires to force the integration function to take certain actions as described below:
- Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to NE_USER_STOP.
- Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set when a physically meaningless input or output value has been generated. If you consecutively set , nag_pde_parab_1d_fd (d03pcc) returns to the calling function with the error indicator set to NE_FAILED_DERIV.
- 10:
– Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
pdedef.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling
nag_pde_parab_1d_fd (d03pcc) you may allocate memory and initialize these pointers with various quantities for use by
pdedef when called from
nag_pde_parab_1d_fd (d03pcc) (see
Section 3.3.1.1 in How to Use the NAG Library and its Documentation).
Note: pdedef should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
nag_pde_parab_1d_fd (d03pcc). If your code inadvertently
does return any NaNs or infinities,
nag_pde_parab_1d_fd (d03pcc) is likely to produce unexpected results.
- 6:
– function, supplied by the userExternal Function
-
bndary must compute the functions
and
which define the boundary conditions as in equation
(3).
The specification of
bndary is:
void |
bndary (Integer npde,
double t,
const double u[],
const double ux[],
Integer ibnd,
double beta[],
double gamma[],
Integer *ires,
Nag_Comm *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of PDEs in the system.
- 2:
– doubleInput
-
On entry: the current value of the independent variable .
- 3:
– const doubleInput
-
On entry:
contains the value of the component
at the boundary specified by
ibnd, for
.
- 4:
– const doubleInput
-
On entry:
contains the value of the component
at the boundary specified by
ibnd, for
.
- 5:
– IntegerInput
-
On entry: determines the position of the boundary conditions.
- bndary must set up the coefficients of the left-hand boundary, .
- Indicates that bndary must set up the coefficients of the right-hand boundary, .
- 6:
– doubleOutput
-
On exit:
must be set to the value of
at the boundary specified by
ibnd, for
.
- 7:
– doubleOutput
-
On exit:
must be set to the value of
at the boundary specified by
ibnd, for
.
- 8:
– Integer *Input/Output
-
On entry: set to .
On exit: should usually remain unchanged. However, you may set
ires to force the integration function to take certain actions as described below:
- Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to NE_USER_STOP.
- Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set when a physically meaningless input or output value has been generated. If you consecutively set , nag_pde_parab_1d_fd (d03pcc) returns to the calling function with the error indicator set to NE_FAILED_DERIV.
- 9:
– Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
bndary.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling
nag_pde_parab_1d_fd (d03pcc) you may allocate memory and initialize these pointers with various quantities for use by
bndary when called from
nag_pde_parab_1d_fd (d03pcc) (see
Section 3.3.1.1 in How to Use the NAG Library and its Documentation).
Note: bndary should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
nag_pde_parab_1d_fd (d03pcc). If your code inadvertently
does return any NaNs or infinities,
nag_pde_parab_1d_fd (d03pcc) is likely to produce unexpected results.
- 7:
– doubleInput/Output
-
Note: the th element of the matrix is stored in .
On entry: the initial values of at and the mesh points
, for .
On exit: will contain the computed solution at .
- 8:
– IntegerInput
-
On entry: the number of mesh points in the interval .
Constraint:
.
- 9:
– const doubleInput
-
On entry: the mesh points in the spatial direction. must specify the left-hand boundary, , and must specify the right-hand boundary, .
Constraint:
.
- 10:
– doubleInput
-
On entry: a positive quantity for controlling the local error estimate in the time integration. If
is the estimated error for
at the
th mesh point, the error test is:
Constraint:
.
- 11:
– doubleCommunication Array
-
If
,
rsave need not be set on entry.
If
,
rsave must be unchanged from the previous call to the function because it contains required information about the iteration.
- 12:
– IntegerInput
-
On entry: the dimension of the array
rsave.
Constraint:
.
- 13:
– IntegerCommunication Array
-
If
,
isave need not be set on entry.
If
,
isave must be unchanged from the previous call to the function because it contains required information about the iteration. In particular:
- Contains the number of steps taken in time.
- 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.
- Contains the number of Jacobian evaluations performed by the time integrator.
- Contains the order of the last backward differentiation formula method used.
- Contains the number of Newton iterations performed by the time integrator. Each iteration involves an ODE residual evaluation followed by a back-substitution using the decomposition of the Jacobian matrix.
- 14:
– IntegerInput
-
On entry: the dimension of the array
isave.
Constraint:
.
- 15:
– IntegerInput
-
On entry: specifies the task to be performed by the ODE integrator.
- Normal computation of output values u at .
- One step and return.
- Stop at first internal integration point at or beyond .
Constraint:
, or .
- 16:
– IntegerInput
-
On entry: the level of trace information required from
nag_pde_parab_1d_fd (d03pcc) and the underlying ODE solver.
itrace may take the value
,
,
,
or
.
- No output is generated.
- Only warning messages from the PDE solver are printed.
- Output from the underlying ODE solver is printed. This output contains details of Jacobian entries, the nonlinear iteration and the time integration during the computation of the ODE system.
If , is assumed and similarly if , is assumed.
The advisory messages are given in greater detail as
itrace increases.
- 17:
– const char *Input
-
On entry: the name of a file to which diagnostic output will be directed. If
outfile is
NULL the diagnostic output will be directed to standard output.
- 18:
– Integer *Input/Output
-
On entry: indicates whether this is a continuation call or a new integration.
- Starts or restarts the integration in time.
- Continues the integration after an earlier exit from the function. In this case, only the arguments tout and fail should be reset between calls to nag_pde_parab_1d_fd (d03pcc).
Constraint:
or .
On exit: .
- 19:
– Nag_Comm *
-
The NAG communication argument (see
Section 3.3.1.1 in How to Use the NAG Library and its Documentation).
- 20:
– Nag_D03_Save *Communication Structure
-
saved must remain unchanged following a previous call to a
Chapter d03 function and prior to any subsequent call to a
Chapter d03 function.
- 21:
– NagError *Input/Output
-
The NAG error argument (see
Section 3.7 in How to Use the NAG Library and its Documentation).
6
Error Indicators and Warnings
- NE_ACC_IN_DOUBT
-
Integration completed, but a small change in
acc is unlikely to result in a changed solution.
.
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_FAILED_DERIV
-
In setting up the ODE system an internal auxiliary was unable to initialize the derivative. This could be due to your setting
in
pdedef or
bndary.
- NE_FAILED_START
-
acc was too small to start integration:
.
- NE_FAILED_STEP
-
Error during Jacobian formulation for ODE system. Increase
itrace for further details.
Repeated errors in an attempted step of underlying ODE solver. Integration was successful as far as
ts:
.
Underlying ODE solver cannot make further progress from the point
ts with the supplied value of
acc.
,
.
- NE_INCOMPAT_PARAM
-
On entry, and .
Constraint: or
- NE_INT
-
ires set to an invalid value in call to
pdedef or
bndary.
On entry, .
Constraint: or .
On entry, .
Constraint: , or .
On entry, .
Constraint: , or .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, on initial entry .
Constraint: on initial entry .
- NE_INT_2
-
On entry,
lisave is too small:
. Minimum possible dimension:
.
On entry,
lrsave is too small:
. Minimum possible dimension:
.
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
See
Section 2.7.6 in How to Use the NAG Library and its Documentation for further information.
Serious error in internal call to an auxiliary. Increase
itrace for further details.
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 2.7.5 in How to Use the NAG Library and its Documentation for further information.
- NE_NOT_CLOSE_FILE
-
Cannot close file .
- NE_NOT_STRICTLY_INCREASING
-
On entry, mesh points
x appear to be badly ordered:
,
,
and
.
- NE_NOT_WRITE_FILE
-
Cannot open file for writing.
- NE_REAL
-
On entry, .
Constraint: .
- NE_REAL_2
-
On entry, and .
Constraint: .
On entry, is too small:
and .
- NE_SING_JAC
-
Singular Jacobian of ODE system. Check problem formulation.
- NE_TIME_DERIV_DEP
-
Flux function appears to depend on time derivatives.
- NE_USER_STOP
-
In evaluating residual of ODE system,
has been set in
pdedef or
bndary. Integration is successful as far as
ts:
.
7
Accuracy
nag_pde_parab_1d_fd (d03pcc) 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 argument,
acc.
8
Parallelism and Performance
nag_pde_parab_1d_fd (d03pcc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_pde_parab_1d_fd (d03pcc) makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the
x06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this function. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
nag_pde_parab_1d_fd (d03pcc) is designed to solve parabolic systems (possibly including some elliptic equations) with second-order derivatives in space. The argument 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. It may be advisable in such cases to reduce the whole system to first-order and to use the Keller box scheme function
nag_pde_parab_1d_keller (d03pec).
The time taken depends on the complexity of the parabolic system and on the accuracy requested.
10
Example
We use the example given in
Dew and Walsh (1981) which consists of an elliptic-parabolic pair of PDEs. The problem was originally derived from a single third-order in space PDE. The elliptic equation is
and the parabolic equation is
where
. The boundary conditions are given by
and
The first of these boundary conditions implies that the flux term in the second PDE,
, is zero at .
The initial conditions at
are given by
The value
was used in the problem definition. A mesh of
points was used with a circular mesh spacing to cluster the points towards the right-hand side of the spatial interval,
.
10.1
Program Text
Program Text (d03pcce.c)
10.2
Program Data
None.
10.3
Program Results
Program Results (d03pcce.r)