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

Inheritance diagram for Uniform< Type >:

Collaboration diagram for Uniform< Type >:

Public Member Functions
	TypeName ("uniform")

	Uniform (const Uniform &)=default

void	operator= (const Uniform< Type > &)=delete

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

Public Member Functions inherited from Constant< Type >
	TypeName ("constant")

void	operator= (const Constant< Type > &)=delete

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

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

	Constant (const word &entryName, Istream &is)

	Constant (const Constant< Type > &rhs)

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

virtual	~Constant ()=default

void	reset (const Type &val)

virtual bool	constant () const

virtual Type	value (const scalar) const

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

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

virtual void	writeData (Ostream &os) const

Public Member Functions inherited from Function1< Type >
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)

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

	Function1 (const Function1< Type > &rhs)

	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr

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

virtual	~Function1 ()=default

virtual bool	constant () const

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

void	writeEntries (Ostream &os) const

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)

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

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)

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)

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

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary const objectRegistry	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete

Detailed Description

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

Templated function that returns a constant value.

Provides backward-compatibility for cases where a field is spatially "uniform" and may be treated as a constant value.

Usage - for entry <entryName> returning the value

:

    <entryName>    uniform  <value>

Definition at line 53 of file Uniform.H.

Constructor & Destructor Documentation

◆ Uniform() [1/2]

Uniform ( const Uniform< Type > & )

default

◆ Uniform() [2/2]

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

inline

Definition at line 76 of file Uniform.H.

Member Function Documentation

◆ TypeName()

TypeName ( "uniform" )

◆ operator=()

void operator= ( const Uniform< Type > & )

delete

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

src/OpenFOAM/primitives/functions/Function1/Uniform/Uniform.H

Public Member Functions

Additional Inherited Members