#include <OffLatticeRandomFieldGenerator.hpp>

Collaboration diagram for OffLatticeRandomFieldGenerator< SPACE_DIM >:

Public Member Functions
	OffLatticeRandomFieldGenerator (std::array< double, SPACE_DIM > lowerCorner, std::array< double, SPACE_DIM > upperCorner, std::array< bool, SPACE_DIM > periodicity, double lengthScale, double boxWidth=DOUBLE_UNSET)

virtual	~OffLatticeRandomFieldGenerator ()=default

std::vector< double >	SampleRandomField (const std::vector< Node< SPACE_DIM > * > &rNodes)

std::vector< double >	SampleRandomFieldAtTime (const std::vector< Node< SPACE_DIM > * > &rNodes, double time)

void	SetRandomSeed (const unsigned seed)

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

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

std::array< double, SPACE_DIM >	mUpperCorner

std::array< bool, SPACE_DIM >	mPeriodicity

double	mLengthScale

std::unique_ptr< ObsoleteBoxCollection< SPACE_DIM > >	mpBoxCollection

unsigned	mNumNodesAtLastUpdate

OpenSimplex2S	mOpenSimplex

Friends
class	boost::serialization::access

class	TestOffLatticeRandomFieldGenerator

Detailed Description

template<unsigned SPACE_DIM>
class OffLatticeRandomFieldGenerator< SPACE_DIM >

An OffLatticeRandomFieldGenerator for adding spatially-correlated noise to a mesh with off-lattice nodes.

Definition at line 54 of file OffLatticeRandomFieldGenerator.hpp.

Constructor & Destructor Documentation

◆ OffLatticeRandomFieldGenerator()

template<unsigned SPACE_DIM>

OffLatticeRandomFieldGenerator< SPACE_DIM >::OffLatticeRandomFieldGenerator	(	std::array< double, SPACE_DIM >	lowerCorner,
		std::array< double, SPACE_DIM >	upperCorner,
		std::array< bool, SPACE_DIM >	periodicity,
		double	lengthScale,
		double	boxWidth = `DOUBLE_UNSET`
	)

Constructor that takes all parameters as arguments, and sets up an appropriate box collection.

Parameters

lowerCorner	the lower corner of the rectangular grid
upperCorner	the upper corner of the rectangular grid
periodicity	whether the grid is periodic in each dimension
lengthScale	the length scale of the correlation when calculating the covariance matrix
boxWidth	the box size for the box collection. Defaults to DOUBLE_UNSET in which case it is reset appropriately.

Todo:: : Obsolete box collection should take a std::array<bool, DIM>

Definition at line 49 of file OffLatticeRandomFieldGenerator.cpp.

References DOUBLE_UNSET, OffLatticeRandomFieldGenerator< SPACE_DIM >::mOpenSimplex, and OffLatticeRandomFieldGenerator< SPACE_DIM >::mpBoxCollection.

◆ ~OffLatticeRandomFieldGenerator()

template<unsigned SPACE_DIM>

virtual OffLatticeRandomFieldGenerator< SPACE_DIM >::~OffLatticeRandomFieldGenerator ( )

virtualdefault

Default constructor.

Member Function Documentation

◆ SampleRandomField()

template<unsigned SPACE_DIM>

std::vector< double > OffLatticeRandomFieldGenerator< SPACE_DIM >::SampleRandomField ( const std::vector< Node< SPACE_DIM > * > & rNodes )

Sample an instance of the random field.

Calls SampleRandomFieldAtTime() at a time chosen uniformly at random from 0 to 100 * lengthScale.

Parameters

rNodes a vector of nodes at which to sample the random field

Returns: A vector representing an instance of the random field.

Definition at line 101 of file OffLatticeRandomFieldGenerator.cpp.

References RandomNumberGenerator::Instance().

◆ SampleRandomFieldAtTime()

template<unsigned SPACE_DIM>

std::vector< double > OffLatticeRandomFieldGenerator< SPACE_DIM >::SampleRandomFieldAtTime	(	const std::vector< Node< SPACE_DIM > * > &	rNodes,
		double	time
	)

Sample an instance of the random field at a given time. First, draw mNumTotalGridPts random numbers from N(0,1), and then create an appropriate linear combination of the eigenvectors.

Parameters