codedFunctionObject.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
    Copyright (C) 2019-2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::functionObjects::codedFunctionObject
 
Group
    grpUtilitiesFunctionObjects
 
Description
    Provides a general interface to enable dynamic code compilation.
 
Usage
    Minimal example by using \c system/controlDict.functions:
    \verbatim
    difference
    {
        // Mandatory entries
        type                coded;
        libs                (utilityFunctionObjects);
 
        // Name of on-the-fly generated functionObject
        name                <word>;  // writeMagU;
        codeWrite
        #{
            // Lookup U
            const volVectorField& U = mesh().lookupObject<volVectorField>("U");
 
            // Write
            mag(U)().write();
        #};
        ...
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      Property | Description                        | Type | Reqd | Deflt
      type     | Type name: coded                   | word | yes  | -
      libs     | Library name: utilityFunctionObjects | word | yes | -
      name     | Name of the function object        | word | yes  | -
      codeInclude | include files                   | word | no | -
      codeOptions | compiler line: added to EXE_INC (Make/options) | word | no | -
      codeLibs    | linker line: added to LIB_LIBS (Make/options) | word | no | -
      codeData    | c++; local member data (default constructed) | word | no | -
      localCode   | c++; local static functions | word | no | -
      codeRead    | c++; upon functionObject::read() | word | no | -
      codeExecute | c++; upon functionObject::execute() | word | no | -
      codeWrite   | c++; upon functionObject::write() | word | no | -
      codeEnd     | c++; upon functionObject::end() | word | no | -
      codeContext | additional dictionary context for the code | word | no | -
    \endtable
 
    The inherited entries are elaborated in:
      - \link timeFunctionObject.H \endlink
      - \link codedBase.H \endlink
Note
    The code context dictionary can be supplied separately as the
    \c codeContext entry.
 
SourceFiles
    codedFunctionObject.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef Foam_functionObjects_codedFunctionObject_H
#define Foam_functionObjects_codedFunctionObject_H
 
#include "timeFunctionObject.H"
#include "codedBase.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace functionObjects
{
 
/*---------------------------------------------------------------------------*\
                     Class codedFunctionObject Declaration
\*---------------------------------------------------------------------------*/
 
class codedFunctionObject
:
    public functionObjects::timeFunctionObject,
    public codedBase
{
protected:
 
    // Protected Data
 
        //- Input dictionary
        dictionary dict_;
 
        word name_;
 
        string codeData_;
        string codeRead_;
        string codeExecute_;
        string codeWrite_;
        string codeEnd_;
 
        //- Underlying functionObject
        mutable autoPtr<functionObject> redirectFunctionObjectPtr_;
 
 
    // Protected Member Functions
 
        //- Mutable access to the loaded dynamic libraries
        virtual dlLibraryTable& libs() const;
 
        //- Description (type + name) for the output
        virtual string description() const;
 
        //- Clear redirected object(s)
        virtual void clearRedirect() const;
 
        //- Additional 'codeContext' dictionary to pass through
        virtual const dictionary& codeContext() const;
 
        //- The code dictionary
        virtual const dictionary& codeDict() const;
 
        //- Adapt the context for the current object
        virtual void prepare(dynamicCode&, const dynamicCodeContext&) const;
 
 
        //- No copy construct
        codedFunctionObject(const codedFunctionObject&) = delete;
 
        //- No copy assignment
        void operator=(const codedFunctionObject&) = delete;
 
 
public:
 
    // Static Data Members
 
        //- Name of the C code template to be used
        static constexpr const char* const codeTemplateC
            = "functionObjectTemplate.C";
 
        //- Name of the H code template to be used
        static constexpr const char* const codeTemplateH
            = "functionObjectTemplate.H";
 
 
    //- Runtime type information
    TypeName("coded");
 
 
    // Constructors
 
        //- Construct from name, Time and dictionary
        codedFunctionObject
        (
            const word& name,
            const Time& runTime,
            const dictionary& dict
        );
 
 
    //- Destructor
    virtual ~codedFunctionObject() = default;
 
 
    // Member Functions
 
        //- Dynamically compiled functionObject
        functionObject& redirectFunctionObject() const;
 
        //- Called at each ++ or += of the time-loop.
        //  postProcess overrides the usual executeControl behaviour and
        //  forces execution (used in post-processing mode)
        virtual bool execute();
 
        //- Called at each ++ or += of the time-loop.
        //  postProcess overrides the usual writeControl behaviour and
        //  forces writing always (used in post-processing mode)
        virtual bool write();
 
        //- Called when Time::run() determines that the time-loop exits.
        //  By default it simply calls execute().
        virtual bool end();
 
        //- Read and set the function object if its data have changed
        virtual bool read(const dictionary&);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace functionObjects
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //