Public Member Functions | List of all members
OneConstant< Type > Class Template Reference

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

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

Public Member Functions

 TypeName ("one")
 
 OneConstant (const word &entryName)
 Construct from entry name. More...
 
 OneConstant (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~OneConstant ()
 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 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...
 
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 Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()=default
 Destructor. More...
 
const word & name () const
 Return the name of the entry. More...
 
virtual void convertTimeBase (const Time &t)
 Convert time. 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=word::null)
 Selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const word & entryName
 
const word const dictionary & dict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Templated function that returns the corresponding 1 (one).

Usage: 

    <entryName> one;
Source files

Definition at line 58 of file OneConstant.H.

Constructor & Destructor Documentation

◆ OneConstant() [1/2]

OneConstant ( const word &  entryName)
explicit

Construct from entry name.

Definition at line 33 of file OneConstant.C.

◆ OneConstant() [2/2]

OneConstant ( const word &  entryName,
const dictionary &  dict 
)

Construct from entry name and dictionary.

Definition at line 41 of file OneConstant.C.

◆ ~OneConstant()

~OneConstant ( )
virtual

Destructor.

Definition at line 53 of file OneConstant.C.

Member Function Documentation

◆ TypeName()

TypeName ( "one"  )

◆ clone()

virtual tmp<Function1<Type> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 83 of file OneConstant.H.

◆ value() [1/2]

Type value ( const scalar  x) const
inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 33 of file OneConstantI.H.

◆ integrate() [1/2]

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

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 41 of file OneConstantI.H.

◆ value() [2/2]

Foam::tmp< Foam::Field< Type > > value ( const scalarField &  x) const
virtual

Return value as a function of (scalar) independent variable.

Reimplemented from Function1< Type >.

Definition at line 61 of file OneConstant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ integrate() [2/2]

Foam::tmp< Foam::Field< Type > > integrate ( const scalarField &  x1,
const scalarField &  x2 
) const
virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 71 of file OneConstant.C.

◆ writeData()

void writeData ( Ostream &  os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 81 of file OneConstant.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: