FixVec.h 18.5 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
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file FixVec.h */

#ifndef AMDIS_FIXVEC_H
#define AMDIS_FIXVEC_H

#include "Global.h"
#include "MemoryManager.h"
#include <iostream>
#include "MatrixVector.h"

namespace AMDiS {

  class Mesh;
33
  template<typename T> class DimMat;
34
35
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
  template<typename T> class WorldVector;
  template<typename T> class WorldMatrix;

  /** determines how to initialize a FixVec when constructed */
  enum InitType 
    {
      NO_INIT = 0,       /**< no initialisation */
      VALUE_LIST = 1,    /**< a complete value list is given */
      DEFAULT_VALUE = 2, /**< all values ar set to a given default value */
      UNIT_VECTOR = 3,   /**< the i-th value is 1, all other values are 0 */
      UNIT_MATRIX = 4    /**< values at the diagonal of a matrix are set to one */
    };

  /** \ingroup Common
   * \brief
   * A FixVec is a template vector of a fixed size. 
   *
   * The size is determined at construction time and depends on the dimension
   * and the template parameter d. So a FixVec<int, VERTEX> is a integer vector
   * with 3 entries in 2d and with 4 entries in 3d. The dimension and the way
   * the vector should be initialized are specified by the constructor call.
   */
  template<typename T,GeoIndex d>
  class FixVec : public Vector<T>
  {
  public:
    MEMORY_MANAGED(FixVec<T COMMA d>);

    /** \brief
     * constructor without initialisation. initType must be NO_INIT. If dim is
     * not spezified, a FixVec for DIM_OF_WORLD is created.
     */
    FixVec(int dim = -1, InitType initType = NO_INIT)
      : Vector<T>(calcSize(dim))
    { 
69
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or missing initializer\n");
70
71
72
73
74
75
76
77
78
    }

    /** \brief
     * constructor with value list initialisation. initType must be VALUE_LIST.
     * ini is an array which contains the initialisation values.
     */
    FixVec(int dim, InitType initType, const T* ini)
      : Vector<T>(calcSize(dim))
    {
79
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
80
      setValues(ini);
81
    }
82
83
84
85
86
87
88
89

    /** \brief
     * constructor with default value initialisation. initType must be
     * DEFAULT_VALUE. All vector entries are set to ini.
     */
    FixVec(int dim, InitType initType, const T& ini)
      : Vector<T>(calcSize(dim))
    {
90
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");
91
92
93
      this->set(ini);
    }

94
95
    /// Initialisation for dim.
    inline void init(int dim) {
96
      this->resize(calcSize(dim));
97
    }
98

99
100
    /// Initialisation for size
    inline void initSize(int size) {
101
      this->resize(size);
102
    }
103

104
    /// Returns the \ref size_ of the FixVec.
105
106
    inline int size() const { 
      return this->getSize(); 
107
    } 
108
109

  protected:
110
    /// Determines needed vector size.
111
112
113
114
115
116
    static int calcSize(int dim) {
      if (dim < 0) {
	return Global::getGeo(WORLD);
      } else {
	return Global::getGeo(d, dim);
      }
117
    }
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

  public:
    friend class GLWindow;
  };


  // ===========================================================================
  // ===== class VectorOfFixVecs ===============================================
  // ===========================================================================

  /** \ingroup Common
   * \brief
   * Contains an vector of FixVecs of same type. To simply allocate an array of 
   * FixVecs
   * isn't possible, because the FixVec constructor normally needs at least
   * the corresponding dimension. So you must create an array of FixVec pointers
   * and call the constructor of each FixVec manually. When you use 
   * VectorOfFixVecs, this work is done by VectorOfFixVecs's constructor.
   */
  template<typename FixVecType>
  class VectorOfFixVecs
  {
  public:
    MEMORY_MANAGED(VectorOfFixVecs<FixVecType>);

    /** \brief
     * constructs a VectorOfFixVecs without initialisation. dim is passed to 
     * FixVec's constructors. size_ is the number of contained FixVecs. initType
     * must be NO_INIT.
     */
148
149
150
    VectorOfFixVecs(int d, int s, InitType initType) 
      : size(s),
	dim(d)
151
    {
152
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or wrong initializer\n");
153

154
155
156
      vec.resize(size);
      for (int i = 0; i < size; i++)
	vec[i] = NEW FixVecType(dim, NO_INIT);
157
158
159
160
161
162
163
    }

    /** \brief
     * constructs a VectorOfFixVecs via an value list.  dim is passed to 
     * FixVec's constructors. size_ is the number of contained FixVecs. initType
     * must be VALUE_LIST. ini contains the initialisation values.
     */
164
165
166
    VectorOfFixVecs(int d, int s, InitType initType, const FixVecType* ini)
      : size(s),
	dim(d)
167
    {
168
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
169

170
171
172
      vec.resize(size);
      for (int i = 0; i < size; i++)
	vec[i] = NEW FixVecType(ini[i]);
173
174
175
176
177
178
179
    }

    /** \brief
     * constructs a VectorOfFixVecs with an default value.  dim is passed to 
     * FixVec's constructors. size_ is the number of contained FixVecs. initType
     * must be DEFAULT_VALUE. All entries are set to ini.
     */
180
181
182
    VectorOfFixVecs(int d, int s, InitType initType, const FixVecType& ini)
      : size(s),
	dim(d)
183
    {
184
185
186
187
188
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");

      vec.resize(size);
      for (int i = 0; i < size; i++) 
	vec[i] = NEW FixVecType(ini);
189
190
    }

191
    /// Copy constructor
192
193
    VectorOfFixVecs(const VectorOfFixVecs<FixVecType>& rhs)
    {
194
195
      size = rhs.getSize();
      dim = rhs.getDim();
196

197
198
      vec.resize(size);
      for (int i = 0; i < size; i++) 
199
	vec[i] = NEW FixVecType(*(rhs.vec[i]));
200
    }
201

202
    /// Destructor
203
204
    virtual ~VectorOfFixVecs()
    {
205
206
      for (int i = 0; i < size; i++)
	DELETE vec[i];
207

208
209
210
211
      vec.clear();
    }

    /// Allows the access like in a normal array via []. Used for const objects.
212
213
    inline const FixVecType& operator[](int index) const
    {
214
      TEST_EXIT_DBG(index >= 0 && index < size)("invalid index\n");
215
      return *(vec[index]);
216
    }
217

218
    /// Allows the access like in a normal array via []. 
219
220
    inline FixVecType& operator[](int index)
    {
221
      TEST_EXIT_DBG(index >= 0 && index < size)("invalid index\n");
222
      return *(vec[index]);
223
    }
224

225
    /// Assignment operator
226
227
228
    VectorOfFixVecs<FixVecType>& 
    operator=(const VectorOfFixVecs<FixVecType>& rhs)
    {
229
230
231
232
      TEST_EXIT_DBG(size == rhs.size)("vectors of different size\n");
      if (this != &rhs) {
	for (int i = 0; i < size; i++)
	  *(vec[i]) = *(rhs.vec[i]);
233
234
      }
      return *this;
235
    }
236

237
238
239
240
241
242
243
244
245
246
    /// Resize the vector
    inline void resize(int newsize)
    {
      vec.resize(newsize);
      for (int i = size; i < newsize; i++)
	vec[i] = NEW FixVecType(dim, NO_INIT);
      size = newsize;
    }

    /// Returns the \ref size of this VectorOfFixVecs
247
    inline int getSize() const { 
248
249
      return size;
    }
250

251
252
253
254
255
256
    /// Returns \ref dim
    inline int getDim() const {
      return dim;
    }

    /// Returns the size of the contained FixVecs
257
258
259
    inline int getSizeOfFixVec() const { 
      return vec[0]->getSize(); 
    }
260
261

  protected:
262
263
    /// number of contained FixVecs
    int size;
264

265
266
267
268
269
    /// dimension of world
    int dim;

    /// array of pointers to FixVecs
    std::vector<FixVecType*> vec;
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
  };

  // ===========================================================================
  // ===== class MatrixOfFixVecs ===============================================
  // ===========================================================================

  /** \ingroup Common
   * \brief
   * Like the class VectorOfFixVecs contains a vector of FixVecs, this class
   * contains a matrix of FixVecs of same type.
   */
  template<typename FixVecType>
  class MatrixOfFixVecs
  {
  public:
    MEMORY_MANAGED(MatrixOfFixVecs<FixVecType>);

    /** \brief
     * Constructs the matrix without initialisation. r is the number of rows,
     * c is the number of columns. The other parameters are analog to the
     * VectorOfFixVecs constructors.
     */
    MatrixOfFixVecs(int dim, int r, int c, InitType initType)
      : rows(r), columns(c)
    {
295
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or wrong initializer\n");
296
      vec = GET_MEMORY(VectorOfFixVecs<FixVecType>*, rows);
297
      for (VectorOfFixVecs<FixVecType>** i = &vec[0]; i < &vec[rows]; i++) {
298
299
	*i = NEW VectorOfFixVecs<FixVecType>(dim, columns, NO_INIT);
      }
300
    }
301

302
    /// destructor
303
304
    virtual ~MatrixOfFixVecs()
    {
305
      for (VectorOfFixVecs<FixVecType>** i = &vec[0]; i < &vec[rows]; i++) {
306
307
308
	DELETE *i;
      }
      FREE_MEMORY(vec, VectorOfFixVecs<FixVecType>*, rows);
309
    }
310

311
    /// assignment operator
312
313
    inline VectorOfFixVecs<FixVecType >& operator[](int index)
    {
314
      TEST_EXIT_DBG(index >= 0 && index < rows)("invalid index\n");
315
      return *(vec[index]);
316
    }
317

318
    /// assignment operator
319
320
    inline const VectorOfFixVecs<FixVecType >& operator[](int index) const
    {
321
      TEST_EXIT_DBG(index >= 0 && index < rows)("invalid index\n");
322
      return *(vec[index]);
323
    }
324

325
    /// Returns \ref rows
326
327
    inline int getNumberOfRows() const { 
      return rows; 
328
    }
329

330
    /// Returns \ref columns
331
332
    inline int getNumberOfColumns() const { 
      return columns; 
333
    }
334
335

  private:
336
    /// number of rows of the matrix
337
338
    int rows;

339
    /// number of columns of the matrix
340
341
    int columns;

342
    /// array of pointers to VectorOfFixVecs
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
    VectorOfFixVecs<FixVecType> **vec;
  };


  /** \ingroup Common
   * \brief
   * A DimVec is a FixVec with dim + 1 entries. It can be used for storing
   * barycentric coordinates or information associated to vertices or
   * parts of an element.
   */
  template<typename T>
  class DimVec : public FixVec<T,PARTS> {
  public:
    MEMORY_MANAGED(DimVec<T>);

358
    DimVec() {}
359

360
361
    /// Calls the corresponding constructor of FixVec
    DimVec(int dim, InitType initType = NO_INIT)
362
      : FixVec<T,PARTS>(dim, initType)
363
    {}
364

365
    /// Calls the corresponding constructor of FixVec
366
367
    DimVec(int dim, InitType initType, T* ini)
      : FixVec<T,PARTS>(dim, initType, ini)
368
    {}
369

370
    /// Calls the corresponding constructor of FixVec
371
372
    DimVec(int dim, InitType initType, const T& ini)
      : FixVec<T,PARTS>(dim, initType, ini)
373
374
    {}

375
    /// Multplication of a matrix with a vector.
376
    void multMatrixVec(DimMat<T> &m, DimVec<T> &v);
377
378
379
380
381
382
383
384
385
386
387
388
389
  };


  /** \ingroup Common
   * \brief
   * A DimMat is a VectorOfFixVecs of dim+1 DimVecs. 
   */
  template<typename T>
  class DimMat : public Matrix<T>
  {
  public:
    MEMORY_MANAGED(DimMat<T>);

Thomas Witkowski's avatar
Thomas Witkowski committed
390
    /// Calls the corresponding constructor of VectorOfFixVecs
391
392
    DimMat(int dim, InitType initType = NO_INIT)
      : Matrix<T>(dim + 1, dim + 1)
393
    {}
394

Thomas Witkowski's avatar
Thomas Witkowski committed
395
    /// Calls the corresponding constructor of VectorOfFixVecs
396
    DimMat(int dim, InitType initType, const T& ini)
397
      : Matrix<T>(dim + 1, dim + 1)
398
    {
399
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)
400
401
	("wrong initType or wrong initializer\n");    
      this->set(ini);
402
    }
403

Thomas Witkowski's avatar
Thomas Witkowski committed
404
    /// Calls the corresponding constructor of VectorOfFixVecs
405
    DimMat(int dim, InitType initType, T* ini)
406
      : Matrix<T>(dim + 1, dim + 1)
407
    {
408
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
409
      setValues(ini);
410
    }
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  };

  // ===========================================================================
  // ===== class WorldVector ===================================================
  // ===========================================================================

  /** \ingroup Common
   * \brief
   * A WorldVector is an AlgoVec with DIM_OF_WORLD entries of type double.
   * Can be used for storing world coordinates.
   */
  template<typename T>
  class WorldVector : public FixVec<T, WORLD>
  {
  public:
    MEMORY_MANAGED(WorldVector<T>);

    /** \brief
     * Calls the corresponding constructor of AlgoVec
     */
    WorldVector() 
      : FixVec<T, WORLD>(Global::getGeo(WORLD), NO_INIT) 
433
    {}
434
435
436
437
438
439

    /** \brief
     * Calls the corresponding constructor of AlgoVec
     */
    WorldVector(InitType initType, T* ini) 
      : FixVec<T, WORLD>(Global::getGeo(WORLD), initType, ini)
440
    {}
441
442
443
444
445
446

    /** \brief
     * Calls the corresponding constructor of AlgoVec
     */
    WorldVector(InitType initType, const T& ini)
      : FixVec<T, WORLD>(Global::getGeo(WORLD), initType, ini)
447
    {}
448
449
450
451
452
453
454
455

    /** \brief
     * Sets all entries to d
     */
    inline const WorldVector<T>& operator=(const T& d)
    {
      this->set(d);
      return (*this);
456
    }
457

458
459
460
461
462
463
464
465
466
467
468
469
470
    /** \brief
     * Sets the arrays value to the geometric midpoint of the points
     * p1 and p2;
     */
    inline void setMidpoint(const WorldVector<T> &p1, const WorldVector<T> &p2)
    {
      int dow = Global::getGeo(WORLD);

      for (int i = 0; i < dow; i++) {
	this->valArray[i] = 0.5 * (p1[i] + p2[i]);
      }
    }

471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
    /** \brief
     * Multplication of a matrix with a vector.
     */
    void multMatrixVec(WorldMatrix<T> &m, WorldVector<T> &v);
  };


  // ===========================================================================
  // ===== class WorldMatrix ===================================================
  // ===========================================================================

  /** \ingroup Common
   * \brief
   * A WorldMatrix is a FixVec with DIM_OF_WORLD WorldVector entries.
   * So it can be seen as matrix with DIM_OF_WORLD x DIM_OF_WORLD double 
   * entries.
   * Here it's not necessary to use the VectorOfFixVecs class, because the 
   * FixVec constructor assumes dim = DIM_OF_WORLD, if no dim is spezified, 
   * what is the right assumption in this case.
   */
  template<typename T>
  class WorldMatrix : public Matrix<T>
  {
  public:
    MEMORY_MANAGED(WorldMatrix<T>);

497
    /// Calls the corresponding constructor of FixVec
498
499
    WorldMatrix()
      : Matrix<T>(Global::getGeo(WORLD), Global::getGeo(WORLD))
500
    {}
501

502
    /// Calls the corresponding constructor of FixVec
503
504
505
    WorldMatrix(InitType initType, T* ini)
      : Matrix<T>(Global::getGeo(WORLD), Global::getGeo(WORLD))
    {
506
      TEST_EXIT_DBG(initType == VALUE_LIST)("???\n");
507
      setValues(ini);
508
    }
509
510
511
512
513
514
515
516

    /** \brief
     * Calls the corresponding constructor of FixVec and sets all matrix entries
     * to ini
     */
    WorldMatrix(InitType initType, const T& ini)
      : Matrix<T>(Global::getGeo(WORLD), Global::getGeo(WORLD))
    {
517
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");
518
      this->set(ini);
519
    }
520
  
521
    /// Returns true if the matrix is a diagonal matrix, returns false otherwise.
522
523
    bool isDiagMatrix() const;

524
    /// Returns true if the matrix is symmetric, returns false otherwise.
525
526
    bool isSymmetric() const;

527
    /// Sets the diagonal entries to the given value.
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
    void setDiag(T value);

    /** \brief
     * Creates a matrix from the "multiplication" of two vectors.
     *
     * 2d-Example:
     *
     * /a\   /c\   /ac ad\
     * | | * | | = |     |
     * \b/   \d/   \bc bd/
     */
    void vecProduct(const WorldVector<T>& v1, const WorldVector<T>& v2);
  };


  // ===========================================================================
  // ===== global functions ====================================================
  // ===========================================================================


548
  /// returns the euclidian distance of a and b
549
550
551
  template<typename T, GeoIndex d>
  double absteukl(const FixVec<T,d>& a,const FixVec<T,d>& b);

552
  /// FixVec operator for stream output
553
  template<typename T, GeoIndex d>
554
  std::ostream& operator <<(std::ostream& out, const FixVec<T,d>& fixvec)
555
  {
556
    for (int i = 0; i < fixvec.getSize()-1; i++) {
557
558
559
560
561
562
      out << fixvec[i] << " ";
    }
    out << fixvec[fixvec.getSize()-1];
    return out;
  }

563
  /// creates and inits a VectorOfFixVecs<DimVec<double> >
564
565
  VectorOfFixVecs<DimVec<double> > *createAndInit(int dim, int size, ...);

566
  /// creates and inits and double array
567
568
569
570
571
572
  double *createAndInitArray(int size, ...); 

  inline WorldVector<double> operator*(const WorldVector<double>& v, double d) {
    WorldVector<double> result = v;
    result *= d;
    return result;
573
  }
574
575
576
577
578
579
580

  inline WorldVector<double> operator+(const WorldVector<double>& v1,
				       const WorldVector<double>& v2) 
  {
    WorldVector<double> result = v1;
    result += v2;
    return result;
581
  }
582
583
584
585
586
587
588

  inline WorldVector<int> operator+(const WorldVector<int>& v1,
				    const WorldVector<int>& v2) 
  {
    WorldVector<int> result = v1;
    result += v2;
    return result;
589
  }
590
591
592
593
594
595
596

  inline WorldVector<double> operator-(const WorldVector<double>& v1,
				       const WorldVector<double>& v2) 
  {
    WorldVector<double> result = v1;
    result -= v2;
    return result;
597
  }
598
599
600
601

  inline bool operator<(const WorldVector<double>& v1,
			const WorldVector<double>& v2) 
  {
602
603
604
605
    int dow = Global::getGeo(WORLD);
    for (int i = 0; i < dow; i++) {
      if (abs(v1[i] - v2[i]) < DBL_TOL) 
	continue;
606
607
608
      return v1[i] < v2[i];
    }
    return false;
609
  }
610
611
612
613

  inline bool operator==(const WorldVector<double>& v1,
			 const WorldVector<double>& v2) 
  {
614
615
616
    int dow = Global::getGeo(WORLD);
    for (int i = 0; i < dow; i++) {
      if (abs(v1[i] - v2[i]) > DBL_TOL) return false;
617
618
    }
    return true;
619
  }
620
621
622
623
624
625
626
627
628
629
630
631
632
633

  template<typename T>
  const WorldMatrix<T>& operator*=(WorldMatrix<T>& m, T scal);

  template<typename T>
    const WorldMatrix<T>& operator-=(WorldMatrix<T>& m1, const WorldMatrix<T>& m2);

  template<typename T>
    const WorldMatrix<T>& operator+=(WorldMatrix<T>& m1, const WorldMatrix<T>& m2);
}

#include "FixVec.hh"

#endif // AMDIS_FIXVEC_H