All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FieldFunction1< Type, Function1Type > Class Template Referenceabstract
Inheritance diagram for FieldFunction1< Type, Function1Type >:
Collaboration diagram for FieldFunction1< Type, Function1Type >:

Public Member Functions

 FieldFunction1 (const word &entryName)
 Construct from entry name. More...
 
 FieldFunction1 (const FieldFunction1< Type, Function1Type > &ff1)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction1 ()
 Destructor. More...
 
virtual Type value (const scalar x) const =0
 Return value as a function of (scalar) independent variable. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const =0
 Integrate between two (scalar) values. More...
 
virtual tmp< Field< Type > > 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 Function1< Type > &f1)
 Copy constructor. More...
 
virtual ~Function1 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 
void operator= (const Function1< Type > &)=delete
 Disallow default bitwise 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 &entryName, const dictionary &dict)
 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 refCount
 refCount ()
 Construct null initializing count to 0. More...
 
- Protected Attributes inherited from Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type, class Function1Type>
class Foam::FieldFunction1< Type, Function1Type >

Definition at line 174 of file Function1.H.

Constructor & Destructor Documentation

◆ FieldFunction1() [1/2]

FieldFunction1 ( const word entryName)

Construct from entry name.

Definition at line 47 of file Function1.C.

Referenced by FieldFunction1< Type, Sine< Type > >::FieldFunction1().

Here is the caller graph for this function:

◆ FieldFunction1() [2/2]

FieldFunction1 ( const FieldFunction1< Type, Function1Type > &  ff1)

Copy constructor.

Definition at line 57 of file Function1.C.

◆ ~FieldFunction1()

~FieldFunction1 ( )
virtual

Destructor.

Definition at line 84 of file Function1.C.

Member Function Documentation

◆ clone()

Foam::tmp< Foam::Function1< Type > > clone ( ) const
virtual

Construct and return a clone.

Implements Function1< Type >.

Reimplemented in Constant< Type >.

Definition at line 67 of file Function1.C.

◆ value() [1/2]

◆ value() [2/2]

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

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

Implements Function1< Type >.

Definition at line 106 of file Function1.C.

◆ integrate() [1/2]

◆ integrate() [2/2]

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

Integrate between two (scalar) values.

Implements Function1< Type >.

Definition at line 125 of file Function1.C.


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