src/triSurface/triSurface/surfacePatch/surfacePatchIOList.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::surfacePatchIOList
  27
  28 Description
  29     IOobject for a surfacePatchList
  30
  31 SourceFiles
  32     surfacePatchIOList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef surfacePatchIOList_H
  37 #define surfacePatchIOList_H
  38
  39 #include "surfacePatchList.H"
  40 #include "regIOobject.H"
  41 #include "faceList.H"
  42 #include "className.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // Forward declaration of classes
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class surfacePatchIOList Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class surfacePatchIOList
  56 :
  57     public surfacePatchList,
  58     public regIOobject
  59 {
  60     // Private data
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         surfacePatchIOList(const surfacePatchIOList&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const surfacePatchIOList&);
  70
  71
  72 public:
  73
  74     //- Runtime type information
  75     TypeName("surfacePatchIOList");
  76
  77
  78     // Static data members
  79
  80         //- Static data someStaticData
  81
  82     // Constructors
  83
  84         //- Construct from IOobject
  85         explicit surfacePatchIOList(const IOobject& io);
  86
  87         //- Construct from IOobject
  88         surfacePatchIOList(const IOobject& io, const surfacePatchList&);
  89
  90     // Destructor
  91
  92         ~surfacePatchIOList();
  93
  94
  95     // Member Functions
  96
  97         //- writeData member function required by regIOobject
  98         bool writeData(Ostream&) const;
  99
 100
 101     // Member Operators
 102
 103     // Friend Functions
 104
 105     // Friend Operators
 106
 107     // IOstream Operators
 108
 109         friend Ostream& operator<<(Ostream&, const surfacePatchIOList&);
 110 };
 111
 112
 113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 114
 115 } // End namespace Foam
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 #endif
 120
 121 // ************************************************************************* //