Public Member Functions | List of all members
Uniform< Type > Class Template Reference

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

Inheritance diagram for Uniform< Type >:
Inheritance graph
[legend]
Collaboration diagram for Uniform< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("uniform")
 
 Uniform (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
- Public Member Functions inherited from Constant< Type >
 TypeName ("constant")
 
 Constant (const word &entryName, const Type &val)
 Construct from entry name and value. 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 > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. 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...
 

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)
 Selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. 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>
Source files

Definition at line 59 of file Uniform.H.

Constructor & Destructor Documentation

◆ Uniform()

Uniform ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 32 of file Uniform.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniform"  )

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