All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 &entryName, const dictionary &dict)
 Construct from entry 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. 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
 Integrate between two values. 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...
 
void operator= (const Coded< Type > &)=delete
 Disallow default bitwise assignment. 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...
 
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...
 
- Public Member Functions inherited from CodedBase< coded >
 CodedBase ()
 Construct null. More...
 
 CodedBase (const dictionary &dict)
 Construct from dictionary. More...
 
 CodedBase (const CodedBase< coded > &cb)
 Copy constructor. More...
 
virtual ~CodedBase ()
 Destructor. More...
 
virtual const wordcodeName () const
 Name of the dynamically generated CodedType. More...
 
virtual const dictionarycodeDict () const
 Get the dictionary to initialize the codeContext. More...
 
void writeCode (Ostream &os) const
 
- Public Member Functions inherited from codedBase
 ClassName ("codedBase")
 Runtime type information. More...
 
 codedBase ()
 Construct null. More...
 
 codedBase (const codedBase &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~codedBase ()
 Destructor. More...
 
void operator= (const codedBase &)=delete
 Disallow default bitwise assignment. 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
 
- Static Public Attributes inherited from CodedBase< coded >
static const word codeTemplateC
 Name of the C code template to be used. More...
 
static const word codeTemplateH
 Name of the H code template to be used. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initializing count to 0. More...
 
- Protected Member Functions inherited from codedBase
void updateLibrary () const
 Update library as required. 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 96 of file CodedFunction1.H.

Constructor & Destructor Documentation

◆ Coded() [1/2]

Coded ( const word entryName,
const dictionary dict 
)

Construct from entry name and dictionary.

Definition at line 95 of file CodedFunction1.C.

◆ Coded() [2/2]

Coded ( const Coded< Type > &  cf1)

Copy constructor.

Definition at line 109 of file CodedFunction1.C.

◆ ~Coded()

~Coded ( )
virtual

Destructor.

Definition at line 128 of file CodedFunction1.C.

References Coded< Type >::value().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "coded"  )

◆ clone()

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

Construct and return a clone.

Implements Function1< Type >.

Definition at line 119 of file CodedFunction1.C.

◆ value() [1/2]

Type value ( const scalar  x) const
inlinevirtual

Return value.

Implements Function1< Type >.

Definition at line 31 of file CodedFunction1I.H.

Referenced by Coded< Type >::~Coded().

Here is the caller graph for this function:

◆ 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 136 of file CodedFunction1.C.

References Coded< Type >::integrate().

Here is the call graph for this function:

◆ integrate() [1/2]

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

Integrate between two values.

Implements Function1< Type >.

Definition at line 146 of file CodedFunction1.C.

References NotImplemented.

Referenced by Coded< Type >::value().

Here is the caller graph for this function:

◆ 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 158 of file CodedFunction1.C.

References NotImplemented.

◆ writeData()

void writeData ( Ostream os) const
virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 169 of file CodedFunction1.C.

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

Here is the call graph for this function:

◆ operator=()

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

Disallow default bitwise assignment.


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