RandGenerator Class Reference

#include <RandGenerator.h>

Inheritance diagram for RandGenerator:
Inheritance graph
[legend]
Collaboration diagram for RandGenerator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 RandGenerator ()
virtual ~RandGenerator ()
double getMean () const
double getVariance () const
double getSample () const
void process (const Eref &e, ProcPtr info)
void reinit (const Eref &e, ProcPtr info)
virtual void vReinit (const Eref &e, ProcPtr info)

Static Public Member Functions

static const CinfoinitCinfo ()

Protected Attributes

Probabilityrng_
double sample_

Detailed Description

This class is a moose interface to underlying random number generators (which is an instance of Probability class).


Constructor & Destructor Documentation

RandGenerator::RandGenerator (  ) 

References rng_, and sample_.

RandGenerator::~RandGenerator (  )  [virtual]

References rng_.


Member Function Documentation

double RandGenerator::getMean (  )  const

Reimplemented in ExponentialRng.

References Probability::getMean(), and rng_.

Referenced by initCinfo(), PoissonRng::initCinfo(), and NormalRng::initCinfo().

Here is the call graph for this function:

double RandGenerator::getSample (  )  const

References sample_.

Referenced by initCinfo().

double RandGenerator::getVariance (  )  const

References Probability::getVariance(), and rng_.

Referenced by initCinfo(), and NormalRng::initCinfo().

Here is the call graph for this function:

const Cinfo * RandGenerator::initCinfo (  )  [static]
void RandGenerator::process ( const Eref e,
ProcPtr  info 
)

References Probability::getNextSample(), rng_, and sample_.

Referenced by initCinfo().

Here is the call graph for this function:

void RandGenerator::reinit ( const Eref e,
ProcPtr  info 
)

References vReinit().

Referenced by initCinfo().

Here is the call graph for this function:

void RandGenerator::vReinit ( const Eref e,
ProcPtr  info 
) [virtual]

Reimplemented in BinomialRng, ExponentialRng, GammaRng, NormalRng, PoissonRng, and UniformRng.

References Eref::id(), and Id::path().

Referenced by reinit().

Here is the call graph for this function:


Member Data Documentation

double RandGenerator::sample_ [protected]

Referenced by getSample(), process(), and RandGenerator().


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

Generated on 1 Jul 2015 for MOOSE by  doxygen 1.6.1