codedBase Class Reference

Base class for coded functionObjects, fvModels, Function1, Function2. More...

Inheritance diagram for codedBase:
Collaboration diagram for codedBase:

Public Member Functions

 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 wordcodeName () const
 Return the code-name. More...
 
const wordcodeSha1Name () 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...
 

Static Public Member Functions

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...
 

Additional Inherited Members

- Static Public Attributes inherited from dynamicCode
static int allowSystemOperations
 Flag if system operations are allowed. More...
 

Detailed Description

Base class for coded functionObjects, fvModels, Function1, Function2.

and boundary conditions

Source files

Definition at line 50 of file codedBase.H.

Constructor & Destructor Documentation

◆ codedBase()

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.

Definition at line 157 of file codedBase.C.

◆ ~codedBase()

~codedBase ( )
virtual

Destructor.

Definition at line 186 of file codedBase.C.

References dynamicCode::libraryBaseName().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "codedBase"  )

Runtime type information.

◆ codedName()

Foam::word codedName ( const word name)
static

Create a coded name from the given name.

Definition at line 202 of file codedBase.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::blendedInterfacialModel::valid().

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

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

◆ updateLibrary()

◆ operator=()

void operator= ( const codedBase )
delete

Disallow default bitwise assignment.


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