src/OpenFOAM/meshes/patchIdentifier/patchIdentifier.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::patchIdentifier
  27
  28 Description
  29     Identifies patch by name, patch index and physical type
  30
  31 SourceFiles
  32     patchIdentifier.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef patchIdentifier_H
  37 #define patchIdentifier_H
  38
  39 #include "word.H"
  40 #include "label.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 class dictionary;
  48
  49 // Forward declaration of friend functions and operators
  50
  51 class patchIdentifier;
  52 Ostream& operator<<(Ostream&, const patchIdentifier&);
  53
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class patchIdentifier Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class patchIdentifier
  60 {
  61     // Private data
  62
  63         //- Name of patch
  64         word name_;
  65
  66         //- Index of patch in boundary
  67         label index_;
  68
  69         //- Optional physical type
  70         mutable word physicalType_;
  71
  72
  73 public:
  74
  75     // Constructors
  76
  77         //- Construct from components
  78         patchIdentifier
  79         (
  80             const word& name,
  81             const label index,
  82             const word& physicalType = word::null
  83         );
  84
  85         //- Construct from dictionary
  86         patchIdentifier
  87         (
  88             const word& name,
  89             const dictionary&,
  90             const label index
  91         );
  92
  93         //- Construct from geometric patch, resetting the index
  94         patchIdentifier
  95         (
  96             const patchIdentifier&,
  97             const label index
  98         );
  99
 100
 101     // Destructor
 102
 103         virtual ~patchIdentifier();
 104
 105
 106     // Member Functions
 107
 108         //- Return name
 109         const word& name() const
 110         {
 111             return name_;
 112         }
 113
 114         //- Return name for modification
 115         word& name()
 116         {
 117             return name_;
 118         }
 119
 120         //- Return the optional physical type of the patch
 121         const word& physicalType() const
 122         {
 123             return physicalType_;
 124         }
 125
 126         //- Return the optional physical type of the patch for modification
 127         word& physicalType()
 128         {
 129             return physicalType_;
 130         }
 131
 132         //- Return the index of this patch in the boundaryMesh
 133         label index() const
 134         {
 135             return index_;
 136         }
 137
 138         //- Return the index of this patch in the boundaryMesh for modification
 139         label& index()
 140         {
 141             return index_;
 142         }
 143
 144         //- Write patchIdentifier as a dictionary
 145         void write(Ostream&) const;
 146
 147
 148     // Ostream Operator
 149
 150         friend Ostream& operator<<(Ostream&, const patchIdentifier&);
 151 };
 152
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #endif
 161
 162 // ************************************************************************* //