FieldFunction2< Type, Function2Type > Class Template Referenceabstract
Inheritance diagram for FieldFunction2< Type, Function2Type >:
Collaboration diagram for FieldFunction2< Type, Function2Type >:

Public Member Functions

 FieldFunction2 (const word &name)
 Construct from name. More...
 
virtual tmp< Function2< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~FieldFunction2 ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const =0
 Return value as a function of two scalars. More...
 
virtual tmp< Field< Type > > value (const scalarField &x, const scalarField &y) const
 Return value as a function of two scalar fields. More...
 
- Public Member Functions inherited from Function2< Type >
 TypeName ("Function2")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitConversions &units, Istream &is),(name, units, is))
 
 Function2 (const word &name)
 Construct from name. More...
 
 Function2 (const Function2< Type > &f2)
 Copy constructor. More...
 
virtual ~Function2 ()
 Destructor. More...
 
const wordname () const
 Return the name of the entry. More...
 
virtual void write (Ostream &os, const Function2s::unitConversions &) const =0
 Write in dictionary format. 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 Function2s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function2< Type > > New (const word &name, const Function2s::unitConversions &units, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function2< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &yUnits, const unitConversion &valueUnits, const word &Function2Type, Istream &is)
 Select from Istream. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type, class Function2Type>
class Foam::FieldFunction2< Type, Function2Type >

Definition at line 270 of file Function2.H.

Constructor & Destructor Documentation

◆ FieldFunction2()

FieldFunction2 ( const word name)

Construct from name.

Definition at line 46 of file Function2.C.

◆ ~FieldFunction2()

~FieldFunction2
virtual

Destructor.

Definition at line 71 of file Function2.C.

Member Function Documentation

◆ clone()

Foam::tmp< Foam::Function2< Type > > clone
virtual

Construct and return a clone.

Implements Function2< Type >.

Reimplemented in APIdiffCoef, and Constant< Type >.

Definition at line 54 of file Function2.C.

◆ value() [1/2]

virtual Type value ( const scalar  x,
const scalar  y 
) const
pure virtual

◆ value() [2/2]

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

Return value as a function of two scalar fields.

Implements Function2< Type >.

Reimplemented in ZeroConstant< Type >, OneConstant< Type >, and Constant< Type >.

Definition at line 85 of file Function2.C.

References fld(), forAll, tmp< T >::ref(), x, and y.

Here is the call graph for this function:

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