distributionModel Class Reference

A library of runtime-selectable doubly-truncated probability distribution models. Returns random samples based on given distribution parameters. More...

Inheritance diagram for distributionModel:

Collaboration diagram for distributionModel:

Public Member Functions
	TypeName ("distributionModel")
	declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen))
	distributionModel (const word &name, const dictionary &dict, Random &rndGen)
	distributionModel (const distributionModel &p)
virtual autoPtr< distributionModel >	clone () const =0
virtual	~distributionModel ()=default
virtual scalar	sample () const =0
virtual scalar	minValue () const
virtual scalar	maxValue () const
virtual scalar	meanValue () const =0

Static Public Member Functions
static autoPtr< distributionModel >	New (const dictionary &dict, Random &rndGen)

Protected Member Functions
virtual void	check () const

Protected Attributes
const dictionary	distributionModelDict_
Random &	rndGen_
scalar	minValue_
scalar	maxValue_

Detailed Description

A library of runtime-selectable doubly-truncated probability distribution models. Returns random samples based on given distribution parameters.

Available distribution models include:

• binned
• exponential
• fixedValue
• general
• multi-normal
• normal
• Rosin-Rammler
• Mass-based Rosin-Rammler
• uniform

Source files

• distributionModel.H
• distributionModel.C
• distributionModelNew.C

Definition at line 69 of file distributionModel.H.

Constructor & Destructor Documentation

distributionModel() [1/2]

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

Definition at line 71 of file distributionModel.C.

distributionModel() [2/2]

distributionModel

(

const distributionModel &

p

)

Definition at line 85 of file distributionModel.C.

~distributionModel()

virtual ~distributionModel ( )

virtualdefault

Member Function Documentation

check()

void check ( ) const

protectedvirtual

Definition at line 35 of file distributionModel.C.

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

Here is the call graph for this function:

TypeName()

TypeName

(

"distributionModel"

)

declareRunTimeSelectionTable()

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

clone()

virtual autoPtr<distributionModel> clone ( ) const

pure virtual

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

New()

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

static

Definition at line 27 of file distributionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and rndGen.

Here is the call graph for this function:

sample()

virtual scalar sample ( ) const

pure virtual

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

minValue()

Foam::scalar minValue ( ) const

virtual

Reimplemented in fixedValue.

Definition at line 98 of file distributionModel.C.

Referenced by distributionModel::check().

Here is the caller graph for this function:

maxValue()

Foam::scalar maxValue ( ) const

virtual

Reimplemented in fixedValue.

Definition at line 104 of file distributionModel.C.

Referenced by distributionModel::check().

Here is the caller graph for this function:

meanValue()

virtual scalar meanValue ( ) const

pure virtual

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

Member Data Documentation

distributionModelDict_

const dictionary distributionModelDict_

protected

Definition at line 76 of file distributionModel.H.

rndGen_

Random& rndGen_

protected

Definition at line 79 of file distributionModel.H.

Referenced by massRosinRammler::sample().

minValue_

scalar minValue_

protected

Definition at line 82 of file distributionModel.H.

Referenced by massRosinRammler::sample().

maxValue_

scalar maxValue_

protected

Definition at line 85 of file distributionModel.H.

Referenced by massRosinRammler::sample().

---

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