data/templates/foamTemplate.H

   1 /*----------------------------------------------------------------------------*\
   2                 ______                _     ____          __  __
   3                |  ____|             _| |_  / __ \   /\   |  \/  |
   4                | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
   5                |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
   6                | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
   7                |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
   8
   9                     FreeFOAM: The Cross-Platform CFD Toolkit
  10
  11   Copyright (C) 2008-2009 Michael Wild <themiwi@users.sf.net>
  12                           Gerber van der Graaf <gerber_graaf@users.sf.net>
  13 --------------------------------------------------------------------------------
  14 License
  15     This file is part of FreeFOAM.
  16
  17     FreeFOAM is free software; you can redistribute it and/or modify it
  18     under the terms of the GNU General Public License as published by the
  19     Free Software Foundation; either version 2 of the License, or (at your
  20     option) any later version.
  21
  22     FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
  23     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  24     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  25     for more details.
  26
  27     You should have received a copy of the GNU General Public License
  28     along with FreeFOAM; if not, write to the Free Software Foundation,
  29     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  30
  31 Class
  32     Foam::className
  33
  34 Description
  35
  36 SourceFiles
  37     classNameI.H
  38     className.C
  39     classNameIO.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef className_H
  44 #define className_H
  45
  46 #include </.H>
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Forward declaration of classes
  54 class Istream;
  55 class Ostream;
  56
  57 // Forward declaration of friend functions and operators
  58 class className;
  59 Istream& operator>>(Istream&, className&);
  60 Ostream& operator<<(Ostream&, const className&);
  61
  62
  63 /*---------------------------------------------------------------------------*\
  64                           Class className Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class className
  68 :
  69     public baseClassName
  70 {
  71     // Private data
  72
  73         //- Description of data_
  74         dataType data_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow default bitwise copy construct
  80         className(const className&);
  81
  82         //- Disallow default bitwise assignment
  83         void operator=(const className&);
  84
  85
  86 public:
  87
  88     // Static data members
  89
  90         //- Static data staticData
  91         static const dataType staticData;
  92
  93
  94     // Constructors
  95
  96         //- Construct null
  97         className();
  98
  99         //- Construct from components
 100         className(const dataType& data);
 101
 102         //- Construct from Istream
 103         className(Istream&);
 104
 105         //- Construct as copy
 106         className(const className&);
 107
 108
 109     // Selectors
 110
 111         //- Select null constructed
 112         static autoPtr<className> New();
 113
 114
 115     //- Destructor
 116     ~className();
 117
 118
 119     // Member Functions
 120
 121         // Access
 122
 123         // Check
 124
 125         // Edit
 126
 127         // Write
 128
 129
 130     // Member Operators
 131
 132         void operator=(const className&);
 133
 134
 135     // Friend Functions
 136
 137     // Friend Operators
 138
 139     // IOstream Operators
 140
 141         friend Istream& operator>>(Istream&, className&);
 142         friend Ostream& operator<<(Ostream&, const className&);
 143 };
 144
 145
 146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 147
 148 } // End namespace Foam
 149
 150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 151
 152 #include "classNameI.H"
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 #endif
 157
 158 // ************************ vim: set sw=4 sts=4 et: ************************ //