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 &name, const Type &val)
	Construct from name and value. More...

	Constant (const word &name, const unitConversions &units, const dictionary &dict)
	Construct from name and dictionary. More...

	Constant (const word &name, const unitConversions &units, Istream &is)
	Construct from 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...

virtual Type	value (const scalar) const
	Return constant value. More...

virtual Type	integral (const scalar x1, const scalar x2) const
	Integrate between two values. More...

virtual bool	constant () const
	Is this function guaranteed to be constant? More...

virtual void	write (Ostream &os, const unitConversions &units) const
	Write in dictionary format. More...

void	operator= (const Constant< Type > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from FieldFunction1< Type, Constant< Type > >
	FieldFunction1 (const word &name)
	Construct from name. More...

virtual	~FieldFunction1 ()
	Destructor. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of one scalar field. More...

virtual tmp< Field< Type > >	integral (const scalarField &x1, const scalarField &x2) const
	Integrate between two scalar fields. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))

	Function1 (const word &name)
	Construct from name. More...

	Function1 (const Function1< Type > &f1)
	Copy constructor. More...

virtual	~Function1 ()
	Destructor. More...

const word &	name () const
	Return the name of the entry. More...

void	operator= (const Function1< Type > &)
	Assignment. 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...

void	operator= (const refCount &)=delete
	Disallow bitwise assignment. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, Istream &is)
	Select from Istream. More...

Protected Member Functions inherited from refCount
	refCount ()
	Construct null initialising count to 0. More...

	refCount (const refCount &)=delete
	Disallow copy. More...

Protected Attributes inherited from Function1< Type >
const word	name_
	Name of entry. More...

Detailed Description

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

Templated function that returns a constant value.

Usage: For entry <name> returning the value

:

    <name>    constant  <value>

Source files

Definition at line 57 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

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

Construct from name and value.

Definition at line 58 of file Constant.C.

◆ Constant() [2/4]

Constant	(	const word &	name,
		const unitConversions &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 70 of file Constant.C.

◆ Constant() [3/4]

Constant	(	const word &	name,
		const unitConversions &	units,
		Istream &	is
	)

Construct from name and Istream.

Definition at line 83 of file Constant.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > & cnst )

Copy constructor.

Definition at line 96 of file Constant.C.

◆ ~Constant()

~Constant

virtual

Destructor.

Definition at line 106 of file Constant.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

◆ clone()

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

inlinevirtual

Construct and return a clone.

Reimplemented from FieldFunction1< Type, Constant< Type > >.

Reimplemented in Uniform< Type >.

Definition at line 99 of file Constant.H.

◆ value()

Type value ( const scalar x ) const

inlinevirtual

Return constant value.

Implements FieldFunction1< Type, Constant< Type > >.

Definition at line 31 of file ConstantI.H.

◆ integral()

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

inlinevirtual

Integrate between two values.

Implements FieldFunction1< Type, Constant< Type > >.

Definition at line 38 of file ConstantI.H.

◆ constant()

bool constant

inlinevirtual

Is this function guaranteed to be constant?

Reimplemented from Function1< Type >.

Definition at line 49 of file ConstantI.H.

◆ write()

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

virtual

Write in dictionary format.

Implements Function1< Type >.

Definition at line 113 of file Constant.C.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const Constant< Type > & )

delete

Disallow default bitwise assignment.

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
src/OpenFOAM/primitives/functions/Function1/Constant/ConstantI.H

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Constant() [1/4]

◆ Constant() [2/4]

◆ Constant() [3/4]

◆ Constant() [4/4]

◆ ~Constant()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ value()

◆ integral()

◆ constant()

◆ write()

◆ operator=()

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