Constant< Type > Class Template Reference

Templated function 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 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< 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 integral (const scalar x1, const scalar x2) const
 Integrate between two values. 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 FieldFunction1< Type, Constant< Type > >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
void operator= (const Function1< 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 Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &name, const dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordname
 
const word const dictionarydict
 
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 Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Templated function that returns a constant value.

Usage - for entry <name> returning the value

:

    <name>    constant  <value>
Source files

Definition at line 56 of file Constant.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 Constant.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 Constant.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 Function1 type for backward compatibility

Definition at line 75 of file Constant.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > &  cnst)

Copy constructor.

Definition at line 86 of file Constant.C.

◆ ~Constant()

~Constant ( )
virtual

Destructor.

Definition at line 96 of file Constant.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "constant"  )

◆ clone()

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

Construct and return a clone.

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

Definition at line 89 of file Constant.H.

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

Here is the call graph for this function:

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return constant value.

Implements FieldFunction1< Type, Constant< Type > >.

Definition at line 31 of file ConstantI.H.

References Constant< Type >::integral().

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

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

◆ integral()

Type integral ( const scalar  x1,
const scalar  x2 
) const
inlinevirtual

Integrate between two values.

Implements FieldFunction1< Type, Constant< Type > >.

Definition at line 39 of file ConstantI.H.

Referenced by Constant< Type >::clone(), and Constant< Type >::value().

Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write in dictionary format.

Implements Function1< Type >.

Definition at line 103 of file Constant.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: