src/OpenFOAM/meshes/polyMesh/zones/ZoneID/polyPatchID.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::polyPatchID
  27
  28 Description
  29     A class holds the data needed to identify a patch in a dynamic mesh.
  30
  31     The patch is identified by name and its index in the boundary mesh
  32     is updated if the mesh has changed.
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef polyPatchID_H
  37 #define polyPatchID_H
  38
  39 #include "polyBoundaryMesh.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 // Forward declaration of friend functions and operators
  47
  48 class polyPatchID;
  49 Ostream& operator<<(Ostream& os, const polyPatchID& p);
  50
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class polyPatchID Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class polyPatchID
  57 {
  58     // Private data
  59
  60         //- Patch name
  61         word name_;
  62
  63         //- Patch index
  64         label index_;
  65
  66
  67 public:
  68
  69     // Constructors
  70
  71         //- Construct from name
  72         polyPatchID(const word& name, const polyBoundaryMesh& bm)
  73         :
  74             name_(name),
  75             index_(bm.findPatchID(name))
  76         {}
  77
  78         //- Construct from Istream
  79         polyPatchID(Istream& is, const polyBoundaryMesh& bm)
  80         :
  81             name_(is),
  82             index_(bm.findPatchID(name_))
  83         {}
  84
  85
  86     // Member Functions
  87
  88         // Access
  89
  90             //- Return name
  91             const word& name() const
  92             {
  93                 return name_;
  94             }
  95
  96             //- Return index
  97             label index() const
  98             {
  99                 return index_;
 100             }
 101
 102             //- Has the patch been found
 103             bool active() const
 104             {
 105                 return index_ > -1;
 106             }
 107
 108
 109         // Edit
 110
 111             //- Update
 112             void update(const polyBoundaryMesh& bm)
 113             {
 114                 index_ = bm.findPatchID(name_);
 115             }
 116
 117
 118     // Ostream Operator
 119
 120         friend Ostream& operator<<(Ostream& os, const polyPatchID& p)
 121         {
 122             os  << token::BEGIN_LIST
 123                 << p.name_ << token::SPACE
 124                 << p.index_
 125                 << token::END_LIST;
 126
 127             // Check state of Ostream
 128             os.check("Ostream& operator<<(Ostream&, const polyPatchID&)");
 129
 130             return os;
 131         }
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //