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

Inheritance diagram for Constant< Type >:

Collaboration diagram for Constant< Type >:

Public Member Functions
	TypeName ("constant")

void	operator= (const Constant< Type > &)=delete
	No copy assignment. More...

	Constant (const word &entryName, const Type &value, const objectRegistry *obrPtr=nullptr)
	Construct from components. More...

	Constant (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

	Constant (const word &entryName, Istream &is)
	Construct from entry name and Istream. More...

	Constant (const Constant< Type > &rhs)
	Copy constructor. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

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

void	reset (const Type &val)
	Change the constant value. More...

virtual bool	constant () const
	Value is independent of x. 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 void	writeData (Ostream &os) const
	Write as primitive (inline) format. More...

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

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

virtual tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. More...

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

virtual bool	constant () const
	Is value constant (i.e. independent of x) More...

virtual bool	good () const
	Can function be evaluated? More...

virtual Type	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...

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

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

virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry. More...

	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry. More...

	function1Base (const function1Base &rhs)
	Copy construct. More...

virtual	~function1Base ()
	Destructor. More...

const word &	name () const noexcept
	The name of the entry. More...

const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr. More...

void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry. More...

void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry. More...

const objectRegistry &	obr () const
	Return the object registry. More...

bool	isTime () const noexcept
	Return true if this function was created with the time database. More...

const Time &	time () const
	Return the time database. More...

template<class MeshType >
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh. More...

virtual void	userTimeToTime (const Time &t)
	Convert time. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. 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, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char , int > > compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type > > &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment. More...

Protected Attributes inherited from function1Base
const word	name_
	Name of entry. More...

const objectRegistry *	obrPtr_
	Pointer to an object registry. 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 <value>, can be specified is different formats.

Inline specification:

    <entryName>  constant <value>

Dictionary format:

    <entryName>
    {
        type    constant;
        value   <value>;
    }

Source files

Definition at line 72 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

Constant	(	const word &	entryName,
		const Type &	value,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from components.

Definition at line 34 of file Constant.C.

◆ Constant() [2/4]

Constant	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 47 of file Constant.C.

References Function1< Type >::dict, Function1< Type >::entryName, entry::isStream(), token::isWord(), keyType::LITERAL, ITstream::peek(), ITstream::skip(), and entry::stream().

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

◆ Constant() [4/4]

Constant ( const Constant< Type > & rhs )

explicit

Copy constructor.

Definition at line 96 of file Constant.C.

◆ ~Constant()

virtual ~Constant ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

◆ operator=()

void operator= ( const Constant< Type > & )

delete

No copy assignment.

◆ clone()

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

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Reimplemented in Uniform< Type >.

Definition at line 121 of file Constant.H.

◆ reset()

void reset ( const Type & val )

inline

Change the constant value.

Definition at line 34 of file ConstantI.H.

◆ constant()

virtual bool constant ( ) const

inlinevirtual

Value is independent of x.

Reimplemented from Function1< Type >.

Definition at line 137 of file Constant.H.

◆ value() [1/2]

Type value ( const scalar ) const

inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 41 of file ConstantI.H.

◆ integrate()

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

inlinevirtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 48 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 106 of file Constant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 116 of file Constant.C.

References os(), and token::SPACE.

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

Constructor & Destructor Documentation

◆ Constant() [1/4]

◆ Constant() [2/4]

◆ Constant() [3/4]

◆ Constant() [4/4]

◆ ~Constant()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ reset()

◆ constant()

◆ value() [1/2]

◆ integrate()

◆ value() [2/2]

◆ writeData()