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

Inheritance diagram for Uniform< Type >:

Collaboration diagram for Uniform< Type >:

Public Member Functions
	TypeName ("uniform")
	Declare type-name, virtual type (with debug switch) More...

	Uniform (const Uniform &)=default
	Copy construct. More...

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

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

Public Member Functions inherited from Constant< Type >
	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	~Function1 ()=default
	Destructor. More...

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

void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. 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...

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 59 of file Uniform.H.

Constructor & Destructor Documentation

◆ Uniform() [1/2]

Uniform ( const Uniform< Type > & )

default

Copy construct.

◆ Uniform() [2/2]

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

inline

Construct from entry name, dictionary and optional registry.

Definition at line 82 of file Uniform.H.

Member Function Documentation

◆ TypeName()

TypeName ( "uniform" )

Declare type-name, virtual type (with debug switch)

◆ operator=()

void operator= ( const Uniform< Type > & )

delete

No copy assignment.

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