ZeroConstant< Type > Class Template Reference

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

Inheritance diagram for ZeroConstant< Type >:
Collaboration diagram for ZeroConstant< Type >:

Public Member Functions

 TypeName ("zero")
 
 ZeroConstant (const word &name)
 Construct from name. More...
 
 ZeroConstant (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual ~ZeroConstant ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const
 Return Zero. More...
 
virtual tmp< Field< Type > > value (const scalarField &x, const scalarField &y) const
 Return Zero field. More...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write in dictionary format. More...
 
void operator= (const ZeroConstant< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction2< Type, ZeroConstant< Type > >
 FieldFunction2 (const word &name)
 Construct from name. More...
 
virtual tmp< Function2< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction2 ()
 Destructor. More...
 
- Public Member Functions inherited from Function2< Type >
 TypeName ("Function2")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f2)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const wordname () 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 Function2s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function2s::ZeroConstant< Type >

Templated function of two variables that returns the corresponding 0 (zero).

Usage
    <name> zero;
Source files

Definition at line 56 of file ZeroConstant2.H.

Constructor & Destructor Documentation

◆ ZeroConstant() [1/2]

ZeroConstant ( const word name)

Construct from name.

Definition at line 31 of file ZeroConstant2.C.

◆ ZeroConstant() [2/2]

ZeroConstant ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 38 of file ZeroConstant2.C.

◆ ~ZeroConstant()

~ZeroConstant
virtual

Destructor.

Definition at line 52 of file ZeroConstant2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "zero"  )

◆ value() [1/2]

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

Return Zero.

Implements FieldFunction2< Type, ZeroConstant< Type > >.

Definition at line 31 of file ZeroConstant2I.H.

◆ value() [2/2]

Foam::tmp< Foam::Field< Type > > value ( const scalarField x,
const scalarField y 
) const
inlinevirtual

Return Zero field.

Reimplemented from FieldFunction2< Type, ZeroConstant< Type > >.

Definition at line 42 of file ZeroConstant2I.H.

References x.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write in dictionary format.

Implements Function2< Type >.

Definition at line 59 of file ZeroConstant2.C.

◆ operator=()

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

Disallow default bitwise assignment.


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