exponential Class Reference

Inheritance diagram for exponential:

Collaboration diagram for exponential:

Public Member Functions
	TypeName ("exponential")
	Runtime type information. More...
	exponential (const dictionary &dict, cachedRandom &rndGen)
	Construct from components. More...
	exponential (const exponential &p)
	Construct copy. More...
virtual autoPtr< distributionModel >	clone () const
	Construct and return a clone. More...
virtual	~exponential ()
	Destructor. More...
virtual scalar	sample () const
	Sample the distributionModel. More...
virtual scalar	minValue () const
	Return the minimum value. More...
virtual scalar	maxValue () const
	Return the maximum value. More...
virtual scalar	meanValue () const
	Return the mean value. More...
Public Member Functions inherited from distributionModel
	TypeName ("distributionModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, cachedRandom &rndGen),(dict, rndGen))
	Declare runtime constructor selection table. More...
	distributionModel (const word &name, const dictionary &dict, cachedRandom &rndGen)
	Construct from dictionary. More...
	distributionModel (const distributionModel &p)
	Construct copy. More...
virtual	~distributionModel ()
	Destructor. More...

Private Attributes
scalar	minValue_
	Distribution minimum. More...
scalar	maxValue_
	Distribution maximum. More...
scalar	lambda_

Additional Inherited Members
Static Public Member Functions inherited from distributionModel
static autoPtr< distributionModel >	New (const dictionary &dict, cachedRandom &rndGen)
	Selector. More...
Protected Member Functions inherited from distributionModel
virtual void	check () const
	Check that the distribution model is valid. More...
Protected Attributes inherited from distributionModel
const dictionary	distributionModelDict_
	Coefficients dictionary. More...
cachedRandom &	rndGen_
	Reference to the random number generator. More...

Detailed Description

Definition at line 50 of file exponential.H.

Constructor & Destructor Documentation

exponential() [1/2]

exponential	(	const dictionary &	dict,
		cachedRandom &	rndGen
	)

Construct from components.

Definition at line 43 of file exponential.C.

Referenced by exponential::clone().

Here is the caller graph for this function:

exponential() [2/2]

exponential

(

const exponential &

p

)

Construct copy.

Definition at line 57 of file exponential.C.

~exponential()

~exponential ( )

virtual

Destructor.

Definition at line 68 of file exponential.C.

Member Function Documentation

TypeName()

TypeName

(

"exponential"

)

Runtime type information.

clone()

virtual autoPtr<distributionModel> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 83 of file exponential.H.

References exponential::exponential().

Here is the call graph for this function:

sample()

Foam::scalar sample ( ) const

virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 74 of file exponential.C.

References Foam::exp(), Foam::log(), and y.

Here is the call graph for this function:

minValue()

Foam::scalar minValue ( ) const

virtual

Return the minimum value.

Implements distributionModel.

Definition at line 82 of file exponential.C.

maxValue()

Foam::scalar maxValue ( ) const

virtual

Return the maximum value.

Implements distributionModel.

Definition at line 88 of file exponential.C.

meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the mean value.

Implements distributionModel.

Definition at line 94 of file exponential.C.

Field Documentation

minValue_

scalar minValue_

private

Distribution minimum.

Definition at line 57 of file exponential.H.

maxValue_

scalar maxValue_

private

Distribution maximum.

Definition at line 60 of file exponential.H.

lambda_

scalar lambda_

private

Definition at line 65 of file exponential.H.

---

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

• src/lagrangian/distributionModels/exponential/exponential.H
• src/lagrangian/distributionModels/exponential/exponential.C