etc/codeTemplates/dynamicCode/codeStreamTemplate.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 Description
  25     Template for use with codeStream.
  26
  27 \*---------------------------------------------------------------------------*/
  28
  29 #include "dictionary.H"
  30 #include "Ostream.H"
  31 #include "Pstream.H"
  32
  33 //{{{ begin codeInclude
  34 ${codeInclude}
  35 //}}} end codeInclude
  36
  37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  38
  39 namespace Foam
  40 {
  41
  42 // * * * * * * * * * * * * * * * Local Functions * * * * * * * * * * * * * * //
  43
  44 //{{{ begin localCode
  45 ${localCode}
  46 //}}} end localCode
  47
  48
  49 // * * * * * * * * * * * * * * * Global Functions  * * * * * * * * * * * * * //
  50
  51 extern "C"
  52 {
  53     void ${typeName}
  54     (
  55         Ostream& os,
  56         const dictionary& dict
  57     )
  58     {
  59 //{{{ begin code
  60         ${code}
  61 //}}} end code
  62     }
  63 }
  64
  65
  66 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  67
  68 } // End namespace Foam
  69
  70 // ************************************************************************* //