randGauss

randGauss

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Creates a random sequence distributed according to the Gaussian probability density function:

\[f\left(x\right) = \frac{1}{\sigma \sqrt{2 \pi}} \exp\left[- \frac{\left(x-\mu\right)^2}{2 \sigma^2}\right]\]

where \(\mu \in \mathbb{R}\) is the mean and \(\sigma > 0\) is the standard deviation.

randGauss Parameters

sigma (float)

The standard deviation.

mean (float)

The mean.

seed (integer)

Random number seed.

numberSequence (code block, optional)

The <NAFunc numberSequence> is an NAFunc code block that generates a random number; if not specified, Vorpal’s default random number generator (uniform in [0,1)) will be used to generate the initial random number.

Example randGauss Block

<NAFunc velocitySequence_0>
  kind = randGauss
  mean = 0.0
  sigma = 1.0e6
</NAFunc>