NAG FL Interface
g05zrf (field_2d_predef_setup)
1
Purpose
g05zrf performs the setup required in order to simulate stationary Gaussian random fields in two dimensions, for a preset 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 g05zrf ( |
ns, xmin, xmax, ymin, ymax, maxm, var, icov2, norm, np, params, pad, icorr, lam, xx, yy, m, approx, rho, icount, eig, ifail) |
Integer, Intent (In) |
:: |
ns(2), maxm(2), icov2, norm, np, pad, icorr |
Integer, Intent (Inout) |
:: |
ifail |
Integer, Intent (Out) |
:: |
m(2), approx, icount |
Real (Kind=nag_wp), Intent (In) |
:: |
xmin, xmax, ymin, ymax, var, params(np) |
Real (Kind=nag_wp), Intent (Out) |
:: |
lam(MAXM(1)*MAXM(2)), xx(NS(1)), yy(NS(2)), rho, eig(3) |
|
C Header Interface
#include <nag.h>
void |
g05zrf_ (const Integer ns[], const double *xmin, const double *xmax, const double *ymin, const double *ymax, const Integer maxm[], const double *var, const Integer *icov2, const Integer *norm, const Integer *np, const double params[], const Integer *pad, const Integer *icorr, double lam[], double xx[], double yy[], Integer m[], Integer *approx, double *rho, Integer *icount, double eig[], Integer *ifail) |
|
C++ Header Interface
#include <nag.h> extern "C" {
void |
g05zrf_ (const Integer ns[], const double &xmin, const double &xmax, const double &ymin, const double &ymax, const Integer maxm[], const double &var, const Integer &icov2, const Integer &norm, const Integer &np, const double params[], const Integer &pad, const Integer &icorr, double lam[], double xx[], double yy[], Integer m[], Integer &approx, double &rho, Integer &icount, double eig[], Integer &ifail) |
}
|
The routine may be called by the names g05zrf or nagf_rand_field_2d_predef_setup.
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
g05zrf 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 Gaussian 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.
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 .
g05zrf 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 (1997) Algorithm AS 312: An Algorithm for Simulating Stationary Gaussian Random Fields Journal of the Royal Statistical Society, Series C (Applied Statistics) (Volume 46) 1 171–181
5
Arguments
-
1:
– Integer array
Input
-
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 array
Input
-
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 .
Constraint:
, where is the smallest integer satisfying , for .
-
7:
– Real (Kind=nag_wp)
Input
-
On entry: the multiplicative factor of the variogram .
Constraint:
.
-
8:
– Integer
Input
-
On entry: determines which of the preset variograms to use. The choices are given below. Note that
, where
and
are correlation lengths in the
and
directions respectively and are parameters for most of the variograms, and
is the variance specified by
var.
- Symmetric stable variogram
where
- , ,
- , ,
- , .
- Cauchy variogram
where
- , ,
- , ,
- , .
- Differential variogram with compact support
where
- , ,
- , .
- Exponential variogram
where
- , ,
- , .
- Gaussian variogram
where
- , ,
- , .
- Nugget variogram
No parameters need be set for this value of icov2.
- Spherical variogram
where
- , ,
- , .
- Bessel variogram
where
- is the Bessel function of the first kind,
- , ,
- , ,
- , .
- Hole effect variogram
where
- , ,
- , .
- Whittle-Matérn variogram
where
- is the modified Bessel function of the second kind,
- , ,
- , ,
- , .
- Continuously parameterised variogram with compact support
where
- ,
- is the modified Bessel function of the second kind,
- , ,
- , ,
- , ,
- , ,
- , .
- Generalized hyperbolic distribution variogram
where
- is the modified Bessel function of the second kind,
- , ,
- , ,
- , no constraint on ,
- , ,
- , .
Constraint:
, , , , , , , , , , or .
-
9:
– Integer
Input
-
On entry: determines which norm to use when calculating the variogram.
- The 1-norm is used, i.e., .
- The 2-norm (Euclidean norm) is used, i.e., .
Suggested value:
.
Constraint:
or .
-
10:
– Integer
Input
-
On entry: the number of parameters to be set. Different covariance functions need a different number of parameters.
- np must be set to .
- , , , or
- np must be set to .
- , , or
- np must be set to .
- or
- np must be set to .
-
11:
– Real (Kind=nag_wp) array
Input
-
On entry: the parameters for the variogram as detailed in the description of
icov2.
Constraint:
see
icov2 for a description of the individual parameter constraints.
-
12:
– Integer
Input
-
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 .
-
13:
– Integer
Input
-
On entry: determines which approximation to implement if required, as described in
Section 3.
Suggested value:
.
Constraint:
, or .
-
14:
– Real (Kind=nag_wp) array
Output
-
On exit: contains the square roots of the eigenvalues of the embedding matrix.
-
15:
– Real (Kind=nag_wp) array
Output
-
On exit: the points of the -coordinates at which values of the random field will be output.
-
16:
– Real (Kind=nag_wp) array
Output
-
On exit: the points of the -coordinates at which values of the random field will be output.
-
17:
– Integer array
Output
-
On exit: contains , the size of the circulant blocks and contains , the number of blocks, resulting in a final square matrix of size .
-
18:
– Integer
Output
-
On exit: indicates whether approximation was used.
- No approximation was used.
- Approximation was used.
-
19:
– Real (Kind=nag_wp)
Output
-
On exit: indicates the scaling of the covariance matrix. unless approximation was used with or .
-
20:
– Integer
Output
-
On exit: indicates the number of negative eigenvalues in the embedding matrix which have had to be set to zero.
-
21:
– Real (Kind=nag_wp) array
Output
-
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.
-
22:
– Integer
Input/Output
-
On entry:
ifail must be set to
,
or
to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of means that an error message is printed while a value of means that it is not.
If halting is not appropriate, the value
or
is recommended. If message printing is undesirable, then the value
is recommended. Otherwise, the value
is recommended.
When the value or 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 minimum calculated value for
maxm are
.
Where the minima of
is given by
, where
is the smallest integer satisfying
, for
.
-
On entry, .
Constraint: .
-
On entry, .
Constraint: and .
-
On entry, .
Constraint: or .
-
On entry, .
Constraint: for , .
-
On entry,
.
Constraint: dependent on
icov2, see documentation.
-
On entry, .
Constraint: or .
-
On entry, .
Constraint: , or .
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.
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.
Dynamic memory allocation failed.
See
Section 9 in the Introduction to the NAG Library FL Interface 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
g05zrf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
g05zrf 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 g05zrf 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 ().
10.1
Program Text
10.2
Program Data
10.3
Program Results
The two plots shown below illustrate the random fields that can be generated by
g05zsf using the eigenvalues calculated by
g05zrf. These are for two realizations of a two-dimensional random field, based on eigenvalues of the embedding matrix for points on a
by
grid. The random field is characterized by the
exponential variogram (
) with correlation lengths both equal to
.