All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OneConstant< Type > Class Template Reference

Templated function of two variables that returns the corresponding 1 (one). More...

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

Public Member Functions

 TypeName ("one")
 
 OneConstant (const word &name)
 Construct from name. More...
 
 OneConstant (const word &name, const dictionary &dict)
 Construct from name and dictionary. More...
 
virtual ~OneConstant ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const
 Return One. More...
 
virtual tmp< Field< Type > > value (const scalarField &x, const scalarField &y) const
 Return One field. More...
 
virtual void write (Ostream &os) const
 Write in dictionary format. More...
 
void operator= (const OneConstant< Type > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from FieldFunction2< Type, OneConstant< 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") declareRunTimeSelectionTable(autoPtr
 Runtime type information. More...
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f1)
 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...
 

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 dictionary &dict)
 Selector. More...
 
- Public Attributes inherited from Function2< Type >
 Function2
 
 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 Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Templated function of two variables that returns the corresponding 1 (one).

Usage:

    <name> one;
Source files

Definition at line 56 of file OneConstant2.H.

Constructor & Destructor Documentation

◆ OneConstant() [1/2]

OneConstant ( const word name)

Construct from name.

Definition at line 31 of file OneConstant2.C.

◆ OneConstant() [2/2]

OneConstant ( const word name,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 39 of file OneConstant2.C.

◆ ~OneConstant()

~OneConstant ( )
virtual

Destructor.

Definition at line 51 of file OneConstant2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "one"  )

◆ value() [1/2]

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

Return One.

Implements FieldFunction2< Type, OneConstant< Type > >.

Definition at line 32 of file OneConstant2I.H.

◆ value() [2/2]

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

Return One field.

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

Definition at line 43 of file OneConstant2I.H.

References List< T >::size().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write in dictionary format.

Implements Function2< Type >.

Definition at line 58 of file OneConstant2.C.

◆ operator=()

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

Disallow default bitwise assignment.


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