src/OpenFOAM/meshes/Identifiers/patch/patchIdentifier.H

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