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 unitSets &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 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 Function2< Type >
	TypeName ("Function2")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, Function2, dictionary,(const word &name, const Function2s::unitSets &units, const dictionary &dict),(name, units, dict))

	declareRunTimeSelectionTable (autoPtr, Function2, Istream,(const word &name, const Function2s::unitSets &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 word &	name () 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 (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 Function2< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function2< Type >
static autoPtr< Function2< Type > >	New (const word &name, const Function2s::unitSets &units, const dictionary &dict)
	Select from dictionary. More...

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

static autoPtr< Function2< Type > >	New (const word &name, const Function2s::unitSets &units, const word &Function2Type, Istream &is)
	Select from Istream. More...

static autoPtr< Function2< Type > >	New (const word &name, const unitSet &xUnits, const unitSet &yUnits, const unitSet &valueUnits, const word &Function2Type, 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 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 unitSets &	units,
		const dictionary &	dict
	)

Construct from name and dictionary.

Definition at line 64 of file CodedFunction2.C.

References dynamicCode::codeName(), dict, Foam::name(), Function2< Type >::New(), codedBase::updateLibrary(), and dynamicCode::varSubstitutions().

Here is the call graph for this function:

◆ Coded() [2/2]

Coded ( const Coded< Type > & cf1 )

Copy constructor.

Definition at line 105 of file CodedFunction2.C.

◆ ~Coded()

~Coded

virtual

Destructor.

Definition at line 124 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 115 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 131 of file CodedFunction2.C.

References x, and y.

◆ write()

void write	(	Ostream &	os,
		const unitSets &	units
	)		const

virtual

Write data to dictionary stream.

Implements Function2< Type >.

Definition at line 150 of file CodedFunction2.C.

References dynamicCode::write().

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:

src/OpenFOAM/primitives/functions/Function2/Coded/CodedFunction2.H
src/OpenFOAM/primitives/functions/Function2/Coded/CodedFunction2.C
src/OpenFOAM/primitives/functions/Function2/Coded/CodedFunction2I.H

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Coded() [1/2]

◆ Coded() [2/2]

◆ ~Coded()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ value() [1/2]

◆ value() [2/2]

◆ write()

◆ operator=()

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