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 dictionary &dict, Random &rndGen, const label sampleQ)
	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 >	x (const label n) const
	Return coordinates to plot across the range of the distribution. More...

virtual tmp< scalarField >	PDF (const scalarField &x) const
	Return the distribution probability density function. More...

Public Member Functions inherited from FieldDistribution< distribution, fixedValue >
virtual tmp< scalarField >	sample (const label n) const
	Sample the distribution. More...

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

	distribution ()
	Construct null. More...

	distribution (const scalar binWidth)
	Construct from binWidth. More...

	distribution (const distribution &)
	Copy constructor. More...

virtual	~distribution ()
	Destructor. More...

label	totalEntries () const

scalar	approxTotalEntries () const

scalar	mean () const

scalar	median ()

void	add (const scalar valueToAdd)
	Add a value to the appropriate bin of the distribution. More...

void	add (const label valueToAdd)

void	insertMissingKeys ()

List< Pair< scalar > >	normalised ()

List< Pair< scalar > >	normalisedMinusMean ()

List< Pair< scalar > >	normalisedShifted (scalar shiftValue)

List< Pair< scalar > >	raw ()

scalar	binWidth () const

void	operator= (const distribution &)

	TypeName ("distribution")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, distribution, dictionary,(const dictionary &dict, Random &rndGen, const label sampleQ),(dict, rndGen, sampleQ))
	Declare runtime constructor selection table. More...

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

	distribution (Random &rndGen, const label Q, const label sampleQ)
	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...

void	report () const
	Report. More...

Public Member Functions inherited from Map< label >
	Map (const label size=128)
	Construct given initial size. More...

	Map (Istream &is)
	Construct from Istream. More...

	Map (const Map< label > &map)
	Copy constructor. More...

	Map (Map< label > &&map)
	Move constructor. More...

	Map (HashTable< label, label, Hash< label >> &&map)
	Move constructor. More...

	Map (std::initializer_list< Tuple2< label, label >> map)
	Construct from an initialiser list. More...

void	operator= (const Map< label > &map)

void	operator= (Map< label > &&map)

Public Member Functions inherited from HashTable< T, Key, Hash >
	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const HashTable< T, Key, Hash > &)
	Copy constructor. More...

	HashTable (HashTable< T, Key, Hash > &&)
	Move constructor. More...

	HashTable (std::initializer_list< Tuple2< Key, T >>)
	Construct from an initialiser list. More...

	~HashTable ()
	Destructor. More...

label	capacity () const
	The size of the underlying table. More...

label	size () const
	Return number of elements in table. More...

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const Key &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const Key &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const Key &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< Key >	toc () const
	Return the table of contents. More...

List< Key >	sortedToc () const
	Return the table of contents as a sorted list. More...

Ostream &	printInfo (Ostream &) const
	Print information. More...

bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry. More...

bool	set (const Key &, const T &newElmt)
	Assign a new hashedEntry, overwriting existing entries. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const Key &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable. More...

template<class AnyType , class AnyHash >
label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

void	resize (const label newSize)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< T, Key, Hash > &)
	Transfer the contents of the argument table into this table. More...

T &	operator[] (const Key &)
	Find and return a hashedEntry. More...

const T &	operator[] (const Key &) const
	Find and return a hashedEntry. More...

T &	operator() (const Key &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< T, Key, Hash > &)
	Assignment operator. More...

void	operator= (HashTable< T, Key, Hash > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< Tuple2< Key, T >>)
	Assignment to an initialiser list. More...

bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time. More...

iterator	begin ()
	Iterator set to the beginning of the HashTable. More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

template<class AnyType , class AnyHash >
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &rhs)

Public Member Functions inherited from HashTableCore
	HashTableCore ()
	Construct null. More...

	ClassName ("HashTable")
	Define template name and debug. More...

Additional Inherited Members
Public Types inherited from Map< label >
typedef HashTable< label, label, Hash< label > >::iterator	iterator

typedef HashTable< label, label, Hash< label > >::const_iterator	const_iterator

Public Types inherited from HashTable< T, Key, Hash >
typedef T	value_type
	Type of values the HashTable contains. More...

typedef T &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

Static Public Member Functions inherited from distribution
static void	write (const fileName &file, const List< Pair< scalar >> &pairs)
	Write to file. More...

static autoPtr< distribution >	New (const dictionary &dict, Random &rndGen, const label sampleQ)
	Selector. More...

Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label)
	Return a canonical (power-of-two) size. More...

static iteratorEnd	cend ()
	iteratorEnd set to beyond the end of any HashTable More...

static iteratorEnd	end ()
	iteratorEnd set to beyond the end of any HashTable More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable table size. More...

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...

Protected Attributes inherited from distribution
Random &	rndGen_
	Reference to a random number generator. More...

const label	Q_
	Distribution size exponent. More...

const label	sampleQ_
	Sample size exponent. 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 dictionary &	dict,
		Random &	rndGen,
		const label	sampleQ
	)

Construct from a dictionary.

Definition at line 43 of file fixedValue.C.

References distribution::report().

Referenced by fixedValue::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fixedValue() [2/2]

fixedValue	(	const fixedValue &	d,
		const label	sampleQ
	)

Construct copy.

Definition at line 57 of file fixedValue.C.

◆ ~fixedValue()

~fixedValue ( )

virtual

Destructor.

Definition at line 70 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 92 of file fixedValue.H.

References fixedValue::fixedValue().

Here is the call graph for this function:

◆ sample()

Foam::scalar sample ( ) const

virtual

Sample the distribution.

Implements distribution.

Definition at line 76 of file fixedValue.C.

◆ min()

Foam::scalar min ( ) const

virtual

Return the minimum value.

Implements distribution.

Definition at line 82 of file fixedValue.C.

◆ max()

Foam::scalar max ( ) const

virtual

Return the maximum value.

Implements distribution.

Definition at line 88 of file fixedValue.C.

◆ mean()

Foam::scalar mean ( ) const

virtual

Return the mean value.

Implements distribution.

Definition at line 94 of file fixedValue.C.

◆ x()

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

virtual

Return coordinates to plot across the range of the distribution.

Reimplemented from distribution.

Definition at line 101 of file fixedValue.C.

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

Here is the call graph for this function:

◆ PDF()

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

virtual

Return the distribution probability density function.

Implements distribution.

Definition at line 119 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()

◆ x()

◆ PDF()