src/triSurface/triSurface/geometricSurfacePatch/geometricSurfacePatch.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::geometricSurfacePatch
  27
  28 Description
  29     The geometricSurfacePatch is like patchIdentifier but for surfaces.
  30     Holds type, name and index.
  31
  32 SourceFiles
  33     geometricSurfacePatch.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef geometricSurfacePatch_H
  38 #define geometricSurfacePatch_H
  39
  40 #include "word.H"
  41 #include "label.H"
  42 #include "typeInfo.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 class dictionary;
  50
  51 /*---------------------------------------------------------------------------*\
  52                            Class geometricSurfacePatch Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 class geometricSurfacePatch
  56 {
  57     // Private data
  58
  59         //- Type name of patch
  60         word geometricType_;
  61
  62         //- Name of patch
  63         word name_;
  64
  65         //- Index of patch in boundary
  66         label index_;
  67
  68 public:
  69
  70     //- Runtime type information
  71     ClassName("geometricSurfacePatch");
  72
  73
  74     // Constructors
  75
  76         //- Construct null
  77         geometricSurfacePatch();
  78
  79         //- Construct from components
  80         geometricSurfacePatch
  81         (
  82             const word& geometricType,
  83             const word& name,
  84             const label index
  85         );
  86
  87         //- Construct from Istream
  88         geometricSurfacePatch(Istream&, const label index);
  89
  90         //- Construct from dictionary
  91         geometricSurfacePatch
  92         (
  93             const word& name,
  94             const dictionary& dict,
  95             const label index
  96         );
  97
  98
  99     // Member Functions
 100
 101         //- Return name
 102         const word& name() const
 103         {
 104             return name_;
 105         }
 106
 107         //- Return name
 108         word& name()
 109         {
 110             return name_;
 111         }
 112
 113         //- Return the type of the patch
 114         const word& geometricType() const
 115         {
 116             return geometricType_;
 117         }
 118
 119         //- Return the type of the patch
 120         word& geometricType()
 121         {
 122             return geometricType_;
 123         }
 124
 125         //- Return the index of this patch in the boundaryMesh
 126         label index() const
 127         {
 128             return index_;
 129         }
 130
 131         //- Write
 132         void write(Ostream&) const;
 133
 134         //- Write dictionary
 135         void writeDict(Ostream&) const;
 136
 137
 138     // Member Operators
 139
 140         bool operator!=(const geometricSurfacePatch&) const;
 141
 142         //- compare.
 143         bool operator==(const geometricSurfacePatch&) const;
 144
 145
 146     // Ostream Operator
 147
 148         friend Ostream& operator<<(Ostream&, const geometricSurfacePatch&);
 149         friend Istream& operator>>(Istream&, geometricSurfacePatch&);
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace Foam
 156
 157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 158
 159 #endif
 160
 161 // ************************************************************************* //