d03ecf uses the Strongly Implicit Procedure to calculate the solution to a system of simultaneous algebraic equations of seven-point molecule form on a three-dimensional topologically-rectangular mesh. (‘Topological’ means that a polar grid, for example, can be used if it is equivalent to a rectangular box.)

2 Specification

Fortran Interface

Subroutine d03ecf (

n1, n2, n3, lda, sda, a, b, c, d, e, f, g, q, t, aparam, itmax, itcoun, itused, ndir, ixn, iyn, izn, conres, conchn, resids, chngs, wrksp1, wrksp2, wrksp3, wrksp4, ifail)

Integer, Intent (In)	::	n1, n2, n3, lda, sda, itmax, ndir, ixn, iyn, izn
Integer, Intent (Inout)	::	itcoun, ifail
Integer, Intent (Out)	::	itused
Real (Kind=nag_wp), Intent (In)	::	a(lda,sda,n3), b(lda,sda,n3), c(lda,sda,n3), d(lda,sda,n3), e(lda,sda,n3), f(lda,sda,n3), g(lda,sda,n3), q(lda,sda,n3), aparam, conres, conchn
Real (Kind=nag_wp), Intent (Inout)	::	t(lda,sda,n3), wrksp1(lda,sda,n3), wrksp2(lda,sda,n3), wrksp3(lda,sda,n3), wrksp4(lda,sda,n3)
Real (Kind=nag_wp), Intent (Out)	::	resids(itmax), chngs(itmax)

C Header Interface

#include <nag.h>

void

d03ecf_ (const Integer *n1, const Integer *n2, const Integer *n3, const Integer *lda, const Integer *sda, const double a[], const double b[], const double c[], const double d[], const double e[], const double f[], const double g[], const double q[], double t[], const double *aparam, const Integer *itmax, Integer *itcoun, Integer *itused, const Integer *ndir, const Integer *ixn, const Integer *iyn, const Integer *izn, const double *conres, const double *conchn, double resids[], double chngs[], double wrksp1[], double wrksp2[], double wrksp3[], double wrksp4[], Integer *ifail)

The routine may be called by the names d03ecf or nagf_pde_dim3_ellip_fd.

3 Description

Given a set of simultaneous equations

M t = q

(1)

(which could be nonlinear) derived, for example, from a finite difference representation of a three-dimensional elliptic partial differential equation and its boundary conditions, the routine determines the values of the dependent variable

t

M

is a square

(n_{1} \times n_{2} \times n_{3})

(n_{1} \times n_{2} \times n_{3})

matrix and

q

is a known vector of length

(n_{1} \times n_{2} \times n_{3})

The equations must be of seven-diagonal form:

a_{i j k} t_{i j, k - 1} + b_{i j k} t_{i, j - 1, k} + c_{i j k} t_{i - 1, j k} + d_{i j k} t_{i j k} + e_{i j k} t_{i + 1, j k} + f_{i j k} t_{i, j + 1, k} + g_{i j k} t_{i j, k + 1} = q_{i j k}

for

i = 1, 2, \dots, n_{1}

j = 1, 2, \dots, n_{2}

and

k = 1, 2, \dots, n_{3}

, provided that

d_{i j k} \neq 0.0

Indeed, if

d_{i j k} = 0.0

, then the equation is assumed to be:

t_{i j k} = q_{i j k} .

The system is solved iteratively from a starting approximation

t^{(1)}

by the formulae:

\begin{array}{l} r^{(n)} & = & q - M t^{(n)} \\ M s^{(n)} & = & r^{(n)} \\ t^{(n + 1)} & = & t^{(n)} + s^{(n)} . \end{array}

Thus

r^{(n)}

is the residual of the

n

th approximate solution

t^{(n)}

, and

s^{(n)}

is the update change vector.

The calling program supplies an initial approximation for the values of the dependent variable in the array t, the coefficients of the seven-point molecule system of equations in the arrays a, b, c, d, e, f and g, and the source terms in the array q. The routine derives the residual of the latest approximate solution, and then uses the approximate

L U

factorization of the Strongly Implicit Procedure with the necessary acceleration argument adjustment by calling d03ubf at each iteration. d03ecf combines the newly derived change with the old approximation to obtain the new approximate solution for

t

. The new solution is checked for convergence against the user-supplied convergence criteria, and if these have not been satisfied, the iterative cycle is repeated. Convergence is based on both the maximum absolute normalized residuals (calculated with reference to the previous approximate solution as these are calculated at the commencement of each iteration) and on the maximum absolute change made to the values of

t

Problems in topologically non-rectangular-box-shaped regions can be solved using the routine by surrounding the region by a circumscribing topologically rectangular box. The equations for the nodal values external to the region of interest are set to zero (i.e.,

d_{i j k} = t_{i j k} = 0

) and the boundary conditions are incorporated into the equations for the appropriate nodes.

If there is no better initial approximation when starting the iterative cycle, one can use an array of zeros as the initial approximation.

The routine can be used to solve linear elliptic equations in which case the arrays a, b, c, d, e, f, g and q remain constant and for which a single call provides the required solution. It can also be used to solve nonlinear elliptic equations, in which case some or all of these arrays may require updating during the progress of the iterations as more accurate solutions are derived. The routine will then have to be called repeatedly in an outer iterative cycle. Dependent on the nonlinearity, some under-relaxation of the coefficients and/or source terms may be needed during their recalculation using the new estimates of the solution.

The routine can also be used to solve each step of a time-dependent parabolic equation in three space dimensions. The solution at each time step can be expressed in terms of an elliptic equation if the Crank–Nicolson or other form of implicit time integration is used.

Neither diagonal dominance, nor positive-definiteness, of the matrix

M

formed from the arrays a, b, c, d, e, f and g is necessary to ensure convergence.

For problems in which the solution is not unique in the sense that an arbitrary constant can be added to the solution (for example Poisson's equation with all Neumann boundary conditions), an argument is incorporated so that the solution can be rescaled. A specified nodal value is subtracted from the whole solution

t

after the completion of every iteration. This keeps rounding errors to a minimum for those cases when convergence is slow. For such problems there is generally an associated compatibility condition. For the example mentioned this compatibility condition equates the total net source within the region (i.e., the source integrated over the region) with the total net outflow across the boundaries defined by the Neumann conditions (i.e., the normal derivative integrated along the whole boundary). It is very important that the algebraic equations derived to model such a problem implement accurately the compatibility condition. If they do not, a net source or sink is very likely to be represented by the set of algebraic equations and no steady-state solution of the equations exists.

4 References

Jacobs D A H (1972) The strongly implicit procedure for the numerical solution of parabolic and elliptic partial differential equations Note RD/L/N66/72 Central Electricity Research Laboratory

Stone H L (1968) Iterative solution of implicit approximations of multi-dimensional partial differential equations SIAM J. Numer. Anal. 5 530–558

Weinstein H G, Stone H L and Kwan T V (1969) Iterative procedure for solution of systems of parabolic and elliptic equations in three dimensions Industrial and Engineering Chemistry Fundamentals 8 281–287

5 Arguments

1: $n1$ – Integer Input: On entry: the number of nodes in the first coordinate direction, $n_{1}$ .

Constraint: $n1 > 1$ .
2: $n2$ – Integer Input: On entry: the number of nodes in the second coordinate direction, $n_{2}$ .

Constraint: $n2 > 1$ .
3: $n3$ – Integer Input: On entry: the number of nodes in the third coordinate direction, $n_{3}$ .

Constraint: $n3 > 1$ .
4: $lda$ – Integer Input: On entry: the first dimension of the arrays a, b, c, d, e, f, g, q, t, wrksp1, wrksp2, wrksp3 and wrksp4 as declared in the (sub)program from which d03ecf is called.

Constraint: $lda \geq n1$ .
5: $sda$ – Integer Input: On entry: the second dimension of the arrays a, b, c, d, e, f, g, q, t, wrksp1, wrksp2, wrksp3 and wrksp4 as declared in the (sub)program from which d03ecf is called.

Constraint: $sda \geq n2$ .
6: $a (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $a (i, j, k)$ must contain the coefficient of $t_{i j, k - 1}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of a, for $k = 1$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
7: $b (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $b (i, j, k)$ must contain the coefficient of $t_{i, j - 1, k}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of b, for $j = 1$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
8: $c (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $c (i, j, k)$ must contain the coefficient of $t_{i - 1, j k}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of c, for $i = 1$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
9: $d (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $d (i, j, k)$ must contain the coefficient of $t_{i j k}$ (the ‘central’ term) in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of d are checked to ensure that they are nonzero. If any element is found to be zero, the corresponding algebraic equation is assumed to be $t_{i j k} = q_{i j k}$ . This feature can be used to define the equations for nodes at which, for example, Dirichlet boundary conditions are applied, or for nodes external to the problem of interest. Setting $d (i, j, k) = 0.0$ at appropriate points, and the corresponding value of $q (i, j, k)$ to the appropriate value, namely the prescribed value of $t (i, j, k)$ in the Dirichlet case, or to zero at an external point.
10: $e (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $e (i, j, k)$ must contain the coefficient of $t_{i + 1, j k}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of e, for $i = n1$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
11: $f (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $f (i, j, k)$ must contain the coefficient of $t_{i, j + 1, k}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of f, for $j = n2$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
12: $g (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $g (i, j, k)$ must contain the coefficient of $t_{i j, k + 1}$ in the $(i, j, k)$ th equation of the system (1), for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ . The elements of g, for $k = n3$ , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the box.
13: $q (lda, sda, n3)$ – Real (Kind=nag_wp) array Input: On entry: $q (i, j, k)$ must contain $q_{i j k}$ , for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ , i.e., the source-term values at the nodal points of the system (1).
14: $t (lda, sda, n3)$ – Real (Kind=nag_wp) array Input/Output: On entry: $t (i, j, k)$ must contain the element $t_{i j k}$ of an approximate solution to the equations, for $i = 1, 2, \dots, n1$ , $j = 1, 2, \dots, n2$ and $k = 1, 2, \dots, n3$ .
If no better approximation is known, an array of zeros can be used.

On exit: the solution derived by the routine.
15: $aparam$ – Real (Kind=nag_wp) Input: On entry: the iteration acceleration factor. A value of $1.0$ is adequate for most typical problems. However, if convergence is slow, the value can be reduced, typically to $0.2$ or $0.1$ . If divergence is obtained, the value can be increased, typically to $2.0$ , $5.0$ or $10.0$ .

Constraint: $0.0 < aparam \leq ({(n1 - 1)}^{2} + {(n2 - 1)}^{2} + {(n3 - 1)}^{2}) / 3.0$ .
16: $itmax$ – Integer Input: On entry: the maximum number of iterations to be used by the routine in seeking the solution. A reasonable value might be $20$ for a problem with $3000$ nodes and convergence criteria of about $10^{−3}$ of the original residual and change.
17: $itcoun$ – Integer Input/Output: On entry: on the first call of d03ecf, itcoun must be set to $0$ . On subsequent entries, its value must be unchanged from the previous call.

On exit: its value is increased by the number of iterations used on this call (namely itused). It, therefore, stores the accumulated number of iterations actually used.
For subsequent calls for the same problem, i.e., with the same n1, n2 and n3 but possibly different coefficients and/or source terms, as occur with nonlinear systems or with time-dependent systems, itcoun should not be reset, i.e., it must contain the accumulated number of iterations. In this way a suitable cycling of the sequence of iteration arguments is obtained in the calls to d03ubf.
18: $itused$ – Integer Output: On exit: the number of iterations actually used on that call.
19: $ndir$ – Integer Input: On entry: indicates whether or not the system of equations has a unique solution. For systems which have a unique solution, ndir must be set to any nonzero value. For systems derived from problems to which an arbitrary constant can be added to the solution, for example Poisson's equation with all Neumann boundary conditions, ndir should be set to $0$ and the values of the next three arguments must be specified. For such problems the routine subtracts the value of the function derived at the node (ixn, iyn, izn) from the whole solution after each iteration to reduce the possibility of large rounding errors. You must also ensure for such problems that the appropriate compatibility condition on the source terms q is satisfied. See the comments at the end of Section 3.
20: $ixn$ – Integer Input: On entry: is ignored unless ndir is equal to zero, in which case it must specify the first index of the nodal point at which the solution is to be set to zero. The node should not correspond to a corner node, or to a node external to the region of interest.
21: $iyn$ – Integer Input: On entry: is ignored unless ndir is equal to zero, in which case it must specify the second index of the nodal point at which the solution is to be set to zero. The node should not correspond to a corner node, or to a node external to the region of interest.
22: $izn$ – Integer Input: On entry: is ignored unless ndir is equal to zero, in which case it must specify the third index of the nodal point at which the solution is to be set to zero. The node should not correspond to a corner node, or to a node external to the region of interest.
23: $conres$ – Real (Kind=nag_wp) Input: On entry: the convergence criterion to be used on the maximum absolute value of the normalized residual vector components. The latter is defined as the residual of the algebraic equation divided by the central coefficient when the latter is not equal to $0.0$ , and defined as the residual when the central coefficient is zero.
conres should not be less than a reasonable multiple of the machine precision.
24: $conchn$ – Real (Kind=nag_wp) Input: On entry: the convergence criterion to be used on the maximum absolute value of the change made at each iteration to the elements of the array t, namely the dependent variable. conchn should not be less than a reasonable multiple of the machine accuracy multiplied by the maximum value of t attained.
Convergence is achieved when both the convergence criteria are satisfied. You can, therefore, set convergence on either the residual or on the change, or (as is recommended) on a requirement that both are below prescribed limits.
25: $resids (itmax)$ – Real (Kind=nag_wp) array Output: On exit: the maximum absolute value of the residuals calculated at the $i$ th iteration, for $i = 1, 2, \dots, itused$ . If the residual of the solution is sought you must calculate this in the subroutine from which d03ecf is called. The sequence of values resids indicates the rate of convergence.
26: $chngs (itmax)$ – Real (Kind=nag_wp) array Output: On exit: the maximum absolute value of the changes made to the components of the dependent variable t at the $i$ th iteration, for $i = 1, 2, \dots, itused$ . The sequence of values chngs indicates the rate of convergence.
27: $wrksp1 (lda, sda, n3)$ – Real (Kind=nag_wp) array Workspace
28: $wrksp2 (lda, sda, n3)$ – Real (Kind=nag_wp) array Workspace
29: $wrksp3 (lda, sda, n3)$ – Real (Kind=nag_wp) array Workspace
30: $wrksp4 (lda, sda, n3)$ – Real (Kind=nag_wp) array Workspace
31: $ifail$ – Integer Input/Output: On entry: ifail must be set to $0$ , $−1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $−1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $−1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $−1$ is recommended since useful values can be provided in some output arguments even when $ifail \neq 0$ on exit. When the value $- 1$ or $1$ is used it is essential to test the value of ifail on exit.

On exit: $ifail = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

ifail = 0

−1

, explanatory error messages are output on the current error message unit (as defined by x04aaf).

Errors or warnings detected by the routine:

Note: in some cases d03ecf may return useful information.

$ifail = 1$: On entry, $n1 = ⟨ value ⟩$ .
Constraint: $n1 > 1$ .

On entry, $n2 = ⟨ value ⟩$ .
Constraint: $n2 > 1$ .

On entry, $n3 = ⟨ value ⟩$ .
Constraint: $n3 > 1$ .

$ifail = 2$: On entry, $lda = ⟨ value ⟩$ and $n1 = ⟨ value ⟩$ .
Constraint: $lda \geq n1$ .

On entry, $sda = ⟨ value ⟩$ and $n2 = ⟨ value ⟩$ .
Constraint: $sda \geq n2$ .

$ifail = 3$: On entry, $aparam = ⟨ value ⟩$ .
Constraint: $aparam > 0.0$ .

$ifail = 4$: On entry, $aparam = ⟨ value ⟩$ , $n1 = ⟨ value ⟩$ , $n2 = ⟨ value ⟩$ and $n3 = ⟨ value ⟩$ .
Constraint: $aparam \leq ({(n1 - 1)}^{2} + {(n2 - 1)}^{2} + {(n3 - 1)}^{2}) / 3$ .

$ifail = 5$: Convergence not achieved in itmax iterations: $itmax = ⟨ value ⟩$ .

$ifail = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$ifail = - 999$: Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The improvement in accuracy for each iteration depends on the size of the system and on the condition of the update matrix characterised by the seven-diagonal coefficient arrays. The ultimate accuracy obtainable depends on the above factors and on the machine precision. The rate of convergence obtained with the Strongly Implicit Procedure is not always smooth because of the cyclic use of nine acceleration arguments. The convergence may become slow with very large problems. The final accuracy obtained may be judged approximately from the rate of convergence determined from the sequence of values returned in the arrays resids and chngs and the magnitude of the maximum absolute value of the change vector on the last iteration stored in

chngs (itused)

8 Parallelism and Performance

d03ecf is not threaded in any implementation.

9 Further Comments

The time taken per iteration is approximately proportional to

n1 \times n2 \times n3

Convergence may not always be obtained when the problem is very large and/or the coefficients of the equations have widely disparate values. The latter case is often associated with a near ill-conditioned matrix.

10 Example

This example solves Laplace's equation in a rectangular box with a non-uniform grid spacing in the

x

y

, and

z

coordinate directions and with Dirichlet boundary conditions specifying the function on the surfaces of the box equal to

e^{(1.0 + x) / y (n_{2})} \times \cos (\sqrt{2} y / y (n_{2})) \times e^{(- 1.0 - z) / y (n_{2})} .

Note that this is the same problem as that solved in the example for d03ubf. The differences in the maximum residuals obtained at each iteration between the two test runs are explained by the fact that in d03ecf the residual at each node is normalized by dividing by the central coefficient, whereas this normalization has not been used in the example program for d03ubf.

d03ec: FL CL CPP AD

NAG FL Interfaced03ecf (dim3_​ellip_​fd)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

NAG FL Interface
d03ecf (dim3_ellip_fd)