general Class Reference

general distribution model More...

Inheritance diagram for general:

Collaboration diagram for general:

Public Member Functions
	TypeName ("general")
	Runtime type information. More...
	general (const dictionary &dict, Random &rndGen)
	Construct from components. More...
	general (const UList< scalar > &sampleData, const scalar binWidth, Random &rndGen)
	Construct from components. More...
	general (const general &p)
	Construct copy. More...
virtual autoPtr< distributionModel >	clone () const
	Construct and return a clone. More...
virtual	~general ()
	Destructor. More...
virtual tmp< Field< scalar > >	x () const
	Bin boundaries. More...
virtual tmp< Field< scalar > >	y () const
	Probabilities. 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...
virtual void	writeData (Ostream &os) const
	Write data to stream. More...
virtual void	readData (Istream &os)
	Read data from stream. More...
virtual dictionary	writeDict (const word &dictName) const
	Write data in dictionary format. More...
virtual void	readDict (const dictionary &dict)
	Read data from dictionary. More...
Public Member Functions inherited from distributionModel
	TypeName ("distributionModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, distributionModel, dictionary,(const dictionary &dict, Random &rndGen),(dict, rndGen))
	Declare runtime constructor selection table. More...
	distributionModel (const word &name, const dictionary &dict, Random &rndGen)
	Construct from dictionary. More...
	distributionModel (const distributionModel &p)
	Construct copy. More...
virtual	~distributionModel ()
	Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from distributionModel
static autoPtr< distributionModel >	New (const dictionary &dict, Random &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...
Random &	rndGen_
	Reference to the random number generator. More...

Detailed Description

general distribution model

Source files

• general.H
• general.C

Definition at line 70 of file general.H.

Constructor & Destructor Documentation

general() [1/3]

general	(	const dictionary &	dict,
		Random &	rndGen
	)

Construct from components.

Definition at line 82 of file general.C.

Referenced by general::clone().

Here is the caller graph for this function:

general() [2/3]

general	(	const UList< scalar > &	sampleData,
		const scalar	binWidth,
		Random &	rndGen
	)

Construct from components.

Definition at line 99 of file general.C.

References Foam::endl(), forAll, Foam::max(), maxValue, Foam::min(), minValue, Foam::nl, and WarningInFunction.

Here is the call graph for this function:

general() [3/3]

general

(

const general &

p

)

Construct copy.

Definition at line 153 of file general.C.

~general()

~general ( )

virtual

Destructor.

Definition at line 164 of file general.C.

Member Function Documentation

TypeName()

TypeName

(

"general"

)

Runtime type information.

clone()

virtual autoPtr<distributionModel> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 115 of file general.H.

References general::general().

Here is the call graph for this function:

x()

Foam::tmp< Foam::Field< Foam::scalar > > x ( ) const

virtual

Bin boundaries.

Definition at line 279 of file general.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

y()

Foam::tmp< Foam::Field< Foam::scalar > > y ( ) const

virtual

Probabilities.

Definition at line 293 of file general.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

sample()

Foam::scalar sample ( ) const

virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 170 of file general.C.

References Foam::constant::atomic::alpha, k, Foam::mag(), n, p, Foam::sqrt(), x, 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 214 of file general.C.

maxValue()

Foam::scalar maxValue ( ) const

virtual

Return the maximum value.

Implements distributionModel.

Definition at line 220 of file general.C.

meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the mean value.

Implements distributionModel.

Definition at line 226 of file general.C.

writeData()

void writeData ( Ostream &  os ) const

virtual

Write data to stream.

Definition at line 240 of file general.C.

readData()

void readData ( Istream &  os )

virtual

Read data from stream.

Definition at line 232 of file general.C.

writeDict()

Foam::dictionary writeDict ( const word &  dictName ) const

virtual

Write data in dictionary format.

Definition at line 248 of file general.C.

References dict, dictName(), x, and y.

Referenced by InjectedParticleDistributionInjection< CloudType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

readDict()

void readDict ( const dictionary &  dict )

virtual

Read data from dictionary.

Definition at line 261 of file general.C.

References dict, forAll, x, and y.

---

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

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