Public Member Functions | List of all members
codedBase Class Referenceabstract

Base class for function objects and boundary conditions using dynamic code. More...

Inheritance diagram for codedBase:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("codedBase")
 Runtime type information. More...
 
 codedBase (const word &name, const dictionary &dict, const wordList &codeKeys, const wordList &codeDictVars)
 Construct from name and dictionary. More...
 
 codedBase (const dictionary &dict, const wordList &codeKeys, const wordList &codeDictVars)
 Construct from dictionary. More...
 
 codedBase (const codedBase &cb)
 Copy constructor. More...
 
virtual ~codedBase ()
 Destructor. More...
 
const word & codeName () const
 Name of the dynamically generated CodedType. More...
 
string description () const
 Return a description (type + name) for the output. More...
 
word codeTemplateC (const word &baseTypeName) const
 
word codeTemplateH (const word &baseTypeName) const
 
bool updateLibrary (const dictionary &dict) const
 Update library from given updated dictionary as required. More...
 
void read (const dictionary &dict)
 Read the dictionary and update the code. More...
 
void write (Ostream &os) const
 Write the code for restart. More...
 
void operator= (const codedBase &)=delete
 Disallow default bitwise assignment. More...
 

Detailed Description

Base class for function objects and boundary conditions using dynamic code.

Source files

Definition at line 51 of file codedBase.H.

Constructor & Destructor Documentation

◆ codedBase() [1/3]

codedBase ( const word &  name,
const dictionary &  dict,
const wordList &  codeKeys,
const wordList &  codeDictVars 
)

Construct from name and dictionary.

Definition at line 335 of file codedBase.C.

◆ codedBase() [2/3]

codedBase ( const dictionary &  dict,
const wordList &  codeKeys,
const wordList &  codeDictVars 
)

Construct from dictionary.

Definition at line 348 of file codedBase.C.

◆ codedBase() [3/3]

codedBase ( const codedBase &  cb)

Copy constructor.

Definition at line 359 of file codedBase.C.

◆ ~codedBase()

~codedBase ( )
virtual

Destructor.

Definition at line 368 of file codedBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "codedBase"  )

Runtime type information.

◆ codeName()

const Foam::word & codeName ( ) const

Name of the dynamically generated CodedType.

Definition at line 374 of file codedBase.C.

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

Here is the caller graph for this function:

◆ description()

Foam::string description ( ) const

Return a description (type + name) for the output.

Definition at line 380 of file codedBase.C.

References Foam::type().

Here is the call graph for this function:

◆ codeTemplateC()

Foam::word codeTemplateC ( const word &  baseTypeName) const

Definition at line 386 of file codedBase.C.

◆ codeTemplateH()

Foam::word codeTemplateH ( const word &  baseTypeName) const

Definition at line 392 of file codedBase.C.

◆ updateLibrary()

bool updateLibrary ( const dictionary &  dict) const

Update library from given updated dictionary as required.

Returns true if the library was updated, otherwise false

Definition at line 398 of file codedBase.C.

References dynamicCode::checkSecurity(), dynamicCode::codeName(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dlLibraryTable::findLibrary(), Foam::Info, dynamicCode::libPath(), dynamicCode::libraryBaseName(), Foam::libs, dictionaryName::name(), Foam::name(), and dictionary::startLineNumber().

Referenced by Coded< Type >::Coded(), codedFixedValueFvPatchField< Type >::codedFixedValueFvPatchField(), codedFixedValuePointPatchField< Type >::codedFixedValuePointPatchField(), codedMixedFvPatchField< Type >::codedMixedFvPatchField(), and compileTemplate::compileTemplate().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

void read ( const dictionary &  dict)

Read the dictionary and update the code.

Definition at line 455 of file codedBase.C.

References dict.

Referenced by codedFunctionObject::read(), and codedFvModel::read().

Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const

Write the code for restart.

Definition at line 461 of file codedBase.C.

References Foam::writeEntry().

Referenced by codedFixedValueFvPatchField< Type >::write(), codedMixedFvPatchField< Type >::write(), codedFixedValuePointPatchField< Type >::write(), and Coded< Type >::write().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const codedBase &  )
delete

Disallow default bitwise assignment.

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