autopasTools::generators::GaussianGenerator Namespace Reference

Generator class for gaussian distributions. More...

Functions
template<class Container >
void	fillWithParticles (Container &container, const std::array< double, 3 > &boxMin, const std::array< double, 3 > &boxMax, size_t numParticles, const typename autopas::utils::ParticleTypeTrait< Container >::value &defaultParticle=typename autopas::utils::ParticleTypeTrait< Container >::value(), const std::array< double, 3 > &distributionMean={5., 5., 5.}, const std::array< double, 3 > &distributionStdDev={2., 2., 2.})
	Fills any container (also AutoPas object) with randomly 3D gaussian distributed particles.

Variables
constexpr size_t	_maxAttempts = 100
	Maximum number of attempts the random generator gets to find a valid position before considering the input to be bad.

Detailed Description

Generator class for gaussian distributions.

Function Documentation

fillWithParticles()

template<class Container >

void autopasTools::generators::GaussianGenerator::fillWithParticles	(	Container &	container,
		const std::array< double, 3 > &	boxMin,
		const std::array< double, 3 > &	boxMax,
		size_t	numParticles,
		const typename autopas::utils::ParticleTypeTrait< Container >::value &	defaultParticle = typename autopas::utils::ParticleTypeTrait<Container>::value(),
		const std::array< double, 3 > &	distributionMean = {5., 5., 5.},
		const std::array< double, 3 > &	distributionStdDev = {2., 2., 2.}
	)

Fills any container (also AutoPas object) with randomly 3D gaussian distributed particles.

Particle properties will be used from the default particle. Particle IDs start from the default particle.

Template Parameters

Container

Arbitrary container class. Needs to support addParticle().

Parameters

container
boxMin
boxMax
numParticles	number of particles
defaultParticle	inserted particle
distributionMean	mean value / expected value. Mean is relative to boxMin.
distributionStdDev	standard deviation