Constant< Type > Class Template Reference

Templated function of two variables that returns a constant value. More...

Inheritance diagram for Constant< Type >:
Collaboration diagram for Constant< Type >:

Public Member Functions

 TypeName ("constant")
 
 Constant (const word &name, const Type &val)
 Construct from name and value. More...
 
 Constant (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Constant (const word &name, const unitConversions &units, Istream &is)
 Construct from name and Istream. More...
 
 Constant (const Constant< Type > &cnst)
 Copy constructor. More...
 
virtual tmp< Function2< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Constant ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const
 Return constant. More...
 
virtual tmp< Field< Type > > value (const scalarField &x, const scalarField &y) const
 Return constant field. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write in dictionary format. More...
 
void operator= (const Constant< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction2< Type, Constant< Type > >
 FieldFunction2 (const word &name)
 Construct from name. More...
 
virtual ~FieldFunction2 ()
 Destructor. More...
 
- Public Member Functions inherited from Function2< Type >
 TypeName ("Function2")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f2)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
void operator= (const Function2< Type > &)
 Assignment. 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Function2< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function2< Type >
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Templated function of two variables that returns a constant value.

Usage
For entry <name> returning the value

:

    <name>     constant <value>;

or simply

    <name>     <value>;
Source files

Definition at line 63 of file Constant2.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

Constant ( const word name,
const Type &  val 
)

Construct from name and value.

Definition at line 58 of file Constant2.C.

◆ Constant() [2/4]

Constant ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 70 of file Constant2.C.

◆ Constant() [3/4]

Constant ( const word name,
const unitConversions units,
Istream is 
)

Construct from name and Istream.

Reads the constant value without the Function2 type for backward compatibility

Definition at line 83 of file Constant2.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > &  cnst)

Copy constructor.

Definition at line 96 of file Constant2.C.

◆ ~Constant()

~Constant
virtual

Destructor.

Definition at line 106 of file Constant2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constant"  )

◆ clone()

virtual tmp<Function2<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from FieldFunction2< Type, Constant< Type > >.

Definition at line 107 of file Constant2.H.

◆ value() [1/2]

Type value ( const scalar  x,
const scalar  y 
) const
inlinevirtual

Return constant.

Implements FieldFunction2< Type, Constant< Type > >.

Definition at line 31 of file Constant2I.H.

◆ value() [2/2]

Foam::tmp< Foam::Field< Type > > value ( const scalarField x,
const scalarField y 
) const
inlinevirtual

Return constant field.

Reimplemented from FieldFunction2< Type, Constant< Type > >.

Definition at line 42 of file Constant2I.H.

References x.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write in dictionary format.

Implements Function2< Type >.

Definition at line 113 of file Constant2.C.

References Foam::units(), and Foam::writeEntry().

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.


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