File size: 4,301 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::codedBase
Description
Base class for coded functionObjects, fvModels, Function1, Function2
and boundary conditions
SourceFiles
codedBase.C
\*---------------------------------------------------------------------------*/
#ifndef codedBase_H
#define codedBase_H
#include "dynamicCode.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class codedBase Declaration
\*---------------------------------------------------------------------------*/
class codedBase
:
public dynamicCode
{
// Private Data
//- Optional switch to allow library unloading and reloading
// to support run-time code update
const bool reloadable_;
//- Previously loaded library
mutable fileName oldLibPath_;
// Private Member Functions
//- Global loader/unloader function type
typedef void (*loaderFunctionType)(bool);
void checkLibrary
(
const dictionary& dict,
const fileName& libPath,
void* lib,
const string& uniqueFuncName,
const bool load
) const;
//- Load specified library and execute uniqueFuncName(true)
void* loadLibrary
(
const dictionary& dict,
const fileName& libPath,
const string& uniqueFuncName
) const;
//- Execute uniqueFuncName(false) and unload specified library
void unloadLibrary
(
const dictionary& dict,
const fileName& libPath,
const string& uniqueFuncName
) const;
verbatimString expandCodeString
(
const dictionary& dict,
const word& codeKey,
const word& codeDictVar
) const;
public:
//- Runtime type information
TypeName("codedBase");
// Constructors
//- Construct from name and dictionary
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
);
//- Destructor
virtual ~codedBase();
// Member Functions
//- Create a coded name from the given name
static word codedName(const word& name);
//- Update library from given updated dictionary as required
// Returns true if the library was updated, otherwise false
bool updateLibrary(const dictionary& dict) const;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const codedBase&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|