etc/codeTemplates/dynamicCode/functionObjectTemplate.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 Description
  25     Template for use with dynamic code generation of a
  26     OutputFilter functionObject.
  27
  28 SourceFiles
  29     functionObjectTemplate.C
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef functionObjectTemplate_H
  34 #define functionObjectTemplate_H
  35
  36 #include "stringList.H"
  37 #include "pointField.H"
  38
  39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  40
  41 namespace Foam
  42 {
  43
  44 // Forward declaration of classes
  45 class objectRegistry;
  46 class dictionary;
  47 class mapPolyMesh;
  48 class fvMesh;
  49
  50 /*---------------------------------------------------------------------------*\
  51                          A templated functionObject
  52 \*---------------------------------------------------------------------------*/
  53
  54 class ${typeName}FunctionObject
  55 {
  56     // Private data
  57
  58         //- Name of this set of system calls
  59         word name_;
  60
  61         //- Registry
  62         const objectRegistry& obr_;
  63
  64 //{{{ begin codeData
  65         ${codeData}
  66 //}}} end codeData
  67
  68
  69     // Private Member Functions
  70
  71         const objectRegistry& obr() const;
  72
  73         const fvMesh& mesh() const;
  74
  75         //- Disallow default bitwise copy construct
  76         ${typeName}FunctionObject(const ${typeName}FunctionObject&);
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const ${typeName}FunctionObject&);
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("${typeName}");
  86
  87
  88     // Constructors
  89
  90         //- Construct for given objectRegistry and dictionary.
  91         //  Allow the possibility to load fields from files
  92         ${typeName}FunctionObject
  93         (
  94             const word& name,
  95             const objectRegistry& unused,
  96             const dictionary&,
  97             const bool loadFromFilesUnused = false
  98         );
  99
 100
 101     //- Destructor
 102     virtual ~${typeName}FunctionObject();
 103
 104
 105     // Member Functions
 106
 107         //- Return name of the system call set
 108         virtual const word& name() const
 109         {
 110             return name_;
 111         }
 112
 113         //- Read the system calls
 114         virtual void read(const dictionary&);
 115
 116         //- Execute the "executeCalls" at each time-step
 117         virtual void execute();
 118
 119         //- Execute the "endCalls" at the final time-loop
 120         virtual void end();
 121
 122         //- Write, execute the "writeCalls"
 123         virtual void write();
 124
 125         //- Update for changes of mesh
 126         virtual void updateMesh(const mapPolyMesh&)
 127         {}
 128
 129         //- Update for changes of mesh
 130         virtual void movePoints(const pointField&)
 131         {}
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //