src/OpenFOAM/meshes/polyMesh/polyBoundaryMesh/polyBoundaryMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2011 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
  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::polyBoundaryMesh
  26
  27 Description
  28     Foam::polyBoundaryMesh
  29
  30 SourceFiles
  31     polyBoundaryMesh.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef polyBoundaryMesh_H
  36 #define polyBoundaryMesh_H
  37
  38 #include "polyPatchList.H"
  39 #include "regIOobject.H"
  40 #include "labelPair.H"
  41 #include "HashSet.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class polyMesh;
  50 class wordRe;
  51
  52 // Forward declaration of friend functions and operators
  53
  54 Ostream& operator<<(Ostream&, const polyBoundaryMesh&);
  55
  56
  57 /*---------------------------------------------------------------------------*\
  58                       Class polyBoundaryMesh Declaration
  59 \*---------------------------------------------------------------------------*/
  60
  61 class polyBoundaryMesh
  62 :
  63     public polyPatchList,
  64     public regIOobject
  65 {
  66     // private data
  67
  68         //- Reference to mesh
  69         const polyMesh& mesh_;
  70
  71         mutable autoPtr<labelList> patchIDPtr_;
  72
  73         //- Edges of neighbouring patches
  74         mutable autoPtr<List<labelPairList> > neighbourEdgesPtr_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Create identity map
  80         static labelList ident(const label len);
  81
  82         //- Calculate the geometry for the patches (transformation tensors etc.)
  83         void calcGeometry();
  84
  85         //- Disallow construct as copy
  86         polyBoundaryMesh(const polyBoundaryMesh&);
  87
  88         //- Disallow assignment
  89         void operator=(const polyBoundaryMesh&);
  90
  91
  92 public:
  93
  94     //- Declare friendship with polyMesh
  95     friend class polyMesh;
  96
  97
  98     //- Runtime type information
  99     TypeName("polyBoundaryMesh");
 100
 101
 102     // Constructors
 103
 104         //- Read constructor given IOobject and a polyMesh reference
 105         //  Note point pointers are unset, only used in copying meshes
 106         polyBoundaryMesh
 107         (
 108             const IOobject&,
 109             const polyMesh&
 110         );
 111
 112         //- Construct given size
 113         polyBoundaryMesh
 114         (
 115             const IOobject&,
 116             const polyMesh&,
 117             const label size
 118         );
 119
 120
 121     //- Destructor
 122     ~polyBoundaryMesh();
 123
 124         //- Clear geometry at this level and at patches
 125         void clearGeom();
 126
 127         //- Clear addressing at this level and at patches
 128         void clearAddressing();
 129
 130
 131     // Member Functions
 132
 133         //- Return the mesh reference
 134         const polyMesh& mesh() const
 135         {
 136             return mesh_;
 137         }
 138
 139         //- Per patch the edges on the neighbouring patch. Is for every external
 140         //  edge the neighbouring patch and neighbouring (external) patch edge
 141         //  label. Note that edge indices are offset by nInternalEdges to keep
 142         //  it as much as possible consistent with coupled patch addressing
 143         //  (where coupling is by local patch face index).
 144         //  Only valid for singly connected polyBoundaryMesh and not parallel
 145         const List<labelPairList>& neighbourEdges() const;
 146
 147         //- Return a list of patch names
 148         wordList names() const;
 149
 150         //- Return a list of patch types
 151         wordList types() const;
 152
 153         //- Return a list of physical types
 154         wordList physicalTypes() const;
 155
 156         //- Return patch indices for all matches
 157         labelList findIndices(const keyType&) const;
 158
 159         //- Return patch index for the first match, return -1 if not found
 160         label findIndex(const keyType&) const;
 161
 162         //- Find patch index given a name
 163         label findPatchID(const word& patchName) const;
 164
 165         //- Return patch index for a given face label
 166         label whichPatch(const label faceIndex) const;
 167
 168         //- Per boundary face label the patch index
 169         const labelList& patchID() const;
 170
 171         //- Return the set of patch IDs corresponding to the given names
 172         //  By default warns if given names are not found.
 173         labelHashSet patchSet
 174         (
 175             const UList<wordRe>& patchNames,
 176             const bool warnNotFound = true
 177         ) const;
 178
 179         //- Check whether all procs have all patches and in same order. Return
 180         //  true if in error.
 181         bool checkParallelSync(const bool report = false) const;
 182
 183         //- Check boundary definition. Return true if in error.
 184         bool checkDefinition(const bool report = false) const;
 185
 186         //- Correct polyBoundaryMesh after moving points
 187         void movePoints(const pointField&);
 188
 189         //- Correct polyBoundaryMesh after topology update
 190         void updateMesh();
 191
 192         //- Reorders patches. Ordering does not have to be done in
 193         //  ascending or descending order. Reordering has to be unique.
 194         //  (is shuffle) Calls updateMesh() after reordering to recalculate
 195         //  data.
 196         void reorder(const labelUList&);
 197
 198         //- writeData member function required by regIOobject
 199         bool writeData(Ostream&) const;
 200
 201         //- Write using given format, version and form uncompression
 202         bool writeObject
 203         (
 204             IOstream::streamFormat fmt,
 205             IOstream::versionNumber ver,
 206             IOstream::compressionType cmp
 207         ) const;
 208
 209     // Member Operators
 210
 211         //- Return const and non-const reference to polyPatch by index.
 212         using polyPatchList::operator[];
 213
 214         //- Return const reference to polyPatch by name.
 215         const polyPatch& operator[](const word&) const;
 216
 217         //- Return reference to polyPatch by name.
 218         polyPatch& operator[](const word&);
 219
 220
 221     // Ostream operator
 222
 223         friend Ostream& operator<<(Ostream&, const polyBoundaryMesh&);
 224 };
 225
 226
 227 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 228
 229 } // End namespace Foam
 230
 231 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 232
 233 #endif
 234
 235 // ************************************************************************* //