ExternalRandomFieldModel< TYPE > Class Template Reference
Last update: 16.07.2025Provides random field models. More...
Public Types | |
| typedef boost::function< number(TVector3 x, TVector3 y)> | TCorrelationFunction |
| a function which is called to analyze the correlation | |
| typedef std::vector< number > | TDoubleVector |
| a vector of floating point numbers | |
| typedef Eigen::Vector3d | TVector3 |
| a 3D vector type | |
Public Member Functions | |
| check (Structure database) | |
| checks the settings on plausibility More... | |
| compute (Structure database) | |
| does the action More... | |
| ExternalRandomFieldModel (string the_quantity_ident, DataObjectVector the_shapes) | |
| default constructor More... | |
Public Attributes | |
| DataObjectPtr | bounds_lower |
| lower bounds (may be an empty pointer) | |
| DataObjectPtr | bounds_upper |
| upper bounds (may be an empty pointer) | |
| MultivariateDistributionTypes::enum_type | distribution_type |
| The ident of the probability distribution that is assumed to convert data from original space to Gaussian. If empty (default), then it is automatically chosen. | |
| DataObjectPtr | mean |
| mean value of the field (may be an empty pointer) | |
| bool | overwrite_existing |
| Is true if already existing output data objects will be replaced. In this case, also all depending objects of the already existing one will be deleted. | |
| string | quantity_ident |
| the ident of the quantity for which the random field is to be generated | |
| DataObjectVector | shapes |
| the list of independent shape vectors | |
| DataObjectPtr | stddev |
| standard deviation of the field (may be an empty pointer) | |
Detailed Description
template<dataobject_types TYPE>
class ExternalRandomFieldModel< TYPE >
Provides random field models.
- Template Parameters
-
TYPE the field data type
This class provides a field parameterization similar to random field correlation models. The basic idea is that one creates "tents" around given support points. The tent is actually given through an autocorrelation function (governed by a correlation length parameter) centered around each support point. The supports are defined through sets.
The correlation models employed here refer to the correlation matrix that is created after transforming the field marginal CDF to standard normal space.
Constructor & Destructor Documentation
◆ ExternalRandomFieldModel()
| ExternalRandomFieldModel | ( | string | the_quantity_ident, |
| DataObjectVector | the_shapes | ||
| ) |
default constructor
- Parameters
-
the_quantity_ident sets quantity_ident
Member Function Documentation
◆ check()
| check | ( | Structure | database | ) |
checks the settings on plausibility
It throws an exception if there is a problem with the settings. Important: It tries to find out all problems with these settings and then exits the routine.
- Parameters
-
database the SoS structure
◆ compute()
| compute | ( | Structure | database | ) |
does the action
- Parameters
-
database the database where all data is stored into