distributionModel Class Reference

Inheritance diagram for distributionModel:

Collaboration diagram for distributionModel:

Public Member Functions
	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 autoPtr< distributionModel >	clone () const =0
	Construct and return a clone. More...
virtual	~distributionModel ()
	Destructor. More...
virtual scalar	sample () const =0
	Sample the distributionModel. More...
virtual scalar	minValue () const =0
	Return the minimum value. More...
virtual scalar	maxValue () const =0
	Return the maximum value. More...
virtual scalar	meanValue () const =0
	Return the maximum value. More...

Static Public Member Functions
static autoPtr< distributionModel >	New (const dictionary &dict, cachedRandom &rndGen)
	Selector. More...

Protected Member Functions
virtual void	check () const
	Check that the distribution model is valid. More...

Protected Attributes
const dictionary	distributionModelDict_
	Coefficients dictionary. More...
cachedRandom &	rndGen_
	Reference to the random number generator. More...

Detailed Description

Definition at line 69 of file distributionModel.H.

Constructor & Destructor Documentation

distributionModel() [1/2]

distributionModel	(	const word &	name,
		const dictionary &	dict,
		cachedRandom &	rndGen
	)

Construct from dictionary.

Definition at line 73 of file distributionModel.C.

distributionModel() [2/2]

distributionModel

(

const distributionModel &

p

)

Construct copy.

Definition at line 85 of file distributionModel.C.

~distributionModel()

~distributionModel ( )

virtual

Destructor.

Definition at line 96 of file distributionModel.C.

Member Function Documentation

check()

void check ( ) const

protectedvirtual

Check that the distribution model is valid.

Definition at line 49 of file distributionModel.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, distributionModel::maxValue(), distributionModel::minValue(), Foam::nl, and Foam::type().

Here is the call graph for this function:

TypeName()

TypeName

(

"distributionModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		distributionModel	,
		dictionary	,
		(const dictionary &dict, cachedRandom &rndGen)	,
		(dict, rndGen)
	)

Declare runtime constructor selection table.

clone()

virtual autoPtr<distributionModel> clone ( ) const

pure virtual

Construct and return a clone.

Implemented in multiNormal, normal, RosinRammler, general, exponential, uniform, and fixedValue.

New()

Foam::autoPtr< Foam::distributionModels::distributionModel > New ( const dictionary &  dict, cachedRandom &  rndGen  )

static

Selector.

Definition at line 32 of file distributionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::nl, and rndGen().

Here is the call graph for this function:

sample()

virtual scalar sample ( ) const

pure virtual

Sample the distributionModel.

Implemented in multiNormal, normal, RosinRammler, general, exponential, uniform, and fixedValue.

minValue()

virtual scalar minValue ( ) const

pure virtual

Return the minimum value.

Implemented in multiNormal, normal, RosinRammler, general, exponential, uniform, and fixedValue.

Referenced by distributionModel::check().

Here is the caller graph for this function:

maxValue()

virtual scalar maxValue ( ) const

pure virtual

Return the maximum value.

Implemented in multiNormal, normal, RosinRammler, general, exponential, uniform, and fixedValue.

Referenced by distributionModel::check().

Here is the caller graph for this function:

meanValue()

virtual scalar meanValue ( ) const

pure virtual

Return the maximum value.

Implemented in multiNormal, normal, RosinRammler, general, exponential, uniform, and fixedValue.

Field Documentation

distributionModelDict_

const dictionary distributionModelDict_

protected

Coefficients dictionary.

Definition at line 77 of file distributionModel.H.

rndGen_

cachedRandom& rndGen_

protected

Reference to the random number generator.

Definition at line 80 of file distributionModel.H.

---

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

• src/lagrangian/distributionModels/distributionModel/distributionModel.H
• src/lagrangian/distributionModels/distributionModel/distributionModel.C
• src/lagrangian/distributionModels/distributionModel/distributionModelNew.C