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

Templated function that returns the corresponding 0 (zero). More...

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

Public Member Functions

 TypeName ("zero")
 
 ZeroConstant (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~ZeroConstant ()
 Destructor. More...
 
Type value (const scalar) const
 Return constant value. More...
 
Type integrate (const scalar x1, const scalar x2) const
 Integrate between two values. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. 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 > &de)
 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...
 
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...
 
- 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

- 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::ZeroConstant< Type >

Templated function that returns the corresponding 0 (zero).

Usage:

    <entryName> zero;
Source files

Definition at line 56 of file ZeroConstant.H.

Constructor & Destructor Documentation

◆ ZeroConstant()

ZeroConstant ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 32 of file ZeroConstant.C.

◆ ~ZeroConstant()

~ZeroConstant ( )
virtual

Destructor.

Definition at line 44 of file ZeroConstant.C.

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

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "zero"  )

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 78 of file ZeroConstant.H.

References ZeroConstant< Type >::integrate(), ZeroConstant< Type >::value(), ZeroConstant< Type >::writeData(), and ZeroConstant< Type >::~ZeroConstant().

Here is the call graph for this function:

◆ value()

Type value ( const scalar  x) const
virtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 51 of file ZeroConstant.C.

References ZeroConstant< Type >::integrate().

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

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

◆ integrate()

Type integrate ( const scalar  x1,
const scalar  x2 
) const
virtual

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 59 of file ZeroConstant.C.

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

Here is the caller graph for this function:

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 69 of file ZeroConstant.C.

References Foam::nl, and writeData().

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

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

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