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 >:
[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, const objectRegistry *obrPtr=nullptr)
 Construct from entry name and optional registry. More...
 
 ZeroConstant (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 Construct from entry name, dictionary and optional registry. More...
 
virtual ~ZeroConstant ()=default
 Destructor. More...
 
virtual bool constant () const
 Value is independent of x. 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 as primitive (inline) format. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
 Construct from entry name. More...
 
 Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
 
 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 objectRegistry *obrPtr=nullptr, 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 objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, 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, const objectRegistry *obrPtr=nullptr)
 An optional selector. More...
 
static refPtr< Function1< Type > > New (HashPtrTable< Function1< Type >> &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const word & entryName
 
const word const dictionary & dict
 
const word const dictionary const objectRegistry * obrPtr
 
const word const dictionary const objectRegistry entryName
 
const word const dictionary const objectRegistry dict
 
const word const dictionary const objectRegistry obrPtr
 
- 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: Inline specification: 

    <entryName>  zero;

In dictionary format: 

    <entryName>
    {
        type    zero;
    }
Source files

Definition at line 68 of file ZeroConstant.H.

Constructor & Destructor Documentation

◆ ZeroConstant() [1/2]

ZeroConstant ( const word &  entryName,
const objectRegistry *  obrPtr = nullptr 
)
explicit

Construct from entry name and optional registry.

Definition at line 35 of file ZeroConstant.C.

◆ ZeroConstant() [2/2]

ZeroConstant ( const word &  entryName,
const dictionary &  dict,
const objectRegistry *  obrPtr = nullptr 
)

Construct from entry name, dictionary and optional registry.

Definition at line 46 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.

◆ constant()

virtual bool constant ( ) const
inlinevirtual

Value is independent of x.

Reimplemented from Function1< Type >.

Definition at line 109 of file ZeroConstant.H.

◆ 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 as primitive (inline) format.

Reimplemented from Function1< Type >.

Definition at line 59 of file ZeroConstant.C.

References os(), and writeData().

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