DOFAdmin.h 8.62 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file DOFAdmin.h */

/** \defgroup DOFAdministration DOF adaministration module
 * @{ <img src="dof.png"> @}
 * \brief
 * Contains all classes used for the DOF administration.
 */

#ifndef AMDIS_DOFADMIN_H
#define AMDIS_DOFADMIN_H

#include "Global.h"
#include "FixVec.h"
#include "MemoryManager.h"
#include "Serializable.h"
35
#include "OpenMP.h"
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#include <vector>
#include <memory>
#include <list>

namespace AMDiS {

  class Mesh;
  class FiniteElemSpace;
  class ElInfo;
  class DOFAdmin;
  class BasisFunction;
  class DOFIndexedBase;
  class DOFContainer;

  template<typename T> class DOFVector;

  /** \ingroup DOFAdministration
   * \brief
   * Holds all data about one set of DOFs. It includes information about used and
   * unused DOF indices, as well as lists of DOFIndexed objects and DOFContainer
   * objects, that are automatically resized and resorted during mesh changes. 
   */
  class DOFAdmin : public Serializable
  {
  public:
    MEMORY_MANAGED(DOFAdmin);

    DOFAdmin();

    /** \brief
     * constructor
     */
    DOFAdmin(Mesh* m);

    /** \brief
     * constructor
     */
73
    DOFAdmin(Mesh* m, std::string aName);
74
75
76
77
78
79
80
81
82

    /** \brief
     * copy constructor
     */
    DOFAdmin(const DOFAdmin&);

    /** \brief
     * destructor
     */
83
    ~DOFAdmin();
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

    /** \brief
     * Enlarges the number of DOFs that can be managed at least to minsize by 
     * a step size of \ref sizeIncrement.
     */
    void enlargeDOFLists(int minsize);

    /** \brief
     * assignment operator
     */
    DOFAdmin& operator=(const DOFAdmin&);

    /** \brief
     * Compares two DOFAdmins by their names.
     */
    bool operator==(const DOFAdmin&) const;

    /** \brief
     * Compares two DOFAdmins by their names.
     */
104
105
    inline bool operator!=(const DOFAdmin& ad) const {
      return !(ad==*this);
106
    }
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  
    /** \brief
     * Adds a DOFIndexedBase object to the DOFAdmin. This object will be
     * managed by DOFAdmin from now on.
     */
    void addDOFIndexed(DOFIndexedBase* dofIndexed);

    /** \brief
     * Adds a DOFContainer object to the DOFAdmin.
     */
    void addDOFContainer(DOFContainer* dofContainer);

    /** \brief
     * Removes the given DOFIndexedBase object from DOFAdmin.
     */
    void removeDOFIndexed(DOFIndexedBase* dofIndexed);

    /** \brief
     * Removes the given DOFContainer object from DOFAdmin.
     */
    void removeDOFContainer(DOFContainer* dofContainer);

    /** \brief
     * Removes all holes of unused DOF indices by compressing the used range of
     * indices (it does not resize the vectors). While the global index of a DOF
     * may change, the relative order of DOF indices remains unchanged during
     * compression. This method is usually called after mesh adaption involving
     * higher order elements or coarsening.
     */
136
    void compress(std::vector<DegreeOfFreedom> &new_dof);
137
138
139
140

    /** \brief
     * Returns an iterator to the begin of \ref dofIndexedList
     */
141
    std::list<DOFIndexedBase*>::iterator beginDOFIndexed() {
142
      return dofIndexedList.begin();
143
    }
144
145
146
147

    /** \brief
     * Returns an iterator to the end of \ref dofIndexedList
     */
148
    std::list<DOFIndexedBase*>::iterator endDOFIndexed() {
149
      return dofIndexedList.end();
150
    }
151
152
153
154
155
156
157
158
159
160

    /** \name getting methods
     * \{
     */

    /** \brief
     * Returns \ref sizeUsed.
     */
    inline const int getUsedSize() const { 
      return sizeUsed; 
161
    }
162
163
164
165
166
167

    /** \brief 
     * Returns \ref size
     */
    inline const int getSize() const { 
      return size; 
168
    }
169
170
171
172
173
174

    /** \brief 
     * Returns \ref usedCount
     */
    inline const int getUsedDOFs() const { 
      return usedCount; 
175
    }
176
177
178
179
180
181

    /** \brief 
     * Returns \ref holeCount
     */
    inline const int getHoleCount() const { 
      return holeCount; 
182
    }
183
184
185
186

    /** \brief 
     * Returns \ref name
     */
187
    inline const std::string& getName() const { 
188
      return name; 
189
    }
190
191

    /** \brief 
192
193
     * Returns \ref nrDOF[i], i.e., the number of dofs for the
     * position i.
194
     */
195
196
197
    inline const int getNumberOfDOFs(int i) const {
      return nrDOF[i];
    }
198
199
200
201
202
203
 
    /** \brief
     * Returns \ref nrDOF
     */
    inline const DimVec<int>& getNumberOfDOFs() const { 
      return nrDOF; 
204
    }
205
206
207
208
 
    /** \brief
     * Returns \ref nr0DOF[i]
     */
209
210
211
    inline const int getNumberOfPreDOFs(int i) const {
      return nr0DOF[i];
    }
212
213
214
215
216
217
 
    /** \brief
     * Returns \ref nr0DOF
     */
    inline const DimVec<int>& getNumberOfPreDOFs() const { 
      return nr0DOF; 
218
    }
219
220
221
222
223
224

    /** \brief
     * Returns \ref mesh 
     */
    inline const Mesh* getMesh() const { 
      return mesh; 
225
    }
226
227
228
229

    /** \brief
     * Returns \ref dofFree, the array denoting DOFs to be either free or used.
     */
230
    inline const std::vector<bool>& getDOFFree() const { 
231
      return dofFree; 
232
    }
233
234
235
236
237
238

    /** \brief
     * Returns if the given DOF is free.
     */
    inline const bool isDOFFree(int i) const {
      return dofFree[i];
239
    }
240
241
242
243
244
245
246
247
248
249

    /** \} */

    /** \name setting methods
     * \{
     */

    /** \brief
     * Sets \ref nrDOF[i] = v
     */
250
    void setNumberOfDOFs(int i, int v); 
251
252
253
254
255
256
257
258
259

    /** \brief
     * Sets \ref nr0DOF[i] = v
     */
    void setNumberOfPreDOFs(int i, int v);

    /** \brief
     * Sets \ref name = n
     */
260
261
    inline void setName(const std::string& n) { 
      name = n; 
262
    }
263
264
265
266

    /** \brief
     * Sets \ref mesh = m
     */
267
268
    inline void setMesh(Mesh* m) { 
      mesh = m; 
269
    }
270

271
272
    int calcMemoryUsage();

273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
    /** \} */

  protected:
    /** \brief
     * initializes this DOFAdmin
     */
    void init();

    /** \brief
     * Adds one index to all DOF lists. Used by Mesh::getDOF() to provide 
     * DOFS for a specific position
     */
    int getDOFIndex();

    /** \brief
     * Frees index dof. Used by Mesh::getDOF()
     */
    void freeDOFIndex(int dof);

292
    ///
293
    void serialize(std::ostream &out);
294

295
    ///
296
    void deserialize(std::istream &in);
297
298
299
300
301

  protected:
    /** \brief
     * name of this DOFAdmin
     */
302
    std::string name;
303
304
305
306
307
308
309
310
311

    /** \brief
     * the mesh this DOFAdmin belongs to
     */
    Mesh *mesh;

    /** \brief
     * the dofFree vector stores for each index whether it is used or not
     */
312
    std::vector<bool> dofFree;
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339

    /** \brief
     * index of the first free value in \ref dofFree
     */
    int firstHole;   

    /** \brief
     * allocated size of managed vectors and matrices
     */
    int size;

    /** \brief
     * number of used dof indices
     */
    int usedCount;

    /** \brief
     * number of FREED dof indices (NOT size-sizeUsed)
     */
    int holeCount;

    /** \brief
     * > max. index of a used entry
     */
    int sizeUsed;

    /** \brief
340
341
     * Number of dofs for each position, i.e., vertex, 
     * edge, ..., center, for this DOFAdmin.
342
343
344
345
346
347
348
349
350
351
352
     */
    DimVec<int> nrDOF;

    /** \brief
     * dofs from previous DOFAdmins
     */
    DimVec<int> nr0DOF;

    /** \brief
     * list of all managed DOFIndexed objects.
     */
353
    std::list<DOFIndexedBase*> dofIndexedList;
354
355
356
357

    /** \brief
     * list of all managed DOFContainer objects
     */
358
    std::list<DOFContainer*> dofContainerList;
359
360
361
362
363
364
365
366
367
368
369
370
371

    /** \brief
     * size increment used by \ref enlargeDOFLists.
     */
    static const int sizeIncrement; 

    friend class DOFIteratorBase;
    friend class Mesh;
  };

}

#endif  // AMDIS_DOFADMIN_H