etc/codeTemplates/dynamicCode/FilterFunctionObjectTemplate.C

   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 \*---------------------------------------------------------------------------*/
  25
  26 #include "FilterFunctionObjectTemplate.H"
  27
  28 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
  29
  30 extern "C"
  31 {
  32     // dynamicCode:
  33     // SHA1 = ${SHA1sum}
  34     //
  35     // unique function name that can be checked if the correct library version
  36     // has been loaded
  37     void ${typeName}_${SHA1sum}(bool load)
  38     {
  39         if (load)
  40         {
  41             // code that can be explicitly executed after loading
  42         }
  43         else
  44         {
  45             // code that can be explicitly executed before unloading
  46         }
  47     }
  48 }
  49
  50 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  51
  52 namespace Foam
  53 {
  54     defineNamedTemplateTypeNameAndDebug(${typeName}FilterFunctionObject, 0);
  55
  56     //addToRunTimeSelectionTable
  57     addRemovableToRunTimeSelectionTable
  58     (
  59         functionObject,
  60         ${typeName}FilterFunctionObject,
  61         dictionary
  62     );
  63 }
  64
  65 // ************************************************************************* //