NAG Library Function Document
nag_pde_parab_1d_keller_ode_remesh (d03prc)
1 Purpose
nag_pde_parab_1d_keller_ode_remesh (d03prc) integrates a system of linear or nonlinear, first-order, time-dependent partial differential equations (PDEs) in one space variable, with scope for coupled ordinary differential equations (ODEs), and automatic adaptive spatial remeshing. The spatial discretization is performed using the Keller box scheme (see
Keller (1970)) 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).
2 Specification
#include <nag.h> |
#include <nagd03.h> |
void |
nag_pde_parab_1d_keller_ode_remesh (Integer npde,
double *ts,
double tout,
void |
(*pdedef)(Integer npde,
double t,
double x,
const double u[],
const double udot[],
const double ux[],
Integer ncode,
const double v[],
const double vdot[],
double res[],
Integer *ires,
Nag_Comm *comm),
|
|
void |
(*bndary)(Integer npde,
double t,
Integer ibnd,
Integer nobc,
const double u[],
const double udot[],
Integer ncode,
const double v[],
const double vdot[],
double res[],
Integer *ires,
Nag_Comm *comm),
|
|
double u[],
Integer npts,
double x[],
Integer nleft,
Integer ncode,
void |
(*odedef)(Integer npde,
double t,
Integer ncode,
const double v[],
const double vdot[],
Integer nxi,
const double xi[],
const double ucp[],
const double ucpx[],
const double ucpt[],
double r[],
Integer *ires,
Nag_Comm *comm),
|
|
Integer nxi,
const double xi[],
Integer neqn,
const double rtol[],
const double atol[],
Integer itol,
Nag_NormType norm,
Nag_LinAlgOption laopt,
const double algopt[],
Nag_Boolean remesh,
Integer nxfix,
const double xfix[],
Integer nrmesh,
double dxmesh,
double trmesh,
Integer ipminf,
double xratio,
double con,
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_keller_ode_remesh (d03prc) integrates the system of first-order PDEs and coupled ODEs given by the master equations:
In the PDE part of the problem given by
(1), the functions
must have the general form
where
,
and
depend on
,
,
,
and
.
The vector
is the set of PDE solution values
and the vector
is the partial derivative with respect to
. The vector
is the set of ODE solution values
and
denotes its derivative with respect to time.
In the ODE part given by
(2),
represents a vector of
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.
,
and
are the functions
,
and
evaluated at these coupling points. Each
may only depend linearly on time derivatives. Hence equation
(2) may be written more precisely as
where
,
is a vector of length
ncode,
is an
ncode by
ncode matrix,
is an
ncode by
matrix and the entries in
,
and
may depend on
,
,
,
and
. In practice you only need to supply a vector of information to define the ODEs and not the matrices
and
. (See
Section 5 for the specification of
odedef.)
The integration in time is from to , over the space interval , where and are the leftmost and rightmost points of a mesh defined initially by you and (possibly) adapted automatically during the integration according to user-specified criteria.
The PDE system which is defined by the functions
must be specified in
pdedef.
The initial
values of the functions
and
must be specified in
uvinit. Note that
uvinit will be called again following any remeshing, and so
should be specified for
all values of
in the interval
, and not just the initial mesh points.
For a first-order system of PDEs, only one boundary condition is required for each PDE component
. The
npde boundary conditions are separated into
at the left-hand boundary
, and
at the right-hand boundary
, such that
. The position of the boundary condition for each component should be chosen with care; the general rule is that if the characteristic direction of
at the left-hand boundary (say) points into the interior of the solution domain, then the boundary condition for
should be specified at the left-hand boundary. Incorrect positioning of boundary conditions generally results in initialization or integration difficulties in the underlying time integration functions.
The boundary conditions have the master equation form:
at the left-hand boundary, and
at the right-hand boundary.
Note that the functions
and
must not depend on
, since spatial derivatives are not determined explicitly in the Keller box scheme functions. If the problem involves derivative (Neumann) boundary conditions then it is generally possible to restate such boundary conditions in terms of permissible variables. Also note that
and
must be linear with respect to time derivatives, so that the boundary conditions have the general form:
at the left-hand boundary, and
at the right-hand boundary, where
,
,
,
,
and
depend on
and
only.
The boundary conditions must be specified in
bndary.
The problem is subject to the following restrictions:
(i) |
, and must not depend on any time derivatives; |
(ii) |
, so that integration is in the forward direction; |
(iii) |
The evaluation of the function is done approximately at the mid-points of the mesh , for , by calling pdedef for each mid-point in turn. Any discontinuities in the function must therefore be at one or more of the fixed mesh points specified by xfix; |
(iv) |
At least one of the functions must be nonzero so that there is a time derivative present in the PDE problem. |
The algebraic-differential equation system which is defined by the functions
must be specified in
odedef. You must also specify the coupling points
in the array
xi.
The first-order equations are approximated by a system of ODEs in time for the values of at mesh points. In this method of lines approach the Keller box scheme is applied to each PDE in the space variable only, resulting in a system of ODEs in time for the values of at each mesh point. In total there are ODEs in time direction. This system is then integrated forwards in time using a Backward Differentiation Formula (BDF) or a Theta method.
The adaptive space remeshing can be used to generate meshes that automatically follow the changing time-dependent nature of the solution, generally resulting in a more efficient and accurate solution using fewer mesh points than may be necessary with a fixed uniform or non-uniform mesh. Problems with travelling wavefronts or variable-width boundary layers for example will benefit from using a moving adaptive mesh. The discrete time-step method used here (developed by
Furzeland (1984)) automatically creates a new mesh based on the current solution profile at certain time-steps, and the solution is then interpolated onto the new mesh and the integration continues.
The method requires you to supply
monitf which specifies in an analytic or numeric form the particular aspect of the solution behaviour you wish to track. This so-called monitor function is used to choose a mesh which equally distributes the integral of the monitor function over the domain. A typical choice of monitor function is the second space derivative of the solution value at each point (or some combination of the second space derivatives if more than one solution component), which results in refinement in regions where the solution gradient is changing most rapidly.
You must specify the frequency of mesh updates along with certain other criteria such as adjacent mesh ratios. Remeshing can be expensive and you are encouraged to experiment with the different options in order to achieve an efficient solution which adequately tracks the desired features of the solution.
Note that unless the monitor function for the initial solution values is zero at all user-specified initial mesh points, a new initial mesh is calculated and adopted according to the user-specified remeshing criteria.
uvinit will then be called again to determine the initial solution values at the new mesh points (there is no interpolation at this stage) and the integration proceeds.
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
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
Furzeland R M (1984) The construction of adaptive space meshes TNER.85.022 Thornton Research Centre, Chester
Keller H B (1970) A new difference scheme for parabolic problems Numerical Solutions of Partial Differential Equations (ed J Bramble) 2 327–350 Academic Press
Pennington S V and Berzins M (1994) New NAG Library software for first-order partial differential equations ACM Trans. Math. Softw. 20 63–99
5 Arguments
- 1:
– IntegerInput
-
On entry: the number of PDEs to be solved.
Constraint:
.
- 2:
– double *Input/Output
-
On entry: the initial value of the independent variable .
Constraint:
.
On exit: the value of
corresponding to the solution values in
u. Normally
.
- 3:
– doubleInput
-
On entry: the final value of to which the integration is to be carried out.
- 4:
– function, supplied by the userExternal Function
-
pdedef must evaluate the functions
which define the system of PDEs.
pdedef is called approximately midway between each pair of mesh points in turn by nag_pde_parab_1d_keller_ode_remesh (d03prc).
The specification of
pdedef is:
void |
pdedef (Integer npde,
double t,
double x,
const double u[],
const double udot[],
const double ux[],
Integer ncode,
const double v[],
const double vdot[],
double res[],
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:
– const doubleInput
-
On entry: contains the value of the component , for .
- 7:
– IntegerInput
-
On entry: the number of coupled ODEs in the system.
- 8:
– const doubleInput
-
On entry: if , contains the value of the component , for .
- 9:
– const doubleInput
-
On entry: if , contains the value of component , for .
- 10:
– doubleOutput
-
On exit:
must contain the
th component of
, for
, where
is defined as
i.e., only terms depending explicitly on time derivatives, or
i.e., all terms in equation
(3).
The definition of
is determined by the input value of
ires.
- 11:
– Integer *Input/Output
-
On entry: the form of
that must be returned in the array
res.
- Equation (9) must be used.
- Equation (10) must be used.
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 , then nag_pde_parab_1d_keller_ode_remesh (d03prc) returns to the calling function with the error indicator set to NE_FAILED_DERIV.
- 12:
– 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_keller_ode_remesh (d03prc) you may allocate memory and initialize these pointers with various quantities for use by
pdedef when called from nag_pde_parab_1d_keller_ode_remesh (d03prc) (see
Section 3.2.1.1 in the Essential Introduction).
- 5:
– function, supplied by the userExternal Function
-
bndary must evaluate the functions
and
which describe the boundary conditions, as given in
(5) and
(6).
The specification of
bndary is:
void |
bndary (Integer npde,
double t,
Integer ibnd,
Integer nobc,
const double u[],
const double udot[],
Integer ncode,
const double v[],
const double vdot[],
double res[],
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:
– IntegerInput
-
On entry: specifies which boundary conditions are to be evaluated.
- bndary must compute the left-hand boundary condition at .
- bndary must compute of the right-hand boundary condition at .
- 4:
– IntegerInput
-
On entry: specifies the number
of boundary conditions at the boundary specified by
ibnd.
- 5:
– const doubleInput
-
On entry:
contains the value of the component
at the boundary specified by
ibnd, for
.
- 6:
– const doubleInput
-
On entry: contains the value of the component , for .
- 7:
– IntegerInput
-
On entry: the number of coupled ODEs in the system.
- 8:
– const doubleInput
-
On entry: if , contains the value of the component , for .
- 9:
– const doubleInput
-
On entry: if
,
contains the value of component
, for
.
Note:
, for
, may only appear linearly as in
(11) and
(12).
- 10:
– doubleOutput
-
On exit:
must contain the
th component of
or
, depending on the value of
ibnd, for
, where
is defined as
i.e., only terms depending explicitly on time derivatives, or
i.e., all terms in equation
(7), and similarly for
.
The definitions of
and
are determined by the input value of
ires.
- 11:
– Integer *Input/Output
-
On entry: the form of
(or
) that must be returned in the array
res.
- Equation (11) must be used.
- Equation (12) must be used.
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 , then nag_pde_parab_1d_keller_ode_remesh (d03prc) returns to the calling function with the error indicator set to NE_FAILED_DERIV.
- 12:
– 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_keller_ode_remesh (d03prc) you may allocate memory and initialize these pointers with various quantities for use by
bndary when called from nag_pde_parab_1d_keller_ode_remesh (d03prc) (see
Section 3.2.1.1 in the Essential Introduction).
- 6:
– function, supplied by the userExternal Function
-
uvinit must supply the initial
values of
and
for all values of
in the interval
.
The specification of
uvinit is:
void |
uvinit (Integer npde,
Integer npts,
Integer nxi,
const double x[],
const double xi[],
double u[],
Integer ncode,
double v[],
Nag_Comm *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of PDEs in the system.
- 2:
– IntegerInput
-
On entry: the number of mesh points in the interval .
- 3:
– IntegerInput
-
On entry: the number of ODE/PDE coupling points.
- 4:
– const doubleInput
-
On entry: the current mesh. contains the value of , for .
- 5:
– const doubleInput
-
On entry: if , contains the ODE/PDE coupling point, , for .
- 6:
– doubleOutput
-
On exit: if , contains the value of the component , for and .
- 7:
– IntegerInput
-
On entry: the number of coupled ODEs in the system.
- 8:
– doubleOutput
-
On exit: if , must contain the value of component , for .
- 9:
– Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
uvinit.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling nag_pde_parab_1d_keller_ode_remesh (d03prc) you may allocate memory and initialize these pointers with various quantities for use by
uvinit when called from nag_pde_parab_1d_keller_ode_remesh (d03prc) (see
Section 3.2.1.1 in the Essential Introduction).
- 7:
– doubleInput/Output
-
On entry: if
, the value of
u must be unchanged from the previous call.
On exit: contains the computed solution , for and , evaluated at .
- 8:
– IntegerInput
-
On entry: the number of mesh points in the interval [].
Constraint:
.
- 9:
– doubleInput/Output
-
On entry: the initial mesh points in the space direction. must specify the left-hand boundary, , and must specify the right-hand boundary, .
Constraint:
.
On exit: the final values of the mesh points.
- 10:
– IntegerInput
-
On entry: the number of boundary conditions at the left-hand mesh point .
Constraint:
.
- 11:
– IntegerInput
-
On entry: the number of coupled ODE components.
Constraint:
.
- 12:
– function, supplied by the userExternal Function
-
odedef must evaluate the functions
, which define the system of ODEs, as given in
(4).
If
,
odedef will never be called and the NAG defined null void function pointer, NULLFN, can be supplied in the call to nag_pde_parab_1d_keller_ode_remesh (d03prc).
The specification of
odedef is:
void |
odedef (Integer npde,
double t,
Integer ncode,
const double v[],
const double vdot[],
Integer nxi,
const double xi[],
const double ucp[],
const double ucpx[],
const double ucpt[],
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:
– IntegerInput
-
On entry: the number of coupled ODEs in the system.
- 4:
– const doubleInput
-
On entry: if , contains the value of the component , for .
- 5:
– const doubleInput
-
On entry: if , contains the value of component , for .
- 6:
– IntegerInput
-
On entry: the number of ODE/PDE coupling points.
- 7:
– const doubleInput
-
On entry: if , contains the ODE/PDE coupling point, , for .
- 8:
– const doubleInput
-
On entry: if , contains the value of at the coupling point , for and .
- 9:
– const doubleInput
-
On entry: if , contains the value of at the coupling point , for and .
- 10:
– const doubleInput
-
On entry: if , contains the value of at the coupling point , for and .
- 11:
– doubleOutput
-
On exit: if
,
must contain the
th component of
, for
, where
is defined as
i.e., only terms depending explicitly on time derivatives, or
i.e., all terms in equation
(4). The definition of
is determined by the input value of
ires.
- 12:
– Integer *Input/Output
-
On entry: the form of
that must be returned in the array
r.
- Equation (13) must be used.
- Equation (14) must be used.
On exit: should usually remain unchanged. However, you may reset
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 , then nag_pde_parab_1d_keller_ode_remesh (d03prc) returns to the calling function with the error indicator set to NE_FAILED_DERIV.
- 13:
– Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
odedef.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling nag_pde_parab_1d_keller_ode_remesh (d03prc) you may allocate memory and initialize these pointers with various quantities for use by
odedef when called from nag_pde_parab_1d_keller_ode_remesh (d03prc) (see
Section 3.2.1.1 in the Essential Introduction).
- 13:
– IntegerInput
-
On entry: the number of ODE/PDE coupling points.
Constraints:
- if , ;
- if , .
- 14:
– const doubleInput
-
Note: the dimension,
dim, of the array
xi
must be at least
.
On entry: , for , must be set to the ODE/PDE coupling points, .
Constraint:
.
- 15:
– IntegerInput
-
On entry: the number of ODEs in the time direction.
Constraint:
.
- 16:
– const doubleInput
-
Note: the dimension,
dim, of the array
rtol
must be at least
- when or ;
- when or .
On entry: the relative local error tolerance.
Constraint:
for all relevant .
- 17:
– const doubleInput
-
Note: the dimension,
dim, of the array
atol
must be at least
- when or ;
- when or .
On entry: the absolute local error tolerance.
Constraint:
for all relevant
.
Note: corresponding elements of
rtol and
atol cannot both be
.
- 18:
– IntegerInput
-
A value to indicate the form of the local error test.
itol indicates to nag_pde_parab_1d_keller_ode_remesh (d03prc) whether to interpret either or both of
rtol or
atol as a vector or scalar. The error test to be satisfied is
, where
is defined as follows:
On entry:
itol | rtol | atol | |
1 | scalar | scalar | |
2 | scalar | vector | |
3 | vector | scalar | |
4 | vector | vector | |
In the above, denotes the estimated local error for the th component of the coupled PDE/ODE system in time, , for .
The choice of norm used is defined by the argument
norm.
Constraint:
, , or .
- 19:
– Nag_NormTypeInput
-
On entry: the type of norm to be used.
- Maximum norm.
- Averaged norm.
If
denotes the norm of the vector
u of length
neqn, then for the averaged
norm
while for the maximum norm
See the description of
itol for the formulation of the weight vector
.
Constraint:
or .
- 20:
– Nag_LinAlgOptionInput
-
On entry: the type of matrix algebra required.
- Full matrix methods to be used.
- Banded matrix methods to be used.
- Sparse matrix methods to be used.
Constraint:
,
or
.
Note: you are recommended to use the banded option when no coupled ODEs are present (i.e., ).
- 21:
– const doubleInput
-
On entry: may be set to control various options available in the integrator. If you wish to employ all the default options, then
should be set to
. 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:
- Selects the ODE integration method to be used. If , a BDF method is used and if , a Theta method is used. The default value is .
If , then
, for , are not used.
- Specifies the maximum order of the BDF integration formula to be used. may be , , , or . The default value is .
- Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the BDF method. If a modified Newton iteration is used and if 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 .
- 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
, for , for some or when there is no dependence in the coupled ODE system. If , then the Petzold test is used. If , then the Petzold test is not used. The default value is .
If , then
, for , are not used.
- Specifies the value of Theta to be used in the Theta integration method. . The default value is .
- Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the Theta method. If , a modified Newton iteration is used and if , a functional iteration method is used. The default value is .
- 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 , then switching is allowed and if , then switching is not allowed. The default value is .
- Specifies a point in the time direction, , beyond which integration must not be attempted. The use of is described under the argument itask. If , a value of , for , say, should be specified even if itask subsequently specifies that will not be used.
- Specifies the minimum absolute step size to be allowed in the time integration. If this option is not required, should be set to .
- Specifies the maximum absolute step size to be allowed in the time integration. If this option is not required, should be set to .
- Specifies the initial step size to be attempted by the integrator. If , then the initial step size is calculated internally.
- Specifies the maximum number of steps to be attempted by the integrator in any one call. If , then no limit is imposed.
- Specifies what method is to be used to solve the nonlinear equations at the initial point to initialize the values of , , and . If , a modified Newton iteration is used and if , functional iteration is used. The default value is .
and are used only for the sparse matrix algebra option, i.e., .
- Governs the choice of pivots during the decomposition of the first Jacobian matrix. It should lie in the range , with smaller values biasing the algorithm towards maintaining sparsity at the expense of numerical stability. If lies outside this range then the default value is used. If the functions regard the Jacobian matrix as numerically singular then increasing towards may help, but at the cost of increased fill-in. The default value is .
- Used as a relative pivot threshold during subsequent Jacobian decompositions (see ) below which an internal error is invoked. must be greater than zero, otherwise the default value is used. If is greater than 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 ). The default value is .
- 22:
– Nag_BooleanInput
-
On entry: indicates whether or not spatial remeshing should be performed.
- Indicates that spatial remeshing should be performed as specified.
- Indicates that spatial remeshing should be suppressed.
Note: remesh should
not be changed between consecutive calls to nag_pde_parab_1d_keller_ode_remesh (d03prc). Remeshing can be switched off or on at specified times by using appropriate values for the arguments
nrmesh and
trmesh at each call.
- 23:
– IntegerInput
-
On entry: the number of fixed mesh points.
Constraint:
.
Note: the end points and are fixed automatically and hence should not be specified as fixed points.
- 24:
– const doubleInput
-
Note: the dimension,
dim, of the array
xfix
must be at least
.
On entry: , for , must contain the value of the coordinate at the th fixed mesh point.
Constraint:
, for
, and each fixed mesh point must coincide with a user-supplied initial mesh point, that is
for some
,
.
Note: the positions of the fixed mesh points in the array remain fixed during remeshing, and so the number of mesh points between adjacent fixed points (or between fixed points and end points) does not change. You should take this into account when choosing the initial mesh distribution.
- 25:
– IntegerInput
-
On entry: indicates the form of meshing to be performed.
- Indicates that a new mesh is adopted according to the argument dxmesh. The mesh is tested every timesteps.
- Indicates that remeshing should take place just once at the end of the first time step reached when .
- Indicates that remeshing will take place every nrmesh time steps, with no testing using dxmesh.
Note: nrmesh may be changed between consecutive calls to nag_pde_parab_1d_keller_ode_remesh (d03prc) to give greater flexibility over the times of remeshing.
- 26:
– doubleInput
-
On entry: determines whether a new mesh is adopted when
nrmesh is set less than zero. A possible new mesh is calculated at the end of every
time steps, but is adopted only if
or
dxmesh thus imposes a lower limit on the difference between one mesh and the next.
Constraint:
.
- 27:
– doubleInput
-
On entry: specifies when remeshing will take place when
nrmesh is set to zero. Remeshing will occur just once at the end of the first time step reached when
is greater than
trmesh.
Note: trmesh may be changed between consecutive calls to nag_pde_parab_1d_keller_ode_remesh (d03prc) to force remeshing at several specified times.
- 28:
– IntegerInput
-
On entry: the level of trace information regarding the adaptive remeshing.
- No trace information.
- Brief summary of mesh characteristics.
- More detailed information, including old and new mesh points, mesh sizes and monitor function values.
Constraint:
, or .
- 29:
– doubleInput
-
On entry: input bound on adjacent mesh ratio (greater than
and typically in the range
to
). The remeshing functions will attempt to ensure that
Suggested value:
.
Constraint:
.
- 30:
– doubleInput
-
On entry: an input bound on the sub-integral of the monitor function
over each space step. The remeshing functions will attempt to ensure that
(see
Furzeland (1984)).
con gives you more control over the mesh distribution e.g., decreasing
con allows more clustering. A typical value is
, but you are encouraged to experiment with different values. Its value is not critical and the mesh should be qualitatively correct for all values in the range given below.
Suggested value:
.
Constraint:
.
- 31:
– function, supplied by the userExternal Function
-
monitf must supply and evaluate a remesh monitor function to indicate the solution behaviour of interest.
If
,
monitf will never be called and the NAG defined null void function pointer, NULLFN, can be supplied in the call to nag_pde_parab_1d_keller_ode_remesh (d03prc).
The specification of
monitf is:
void |
monitf (double t,
Integer npts,
Integer npde,
const double x[],
const double u[],
double fmon[],
Nag_Comm *comm)
|
|
- 1:
– doubleInput
-
On entry: the current value of the independent variable .
- 2:
– IntegerInput
-
On entry: the number of mesh points in the interval .
- 3:
– IntegerInput
-
On entry: the number of PDEs in the system.
- 4:
– const doubleInput
-
On entry: the current mesh. contains the value of , for .
- 5:
– const doubleInput
-
On entry: contains the value of at and time , for and .
- 6:
– doubleOutput
-
On exit: must contain the value of the monitor function at mesh point .
Constraint:
.
- 7:
– Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
monitf.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling nag_pde_parab_1d_keller_ode_remesh (d03prc) you may allocate memory and initialize these pointers with various quantities for use by
monitf when called from nag_pde_parab_1d_keller_ode_remesh (d03prc) (see
Section 3.2.1.1 in the Essential Introduction).
- 32:
– 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.
- 33:
– IntegerInput
-
On entry: the dimension of the array
rsave.
Its size depends on the type of matrix algebra selected.
If , .
If , .
If , .
Where
| and are the lower and upper half bandwidths given by such that , for problems involving PDEs only; or , for coupled PDE/ODE problems. |
| |
| |
Note: when using the sparse option, the value of
lrsave may be too small when supplied to the integrator. An estimate of the minimum size of
lrsave is printed on the current error message unit if
and the function returns with
NE_INT_2.
- 34:
– IntegerCommunication Array
-
If
,
isave need not be set.
If
,
isave must be unchanged from the previous call to the function because it contains required information about the iteration. In particular the following components of the array
isave concern the efficiency of the integration:
- Contains the number of steps taken in time.
- Contains the number of residual evaluations of the resulting ODE system used. One such evaluation involves evaluating 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 ODE method last used in the time integration.
- 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 decomposition of the Jacobian matrix.
The rest of the array is used as workspace.
- 35:
– IntegerInput
-
On entry: the dimension of the array
isave. Its size depends on the type of matrix algebra selected:
- if , ;
- if , ;
- if , .
Note: when using the sparse option, the value of
lisave may be too small when supplied to the integrator. An estimate of the minimum size of
lisave is printed if
and the function returns with
NE_INT_2.
- 36:
– IntegerInput
-
On entry: the task to be performed by the ODE integrator.
- Normal computation of output values u at (by overshooting and interpolating).
- Take one step in the time direction and return.
- Stop at first internal integration point at or beyond .
- Normal computation of output values u at but without overshooting where is described under the argument algopt.
- Take one step in the time direction and return, without passing , where is described under the argument algopt.
Constraint:
, , , or .
- 37:
– IntegerInput
-
On entry: the level of trace information required from nag_pde_parab_1d_keller_ode_remesh (d03prc) and the underlying ODE solver as follows:
- 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.
- Output from the underlying ODE solver is similar to that produced when , except that the advisory messages are given in greater detail.
- The output from the underlying ODE solver is similar to that produced when , except that the advisory messages are given in greater detail.
- 38:
– 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.
- 39:
– 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 and the remeshing arguments nrmesh, dxmesh, trmesh, xratio and con may be reset between calls to nag_pde_parab_1d_keller_ode_remesh (d03prc).
Constraint:
or .
On exit: .
- 40:
– Nag_Comm *
-
The NAG communication argument (see
Section 3.2.1.1 in the Essential Introduction).
- 41:
– 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.
- 42:
– NagError *Input/Output
-
The NAG error argument (see
Section 3.6 in the Essential Introduction).
6 Error Indicators and Warnings
- NE_ACC_IN_DOUBT
-
Integration completed, but small changes in
atol or
rtol are unlikely to result in a changed solution.
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
See
Section 3.2.1.2 in the Essential Introduction 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
-
atol and
rtol were 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 values of
atol and
rtol.
.
- NE_INCOMPAT_PARAM
-
On entry, ,
.
Constraint: .
On entry, ,
.
Constraint: .
On entry, the point does not coincide with any : and .
- NE_INT
-
ires set to an invalid value in call to
pdedef,
bndary, or
odedef.
On entry, .
Constraint: or .
On entry, .
Constraint: , or .
On entry, .
Constraint: , , , or .
On entry, .
Constraint: , , or .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
On entry, .
Constraint: .
- NE_INT_2
-
On entry, corresponding elements and are both zero: and .
On entry,
lisave is too small:
. Minimum possible dimension:
.
On entry,
lrsave is too small:
. Minimum possible dimension:
.
On entry, and .
Constraint: when .
On entry, and .
Constraint: when .
On entry, ,
.
Constraint: .
On entry, ,
.
Constraint: .
When using the sparse option
lisave or
lrsave is too small:
,
.
- NE_INT_4
-
On entry, , , and .
Constraint: .
- 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.
An unexpected error has been triggered by this function. Please contact
NAG.
See
Section 3.6.6 in the Essential Introduction for further information.
Serious error in internal call to an auxiliary. Increase
itrace for further details.
- NE_ITER_FAIL
-
In solving ODE system, the maximum number of steps has been exceeded. .
- NE_NO_LICENCE
-
Your licence key may have expired or may not have been installed correctly.
See
Section 3.6.5 in the Essential Introduction for further information.
- NE_NOT_CLOSE_FILE
-
Cannot close file .
- NE_NOT_STRICTLY_INCREASING
-
On entry, , and .
Constraint: .
On entry, , and .
Constraint: .
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: .
On entry, .
Constraint: .
- NE_REAL_2
-
On entry, at least one point in
xi lies outside
:
and
.
On entry, and .
Constraint: .
On entry, is too small:
and .
- NE_REAL_ARRAY
-
On entry, and .
Constraint: .
On entry, and .
Constraint: .
- NE_REMESH_CHANGED
-
remesh has been changed between calls to nag_pde_parab_1d_keller_ode_remesh (d03prc).
- NE_SING_JAC
-
Singular Jacobian of ODE system. Check problem formulation.
- NE_USER_STOP
-
In evaluating residual of ODE system,
has been set in
pdedef,
bndary, or
odedef. Integration is successful as far as
ts:
.
- NE_ZERO_WTS
-
Zero error weights encountered during time integration.
7 Accuracy
nag_pde_parab_1d_keller_ode_remesh (d03prc) 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 arguments,
atol and
rtol.
8 Parallelism and Performance
nag_pde_parab_1d_keller_ode_remesh (d03prc) is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
nag_pde_parab_1d_keller_ode_remesh (d03prc) 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.
The Keller box scheme can be used to solve higher-order problems which have been reduced to first-order by the introduction of new variables (see the example in
Section 10). In general, a second-order problem can be solved with slightly greater accuracy using the Keller box scheme instead of a finite difference scheme (
nag_pde_parab_1d_fd_ode_remesh (d03ppc) for example), but at the expense of increased CPU time due to the larger number of function evaluations required.
It should be noted that the Keller box scheme, in common with other central-difference schemes, may be unsuitable for some hyperbolic first-order problems such as the apparently simple linear advection equation
, where
is a constant, resulting in spurious oscillations due to the lack of dissipation. This type of problem requires a discretization scheme with upwind weighting
(
nag_pde_parab_1d_cd_ode_remesh (d03psc) for example), or the addition of a second-order artificial dissipation term.
The time taken depends on the complexity of the system, the accuracy requested, and the frequency of the mesh updates. For a given system with fixed accuracy and mesh-update frequency it is approximately proportional to
neqn.
10 Example
This example is the first-order system
for
and
.
The initial conditions are
and the Dirichlet boundary conditions for
at
and
at
are given by the exact solution:
10.1 Program Text
Program Text (d03prce.c)
10.2 Program Data
None.
10.3 Program Results
Program Results (d03prce.r)