#include <UniformGridRandomFieldGenerator.hpp>

Inheritance diagram for UniformGridRandomFieldGenerator< SPACE_DIM >:

Collaboration diagram for UniformGridRandomFieldGenerator< SPACE_DIM >:

Public Member Functions
	UniformGridRandomFieldGenerator (std::array< double, SPACE_DIM > lowerCorner, std::array< double, SPACE_DIM > upperCorner, std::array< unsigned, SPACE_DIM > numGridPts, std::array< bool, SPACE_DIM > periodicity, double lengthScale)

std::vector< double >	SampleRandomField ()

std::vector< double >	SampleRandomFieldAtTime (double time)

double	Interpolate (const std::vector< double > &rRandomField, const c_vector< double, SPACE_DIM > &rLocation) const

void	SetRandomSeed (const unsigned seed)

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)

long	GetLinearIndex (std::array< long, SPACE_DIM > gridIndex) const

std::array< double, SPACE_DIM >	GetPositionUsingGridIndex (std::array< long, SPACE_DIM > gridIndex) const

Private Attributes
std::array< double, SPACE_DIM >	mLowerCorner

std::array< double, SPACE_DIM >	mUpperCorner

std::array< unsigned, SPACE_DIM >	mNumGridPts

std::array< bool, SPACE_DIM >	mPeriodicity

double	mLengthScale

unsigned	mNumTotalGridPts

std::array< double, SPACE_DIM >	mGridSpacing

std::array< double, SPACE_DIM >	mOneOverGridSpacing

const std::string	mCacheDir

unsigned	mNumEigenvals

OpenSimplex2S	mOpenSimplex

Friends
class	boost::serialization::access

class	TestSamplesFromCachedRandomField

class	TestUniformGridRandomFieldGenerator

Detailed Description

template<unsigned SPACE_DIM>
class UniformGridRandomFieldGenerator< SPACE_DIM >

A UniformGridRandomFieldGenerator for adding spatially-correlated noise to a mesh.

Definition at line 51 of file UniformGridRandomFieldGenerator.hpp.

Constructor & Destructor Documentation

◆ UniformGridRandomFieldGenerator()

template<unsigned SPACE_DIM>

UniformGridRandomFieldGenerator< SPACE_DIM >::UniformGridRandomFieldGenerator	(	std::array< double, SPACE_DIM >	lowerCorner,
		std::array< double, SPACE_DIM >	upperCorner,
		std::array< unsigned, SPACE_DIM >	numGridPts,
		std::array< bool, SPACE_DIM >	periodicity,
		double	lengthScale
	)

Constructor that takes all parameters as arguments.

Parameters

lowerCorner	the lower corner of the rectangular grid
upperCorner	the upper corner of the rectangular grid
numGridPts	the number of grid points in each dimension
periodicity	whether the grid is periodic in each dimension
lengthScale	the length scale of the correlation when calculating the covariance matrix

Definition at line 51 of file UniformGridRandomFieldGenerator.cpp.

Member Function Documentation

◆ GetLinearIndex()

template<unsigned SPACE_DIM>

long UniformGridRandomFieldGenerator< SPACE_DIM >::GetLinearIndex ( std::array< long, SPACE_DIM > gridIndex ) const

private

Helper method for Interpolate(). Get the linear index (along the flat vector representing a random field instance) given the grid index (x,y,z).

Parameters

gridIndex the (x,y,z) coordinate to translate into a linear index

Returns: the linear index along the flat vector representing the (x,y,z) grid coordinate

Definition at line 289 of file UniformGridRandomFieldGenerator.cpp.

References NEVER_REACHED.

◆ GetPositionUsingGridIndex()

template<unsigned SPACE_DIM>

std::array< double, SPACE_DIM > UniformGridRandomFieldGenerator< SPACE_DIM >::GetPositionUsingGridIndex ( std::array< long, SPACE_DIM > gridIndex ) const

private

Helper method for Interpolate(). Get the position in space of the grid point with (x,y,z) grid index gridIndex.

Parameters

gridIndex the (x,y,z) coordinate to calculate the position of

Returns: the position in space of the (x,y,z) coordinate

Definition at line 321 of file UniformGridRandomFieldGenerator.cpp.

◆ Interpolate()

template<unsigned SPACE_DIM>

double UniformGridRandomFieldGenerator< SPACE_DIM >::Interpolate	(	const std::vector< double > &	rRandomField,
		const c_vector< double, SPACE_DIM > &	rLocation
	)		const

Interpolate from the random field by returning the value at the node of the random field closest to the given location.

Parameters

rRandomField	the random field, assumed obtained from SampleRandomField()
rLocation	the location to which we identify the value at the closest node in the random field