src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.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::ZoneMesh
  26
  27 Description
  28     A list of mesh zones.
  29
  30 SourceFiles
  31     ZoneMesh.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef ZoneMesh_H
  36 #define ZoneMesh_H
  37
  38 #include "List.H"
  39 #include "regIOobject.H"
  40 #include "pointFieldsFwd.H"
  41 #include "Map.H"
  42 #include "PackedBoolList.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 // Forward declaration of friend functions and operators
  52
  53 template<class ZoneType, class MeshType> class ZoneMesh;
  54
  55 template<class ZoneType, class MeshType>
  56 Ostream& operator<<(Ostream&, const ZoneMesh<ZoneType, MeshType>&);
  57
  58 /*---------------------------------------------------------------------------*\
  59                            Class ZoneMesh Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 template<class ZoneType, class MeshType>
  63 class ZoneMesh
  64 :
  65     public PtrList<ZoneType>,
  66     public regIOobject
  67 {
  68     // Private data
  69
  70         //- Reference to mesh
  71         const MeshType& mesh_;
  72
  73         //- Map of zone labels for given element
  74         mutable Map<label>* zoneMapPtr_;
  75
  76
  77     // Private Member Functions
  78
  79         //- Disallow construct as copy
  80         ZoneMesh(const ZoneMesh&);
  81
  82         //- Disallow assignment
  83         void operator=(const ZoneMesh<ZoneType, MeshType>&);
  84
  85
  86         //- Create zone map
  87         void calcZoneMap() const;
  88
  89
  90 public:
  91
  92     // Constructors
  93
  94         //- Read constructor given IOobject and a MeshType reference
  95         ZoneMesh
  96         (
  97             const IOobject&,
  98             const MeshType&
  99         );
 100
 101         //- Construct given size
 102         ZoneMesh
 103         (
 104             const IOobject&,
 105             const MeshType&,
 106             const label size
 107         );
 108
 109     //- Destructor
 110     ~ZoneMesh();
 111
 112
 113     // Member Functions
 114
 115         //- Return the mesh reference
 116         const MeshType& mesh() const
 117         {
 118             return mesh_;
 119         }
 120
 121         //- Map of zones containing zone index for all zoned elements
 122         //  Return -1 if the object is not in the zone
 123         const Map<label>& zoneMap() const;
 124
 125         //- Given a global object index, return the zone it is in.
 126         // If object does not belong to any zones, return -1
 127         label whichZone(const label objectIndex) const;
 128
 129         //- Return a list of zone types
 130         wordList types() const;
 131
 132         //- Return a list of zone names
 133         wordList names() const;
 134
 135         //- Return zone indices for all matches
 136         labelList findIndices(const keyType&) const;
 137
 138         //- Return zone index for the first match, return -1 if not found
 139         label findIndex(const keyType&) const;
 140
 141         //- Find zone index given a name
 142         label findZoneID(const word& zoneName) const;
 143
 144         //- Mark cells that match the zone specification
 145         PackedBoolList findMatching(const keyType&) const;
 146
 147         //- Clear addressing
 148         void clearAddressing();
 149
 150         //- Clear the zones
 151         void clear();
 152
 153         //- Check zone definition. Return true if in error.
 154         bool checkDefinition(const bool report = false) const;
 155
 156         //- Check whether all procs have all zones and in same order. Return
 157         //  true if in error.
 158         bool checkParallelSync(const bool report = false) const;
 159
 160         //- Correct zone mesh after moving points
 161         void movePoints(const pointField&);
 162
 163         //- writeData member function required by regIOobject
 164         bool writeData(Ostream&) const;
 165
 166     // Member Operators
 167
 168         //- Return const and non-const reference to ZoneType by index.
 169         using PtrList<ZoneType>::operator[];
 170
 171         //- Return const reference to ZoneType by name.
 172         const ZoneType& operator[](const word&) const;
 173
 174         //- Return reference to ZoneType by name.
 175         ZoneType& operator[](const word&);
 176
 177
 178     // Ostream operator
 179
 180         friend Ostream& operator<< <ZoneType, MeshType>
 181         (
 182             Ostream&,
 183             const ZoneMesh<ZoneType, MeshType>&
 184         );
 185 };
 186
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 } // End namespace Foam
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 #ifdef NoRepository
 195 #   include "ZoneMesh.C"
 196 #endif
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 #endif
 201
 202 // ************************************************************************* //