bdm::GaussianBand Class Reference

#include <substance_initializers.h>

Public Member Functions
	GaussianBand (real_t mean, real_t sigma, uint8_t axis, real_t scaling=1.0)
	The constructor. More...
real_t	operator() (real_t x, real_t y, real_t z)
	The model that we want to apply for substance initialization. The operator is called for the entire space. More...

Private Attributes
real_t	scaling_
real_t	mean_
real_t	sigma_
uint8_t	axis_

Detailed Description

An initializer that follows a Gaussian (normal) distribution along one axis We use ROOT's built-in statistics function normal_pdf(X, sigma, mean), that follows the normal probability density function: ( 1/( sigma * sqrt(2*pi) ))*e^( (-(x - mean )^2) / (2*sigma^2))

Definition at line 83 of file substance_initializers.h.

Constructor & Destructor Documentation

GaussianBand()

bdm::GaussianBand::GaussianBand ( real_t  mean, real_t  sigma, uint8_t  axis, real_t  scaling = 1.0  )

inline

The constructor.

Parameters

[in]	mean	The mean of the Gaussian distribution (should be a value within the range of the chosen axis)
[in]	sigma	The sigma of the Gaussian distribution
[in]	axis	The axis along which you want the Gaussian distribution to be oriented to
[in]	scaling	The scaling factor

Definition at line 94 of file substance_initializers.h.

Member Function Documentation

operator()()

real_t bdm::GaussianBand::operator() ( real_t  x, real_t  y, real_t  z  )

inline

The model that we want to apply for substance initialization. The operator is called for the entire space.

Parameters

[in]	x	The x coordinate
[in]	y	The y coordinate
[in]	z	The z coordinate

Definition at line 108 of file substance_initializers.h.

Member Data Documentation

axis_

uint8_t bdm::GaussianBand::axis_

private

Definition at line 126 of file substance_initializers.h.

mean_

real_t bdm::GaussianBand::mean_

private

Definition at line 124 of file substance_initializers.h.

scaling_

real_t bdm::GaussianBand::scaling_

private

Definition at line 123 of file substance_initializers.h.

sigma_

real_t bdm::GaussianBand::sigma_

private

Definition at line 125 of file substance_initializers.h.

---

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

• core/substance_initializers.h