OneConstant< Type > Class Template Reference

Templated function 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) const
 Return constant value. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Integrate between two values. 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 FieldFunction1< Type, OneConstant< Type > >
 FieldFunction1 (const word &name)
 Construct from name. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of one scalar field. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between two scalar fields. More...
 
- Public Member Functions inherited from Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const dictionary &dict),(name, dict))
 Declare runtime constructor selection table. More...
 
 Function1 (const word &name)
 Construct from name. More...
 
 Function1 (const Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
void operator= (const Function1< 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 Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &name, const dictionary &dict)
 Selector. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Templated function that returns the corresponding 1 (one).

Usage
    <name> one;
Source files

Definition at line 56 of file OneConstant.H.

Constructor & Destructor Documentation

◆ OneConstant() [1/2]

OneConstant ( const word name)

Construct from name.

Definition at line 31 of file OneConstant.C.

◆ OneConstant() [2/2]

OneConstant ( const word name,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 39 of file OneConstant.C.

◆ ~OneConstant()

~OneConstant ( )
virtual

Destructor.

Definition at line 51 of file OneConstant.C.

Member Function Documentation

◆ TypeName()

TypeName ( "one"  )

◆ value()

Type value ( const scalar  x) const
inlinevirtual

Return constant value.

Implements FieldFunction1< Type, OneConstant< Type > >.

Definition at line 31 of file OneConstantI.H.

References OneConstant< Type >::integral().

Here is the call graph for this function:

◆ integral()

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

Integrate between two values.

Implements FieldFunction1< Type, OneConstant< Type > >.

Definition at line 39 of file OneConstantI.H.

Referenced by OneConstant< Type >::value().

Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write in dictionary format.

Implements Function1< Type >.

Definition at line 58 of file OneConstant.C.

◆ operator=()

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

Disallow default bitwise assignment.


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