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::unitSets &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 unitSets &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::unitSets &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function1, Istream,(const word &name, const Function1s::unitSets &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 word &	name () 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 (const word &name, const dictionary &dict, const wordList &codeKeys, const wordList &codeDictVars, const word &codeOptionsFileName, const wordList &compileFiles, const wordList &copyFiles, const bool reloadable=true)
	Construct from name and dictionary. More...

virtual	~codedBase ()
	Destructor. More...

bool	updateLibrary (const dictionary &dict) const
	Update library from given updated dictionary as required. More...

void	operator= (const codedBase &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from dynamicCode
	ClassName ("dynamicCode")

	dynamicCode (const dictionary &contextDict, const dictionary &codeDict, const word &codeName, const word &codeDirName, const wordList &codeKeys, const wordList &codeDictVars, const word &optionsFileName, const wordList &compileFiles, const wordList &copyFiles)
	Construct from the context and code dictionaries. More...

	dynamicCode (const dictionary &contextDict, const word &codeName, const word &codeDirName, const wordList &codeKeys, const wordList &codeDictVars, const word &optionsFileName, const wordList &compileFiles, const wordList &copyFiles)
	Construct from the context dictionary also containing the code. More...

const word &	codeName () const
	Return the code-name. More...

const word &	codeSha1Name () const
	Return the unique code name. More...

fileName	libPath () const
	Library path for specified code name. More...

fileName	libRelPath () const
	Library path for specified code name relative to $FOAM_CASE. More...

HashTable< string > &	varSubstitutions ()

bool	upToDate () const
	Verify if the copied code is up-to-date, based on Make/SHA1Digest. More...

bool	copyOrCreateFiles (const bool verbose=false) const
	Copy/create files prior to compilation. More...

bool	wmakeLibso () const
	Compile a libso. More...

void *	loadLibrary (const fileName &libPath) const

void	createLibrary (const dictionary &dict, const bool masterOnlyRead=false) const

void	read (const dictionary &contextDict, const dictionary &codeDict)

void	read (const dictionary &contextDict)

void	write (Ostream &os) const
	Write the code for restart. 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 &name, const Function1s::unitSets &units, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitSet &xUnits, const unitSet &valueUnits, const dictionary &dict)
	Select from dictionary. More...

static autoPtr< Function1< Type > >	New (const Function1s::unitSets &units, const entry &e)
	Select from an entry. More...

static autoPtr< Function1< Type > >	New (const unitSet &xUnits, const unitSet &valueUnits, const entry &e)
	Select from an entry. More...

static autoPtr< Function1< Type > >	New (const word &name, const Function1s::unitSets &units, const word &Function1Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function1< Type > >	New (const word &name, const unitSet &xUnits, const unitSet &valueUnits, const word &Function1Type, Istream &is)
	Select from Istream. More...

Static Public Member Functions inherited from codedBase
static word	codedName (const word &name)
	Create a coded name from the given name. More...

Static Public Member Functions inherited from dynamicCode
static word	libraryBaseName (const fileName &libPath)
	Return the library basename without leading 'lib' or trailing '.so'. More...

static fileName	resolveTemplate (const fileName &templateName)
	Resolve code-template via Foam::findConfigFile. More...

Static Public Attributes inherited from dynamicCode
static int	allowSystemOperations
	Flag if system operations are allowed. 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 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
        );
    #};
}