NAG Library Routine Document
g05zqf (field_2d_user_setup)
1
Purpose
g05zqf performs the setup required in order to simulate stationary Gaussian random fields in two dimensions, for a user-defined variogram, using the
circulant embedding method. Specifically, the eigenvalues of the extended covariance matrix (or embedding matrix) are calculated, and their square roots output, for use by
g05zsf, which simulates the random field.
2
Specification
Fortran Interface
Subroutine g05zqf ( |
ns, xmin, xmax, ymin, ymax, maxm, var, cov2, even, pad, icorr, lam, xx, yy, m, approx, rho, icount, eig, iuser, ruser, ifail) |
Integer, Intent (In) | :: | ns(2), maxm(2), even, pad, icorr | Integer, Intent (Inout) | :: | iuser(*), ifail | Integer, Intent (Out) | :: | m(2), approx, icount | Real (Kind=nag_wp), Intent (In) | :: | xmin, xmax, ymin, ymax, var | Real (Kind=nag_wp), Intent (Inout) | :: | ruser(*) | Real (Kind=nag_wp), Intent (Out) | :: | lam(MAXM(1)*MAXM(2)), xx(NS(1)), yy(NS(2)), rho, eig(3) | External | :: | cov2 |
|
C Header Interface
#include <nagmk26.h>
void |
g05zqf_ (const Integer ns[], const double *xmin, const double *xmax, const double *ymin, const double *ymax, const Integer maxm[], const double *var, void (NAG_CALL *cov2)(const double *x, const double *y, double *gamma, Integer iuser[], double ruser[]), const Integer *even, const Integer *pad, const Integer *icorr, double lam[], double xx[], double yy[], Integer m[], Integer *approx, double *rho, Integer *icount, double eig[], Integer iuser[], double ruser[], Integer *ifail) |
|
3
Description
A two-dimensional random field in is a function which is random at every point , so is a random variable for each . The random field has a mean function and a symmetric positive semidefinite covariance function . is a Gaussian random field if for any choice of and , the random vector follows a multivariate Normal distribution, which would have a mean vector with entries and a covariance matrix with entries . A Gaussian random field is stationary if is constant for all and for all and hence we can express the covariance function as a function of one variable: . is known as a variogram (or more correctly, a semivariogram) and includes the multiplicative factor representing the variance such that .
The routines
g05zqf and
g05zsf are used to simulate a two-dimensional stationary Gaussian random field, with mean function zero and variogram
, over a domain
, using an equally spaced set of
points;
points in the
-direction and
points in the
-direction. The problem reduces to sampling a Normal random vector
of size
, with mean vector zero and a symmetric covariance matrix
, which is an
by
block Toeplitz matrix with Toeplitz blocks of size
by
. Since
is in general expensive to factorize, a technique known as the
circulant embedding method is used.
is embedded into a larger, symmetric matrix
, which is an
by
block circulant matrix with circulant blocks of size
by
, where
and
.
can now be factorized as
, where
is the two-dimensional Fourier matrix (
is the complex conjugate of
),
is the diagonal matrix containing the eigenvalues of
and
.
is known as the embedding matrix. The eigenvalues can be calculated by performing a discrete Fourier transform of the first row (or column) of
and multiplying by
, and so only the first row (or column) of
is needed – the whole matrix does not need to be formed.
The symmetry of as a block matrix, and the symmetry of each block of , depends on whether the variogram is even or not. is even in its first coordinate if , even in its second coordinate if , and even if it is even in both coordinates (in two dimensions it is impossible for to be even in one coordinate and uneven in the other). If is even then is a symmetric block matrix and has symmetric blocks; if is uneven then is not a symmetric block matrix and has non-symmetric blocks. In the uneven case, and are set to be odd in order to guarantee symmetry in .
As long as all of the values of are non-negative (i.e., is positive semidefinite), is a covariance matrix for a random vector which has blocks of size . Two samples of can now be simulated from the real and imaginary parts of , where and have elements from the standard Normal distribution. Since , this calculation can be done using a discrete Fourier transform of the vector . Two samples of the random vector can now be recovered by taking the first elements of the first blocks of each sample of – because the original covariance matrix is embedded in , will have the correct distribution.
If
is not positive semidefinite, larger embedding matrices
can be tried; however if the size of the matrix would have to be larger than
maxm, an approximation procedure is used. We write
, where
and
contain the non-negative and negative eigenvalues of
respectively. Then
is replaced by
where
and
is a scaling factor. The error
in approximating the distribution of the random field is given by
Three choices for
are available, and are determined by the input argument
icorr:
- setting sets
- setting sets
- setting sets .
g05zqf finds a suitable positive semidefinite embedding matrix
and outputs its sizes in the vector
m and the square roots of its eigenvalues in
lam. If approximation is used, information regarding the accuracy of the approximation is output. Note that only the first row (or column) of
is actually formed and stored.
4
References
Dietrich C R and Newsam G N (1997) Fast and exact simulation of stationary Gaussian processes through circulant embedding of the covariance matrix SIAM J. Sci. Comput. 18 1088–1107
Schlather M (1999) Introduction to positive definite functions and to unconditional simulation of random fields Technical Report ST 99–10 Lancaster University
Wood A T A and Chan G (1994) Simulation of stationary Gaussian processes in Journal of Computational and Graphical Statistics 3(4) 409–432
5
Arguments
- 1: – Integer arrayInput
-
On entry: the number of sample points to use in each direction, with sample points in the -direction, and sample points in the -direction, . The total number of sample points on the grid is therefore .
- 2: – Real (Kind=nag_wp)Input
-
On entry: the lower bound for the -coordinate, for the region in which the random field is to be simulated.
Constraint:
.
- 3: – Real (Kind=nag_wp)Input
-
On entry: the upper bound for the -coordinate, for the region in which the random field is to be simulated.
Constraint:
.
- 4: – Real (Kind=nag_wp)Input
-
On entry: the lower bound for the -coordinate, for the region in which the random field is to be simulated.
Constraint:
.
- 5: – Real (Kind=nag_wp)Input
-
On entry: the upper bound for the -coordinate, for the region in which the random field is to be simulated.
Constraint:
.
- 6: – Integer arrayInput
-
On entry: determines the maximum size of the circulant matrix to use – a maximum of elements in the -direction, and a maximum of elements in the -direction. The maximum size of the circulant matrix is thus .
Constraints:
- if , , where is the smallest integer satisfying , for ;
- if , , where is the smallest integer satisfying , for .
- 7: – Real (Kind=nag_wp)Input
-
On entry: the multiplicative factor of the variogram .
Constraint:
.
- 8: – Subroutine, supplied by the user.External Procedure
-
cov2 must evaluate the variogram
for all
if
, and for all
with non-negative entries if
. The value returned in
gamma is multiplied internally by
var.
The specification of
cov2 is:
Fortran Interface
Integer, Intent (Inout) | :: | iuser(*) | Real (Kind=nag_wp), Intent (In) | :: | x, y | Real (Kind=nag_wp), Intent (Inout) | :: | ruser(*) | Real (Kind=nag_wp), Intent (Out) | :: | gamma |
|
C Header Interface
#include <nagmk26.h>
void |
cov2 (const double *x, const double *y, double *gamma, Integer iuser[], double ruser[]) |
|
- 1: – Real (Kind=nag_wp)Input
-
On entry: the coordinate at which the variogram is to be evaluated.
- 2: – Real (Kind=nag_wp)Input
-
On entry: the coordinate at which the variogram is to be evaluated.
- 3: – Real (Kind=nag_wp)Output
-
On exit: the value of the variogram .
- 4: – Integer arrayUser Workspace
- 5: – Real (Kind=nag_wp) arrayUser Workspace
-
cov2 is called with the arguments
iuser and
ruser as supplied to
g05zqf. You should use the arrays
iuser and
ruser to supply information to
cov2.
cov2 must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
g05zqf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: cov2 should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
g05zqf. If your code inadvertently
does return any NaNs or infinities,
g05zqf is likely to produce unexpected results.
- 9: – IntegerInput
-
On entry: indicates whether the covariance function supplied is even or uneven.
- The covariance function is uneven.
- The covariance function is even.
Constraint:
or .
- 10: – IntegerInput
-
On entry: determines whether the embedding matrix is padded with zeros, or padded with values of the variogram. The choice of padding may affect how big the embedding matrix must be in order to be positive semidefinite.
- The embedding matrix is padded with zeros.
- The embedding matrix is padded with values of the variogram.
Suggested value:
.
Constraint:
or .
- 11: – IntegerInput
-
On entry: determines which approximation to implement if required, as described in
Section 3.
Suggested value:
.
Constraint:
, or .
- 12: – Real (Kind=nag_wp) arrayOutput
-
On exit: contains the square roots of the eigenvalues of the embedding matrix.
- 13: – Real (Kind=nag_wp) arrayOutput
-
On exit: the points of the -coordinates at which values of the random field will be output.
- 14: – Real (Kind=nag_wp) arrayOutput
-
On exit: the points of the -coordinates at which values of the random field will be output.
- 15: – Integer arrayOutput
-
On exit: contains , the size of the circulant blocks and contains , the number of blocks, resulting in a final square matrix of size .
- 16: – IntegerOutput
-
On exit: indicates whether approximation was used.
- No approximation was used.
- Approximation was used.
- 17: – Real (Kind=nag_wp)Output
-
On exit: indicates the scaling of the covariance matrix. unless approximation was used with or .
- 18: – IntegerOutput
-
On exit: indicates the number of negative eigenvalues in the embedding matrix which have had to be set to zero.
- 19: – Real (Kind=nag_wp) arrayOutput
-
On exit: indicates information about the negative eigenvalues in the embedding matrix which have had to be set to zero. contains the smallest eigenvalue, contains the sum of the squares of the negative eigenvalues, and contains the sum of the absolute values of the negative eigenvalues.
- 20: – Integer arrayUser Workspace
- 21: – Real (Kind=nag_wp) arrayUser Workspace
-
iuser and
ruser are not used by
g05zqf, but are passed directly to
cov2 and may be used to pass information to this routine.
- 22: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. If you are unfamiliar with this argument you should refer to
Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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, .
Constraint: , .
-
On entry, and .
Constraint: .
-
On entry, and .
Constraint: .
-
On entry,
.
Constraint: the minima for
maxm are
.
Where, if
, the minimum calculated value of
is given by
, where
is the smallest integer satisfying
, and if
, the minimum calculated value of
is given by
, where
is the smallest integer satisfying
, for
.
-
On entry, .
Constraint: .
-
On entry, .
Constraint: or .
-
On entry, .
Constraint: or .
-
On entry, .
Constraint: , or .
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.9 in How to Use the NAG Library and its Documentation for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 3.8 in How to Use the NAG Library and its Documentation for further information.
Dynamic memory allocation failed.
See
Section 3.7 in How to Use the NAG Library and its Documentation for further information.
7
Accuracy
If on exit
, see the comments in
Section 3 regarding the quality of approximation; increase the values in
maxm to attempt to avoid approximation.
8
Parallelism and Performance
g05zqf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g05zqf 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.
None.
10
Example
This example calls
g05zqf to calculate the eigenvalues of the embedding matrix for
sample points on a
by
grid of a two-dimensional random field characterized by the symmetric stable variogram:
where
, and
,
and
are parameters.
It should be noted that the symmetric stable variogram is one of the pre-defined variograms available in
g05zrf. It is used here purely for illustrative purposes.
10.1
Program Text
Program Text (g05zqfe.f90)
10.2
Program Data
Program Data (g05zqfe.d)
10.3
Program Results
Program Results (g05zqfe.r)