naginterfaces.library.pde.dim2_ellip_fd¶
- naginterfaces.library.pde.dim2_ellip_fd(a, b, c, d, e, q, t, aparam, itmax, itcoun, ndir, ixn, iyn, conres, conchn)[source]¶
dim2_ellip_fd
uses the Strongly Implicit Procedure to calculate the solution to a system of simultaneous algebraic equations of five-point molecule form on a two-dimensional topologically-rectangular mesh. (‘Topological’ means that a polar grid, for example , can be used, being equivalent to a rectangular box.)For full information please refer to the NAG Library document for d03eb
https://support.nag.com/numeric/nl/nagdoc_30.1/flhtml/d03/d03ebf.html
- Parameters
- afloat, array-like, shape
must contain the coefficient of the ‘southerly’ term involving in the th equation of the system (1), for , for . The elements of , for , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the rectangle.
- bfloat, array-like, shape
must contain the coefficient of the ‘westerly’ term involving in the th equation of the system (1), for , for . The elements of , for , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the rectangle.
- cfloat, array-like, shape
must contain the coefficient of the ‘central’ term involving in the th equation of the system (1), for , for . The elements of are checked to ensure that they are nonzero. If any element is found to be zero, the corresponding algebraic equation is assumed to be . 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, by setting at appropriate points, and the corresponding value of to the appropriate value, namely the prescribed value of in the Dirichlet case or zero at an external point.
- dfloat, array-like, shape
must contain the coefficient of the ‘easterly’ term involving in the th equation of the system (1), for , for . The elements of , for , must be zero after incorporating the boundary conditions, since they involve nodal values from outside the rectangle.
- efloat, array-like, shape
must contain the coefficient of the ‘northerly’ term involving in the th equation of the system (1), for , for . The elements of , for must be zero after incorporating the boundary conditions, since they involve nodal values from outside the rectangle.
- qfloat, array-like, shape
must contain , for , for , i.e., the source term values at the nodal points for the system (1).
- tfloat, array-like, shape
must contain the element of the approximate solution to the equations supplied by the calling program as an initial starting value, for , for .
If no better approximation is known, an array of zeros can be used.
- aparamfloat
The iteration acceleration factor. A value of is adequate for most typical problems. However, if convergence is slow, the value can be reduced, typically to or . If divergence is obtained, the value can be increased, typically to , or .
- itmaxint
The maximum number of iterations to be used by the function in seeking the solution. A reasonable value might be if or if .
- itcounint
On the first call of
dim2_ellip_fd
, must be set to . On subsequent entries, its value must be unchanged from the previous call.- ndirint
Indicates whether or not the system of equations has a unique solution. For systems which have a unique solution, must be set to any nonzero value. For systems derived from, for example, Laplace’s equation with all Neumann boundary conditions, i.e., problems in which an arbitrary constant can be added to the solution, should be set to and the values of the next two arguments must be specified. For such problems the function subtracts the value of the function derived at the node (, ) from the whole solution after each iteration to reduce the possibility of large rounding errors. You must also ensure that for such problems the appropriate consistency condition on the source terms is satisfied.
- ixnint
Is ignored unless 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.
- iynint
Is ignored unless 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.
- conresfloat
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 , and defined as the residual when the central coefficient is zero.
Clearly should not be less than a reasonable multiple of the machine precision.
- conchnfloat
The convergence criterion to be used on the maximum absolute value of the change made at each iteration to the elements of the array , namely the dependent variable. Clearly should not be less than a reasonable multiple of the machine precision multiplied by the maximum value of 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.
- Returns
- tfloat, ndarray, shape
The solution derived by the function.
- itcounint
Its value is increased by the number of iterations used on this call (namely ). It, therefore, stores the accumulated number of iterations actually used. For subsequent calls for the same problem, i.e., with the same and but possibly different coefficients and/or source terms, as occur with nonlinear systems or with time-dependent systems, is the accumulated number of iterations. This applies to the second and subsequent calls to
dim2_ellip_fd
. In this way a suitable cycling of the sequence of iteration arguments is obtained in the calls todim2_ellip_fd_iter()
.- itusedint
The number of iterations actually used on that call.
- residsfloat, ndarray, shape
The maximum absolute value of the residuals calculated at the th iteration, for . If you want to know the maximum absolute residual of the solution which is returned you must calculate this in the calling program. The sequence of values indicates the rate of convergence.
- chngsfloat, ndarray, shape
The maximum absolute value of the changes made to the components of the dependent variable at the th iteration, for . The sequence of values indicates the rate of convergence.
- Raises
- NagValueError
- (errno )
On entry, .
Constraint: .
- (errno )
On entry, .
Constraint: .
- (errno )
On entry, .
Constraint: .
- (errno )
On entry, , and .
Constraint: .
- (errno )
Convergence not achieved in iterations: .
- Notes
No equivalent traditional C interface for this routine exists in the NAG Library.
Given a set of simultaneous equations
(which could be nonlinear) derived, for example, from a finite difference representation of a two-dimensional elliptic partial differential equation and its boundary conditions, the function determines the values of the dependent variable . is a known vector of length and is a square matrix.
The equations must be of five-diagonal form:
for and , provided . Indeed, if , then the equation is assumed to be
For example, if and , the equations take the form:
The system is solved iteratively, from a starting approximation , by the formulae
Thus is the residual of the th approximate solution , and is the update change vector. The calling program supplies an initial approximation for the values of the dependent variable in the array , the coefficients of the five-point molecule system of equations in the arrays , , , and , and the source terms in the array . The function derives the residual of the latest approximate solution and then uses the approximate factorization of the Strongly Implicit Procedure with the necessary acceleration argument adjustment by calling
dim2_ellip_fd_iter()
at each iteration.dim2_ellip_fd
combines the newly derived change with the old approximation to obtain the new approximate solution for . The new solution is checked for convergence against the user-supplied convergence criteria and if these have not been achieved 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 .Problems in topologically non-rectangular regions can be solved using the function by surrounding the region by a circumscribing topological rectangle. The equations for the nodal values external to the region of interest are set to zero (i.e., ) 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, an array of all zeros can be used as the initial approximation.
The function can be used to solve linear elliptic equations in which case the arrays , , , , and are constants 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 function 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 function can also be used to solve each step of a time-dependent parabolic equation in two 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 formed from the arrays , , , , 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 Laplace’s equation with all Neumann boundary conditions, an argument is incorporated so that the solution can be rescaled by subtracting a specified nodal value from the whole solution after the completion of every iteration to keep rounding errors to a minimum for those cases when the convergence is slow.
- 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