Constant< Type > Class Template Reference

Templated function that returns a constant value. More...

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

Public Member Functions

 TypeName ("constant")
 
void operator= (const Constant< Type > &)=delete
 No copy assignment. More...
 
 Constant (const word &entryName, const Type &value)
 Construct from components. More...
 
 Constant (const word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Constant (const word &entryName, Istream &is)
 Construct from entry name and Istream. More...
 
 Constant (const Constant< Type > &cnst)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Constant ()=default
 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...
 
template<>
tmp< Field< label > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. More...
 
template<>
Foam::tmp< Foam::Field< Foam::label > > integrate (const scalarField &x1, const scalarField &x2) const
 Integrate between two (scalar) values. 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 word &entryName, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 Function1 (const Function1< Type > &rhs)
 Copy construct. More...
 
virtual ~Function1 ()=default
 Destructor. 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 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 bool mandatory=true)
 Compatibility selector, with fallback redirection. More...
 
static autoPtr< Function1< Type > > New (const word &entryName, const dictionary &dict, 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)
 An optional selector. More...
 
- Public Attributes inherited from Function1< Type >
 Function1
 
 dictionary
 
const wordentryName
 
const word const dictionarydict
 
const word const dictionary entryName
 
const word const dictionary dict
 
- 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::Constant< Type >

Templated function that returns a constant value.

Usage - for entry <entryName> returning the value

:

    <entryName>    constant  <value>
Source files

Definition at line 59 of file Constant.H.

Constructor & Destructor Documentation

◆ Constant() [1/4]

Constant ( const word entryName,
const Type &  value 
)

Construct from components.

Definition at line 35 of file Constant.C.

◆ Constant() [2/4]

Constant ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 47 of file Constant.C.

References dict.

◆ Constant() [3/4]

Constant ( const word entryName,
Istream is 
)

Construct from entry name and Istream.

Reads the constant value without the Function1 type for backward compatibility

Definition at line 63 of file Constant.C.

◆ Constant() [4/4]

Constant ( const Constant< Type > &  cnst)
explicit

Copy constructor.

Definition at line 74 of file Constant.C.

◆ ~Constant()

virtual ~Constant ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "constant"  )

◆ operator=()

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

No copy assignment.

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 99 of file Constant.H.

◆ value() [1/2]

Type value ( const scalar  x) const
inlinevirtual

Return constant value.

Reimplemented from Function1< Type >.

Definition at line 33 of file ConstantI.H.

◆ integrate() [1/4]

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

Integrate between two values.

Reimplemented from Function1< Type >.

Definition at line 41 of file ConstantI.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 85 of file Constant.C.

References Foam::New(), and x.

Here is the call graph for this function:

◆ integrate() [2/4]

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 95 of file Constant.C.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 104 of file Constant.C.

References token::END_STATEMENT, Foam::nl, token::SPACE, and Function1< Type >::writeData().

Here is the call graph for this function:

◆ integrate() [3/4]

tmp< Field< label > > integrate ( const scalarField x1,
const scalarField x2 
) const
virtual

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

◆ integrate() [4/4]

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

Integrate between two (scalar) values.

Reimplemented from Function1< Type >.

Definition at line 78 of file makeFunction1s.C.

References Foam::New(), and NotImplemented.

Here is the call graph for this function:

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