codedBase.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2024 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 function objects and boundary conditions using dynamic code
 
SourceFiles
    codedBase.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef codedBase_H
#define codedBase_H
 
#include "dictionary.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class dynamicCode;
class dynamicCodeContext;
class dlLibraryTable;
 
/*---------------------------------------------------------------------------*\
                          Class codedBase Declaration
\*---------------------------------------------------------------------------*/
 
class codedBase
{
    // Private Member Data
 
        //- Name of the dynamically generated CodedType
        const word codeName_;
 
        //- Dictionary contents for the CodedType
        const dictionary dict_;
 
        //- Previously loaded library
        mutable fileName oldLibPath_;
 
 
    // Private Member Functions
 
        //- Global loader/unloader function type
        typedef void (*loaderFunctionType)(bool);
 
        //- Create a code name from the given function name
        static word codeName(const word& name);
 
        //- Load specified library and execute globalFuncName(true)
        void* loadLibrary
        (
            const fileName& libPath,
            const string& globalFuncName,
            const dictionary& contextDict
        ) const;
 
        //- Execute globalFuncName(false) and unload specified library
        void unloadLibrary
        (
            const fileName& libPath,
            const string& globalFuncName,
            const dictionary& contextDict
        ) const;
 
        //- Create library based on the dynamicCodeContext
        void createLibrary(dynamicCode&, const dynamicCodeContext&) const;
 
 
protected:
 
    // Protected Member Functions
 
        //- Update library as required
        void updateLibrary() const;
 
        //- Name of the dynamically generated CodedType
        virtual const word& codeName() const;
 
        //- Return a description (type + name) for the output
        virtual string description() const;
 
        //- Get the dictionary to initialise the codeContext
        virtual const dictionary& codeDict() const;
 
        //- Get the keywords associated with source code
        virtual wordList codeKeys() const = 0;
 
        //- Get the name of the dictionary variables in the source code
        virtual wordList codeDictVars() const = 0;
 
        //- Adapt the context for the current object
        virtual void prepare(dynamicCode&, const dynamicCodeContext&) const = 0;
 
        //- Clear any redirected objects
        virtual void clearRedirect() const = 0;
 
 
public:
 
    //- Runtime type information
    TypeName("codedBase");
 
 
    // Constructors
 
        //- Construct null
        codedBase();
 
        //- Construct from name and dictionary
        codedBase(const word& name, const dictionary& dict);
 
        //- Construct from dictionary
        codedBase(const dictionary& dict);
 
        //- Copy constructor
        codedBase(const codedBase& cb);
 
 
    //- Destructor
    virtual ~codedBase();
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const codedBase&) = delete;
 
 
    // Member Functions
 
        word codeTemplateC(const word& baseTypeName) const;
 
        word codeTemplateH(const word& baseTypeName) const;
 
        virtual void writeCode(Ostream& os) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //