Coded< Type > Class Template Reference

Constructs a dynamically compiled function of two variables. More...

Inheritance diagram for Coded< Type >:
Collaboration diagram for Coded< Type >:

Public Member Functions

 TypeName ("coded")
 
 Coded (const word &name, const unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Coded (const Coded< Type > &cf1)
 Copy constructor. More...
 
virtual tmp< Function2< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Coded ()
 Destructor. More...
 
virtual Type value (const scalar x, const scalar y) const
 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...
 
virtual void write (Ostream &os, const unitConversions &units) const
 Write data to dictionary stream. More...
 
void operator= (const Coded< Type > &)=delete
 Disallow default bitwise assignment. 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...
 
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...
 
- Public Member Functions inherited from codedBase
 TypeName ("codedBase")
 Runtime type information. More...
 
 codedBase ()
 Construct null. More...
 
 codedBase (const word &name, const dictionary &dict)
 Construct from name and dictionary. More...
 
 codedBase (const dictionary &dict)
 Construct from dictionary. More...
 
 codedBase (const codedBase &cb)
 Copy constructor. More...
 
virtual ~codedBase ()
 Destructor. More...
 
void operator= (const codedBase &)=delete
 Disallow default bitwise assignment. More...
 
word codeTemplateC (const word &baseTypeName) const
 
word codeTemplateH (const word &baseTypeName) const
 
virtual void writeCode (Ostream &os) const
 

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 Member Functions inherited from codedBase
void updateLibrary () const
 Update library as required. More...
 
virtual const wordcodeName () const
 Name of the dynamically generated CodedType. More...
 
virtual string description () const
 Return a description (type + name) for the output. More...
 
virtual const dictionarycodeDict () const
 Get the dictionary to initialise the codeContext. More...
 
- Protected Attributes inherited from Function2< Type >
const word name_
 Name of entry. More...
 

Detailed Description

template<class Type>
class Foam::Function2s::Coded< Type >

Constructs a dynamically compiled function of two variables.

See also
Foam::dynamicCode Foam::functionEntries::codeStream
Source files

Definition at line 69 of file CodedFunction2.H.

Constructor & Destructor Documentation

◆ Coded() [1/2]

Coded ( const word name,
const unitConversions units,
const dictionary dict 
)

Construct from name and dictionary.

Definition at line 108 of file CodedFunction2.C.

◆ Coded() [2/2]

Coded ( const Coded< Type > &  cf1)

Copy constructor.

Definition at line 125 of file CodedFunction2.C.

◆ ~Coded()

~Coded
virtual

Destructor.

Definition at line 145 of file CodedFunction2.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coded"  )

◆ clone()

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

Construct and return a clone.

Implements Function2< Type >.

Definition at line 136 of file CodedFunction2.C.

◆ value() [1/2]

Type value ( const scalar  x,
const scalar  y 
) const
inlinevirtual

Return value as a function of two scalars.

Implements Function2< Type >.

Definition at line 31 of file CodedFunction2I.H.

References x, and y.

◆ 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 >.

Definition at line 152 of file CodedFunction2.C.

References x, and y.

◆ write()

void write ( Ostream os,
const unitConversions units 
) const
virtual

Write data to dictionary stream.

Implements Function2< Type >.

Definition at line 171 of file CodedFunction2.C.

◆ operator=()

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

Disallow default bitwise assignment.


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