Public Member Functions | List of all members
fixedValue Class Reference

Returns a fixed value. More...

Inheritance diagram for fixedValue:
Inheritance graph
[legend]
Collaboration diagram for fixedValue:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("fixedValue")
 Runtime type information. More...
 
 fixedValue (const dictionary &dict, Random &rndGen)
 Construct from components. More...
 
 fixedValue (const fixedValue &p)
 Construct copy. More...
 
virtual autoPtr< distributionModelclone () const
 Construct and return a clone. More...
 
virtual ~fixedValue ()
 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, 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< distributionModelNew (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...
 
RandomrndGen_
 Reference to the random number generator. More...
 

Detailed Description

Returns a fixed value.

Source files

Definition at line 49 of file fixedValue.H.

Constructor & Destructor Documentation

◆ fixedValue() [1/2]

fixedValue ( const dictionary dict,
Random rndGen 
)

Construct from components.

Definition at line 43 of file fixedValue.C.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

◆ fixedValue() [2/2]

fixedValue ( const fixedValue p)

Construct copy.

Definition at line 53 of file fixedValue.C.

◆ ~fixedValue()

~fixedValue ( )
virtual

Destructor.

Definition at line 62 of file fixedValue.C.

References maxValue, and minValue.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue"  )

Runtime type information.

◆ clone()

virtual autoPtr<distributionModel> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements distributionModel.

Definition at line 74 of file fixedValue.H.

References fixedValue::fixedValue(), fixedValue::maxValue(), fixedValue::meanValue(), fixedValue::minValue(), fixedValue::sample(), and fixedValue::~fixedValue().

Here is the call graph for this function:

◆ sample()

virtual scalar sample ( ) const
virtual

Sample the distributionModel.

Implements distributionModel.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

◆ minValue()

virtual scalar minValue ( ) const
virtual

Return the minimum value.

Implements distributionModel.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

◆ maxValue()

virtual scalar maxValue ( ) const
virtual

Return the maximum value.

Implements distributionModel.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

◆ meanValue()

virtual scalar meanValue ( ) const
virtual

Return the mean value.

Implements distributionModel.

Referenced by fixedValue::clone().

Here is the caller graph for this function:

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