src/dynamicMesh/dynamicTopoFvMesh/changeMap.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     changeMap
  26
  27 Description
  28     Accumulate topology change statistics
  29
  30 Author
  31     Sandeep Menon
  32     University of Massachusetts Amherst
  33     All rights reserved
  34
  35 SourceFiles
  36     changeMapI.H
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef changeMap_H
  41 #define changeMap_H
  42
  43 #include "objectMap.H"
  44 #include "labelList.H"
  45 #include "dictionary.H"
  46 #include "DynamicList.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Class forward declarations
  54 class changeMap;
  55
  56 // * * * * * * * * Forward declaration of friend fuctions  * * * * * * * * * //
  57
  58 Ostream& operator<<(Ostream&, const changeMap&);
  59
  60
  61 /*---------------------------------------------------------------------------*\
  62                            Class changeMap Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 class changeMap
  66 :
  67     public dictionary
  68 {
  69     // Entity index
  70     label index_;
  71
  72     // Coupled patch index
  73     label pIndex_;
  74
  75     // Type
  76     label type_;
  77
  78     // Entities that were added during the operation.
  79     DynamicList<objectMap> addedPoints_;
  80     DynamicList<objectMap> addedEdges_;
  81     DynamicList<objectMap> addedFaces_;
  82     DynamicList<objectMap> addedCells_;
  83
  84     // Entities that were removed during the operation
  85     dynamicLabelList removedPoints_;
  86     dynamicLabelList removedEdges_;
  87     dynamicLabelList removedFaces_;
  88     dynamicLabelList removedCells_;
  89
  90 public:
  91
  92     // Constructor
  93     changeMap()
  94     :
  95         index_(-1),
  96         pIndex_(-1),
  97         type_(-1),
  98         addedPoints_(5),
  99         addedEdges_(5),
 100         addedFaces_(5),
 101         addedCells_(5),
 102         removedPoints_(5),
 103         removedEdges_(5),
 104         removedFaces_(5),
 105         removedCells_(5)
 106     {}
 107
 108     //- Access
 109
 110         // Entity index
 111         inline label& index();
 112         inline label index() const;
 113
 114         // Coupled patch index
 115         inline label& patchIndex();
 116         inline label patchIndex() const;
 117
 118         // Type
 119         inline label& type();
 120         inline label type() const;
 121
 122         // Added entities
 123         inline void addPoint
 124         (
 125             const label pIndex,
 126             const labelList& master = labelList()
 127         );
 128
 129         inline void addEdge
 130         (
 131             const label eIndex,
 132             const labelList& master = labelList()
 133         );
 134
 135         inline void addFace
 136         (
 137             const label fIndex,
 138             const labelList& master = labelList()
 139         );
 140
 141         inline void addCell
 142         (
 143             const label cIndex,
 144             const labelList& master = labelList()
 145         );
 146
 147         // Return the list of added entities
 148         inline const List<objectMap>& addedPointList() const;
 149         inline const List<objectMap>& addedEdgeList() const;
 150         inline const List<objectMap>& addedFaceList() const;
 151         inline const List<objectMap>& addedCellList() const;
 152
 153         // Removed entities
 154         inline void removePoint(const label pIndex);
 155         inline void removeEdge(const label eIndex);
 156         inline void removeFace(const label fIndex);
 157         inline void removeCell(const label cIndex);
 158
 159         // Return the list of removed entities
 160         inline const labelList& removedPointList() const;
 161         inline const labelList& removedEdgeList() const;
 162         inline const labelList& removedFaceList() const;
 163         inline const labelList& removedCellList() const;
 164
 165     //- Edit
 166
 167         // Clear existing lists
 168         inline void clear();
 169
 170     //- Operators
 171
 172         inline void operator=(const changeMap& rhs);
 173
 174     //- IOstream Operators
 175
 176         inline friend Ostream& operator<<(Ostream&, const changeMap&);
 177 };
 178
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 } // End namespace Foam
 183
 184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 185
 186 #include "changeMapI.H"
 187
 188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 189
 190 #endif
 191
 192 // ************************************************************************* //