Constant< Type > Class Template Reference

Templated function that returns a constant value. More...

Inheritance diagram for Constant< Type >:

Collaboration diagram for Constant< Type >:

Public Member Functions
	TypeName ("constant")
	Constant (const word &entryName, const Type &val)
	Construct from entry name and value. More...
	Constant (const word &entryName, const dictionary &dict)
	Construct from entry name and dictionary. More...
	Constant (const word &entryName, Istream &is)
	Construct from entry name and Istream. More...
	Constant (const Constant< Type > &cnst)
	Copy constructor. More...
virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...
virtual	~Constant ()
	Destructor. More...
Type	value (const scalar) const
	Return constant value. More...
Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values. More...
virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...
Public Member Functions inherited from Function1< Type >
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...
	Function1 (const word &entryName)
	Construct from entry name. More...
	Function1 (const Function1< Type > &de)
	Copy constructor. More...
virtual	~Function1 ()
	Destructor. More...
const word &	name () const
	Return the name of the entry. More...
virtual void	convertTimeBase (const Time &t)
	Convert time. More...
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable. More...
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...
Public Member Functions inherited from refCount
int	count () const
	Return the current reference count. More...
bool	unique () const
	Return true if the reference count is zero. More...
void	operator++ ()
	Increment the reference count. More...
void	operator++ (int)
	Increment the reference count. More...
void	operator-- ()
	Decrement the reference count. More...
void	operator-- (int)
	Decrement the reference count. More...

Additional Inherited Members
Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict)
	Selector. More...
Public Attributes inherited from Function1< Type >
	Function1
	dictionary
const word &	entryName
const word const dictionary &	dict
const word const dictionary	entryName
const word const dictionary	dict
Protected Member Functions inherited from refCount
	refCount ()
	Construct null initializing count to 0. More...
Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

Detailed Description

template<class Type>
class Foam::Function1Types::Constant< Type >

Templated function that returns a constant value.

Usage - for entry <entryName> returning the value

:

    <entryName>    constant  <value>

Source files

• Constant.H
• Constant.C

Definition at line 56 of file Constant.H.

Constructor & Destructor Documentation

Constant() [1/4]

Constant	(	const word &	entryName,
		const Type &	val
	)

Construct from entry name and value.

Definition at line 32 of file Constant.C.

Referenced by Constant< Type >::Constant().

Here is the caller graph for this function:

Constant() [2/4]

Constant	(	const word &	entryName,
		const dictionary &	dict
	)

Construct from entry name and dictionary.

Definition at line 44 of file Constant.C.

References Constant< Type >::Constant(), and dictionary::lookup().

Here is the call graph for this function:

Constant() [3/4]

Constant	(	const word &	entryName,
		Istream &	is
	)

Construct from entry name and Istream.

Reads the constant value without the Function1 type for backward compatibility

Definition at line 60 of file Constant.C.

Constant() [4/4]

Constant

(

const Constant< Type > &

cnst

)

Copy constructor.

Definition at line 71 of file Constant.C.

~Constant()

~Constant ( )

virtual

Destructor.

Definition at line 81 of file Constant.C.

Referenced by Constant< Type >::clone().

Here is the caller graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"constant"

)

clone()

virtual tmp<Function1<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Reimplemented in Uniform< Type >.

Definition at line 95 of file Constant.H.

References Constant< Type >::integrate(), Constant< Type >::value(), Constant< Type >::writeData(), and Constant< Type >::~Constant().

Here is the call graph for this function:

value()

Type value ( const scalar  x ) const

virtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 88 of file Constant.C.

References Constant< Type >::integrate().

Referenced by Constant< Type >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

integrate()

Type integrate ( const scalar  x1, const scalar  x2  ) const

virtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 96 of file Constant.C.

Referenced by Constant< Type >::clone(), and Constant< Type >::value().

Here is the caller graph for this function:

writeData()

void writeData ( Ostream &  os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 106 of file Constant.C.

References token::END_STATEMENT, Foam::nl, token::SPACE, and Function1< Type >::writeData().

Referenced by Constant< Type >::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/OpenFOAM/primitives/functions/Function1/Constant/Constant.H
• src/OpenFOAM/primitives/functions/Function1/Constant/Constant.C