Diffpack Documentation

---

              Search  

---

CorrelModel Class Reference

hierarchy for random field correlation models. More...

#include <CorrelModel.h>

Inheritance diagram for CorrelModel::

List of all members.

Public Methods
	CorrelModel (int nsd)
virtual	~CorrelModel ()
virtual real	spatialCorrelation (const Ptv(real) &x)=0
virtual void	scan (MenuSystem &menu)
virtual void	define (MenuSystem &menu, int level=MAIN)
Static Public Methods
void	defineStatic (MenuSystem &menu, int level=MAIN)
Public Attributes
String	model_name
Ptv(real)	integral_scale
Ptv(real)	exponent
Protected Attributes
int	nsd

---

Detailed Description

hierarchy for random field correlation models.

NAME: CorrelModel - hierarchy for random field correlation models

DESCRIPTION:

The "CorrelModel" class acts as base class for subclasses that implement various correlation models for random fields. The hierarchy of classes is used in class "RandFieldDescr" as a part of the description of a random field. The description is again used when computing samples of random fields by the subclasses in the "RandFieldGen" hierarchy.

---

Constructor & Destructor Documentation

CorrelModel::CorrelModel ( int nsd )

The number of space dimensions must be provided as argument to the constructor. The rest of the initialization is taken care of by the "scan" function, which reads items from the menu system.

CorrelModel::~CorrelModel ( ) [virtual]

---

Member Function Documentation

void CorrelModel::define ( MenuSystem & menu, int level = MAIN ) [inline, virtual]

void CorrelModel::defineStatic ( MenuSystem & menu, int level = MAIN ) [static]

void CorrelModel::scan ( MenuSystem & menu ) [virtual]

reads two menu items, the "correlation integral scale" and the "correlation exponents". Both items are provided as "Ptv" vectors on the input.

real CorrelModel::spatialCorrelation ( const Ptv(real) & x ) [pure virtual]

this is the central virtual function in the hierarchy; it computes the value of the correlation function at a specified point. Reimplemented in NoCorrelModel, ExponentialCorrelModel, SepExponentialCorrelModel, and GenExponentialCorrelModel.

---

Member Data Documentation

Ptv(real) CorrelModel::exponent

Ptv(real) CorrelModel::integral_scale

String CorrelModel::model_name

int CorrelModel::nsd [protected]

---

The documentation for this class was generated from the following file:

• CorrelModel.h

---