general Class Reference

Inheritance diagram for general:

Collaboration diagram for general:

Public Member Functions
	TypeName ("general")
	Runtime type information. More...
	general (const dictionary &dict, cachedRandom &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 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 Types
typedef VectorSpace< Vector< scalar >, scalar, 2 >	pair

Private Attributes
List< pair >	xy_
label	nEntries_
scalar	minValue_
	Min and max values of the distribution. More...
scalar	maxValue_
scalar	meanValue_
List< scalar >	integral_

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 52 of file general.H.

Member Typedef Documentation

pair

typedef VectorSpace<Vector<scalar>, scalar, 2> pair

private

Definition at line 58 of file general.H.

Constructor & Destructor Documentation

general() [1/2]

general	(	const dictionary &	dict,
		cachedRandom &	rndGen
	)

Construct from components.

Definition at line 43 of file general.C.

References k, Foam::y0(), and Foam::y1().

Referenced by general::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

general() [2/2]

general

(

const general &

p

)

Construct copy.

Definition at line 86 of file general.C.

~general()

~general ( )

virtual

Destructor.

Definition at line 99 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 88 of file general.H.

References general::general().

Here is the call graph for this function:

sample()

Foam::scalar sample ( ) const

virtual

Sample the distributionModel.

Implements distributionModel.

Definition at line 105 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 149 of file general.C.

maxValue()

Foam::scalar maxValue ( ) const

virtual

Return the maximum value.

Implements distributionModel.

Definition at line 155 of file general.C.

meanValue()

Foam::scalar meanValue ( ) const

virtual

Return the mean value.

Implements distributionModel.

Definition at line 161 of file general.C.

Field Documentation

xy_

List<pair> xy_

private

Definition at line 60 of file general.H.

nEntries_

label nEntries_

private

Definition at line 62 of file general.H.

minValue_

scalar minValue_

private

Min and max values of the distribution.

Definition at line 65 of file general.H.

maxValue_

scalar maxValue_

private

Definition at line 66 of file general.H.

meanValue_

scalar meanValue_

private

Definition at line 68 of file general.H.

integral_

List<scalar> integral_

private

Definition at line 70 of file general.H.

---

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

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