ZeroConstant< Type > Class Template Reference

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

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

Public Member Functions

 TypeName ("zero")
 Runtime type information. More...
 
void operator= (const ZeroConstant< Type > &)=delete
 No copy assignment. More...
 
 ZeroConstant (const word &entryName)
 Construct from entry name. More...
 
 ZeroConstant (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual ~ZeroConstant ()=default
 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 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 word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Function1 (const Function1< Type > &rhs)
 Copy construct. More...
 
virtual tmp< Function1< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~Function1 ()=default
 Destructor. 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...
 
void writeEntries (Ostream &os) const
 Write coefficient entries in dictionary format. 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, const word &redirectType, const bool mandatory=true)
 Selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > NewCompat (const word &entryName, std::initializer_list< std::pair< const char *, int >> compat, const dictionary &dict, const word &redirectType=word::null, const bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const bool mandatory=true)
 Selector, without fallback redirection. More...
 
static autoPtr< Function1< Type > > NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null)
 An optional 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 Function1< Type >
void operator= (const Function1< Type > &)=delete
 No copy assignment. 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 59 of file ZeroConstant.H.

Constructor & Destructor Documentation

◆ ZeroConstant() [1/2]

ZeroConstant ( const word entryName)
explicit

Construct from entry name.

Definition at line 34 of file ZeroConstant.C.

◆ ZeroConstant() [2/2]

ZeroConstant ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 42 of file ZeroConstant.C.

◆ ~ZeroConstant()

virtual ~ZeroConstant ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "zero"  )

Runtime type information.

◆ operator=()

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

No copy assignment.

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 34 of file ZeroConstantI.H.

◆ integrate()

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

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 44 of file ZeroConstantI.H.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 54 of file ZeroConstant.C.

References token::END_STATEMENT, Foam::nl, and Function1< Type >::writeData().

Here is the call graph for this function:

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