Coded< Type > Class Template Reference

Constructs a dynamically compiled Function1. More...

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

Public Member Functions

 TypeName ("coded")
 
 Coded (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Construct from name and dictionary. More...
 
 Coded (const Coded< Type > &cf1)
 Copy constructor. More...
 
virtual tmp< Function1< Type > > clone () const
 Construct and return a clone. More...
 
virtual ~Coded ()
 Destructor. More...
 
virtual Type value (const scalar x) const
 Return value as a function of a scalar. More...
 
virtual tmp< Field< Type > > value (const scalarField &x) const
 Return value as a function of a scalar field. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Integrate between two scalars. More...
 
virtual tmp< Field< Type > > integral (const scalarField &x1, const scalarField &x2) const
 Integrate between 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 Function1< Type >
 TypeName ("Function1")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, Function1, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitConversions &units, Istream &is),(name, units, is))
 
 Function1 (const word &name)
 Construct from 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 bool constant () const
 Is this function guaranteed to be constant? More...
 
void operator= (const Function1< 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 Function1< Type >
typedef Type returnType
 
- Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const dictionary &dict)
 Select from dictionary. More...
 
static autoPtr< Function1< Type > > New (const word &name, const Function1s::unitConversions &units, const word &Function1Type, Istream &is)
 Select from Istream. More...
 
static autoPtr< Function1< Type > > New (const word &name, const unitConversion &xUnits, const unitConversion &valueUnits, const word &Function1Type, 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 Function1< Type >
const word name_
 Name of entry. More...
 

Detailed Description

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

Constructs a dynamically compiled Function1.

Usage
Example of a cosine bell shaped pulse inlet:
inlet
{
    type            uniformFixedValue;
    uniformValue    coded;

    name            pulse;

    codeInclude
    #{
        #include "mathematicalConstants.H"
    #};

    code
    #{
        return vector
        (
            0.5*(1 - cos(constant::mathematical::twoPi*min(x/0.3, 1))),
            0,
            0
        );
    #};
}
See also
Foam::dynamicCode Foam::functionEntries::codeStream
Source files

Definition at line 84 of file CodedFunction1.H.

Constructor & Destructor Documentation

◆ Coded() [1/2]

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

Construct from name and dictionary.

Definition at line 108 of file CodedFunction1.C.

◆ Coded() [2/2]

Coded ( const Coded< Type > &  cf1)

Copy constructor.

Definition at line 125 of file CodedFunction1.C.

◆ ~Coded()

~Coded
virtual

Destructor.

Definition at line 145 of file CodedFunction1.C.

Member Function Documentation

◆ TypeName()

TypeName ( "coded"  )

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 136 of file CodedFunction1.C.

◆ value() [1/2]

Type value ( const scalar  x) const
inlinevirtual

Return value as a function of a scalar.

Implements Function1< Type >.

Definition at line 31 of file CodedFunction1I.H.

References x.

◆ value() [2/2]

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

Return value as a function of a scalar field.

Implements Function1< Type >.

Definition at line 152 of file CodedFunction1.C.

References x.

◆ integral() [1/2]

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

Integrate between two scalars.

Implements Function1< Type >.

Definition at line 169 of file CodedFunction1.C.

References NotImplemented.

◆ integral() [2/2]

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

Integrate between two scalar fields.

Implements Function1< Type >.

Definition at line 181 of file CodedFunction1.C.

References NotImplemented.

◆ write()

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

Write data to dictionary stream.

Implements Function1< Type >.

Definition at line 193 of file CodedFunction1.C.

◆ operator=()

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

Disallow default bitwise assignment.


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