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 &value)
	Construct from components. 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...

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

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two values. 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...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

template<>
tmp< Field< label > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...

template<>
Foam::tmp< Foam::Field< Foam::label > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. 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 > &rhs)
	Copy constructor. More...

virtual	~Function1 ()=default
	Destructor. More...

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

virtual void	convertTimeBase (const Time &t)
	Convert time. 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 &entryName, const dictionary &dict, const word &redirectType=word::null)
	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 Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. 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

Definition at line 59 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

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

Construct from components.

Definition at line 35 of file Constant.C.

◆ Constant() [2/4]

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

Construct from entry name and dictionary.

Definition at line 47 of file Constant.C.

References dict.

◆ 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 63 of file Constant.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > & cnst )

explicit

Copy constructor.

Definition at line 74 of file Constant.C.

◆ ~Constant()

~Constant ( )

virtual

Destructor.

Definition at line 84 of file Constant.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 98 of file Constant.H.

◆ value() [1/2]

Type value ( const scalar x ) const

inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 33 of file ConstantI.H.

◆ integrate() [1/4]

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

inlinevirtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 41 of file ConstantI.H.

◆ value() [2/2]

Foam::tmp< Foam::Field< Type > > value ( const scalarField & x ) const

virtual

Return value as a function of (scalar) independent variable.

Reimplemented from Function1< Type >.

Definition at line 92 of file Constant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ integrate() [2/4]

Foam::tmp< Foam::Field< Type > > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 102 of file Constant.C.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 111 of file Constant.C.

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

Here is the call graph for this function:

◆ integrate() [3/4]

tmp< Field< label > > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

◆ integrate() [4/4]

Foam::tmp< Foam::Field< Foam::label > > integrate	(	const scalarField &	x1,
		const scalarField &	x2
	)		const

virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 74 of file makeFunction1s.C.

References Foam::New(), and NotImplemented.

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

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Constant() [1/4]

◆ Constant() [2/4]

◆ Constant() [3/4]

◆ Constant() [4/4]

◆ ~Constant()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ value() [1/2]

◆ integrate() [1/4]

◆ value() [2/2]

◆ integrate() [2/4]

◆ writeData()

◆ integrate() [3/4]

◆ integrate() [4/4]

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