GammaRng Class Reference

#include <GammaRng.h>

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

List of all members.

Public Member Functions

 GammaRng ()
virtual ~GammaRng ()
double getAlpha () const
double getTheta () const
void setAlpha (double alpha)
void setTheta (double theta)
virtual void vReinit (const Eref &e, ProcPtr p)

Static Public Member Functions

static const CinfoinitCinfo ()

Detailed Description

This is MOOSE wrapper for Gammaly distributed random number generator class, Gamma. The default


Constructor & Destructor Documentation

GammaRng::GammaRng (  ) 
virtual GammaRng::~GammaRng (  )  [inline, virtual]

Member Function Documentation

double GammaRng::getAlpha (  )  const

returns the shape parameter.

Referenced by initCinfo().

double GammaRng::getTheta (  )  const

returns the scale parameter.

Referenced by initCinfo().

const Cinfo * GammaRng::initCinfo (  )  [static]

Reimplemented from RandGenerator.

References getAlpha(), getTheta(), RandGenerator::initCinfo(), setAlpha(), and setTheta().

Here is the call graph for this function:

void GammaRng::setAlpha ( double  alpha  ) 

Sets parameter alpha. Also known as the shape parameter.

References Gamma::getAlpha(), and RandGenerator::rng_.

Referenced by initCinfo().

Here is the call graph for this function:

void GammaRng::setTheta ( double  theta  ) 

Sets parameter theta. Also known as the scale parameter.

References Gamma::getTheta(), and RandGenerator::rng_.

Referenced by initCinfo().

Here is the call graph for this function:

void GammaRng::vReinit ( const Eref e,
ProcPtr  p 
) [virtual]

reports error if parameters have not been set properly.

Reimplemented from RandGenerator.

References RandGenerator::rng_.


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

Generated on 1 Jul 2015 for MOOSE by  doxygen 1.6.1