src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::codedFunctionObject
  26
  27 Description
  28     functionObject using dynamic code compilation.
  29
  30 SourceFiles
  31     codedFunctionObject.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef codedFunctionObject_H
  36 #define codedFunctionObject_H
  37
  38 #include "pointFieldFwd.H"
  39 #include "functionObject.H"
  40 #include "dictionary.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class objectRegistry;
  49 class dictionary;
  50 class mapPolyMesh;
  51 class dynamicCode;
  52 class dynamicCodeContext;
  53 class IOdictionary;
  54
  55 /*---------------------------------------------------------------------------*\
  56                        Class codedFunctionObject Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class codedFunctionObject
  60 :
  61     public functionObject
  62 {
  63 protected:
  64
  65     // Protected data
  66
  67         //- Reference to the time database
  68         const Time& time_;
  69
  70         //- Input dictionary
  71         dictionary dict_;
  72
  73         word redirectType_;
  74
  75         string codeRead_;
  76         string codeExecute_;
  77         string codeEnd_;
  78
  79         //- Previously loaded library
  80         mutable fileName oldLibPath_;
  81
  82         //- Underlying functionObject
  83         mutable autoPtr<functionObject> redirectFunctionObjectPtr_;
  84
  85     // Private Member Functions
  86
  87         //- Global loader/unloader function type
  88         typedef void (*loaderFunctionType)(bool);
  89
  90         //- Load specified library and execute globalFuncName(true)
  91         void* loadLibrary
  92         (
  93             const fileName& libPath,
  94             const string& globalFuncName,
  95             const dictionary& contextDict
  96         ) const;
  97
  98         //- Execute globalFuncName(false) and unload specified library
  99         void unloadLibrary
 100         (
 101             const fileName& libPath,
 102             const string& globalFuncName,
 103             const dictionary& contextDict
 104         ) const;
 105
 106
 107         //- Create library based on the dynamicCodeContext
 108         void createLibrary(dynamicCode&, const dynamicCodeContext&) const;
 109
 110         //- Update library as required
 111         void updateLibrary() const;
 112
 113         //- Read relevant dictionary entries
 114         void readDict();
 115
 116         //- Disallow default bitwise copy construct
 117         codedFunctionObject(const codedFunctionObject&);
 118
 119         //- Disallow default bitwise assignment
 120         void operator=(const codedFunctionObject&);
 121
 122
 123 public:
 124
 125     //- Runtime type information
 126     TypeName("coded");
 127
 128
 129     // Constructors
 130
 131         //- Construct for given objectRegistry and dictionary.
 132         //  Allow the possibility to load fields from files
 133         codedFunctionObject
 134         (
 135             const word& name,
 136             const Time& time,
 137             const dictionary& dict
 138         );
 139
 140
 141     //- Destructor
 142     virtual ~codedFunctionObject();
 143
 144
 145     // Member Functions
 146
 147         //- Dynamically compiled functionObject
 148         functionObject& redirectFunctionObject() const;
 149
 150         //- Called at the start of the time-loop
 151         virtual bool start();
 152
 153         //- Called at each ++ or += of the time-loop. forceWrite overrides the
 154         //  outputControl behaviour.
 155         virtual bool execute(const bool forceWrite);
 156
 157         //- Called when Time::run() determines that the time-loop exits.
 158         //  By default it simply calls execute().
 159         virtual bool end();
 160
 161         //- Read and set the function object if its data have changed
 162         virtual bool read(const dictionary&);
 163 };
 164
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 } // End namespace Foam
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 #endif
 173
 174 // ************************************************************************* //