NAG Library Routine Document
D03RBF
1 Purpose
D03RBF integrates a system of linear or nonlinear, time-dependent partial differential equations (PDEs) in two space dimensions on a rectilinear domain. The method of lines is employed to reduce the NPDEs to a system of ordinary differential equations (ODEs) which are solved using a backward differentiation formula (BDF) method. The resulting system of nonlinear equations is solved using a modified Newton method and a Bi-CGSTAB iterative linear solver with ILU preconditioning. Local uniform grid refinement is used to improve the accuracy of the solution. D03RBF originates from the VLUGR2 package (see
Blom and Verwer (1993) and
Blom et al. (1996)).
2 Specification
SUBROUTINE D03RBF ( |
NPDE, TS, TOUT, DT, TOLS, TOLT, INIDOM, PDEDEF, BNDARY, PDEIV, MONITR, OPTI, OPTR, RWK, LENRWK, IWK, LENIWK, LWK, LENLWK, ITRACE, IND, IFAIL) |
INTEGER |
NPDE, OPTI(4), LENRWK, IWK(LENIWK), LENIWK, LENLWK, ITRACE, IND, IFAIL |
REAL (KIND=nag_wp) |
TS, TOUT, DT(3), TOLS, TOLT, OPTR(3,NPDE), RWK(LENRWK) |
LOGICAL |
LWK(LENLWK) |
EXTERNAL |
INIDOM, PDEDEF, BNDARY, PDEIV, MONITR |
|
3 Description
D03RBF integrates the system of PDEs:
where
is an arbitrary rectilinear domain, i.e., a domain bounded by perpendicular straight lines. If the domain is rectangular then it is recommended that
D03RAF is used.
The vector
is the set of solution values
and
denotes partial differentiation with respect to
, and similarly for
, etc.
The functions
must be supplied by you in
PDEDEF. Similarly the initial values of the functions
for
must be specified at
in
PDEIV.
Note that whilst complete generality is offered by the master equations
(1), D03RBF is not appropriate for all PDEs. In particular, hyperbolic systems should not be solved using this routine. Also, at least one component of
must appear in the system of PDEs.
The boundary conditions must be supplied by you in
BNDARY in the form
The domain is covered by a uniform coarse base grid specified by you, and nested finer uniform subgrids are subsequently created in regions with high spatial activity. The refinement is controlled using a space monitor which is computed from the current solution and a user-supplied space tolerance
TOLS. A number of optional parameters, e.g., the maximum number of grid levels at any time, and some weighting factors, can be specified in the arrays
OPTI and
OPTR. Further details of the refinement strategy can be found in
Section 9.
The system of PDEs and the boundary conditions are discretized in space on each grid using a standard second-order finite difference scheme (centred on the internal domain and one-sided at the boundaries), and the resulting system of ODEs is integrated in time using a second-order, two-step, implicit BDF method with variable step size. The time integration is controlled using a time monitor computed at each grid level from the current solution and a user-supplied time tolerance
TOLT, and some further optional user-specified weighting factors held in
OPTR (see
Section 9 for details). The time monitor is used to compute a new step size, subject to restrictions on the size of the change between steps, and (optional) user-specified maximum and minimum step sizes held in
DT. The step size is adjusted so that the remaining integration interval is an integer number times
. In this way a solution is obtained at
.
A modified Newton method is used to solve the nonlinear equations arising from the time integration. You may specify (in
OPTI) the maximum number of Newton iterations to be attempted. A Jacobian matrix is calculated at the beginning of each time step. If the Newton process diverges or the maximum number of iterations is exceeded, a new Jacobian is calculated using the most recent iterates and the Newton process is restarted. If convergence is not achieved after the (optional) user-specified maximum number of new Jacobian evaluations, the time step is retried with
. The linear systems arising from the Newton iteration are solved using a Bi-CGSTAB iterative method, in combination with ILU preconditioning. The maximum number of iterations can be specified by you in
OPTI.
In order to define the base grid you must first specify a virtual uniform rectangular grid which contains the entire base grid. The position of the virtual grid in physical space is given by the coordinates of its boundaries. The number of points and in the and directions must also be given, corresponding to the number of columns and rows respectively. This is sufficient to determine precisely the coordinates of all virtual grid points. Each virtual grid point is then referred to by integer coordinates , where corresponds to the lower-left corner and corresponds to the upper-right corner. and are also referred to as the virtual column and row indices respectively.
The base grid is then specified with respect to the virtual grid, with each base grid point coinciding with a virtual grid point. Each base grid point must be given an index, starting from , and incrementing row-wise from the leftmost point of the lowest row. Also, each base grid row must be numbered consecutively from the lowest row in the grid, so that row contains grid point .
As an example, consider the domain consisting of the two separate squares shown in
Figure 1. The left-hand diagram shows the virtual grid and its integer coordinates (i.e., its column and row indices), and the right-hand diagram shows the base grid point indices and the base row indices (in brackets).
Hence the base grid point with index say is in base row , virtual column 4, and virtual row , i.e., virtual grid integer coordinates ; and the base grid point with index say is in base row , virtual column 2, and virtual row , i.e., virtual grid integer coordinates .
The base grid must then be defined in
INIDOM by specifying the number of base grid rows, the number of base grid points, the number of boundaries, the number of boundary points, and the following integer arrays:
- LROW contains the base grid indices of the starting points of the base grid rows;
- IROW contains the virtual row numbers of the base grid rows;
- ICOL contains the virtual column numbers of the base grid points;
- LBND contains the grid indices of the boundary edges (without corners) and corner points;
- LLBND contains the starting elements of the boundaries and corners in LBND.
Finally,
ILBND contains the types of the boundaries and corners, as follows:
Boundaries:
- 1 – lower boundary
- 2 – left boundary
- 3 – upper boundary
- 4 – right boundary
External corners (
):
- 12 – lower-left corner
- 23 – upper-left corner
- 34 – upper-right corner
- 41 – lower-right corner
Internal corners (
):
- 21 – lower-left corner
- 32 – upper-left corner
- 43 – upper-right corner
- 14 – lower-right corner
Figure 2 shows the boundary types of a domain with a hole. Notice the logic behind the labelling of the corners: each one includes the types of the two adjacent boundary edges, in a clockwise fashion (outside the domain).
As an example, consider the domain shown in
Figure 3. The left-hand diagram shows the physical domain and the right-hand diagram shows the base and virtual grids. The numbers outside the base grid are the indices of the left and rightmost base grid points, and the numbers inside the base grid are the boundary or corner numbers, indicating the order in which the boundaries are stored in
LBND.
For this example we have
NROWS = 11
NPTS = 105
NBNDS = 28
NBPTS = 72
LROW = (1,4,15,26,37,46,57,68,79,88,97)
IROW = (0,1,2,3,4,5,6,7,8,9,10)
ICOL = (0,1,2,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,8,9,10,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,6,7,8,9,10,
0,1,2,3,4,5,6,7,8,
0,1,2,3,4,5,6,7,8,
0,1,2,3,4,5,6,7,8)
LBND = (2,
4,15,26,37,46,57,68,79,88,
98,99,100,101,102,103,104,
96,
86,85,84,83,82,
70,59,48,39,28,17,6,
8,9,10,11,12,13,
18,29,40,49,60,
72,73,74,75,76,77,
67,56,45,36,25,
33,32,
42,
52,53,
43,
1,97,105,87,81,3,7,71,78,14,31,51,54,34)
LLBND = (1,2,11,18,19,24,31,37,42,48,53,55,56,58,59,60,
61,62,63,64,65,66,67,68,69,70,71,72)
ILBND = (1,2,3,4,1,4,1,2,3,4,3,4,1,2,12,23,34,41,14,41,
12,23,34,41,43,14,21,32)
This particular domain is used in the example in
Section 10, and data statements are used to define the above arrays in that example program. For less complicated domains it is simpler to assign the values of the arrays in do-loops. This also allows flexibility in the number of base grid points.
The routine
D03RYF can be called from
INIDOM to obtain a simple graphical representation of the base grid, and to verify the data that you have specified in
INIDOM.
Subgrids are stored internally using the same data structure, and solution information is communicated to you in
PDEIV,
PDEDEF and
BNDARY in arrays according to the grid index on the particular level, e.g.,
and
contain the
coordinates of grid point
, and
contains the
th solution component
at grid point
.
The grid data and the solutions at all grid levels are stored in the workspace arrays, along with other information needed for a restart (i.e., a continuation call). It is not intended that you extract the solution from these arrays, indeed the necessary information regarding these arrays is not provided. The user-supplied monitor (
MONITR) should be used to obtain the solution at particular levels and times.
MONITR is called at the end of every time step, with the last step being identified via the input parameter
TLAST. The routine
D03RZF should be called from
MONITR to obtain grid information at a particular level.
Further details of the underlying algorithm can be found in
Section 9 and in
Blom and Verwer (1993) and
Blom et al. (1996) and the references therein.
4 References
Blom J G, Trompert R A and Verwer J G (1996) Algorithm 758. VLUGR2: A vectorizable adaptive grid solver for PDEs in 2D Trans. Math. Software 22 302–328
Blom J G and Verwer J G (1993) VLUGR2: A vectorized local uniform grid refinement code for PDEs in 2D Report NM-R9306 CWI, Amsterdam
Trompert R A (1993) Local uniform grid refinement and systems of coupled partial differential equations Appl. Numer. Maths 12 331–355
Trompert R A and Verwer J G (1993) Analysis of the implicit Euler local uniform grid refinement method SIAM J. Sci. Comput. 14 259–278
5 Parameters
- 1: – INTEGERInput
-
On entry: the number of PDEs in the system.
Constraint:
.
- 2: – REAL (KIND=nag_wp)Input/Output
-
On entry: the initial value of the independent variable .
On exit: the value of which has been reached. Normally .
Constraint:
.
- 3: – REAL (KIND=nag_wp)Input
-
On entry: the final value of to which the integration is to be carried out.
- 4: – REAL (KIND=nag_wp) arrayInput/Output
-
On entry: the initial, minimum and maximum time step sizes respectively.
- Specifies the initial time step size to be used on the first entry, i.e., when . If then the default value is used. On subsequent entries (), the value of is not referenced.
- Specifies the minimum time step size to be attempted by the integrator. If the default value is used.
- Specifies the maximum time step size to be attempted by the integrator. If the default value is used.
On exit: contains the time step size for the next time step. and are unchanged or set to their default values if zero on entry.
Constraints:
- if , ;
- if and , and , where the values of and will have been reset to their default values if zero on entry;
- .
- 5: – REAL (KIND=nag_wp)Input
-
On entry: the space tolerance used in the grid refinement strategy (
in equation
(4)). See
Section 9.2.
Constraint:
.
- 6: – REAL (KIND=nag_wp)Input
-
On entry: the time tolerance used to determine the time step size (
in equation
(7)). See
Section 9.3.
Constraint:
.
- 7: – SUBROUTINE, supplied by the user.External Procedure
-
INIDOM must specify the base grid in terms of the data structure described in
Section 3.
INIDOM is not referenced if, on entry,
.
D03RYF can be called from
INIDOM to obtain a simple graphical representation of the base grid, and to verify the data that you have specified in
INIDOM. D03RBF also checks the validity of the data, but you are strongly advised to call
D03RYF to ensure that the base grid is exactly as required.
Note: the boundaries of the base grid should consist of as many points as are necessary to employ second-order space discretization, i.e., a boundary enclosing the internal part of the domain must include at least grid points including the corners. If Neumann boundary conditions are to be applied the minimum is .
The specification of
INIDOM is:
SUBROUTINE INIDOM ( |
MAXPTS, XMIN, XMAX, YMIN, YMAX, NX, NY, NPTS, NROWS, NBNDS, NBPTS, LROW, IROW, ICOL, LLBND, ILBND, LBND, IERR) |
INTEGER |
MAXPTS, NX, NY, NPTS, NROWS, NBNDS, NBPTS, LROW(*), IROW(*), ICOL(*), LLBND(*), ILBND(*), LBND(*), IERR |
REAL (KIND=nag_wp) |
XMIN, XMAX, YMIN, YMAX |
|
- 1: – INTEGERInput
-
On entry: the maximum number of base grid points allowed by the available workspace.
- 2: – REAL (KIND=nag_wp)Output
- 3: – REAL (KIND=nag_wp)Output
-
On exit: the extents of the virtual grid in the -direction, i.e., the coordinates of the left and right boundaries respectively.
Constraint:
and
XMAX must be sufficiently distinguishable from
XMIN for the precision of the machine being used.
- 4: – REAL (KIND=nag_wp)Output
- 5: – REAL (KIND=nag_wp)Output
-
On exit: the extents of the virtual grid in the -direction, i.e., the coordinates of the left and right boundaries respectively.
Constraint:
and
YMAX must be sufficiently distinguishable from
YMIN for the precision of the machine being used.
- 6: – INTEGEROutput
- 7: – INTEGEROutput
-
On exit: the number of virtual grid points in the - and -direction respectively (including the boundary points).
- 8: – INTEGEROutput
-
On exit: the total number of points in the base grid. If the required number of points is greater than
MAXPTS then
INIDOM must be exited immediately with
IERR set to
to avoid overwriting memory.
Constraint:
and if on exit, .
- 9: – INTEGEROutput
-
On exit: the total number of rows of the virtual grid that contain base grid points. This is the maximum base row index.
Constraint:
.
- 10: – INTEGEROutput
-
On exit: the total number of physical boundaries and corners in the base grid.
Constraint:
.
- 11: – INTEGEROutput
-
On exit: the total number of boundary points in the base grid.
Constraint:
.
- 12: – INTEGER arrayOutput
-
On exit: , for , must contain the base grid index of the first grid point in base grid row .
Constraints:
- , for ;
- , for .
- 13: – INTEGER arrayOutput
-
On exit: , for , must contain the virtual row number that corresponds to base grid row .
Constraints:
- , for ;
- , for .
- 14: – INTEGER arrayOutput
-
On exit: , for , must contain the virtual column number that contains base grid point .
Constraint:
, for .
- 15: – INTEGER arrayOutput
-
On exit:
, for
, must contain the element of
LBND corresponding to the start of the
th boundary or corner.
Note: the order of the boundaries and corners in
LLBND must be first all the boundaries and then all the corners. The end points of a boundary (i.e., the adjacent corner points) must
not be included in the list of points on that boundary. Also, if a corner is shared by two pairs of physical boundaries then it has two types and must therefore be treated as two corners.
Constraints:
- , for ;
- , for .
- 16: – INTEGER arrayOutput
-
On exit:
, for
, must contain the type of the
th boundary (or corner), as given in
Section 3.
Constraint:
must be equal to one of the following: , , , , , , , , , , or , for .
- 17: – INTEGER arrayOutput
-
On exit:
, for
, must contain the grid index of the
th boundary point. The order of the boundaries is as specified in
LLBND, but within this restriction the order of the points in
LBND is arbitrary.
Constraint:
, for .
- 18: – INTEGERInput/Output
-
On entry: will be initialized by D03RBF to some value prior to internal calls to
INIDOM.
On exit: if the required number of grid points is larger than
MAXPTS,
IERR must be set to
to force a termination of the integration and an immediate return to the calling program with
. Otherwise,
IERR should remain unchanged.
INIDOM must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03RBF is called. Parameters denoted as
Input must
not be changed by this procedure.
- 8: – SUBROUTINE, supplied by the user.External Procedure
-
PDEDEF must evaluate the functions
, for
, in equation
(1) which define the system of PDEs (i.e., the residuals of the resulting ODE system) at all interior points of the domain. Values at points on the boundaries of the domain are ignored and will be overwritten by
BNDARY.
PDEDEF is called for each subgrid in turn.
The specification of
PDEDEF is:
SUBROUTINE PDEDEF ( |
NPTS, NPDE, T, X, Y, U, UT, UX, UY, UXX, UXY, UYY, RES) |
INTEGER |
NPTS, NPDE |
REAL (KIND=nag_wp) |
T, X(NPTS), Y(NPTS), U(NPTS,NPDE), UT(NPTS,NPDE), UX(NPTS,NPDE), UY(NPTS,NPDE), UXX(NPTS,NPDE), UXY(NPTS,NPDE), UYY(NPTS,NPDE), RES(NPTS,NPDE) |
|
- 1: – INTEGERInput
-
On entry: the number of grid points in the current grid.
- 2: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 3: – REAL (KIND=nag_wp)Input
-
On entry: the current value of the independent variable .
- 4: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 5: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 6: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of the th PDE component at the th grid point, for and .
- 7: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 8: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 9: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 10: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 11: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 12: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 13: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must contain the value of , for , at the
th grid point, for , although the residuals at boundary points will be ignored (and overwritten later on) and so they need not be specified here.
PDEDEF must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03RBF is called. Parameters denoted as
Input must
not be changed by this procedure.
- 9: – SUBROUTINE, supplied by the user.External Procedure
-
BNDARY must evaluate the functions
, for
, in equation
(2) which define the boundary conditions at all boundary points of the domain. Residuals at interior points must
not be altered by this subroutine.
The specification of
BNDARY is:
SUBROUTINE BNDARY ( |
NPTS, NPDE, T, X, Y, U, UT, UX, UY, NBNDS, NBPTS, LLBND, ILBND, LBND, RES) |
INTEGER |
NPTS, NPDE, NBNDS, NBPTS, LLBND(NBNDS), ILBND(NBNDS), LBND(NBPTS) |
REAL (KIND=nag_wp) |
T, X(NPTS), Y(NPTS), U(NPTS,NPDE), UT(NPTS,NPDE), UX(NPTS,NPDE), UY(NPTS,NPDE), RES(NPTS,NPDE) |
|
- 1: – INTEGERInput
-
On entry: the number of grid points in the current grid.
- 2: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 3: – REAL (KIND=nag_wp)Input
-
On entry: the current value of the independent variable .
- 4: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 5: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 6: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of the th PDE component at the th grid point, for and .
- 7: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 8: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 9: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of for the th PDE component at the th grid point, for and .
- 10: – INTEGERInput
-
On entry: the total number of physical boundaries and corners in the grid.
- 11: – INTEGERInput
-
On entry: the total number of boundary points in the grid.
- 12: – INTEGER arrayInput
-
On entry:
, for
, contains the element of
LBND corresponding to the start of the
th boundary (or corner).
- 13: – INTEGER arrayInput
-
On entry:
, for
, contains the type of the
th boundary, as given in
Section 3.
- 14: – INTEGER arrayInput
-
On entry:
, contains the grid index of the
th boundary point, where the order of the boundaries is as specified in
LLBND. Hence the
th boundary point has coordinates
and
, and the corresponding solution values are
, for
and
.
- 15: – REAL (KIND=nag_wp) arrayInput/Output
-
On entry: contains function values returned by
PDEDEF.
On exit:
must contain the value of
, for
, at the
th boundary point, for
.
Note: elements of
RES corresponding to interior points, i.e., points not included in
LBND, must
not be altered.
BNDARY must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03RBF is called. Parameters denoted as
Input must
not be changed by this procedure.
- 10: – SUBROUTINE, supplied by the user.External Procedure
-
PDEIV must specify the initial values of the PDE components
at all points in the base grid.
PDEIV is not referenced if, on entry,
.
The specification of
PDEIV is:
INTEGER |
NPTS, NPDE |
REAL (KIND=nag_wp) |
T, X(NPTS), Y(NPTS), U(NPTS,NPDE) |
|
- 1: – INTEGERInput
-
On entry: the number of grid points in the base grid.
- 2: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 3: – REAL (KIND=nag_wp)Input
-
On entry: the (initial) value of the independent variable .
- 4: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 5: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the coordinate of the th grid point, for .
- 6: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must contain the value of the th PDE component at the th grid point, for and .
PDEIV must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03RBF is called. Parameters denoted as
Input must
not be changed by this procedure.
- 11: – SUBROUTINE, supplied by the user.External Procedure
-
MONITR is called by D03RBF at the end of every successful time step, and may be used to examine or print the solution or perform other tasks such as error calculations, particularly at the final time step, indicated by the parameter
TLAST.
The input arguments contain information about the grid and solution at all grid levels used.
D03RZF should be called from
MONITR in order to extract the number of points and their
coordinates on a particular grid.
MONITR can also be used to force an immediate tidy termination of the solution process and return to the calling program.
The specification of
MONITR is:
SUBROUTINE MONITR ( |
NPDE, T, DT, DTNEW, TLAST, NLEV, XMIN, YMIN, DXB, DYB, LGRID, ISTRUC, LSOL, SOL, IERR) |
INTEGER |
NPDE, NLEV, LGRID(*), ISTRUC(*), LSOL(NLEV), IERR |
REAL (KIND=nag_wp) |
T, DT, DTNEW, XMIN, YMIN, DXB, DYB, SOL(*) |
LOGICAL |
TLAST |
|
- 1: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 2: – REAL (KIND=nag_wp)Input
-
On entry: the current value of the independent variable , i.e., the time at the end of the integration step just completed.
- 3: – REAL (KIND=nag_wp)Input
-
On entry: the current time step size , i.e., the time step size used for the integration step just completed.
- 4: – REAL (KIND=nag_wp)Input
-
On entry: the time step size that will be used for the next time step.
- 5: – LOGICALInput
-
On entry: indicates if intermediate or final time step.
for an intermediate step,
for the last call to
MONITR before returning to your program.
- 6: – INTEGERInput
-
On entry: the number of grid levels used at time
T.
- 7: – REAL (KIND=nag_wp)Input
- 8: – REAL (KIND=nag_wp)Input
-
On entry: the coordinates of the lower-left corner of the virtual grid.
- 9: – REAL (KIND=nag_wp)Input
- 10: – REAL (KIND=nag_wp)Input
-
On entry: the sizes of the base grid spacing in the - and -direction respectively.
- 11: – INTEGER arrayInput
-
On entry: contains pointers to the start of the grid structures in
ISTRUC, and must be passed unchanged to
D03RZF in order to extract the grid information.
- 12: – INTEGER arrayInput
-
On entry: contains the grid structures for each grid level and must be passed unchanged to
D03RZF in order to extract the grid information.
- 13: – INTEGER arrayInput
-
On entry:
contains the pointer to the solution in
SOL at grid level
and time
T. (
actually contains the array index immediately preceding the start of the solution in
SOL.)
- 14: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the solution
at time
T for each grid level
in turn, positioned according to
LSOL.
More precisely
represents the
th component of the solution at the
th grid point in the
th level, for
,
and
, where
is the number of grid points at level
(obtainable by a call to
D03RZF).
- 15: – INTEGERInput/Output
-
On entry: will be initialized by D03RBF to some value prior to internal calls to
IERR.
On exit: should be set to
to force a termination of the integration and an immediate return to the calling program with
.
IERR should remain unchanged otherwise.
MONITR must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03RBF is called. Parameters denoted as
Input must
not be changed by this procedure.
- 12: – INTEGER arrayInput
-
On entry: may be set to control various options available in the integrator.
- All the default options are employed.
- The default value of
, for , can be obtained by setting .
- Specifies the maximum number of grid levels allowed (including the base grid). . The default value is .
- Specifies the maximum number of Jacobian evaluations allowed during each nonlinear equations solution. . The default value is .
- Specifies the maximum number of Newton iterations in each nonlinear equations solution. . The default value is .
- Specifies the maximum number of iterations in each linear equations solution. . The default value is .
Constraint:
and if , , for .
- 13: – REAL (KIND=nag_wp) arrayInput
-
On entry: may be used to specify the optional vectors
,
and
in the space and time monitors (see
Section 9).
If an optional vector is not required then all its components should be set to .
, for
, specifies
, the approximate maximum absolute value of the
th component of
, as used in
(4) and
(7).
, for
.
, for
, specifies
, the weighting factors used in the space monitor (see
(4)) to indicate the relative importance of the
th component of
on the space monitor.
, for
.
, for
, specifies
, the weighting factors used in the time monitor (see
(6)) to indicate the relative importance of the
th component of
on the time monitor.
, for
.
Constraints:
- , for ;
- , for and .
- 14: – REAL (KIND=nag_wp) arrayCommunication Array
- 15: – INTEGERInput
-
On entry: the dimension of the array
RWK as declared in the (sub)program from which D03RBF is called.
The required value of
LENRWK cannot be determined exactly in advance, but a suggested value is
where
if
and
otherwise, and
is the expected maximum number of grid points at any one level. If during the execution the supplied value is found to be too small then the routine returns with
and an estimated required size is printed on the current error message unit (see
X04AAF).
Note: the size of
LENRWK cannot be checked upon initial entry to D03RBF since the number of grid points on the base grid is not known.
- 16: – INTEGER arrayCommunication Array
-
On entry: if
,
IWK need not be set. Otherwise
IWK must remain unchanged from a previous call to D03RBF.
On exit: the following components of the array
IWK concern the efficiency of the integration. Here,
is the maximum number of grid levels allowed (
if
and
otherwise), and
is a grid level taking the values
, where
is the number of levels used.
- Contains the number of steps taken in time.
- Contains the number of rejected time steps.
- Contains the total number of residual evaluations performed (i.e., the number of times PDEDEF was called) at grid level .
- Contains the total number of Jacobian evaluations performed at grid level .
- Contains the total number of Newton iterations performed at grid level .
- Contains the total number of linear solver iterations performed at grid level .
- Contains the maximum number of Newton iterations performed at any one time step at grid level .
- Contains the maximum number of linear solver iterations performed at any one time step at grid level .
Note: the total and maximum numbers are cumulative over all calls to D03RBF. If the specified maximum number of Newton or linear solver iterations is exceeded at any stage, then the maximums above are set to the specified maximum plus one.
- 17: – INTEGERInput
-
On entry: the dimension of the array
IWK as declared in the (sub)program from which D03RBF is called.
The required value of
LENIWK cannot be determined exactly in advance, but a suggested value is
where
is the expected maximum number of grid points at any one level and
if
and
otherwise. If during the execution the supplied value is found to be too small then the routine returns with
and an estimated required size is printed on the current error message unit (see
X04AAF).
Note: the size of
LENIWK cannot be checked upon initial entry to D03RBF since the number of grid points on the base grid is not known.
- 18: – LOGICAL arrayWorkspace
- 19: – INTEGERInput
-
On entry: the dimension of the array
LWK as declared in the (sub)program from which D03RBF is called.
The required value of
LENLWK cannot be determined exactly in advance, but a suggested value is
where
is the expected maximum number of grid points at any one level. If during the execution the supplied value is found to be too small then the routine returns with
and an estimated required size is printed on the current error message unit (see
X04AAF).
Note: the size of
LENLWK cannot be checked upon initial entry to D03RBF since the number of grid points on the base grid is not known.
- 20: – INTEGERInput
-
On entry: the level of trace information required from D03RBF.
ITRACE may take the value
,
,
,
or
.
- No output is generated.
- Only warning messages are printed.
- Output from the underlying solver is printed on the current advisory message unit (see X04ABF). This output contains details of the time integration, the nonlinear iteration and the linear solver.
If , then is assumed and similarly if , then is assumed.
The advisory messages are given in greater detail as
ITRACE increases. Setting
allows you to monitor the progress of the integration without possibly excessive information.
- 21: – INTEGERInput/Output
-
On entry: must be set to
or
, alternatively
or
.
- Starts the integration in time. PDEDEF is assumed to be serial.
- Continues the integration after an earlier exit from the routine. In this case, only the following parameters may be reset between calls to D03RBF: TOUT, DT, TOLS, TOLT, OPTI, OPTR, ITRACE and IFAIL. PDEDEF is assumed to be serial.
-
Starts the integration in time. PDEDEF is assumed to have been parallelized by you, as described in Section 8. In all other respects, this is equivalent to .
-
Continues the integration after an earlier exit from the routine. In this case, only the following parameters may be reset between calls to D03RAF: TOUT, DT, TOLS, TOLT, OPTI, OPTR, ITRACE and IFAIL. PDEDEF is assumed to have been parallelized by you, as described in Section 8. In all other respects, this is equivalent to .
Constraint:
or .
On exit:
, if
IND on input was
or
, or
, if
IND on input was
or
.
Note: for users of serial versions of the NAG Library, it is recommended that you only use
or
. See
Section 8 for more information on the use of
IND.
- 22: – INTEGERInput/Output
-
On entry:
IFAIL must be set to
,
. If you are unfamiliar with this parameter you should refer to
Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
.
When the value is used it is essential to test the value of IFAIL on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6 Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
X04AAF).
Errors or warnings detected by the routine:
-
On entry, | , |
or | , |
or | TOUT is too close to TS, |
or | and , |
or | , for , |
or | , |
or | and , |
or | and , |
or | and , |
or | TOLS or , |
or | , |
or | and , for , or , |
or | , for some , |
or | , for some , |
or | , for some , |
or | or , |
or | on initial entry to D03RBF. |
-
The time step size to be attempted is less than the specified minimum size. This may occur following time step failures and subsequent step size reductions caused by one or more of the following:
- the requested accuracy could not be achieved, i.e., TOLT is too small,
- the maximum number of linear solver iterations, Newton iterations or Jacobian evaluations is too small,
- ILU decomposition of the Jacobian matrix could not be performed, possibly due to singularity of the Jacobian.
Setting
ITRACE to a higher value may provide further information.
In the latter two cases you are advised to check their problem formulation in
PDEDEF and/or
BNDARY, and the initial values in
PDEIV if appropriate.
-
One or more of the workspace arrays is too small for the required number of grid points. At the initial time step this error may result because you set
IERR to
in
INIDOM or the internal check on the number of grid points following the call to
INIDOM. An estimate of the required sizes for the current stage is output, but more space may be required at a later stage.
-
IERR was set to
in
MONITR, forcing control to be passed back to calling program. Integration was successful as far as
.
-
The integration has been completed but the maximum number of levels specified in
was insufficient at one or more time steps, meaning that the requested space accuracy could not be achieved. To avoid this warning either increase the value of
or decrease the value of
TOLS.
-
One or more of the output arguments of
INIDOM was incorrectly specified, i.e.,
| , |
or | XMAX too close to XMIN, |
or | , |
or | YMAX too close to YMIN, |
or | NX or , |
or | , |
or | , |
or | , |
or | , |
or | , |
or | , |
or | or , for some , |
or | , for some , |
or | or , for some , |
or | , for some , |
or | or , for some , |
or | or , for some , |
or | , for some , |
or | , , , , , , , , , , or , for some , |
or | or , for some . |
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.8 in the Essential Introduction for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 3.7 in the Essential Introduction for further information.
Dynamic memory allocation failed.
See
Section 3.6 in the Essential Introduction for further information.
7 Accuracy
There are three sources of error in the algorithm: space and time discretization, and interpolation (linear) between grid levels. The space and time discretization errors are controlled separately using the parameters
TOLS and
TOLT described in
Section 9, and you should test the effects of varying these parameters. Interpolation errors are generally implicitly controlled by the refinement criterion since in areas where interpolation errors are potentially large, the space monitor will also be large. It can be shown that the global spatial accuracy is comparable to that which would be obtained on a uniform grid of the finest grid size. A full error analysis can be found in
Trompert and Verwer (1993).
8 Parallelism and Performance
D03RBF is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
D03RBF 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 routine. Please also consult the
Users' Note for your implementation for any additional implementation-specific information.
D03RBF requires a user-supplied routine
PDEDEF to evaluate the functions
, for
. The parallelism within D03RBF will be more efficient if
PDEDEF can also be parallelized. This is often the case, but you must add some OpenMP directives to your version of
PDEDEF to implement the parallelism.
This is often the case, but you must add some OpenMP directives to your version of
PDEDEF to implement the parallelism. For example, if the body of code for
PDEDEF is as follows (adapted from the first test case in the document for D03RBF):
res(1:npts,1:npde) = ut(1:npts,1:npde) - diffusion*(uxx(1:npts,1: &
npde)+uyy(1:npts,1:npde)) - damkohler*(one+heat_release-u(1:npts, &
1:npde))*exp(-activ_energy/u(1:npts,1:npde))
This example can be parallelized, as the updating of
RES for each value in the range
is independent of every other value. Thus this should be parallelized in OpenMP (using an explicit loop rather than Fortran array syntax) as follows:
!$OMP DO
Do i = 1, npts
res(i,1:npde) = ut(i,1:npde) -diffusion*(uxx(i,1:npde)+uyy(i,1:npde &
)) - damkohler*(1.0E0_nag_wp+heat_release-u(i,1:npde))*exp(- &
activ_energy/u(i,1:npde))
End Do
!$OMP END DO
Note that the OpenMP PARALLEL directive must not be specified, as the OpenMP DO directive will bind to the PARALLEL region within the D03RBF code. Also note that this assumes the default OpenMP behaviour that all variables are SHARED, except for loop indices that are PRIVATE.
To avoid problems for existing library users, who will not have specified any OpenMP directives in their
PDEDEF routine, the default assumption of D03RBF is that
PDEDEF has not been parallelized, and executes calls to
PDEDEF in serial mode. You must indicate that
PDEDEF has been parallelized by setting
IND to
or
as appropriate. See
Section 5 for details.
If the code within
PDEDEF cannot be parallelized, you must
not add any OpenMP directives to your code, and must
not set
IND to
or
. If
IND is set to
or
and
PDEDEF has not been parallelized, results on multiple threads will be unpredictable and may give rise to incorrect results and/or program crashes or deadlocks. Please contact
NAG for advice if required. Overloading
IND in this manner is not entirely satisfactory, consequently it is likely that replacement interfaces for D03RBF will be included in a future NAG Library release.
The local uniform grid refinement method is summarised as follows.
1. |
Initialize the course base grid, an initial solution and an initial time step. |
2. |
Solve the system of PDEs on the current grid with the current time step. |
3. |
If the required accuracy in space and the maximum number of grid levels have not yet been reached:
(a) |
Determine new finer grid at forward time level. |
(b) |
Get solution values at previous time level(s) on new grid. |
(c) |
Interpolate internal boundary values from old grid at forward time. |
(d) |
Get initial values for the Newton process at forward time. |
(e) |
Go to . |
|
4. |
Update the coarser grid solution using the finer grid values. |
5. |
Estimate error in time integration. If time error is acceptable advance time level. |
6. |
Determine new step size then go to with coarse base as current grid. |
For each grid point
a space monitor
is determined by
where
and
are the grid widths in the
and
directions; and
,
are the
coordinates at grid point
. The parameter
is obtained from
where
is the user-supplied space tolerance;
is a weighting factor for the relative importance of the
th PDE component on the space monitor; and
is the approximate maximum absolute value of the
th component. A value for
must be supplied by you. Values for
and
must also be supplied but may be set to the values
if little information about the solution is known.
A new level of refinement is created if
depending on the grid level at the previous step in order to avoid fluctuations in the number of grid levels between time steps. If
(5) is satisfied then all grid points for which
are flagged and surrounding cells are quartered in size.
No derefinement takes place as such, since at each time step the solution on the base grid is computed first and new finer grids are then created based on the new solution. Hence derefinement occurs implicitly. See
Section 9.1.
The time integration is controlled using a time monitor calculated at each level
up to the maximum level used, given by
where
is the total number of points on grid level
;
;
is the current time step;
is the time derivative of
which is approximated by first-order finite differences;
is the time equivalent of the space weighting factor
; and
is given by
where
is as before, and
is the user-specified time tolerance.
An integration step is rejected and retried at all levels if
10 Example
This example is taken from
Blom and Verwer (1993) and is the two-dimensional Burgers' system
with
on the domain given in
Figure 3. Dirichlet boundary conditions are used on all boundaries using the exact solution
The solution contains a wave front at which propagates in a direction perpendicular to the front with speed .
10.1 Program Text
Program Text (d03rbfe.f90)
10.2 Program Data
Program Data (d03rbfe.d)
10.3 Program Results
Program Results (d03rbfe.r)