Distribution which always takes a specified fixed value. More...

Inheritance diagram for fixedValue:

Collaboration diagram for fixedValue:

Public Member Functions
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValue (const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen)
	Construct from a dictionary. More...

	fixedValue (const fixedValue &d, const label sampleQ)
	Construct copy. More...

virtual autoPtr< distribution >	clone (const label sampleQ) const
	Construct and return a clone. More...

virtual	~fixedValue ()
	Destructor. More...

virtual scalar	sample () const
	Sample the distribution. More...

virtual scalar	min () const
	Return the minimum value. More...

virtual scalar	max () const
	Return the maximum value. More...

virtual scalar	mean () const
	Return the mean value. More...

virtual tmp< scalarField >	integralPDFxPow (const scalarField &x, const label e, const bool consistent=false) const
	Return the integral of the PDF multiplied by an integer power of x. More...

virtual void	write (Ostream &os, const unitConversion &units) const
	Write to a stream. More...

virtual tmp< scalarField >	plotX (const label n) const
	Return coordinates to plot across the range of the distribution. More...

virtual tmp< scalarField >	plotPDF (const scalarField &x) const
	Return values to plot the probability density function. More...

Public Member Functions inherited from FieldDistribution< distribution, fixedValue >
Type	sample () const
	Sample the distribution into components of a primitive type. More...

virtual tmp< scalarField >	sample (const label n) const
	Sample the distribution into a field. More...

Public Member Functions inherited from distribution
	TypeName ("distribution")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, distribution, dictionary,(const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen),(units, dict, sampleQ, std::move(rndGen)))
	Declare runtime constructor selection table. More...

	distribution (const word &name, const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen)
	Construct from dictionary. More...

	distribution (const label Q, const label sampleQ, randomGenerator &&rndGen)
	Construct from components. More...

	distribution (const distribution &d, const label sampleQ)
	Construct copy. More...

autoPtr< distribution >	clone () const
	Construct and return a clone. More...

virtual	~distribution ()
	Destructor. More...

label	sampleQ () const
	Access the sample size exponent. More...

void	start (const bool repeat) const
	Start a sequence of samples. Either a new sequence, or a. More...

template<class Type >
Type	sample () const
	Sample the distribution into components of a primitive type. More...

virtual tmp< scalarField >	CDF (const scalarField &x) const
	Return the cumulative density function at the given coordinates. More...

virtual void	writeState (Ostream &os) const
	Write the state to a stream. More...

Additional Inherited Members
Static Public Member Functions inherited from distribution
static autoPtr< distribution >	New (const unitConversion &units, const dictionary &dict, const label sampleQ, randomGenerator &&rndGen, const bool report=true)
	Select from dictionary and a random generator. More...

static autoPtr< distribution >	New (const unitConversion &units, const dictionary &dict, const label sampleQ, const randomGenerator::seed &s, const bool global=false, const bool report=true)
	Select from a dictionary and a random generator seed and global flag. More...

static autoPtr< distribution >	New (autoPtr< distribution > &dPtr, const label sampleQ)
	Re-select with a different sample size exponent. More...

Protected Member Functions inherited from FieldDistribution< distribution, fixedValue >
	FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE)

Protected Member Functions inherited from distribution
virtual void	validateBounds (const dictionary &dict) const
	Validate that the bounds are monotonic. More...

virtual void	validatePositive (const dictionary &dict) const
	Validate that the lower bound is positive. More...

tmp< scalarField >	clipPDF (const scalarField &x, const tmp< scalarField > &pdf) const
	Clip the PDF values to zero outside the bounds. More...

label	q () const
	Return the effective distribution size exponent. More...

	FOR_ALL_FIELD_TYPES (VIRTUAL_SAMPLE_TYPE)

Protected Attributes inherited from distribution
const label	Q_
	Distribution size exponent. More...

const label	sampleQ_
	Sample size exponent. More...

restartableRandomGenerator	rndGen_
	Random number generator. More...

Detailed Description

Distribution which always takes a specified fixed value.

Usage

Example usage:

{
    type    fixedValue;
    value   1e-6;
}

Source files

See also: Foam::distribution

Definition at line 62 of file fixedValue.H.

Constructor & Destructor Documentation

◆ fixedValue() [1/2]

fixedValue	(	const unitConversion &	units,
		const dictionary &	dict,
		const label	sampleQ,
		randomGenerator &&	rndGen
	)

Construct from a dictionary.

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 &	d,
		const label	sampleQ
	)

Construct copy.

Definition at line 61 of file fixedValue.C.

◆ ~fixedValue()

~fixedValue ( )

virtual

Destructor.

Definition at line 74 of file fixedValue.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fixedValue" )

Runtime type information.

◆ clone()

virtual autoPtr<distribution> clone ( const label sampleQ ) const

inlinevirtual

Construct and return a clone.

Implements distribution.

Definition at line 93 of file fixedValue.H.

References fixedValue::fixedValue(), and distribution::sampleQ().

Here is the call graph for this function:

◆ sample()

Foam::scalar sample ( ) const

virtual

Sample the distribution.

Implements distribution.

Definition at line 80 of file fixedValue.C.

◆ min()

Foam::scalar min ( ) const

virtual

Return the minimum value.

Implements distribution.

Definition at line 86 of file fixedValue.C.

◆ max()

Foam::scalar max ( ) const

virtual

Return the maximum value.

Implements distribution.

Definition at line 92 of file fixedValue.C.

◆ mean()

Foam::scalar mean ( ) const

virtual

Return the mean value.

Implements distribution.

Definition at line 98 of file fixedValue.C.

◆ integralPDFxPow()

Foam::tmp< Foam::scalarField > integralPDFxPow	(	const scalarField &	x,
		const label	e,
		const bool	consistent = `false`
	)		const

virtual

Return the integral of the PDF multiplied by an integer power of x.

Implements distribution.

Definition at line 104 of file fixedValue.C.

References Foam::e, Foam::integerPow(), Foam::pos(), and x.

Here is the call graph for this function:

◆ write()

void write	(	Ostream &	os,
		const unitConversion &	units
	)		const

virtual

Write to a stream.

Reimplemented from distribution.

Definition at line 115 of file fixedValue.C.

References Foam::type(), Foam::units(), and Foam::writeEntry().

Here is the call graph for this function:

◆ plotX()

Foam::tmp< Foam::scalarField > plotX ( const label n ) const

virtual

Return coordinates to plot across the range of the distribution.

Reimplemented from distribution.

Definition at line 127 of file fixedValue.C.

References Foam::mag(), tmp< T >::ref(), and Foam::sign().

Here is the call graph for this function:

◆ plotPDF()

Foam::tmp< Foam::scalarField > plotPDF ( const scalarField & x ) const

virtual

Return values to plot the probability density function.

Implements distribution.

Definition at line 145 of file fixedValue.C.

References tmp< T >::ref().

Here is the call graph for this function:

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

src/OpenFOAM/distributions/fixedValue/fixedValue.H
src/OpenFOAM/distributions/fixedValue/fixedValue.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fixedValue() [1/2]

◆ fixedValue() [2/2]

◆ ~fixedValue()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ sample()

◆ min()

◆ max()

◆ mean()

◆ integralPDFxPow()

◆ write()

◆ plotX()

◆ plotPDF()