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

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

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

Public Member Functions

 TypeName ("constant")
 
 Constant (const word &name, const Type &val)
 Construct from name and value. More...
 
 Constant (const word &name, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Constant (const word &name, 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
 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") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f1)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const word & name () 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...
 

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 dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from Function2< Type >
 Function2
 
 dictionary
 
const word & name
 
const word const dictionary & dict
 
const word const dictionary name
 
const word const dictionary dict
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. 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 62 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 32 of file Constant2.C.

Referenced by Constant< Type >::Constant().

Here is the caller graph for this function:

◆ Constant() [2/4]

Constant ( const word &  name,
const dictionary &  dict 
)

Construct from name and dictionary.

Definition at line 44 of file Constant2.C.

References Constant< Type >::Constant(), dictionary::found(), and dictionary::lookup().

Here is the call graph for this function:

◆ Constant() [3/4]

Constant ( const word &  name,
Istream &  is 
)

Construct from name and Istream.

Reads the constant value without the Function2 type for backward compatibility

Definition at line 74 of file Constant2.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > &  cnst)

Copy constructor.

Definition at line 85 of file Constant2.C.

◆ ~Constant()

~Constant ( )
virtual

Destructor.

Definition at line 95 of file Constant2.C.

Referenced by Constant< Type >::clone().

Here is the caller graph for this function:

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 95 of file Constant2.H.

References Constant< Type >::operator=(), Constant< Type >::value(), Constant< Type >::write(), x, y, and Constant< Type >::~Constant().

Here is the call graph for this function:

◆ value() [1/2]

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

Return constant.

Implements FieldFunction2< Type, Constant< Type > >.

Definition at line 32 of file Constant2I.H.

Referenced by Constant< Type >::clone().

Here is the caller graph for this function:

◆ 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 43 of file Constant2I.H.

References List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write in dictionary format.

Implements Function2< Type >.

Definition at line 102 of file Constant2.C.

References Foam::writeEntry().

Referenced by Constant< Type >::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.

Referenced by Constant< Type >::clone().

Here is the caller graph for this function:
The documentation for this class was generated from the following files: