FixVec.h 18 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
// ============================================================================
// ==                                                                        ==
// == 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 <iostream>
Thomas Witkowski's avatar
Thomas Witkowski committed
26
#include "Global.h"
27
28
29
30
31
#include "MatrixVector.h"

namespace AMDiS {

  class Mesh;
32
  template<typename T> class DimMat;
33
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
  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:
    /** \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))
    { 
66
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or missing initializer\n");
67
68
69
70
71
72
73
74
75
    }

    /** \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))
    {
76
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
77
      setValues(ini);
78
    }
79
80
81
82
83
84
85
86

    /** \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))
    {
87
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");
88
89
90
      this->set(ini);
    }

91
92
    /// Initialisation for dim.
    inline void init(int dim) {
93
      this->resize(calcSize(dim));
94
    }
95

96
97
    /// Initialisation for size
    inline void initSize(int size) {
98
      this->resize(size);
99
    }
100

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

  protected:
107
    /// Determines needed vector size.
108
109
110
111
112
113
    static int calcSize(int dim) {
      if (dim < 0) {
	return Global::getGeo(WORLD);
      } else {
	return Global::getGeo(d, dim);
      }
114
    }
115
116
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

  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:
    /** \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.
     */
143
144
145
    VectorOfFixVecs(int d, int s, InitType initType) 
      : size(s),
	dim(d)
146
    {
147
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or wrong initializer\n");
148

149
150
      vec.resize(size);
      for (int i = 0; i < size; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
151
	vec[i] = new FixVecType(dim, NO_INIT);
152
153
154
155
156
157
158
    }

    /** \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.
     */
159
160
161
    VectorOfFixVecs(int d, int s, InitType initType, const FixVecType* ini)
      : size(s),
	dim(d)
162
    {
163
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
164

165
166
      vec.resize(size);
      for (int i = 0; i < size; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
167
	vec[i] = new FixVecType(ini[i]);
168
169
170
171
172
173
174
    }

    /** \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.
     */
175
176
177
    VectorOfFixVecs(int d, int s, InitType initType, const FixVecType& ini)
      : size(s),
	dim(d)
178
    {
179
180
181
182
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");

      vec.resize(size);
      for (int i = 0; i < size; i++) 
Thomas Witkowski's avatar
Thomas Witkowski committed
183
	vec[i] = new FixVecType(ini);
184
185
    }

186
    /// Copy constructor
187
188
    VectorOfFixVecs(const VectorOfFixVecs<FixVecType>& rhs)
    {
189
190
      size = rhs.getSize();
      dim = rhs.getDim();
191

192
193
      vec.resize(size);
      for (int i = 0; i < size; i++) 
Thomas Witkowski's avatar
Thomas Witkowski committed
194
	vec[i] = new FixVecType(*(rhs.vec[i]));
195
    }
196

197
    /// Destructor
198
199
    virtual ~VectorOfFixVecs()
    {
200
      for (int i = 0; i < size; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
201
	delete vec[i];
202

203
204
205
206
      vec.clear();
    }

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

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

220
    /// Assignment operator
221
222
223
    VectorOfFixVecs<FixVecType>& 
    operator=(const VectorOfFixVecs<FixVecType>& rhs)
    {
224
225
226
227
      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]);
228
229
      }
      return *this;
230
    }
231

232
233
234
235
236
    /// Resize the vector
    inline void resize(int newsize)
    {
      vec.resize(newsize);
      for (int i = size; i < newsize; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
237
	vec[i] = new FixVecType(dim, NO_INIT);
238
239
240
241
      size = newsize;
    }

    /// Returns the \ref size of this VectorOfFixVecs
242
    inline int getSize() const { 
243
244
      return size;
    }
245

246
247
248
249
250
251
    /// Returns \ref dim
    inline int getDim() const {
      return dim;
    }

    /// Returns the size of the contained FixVecs
252
253
254
    inline int getSizeOfFixVec() const { 
      return vec[0]->getSize(); 
    }
255
256

  protected:
257
258
    /// number of contained FixVecs
    int size;
259

260
261
262
263
264
    /// dimension of world
    int dim;

    /// array of pointers to FixVecs
    std::vector<FixVecType*> vec;
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
  };

  // ===========================================================================
  // ===== 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:
    /** \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)
    {
288
      TEST_EXIT_DBG(initType == NO_INIT)("wrong initType or wrong initializer\n");
Thomas Witkowski's avatar
Thomas Witkowski committed
289
290
      vec = new VectorOfFixVecs<FixVecType>*[rows];
      for (VectorOfFixVecs<FixVecType>** i = &vec[0]; i < &vec[rows]; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
291
	*i = new VectorOfFixVecs<FixVecType>(dim, columns, NO_INIT);
292
    }
293

294
    /// destructor
295
296
    virtual ~MatrixOfFixVecs()
    {
Thomas Witkowski's avatar
Thomas Witkowski committed
297
      for (VectorOfFixVecs<FixVecType>** i = &vec[0]; i < &vec[rows]; i++)
Thomas Witkowski's avatar
Thomas Witkowski committed
298
	delete *i;
Thomas Witkowski's avatar
Thomas Witkowski committed
299
300

      delete [] vec;
301
    }
302

303
    /// assignment operator
304
305
    inline VectorOfFixVecs<FixVecType >& operator[](int index)
    {
306
      TEST_EXIT_DBG(index >= 0 && index < rows)("invalid index\n");
307
      return *(vec[index]);
308
    }
309

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

317
    /// Returns \ref rows
318
319
    inline int getNumberOfRows() const { 
      return rows; 
320
    }
321

322
    /// Returns \ref columns
323
324
    inline int getNumberOfColumns() const { 
      return columns; 
325
    }
326
327

  private:
328
    /// number of rows of the matrix
329
330
    int rows;

331
    /// number of columns of the matrix
332
333
    int columns;

334
    /// array of pointers to VectorOfFixVecs
335
336
337
338
339
340
341
342
343
344
345
346
347
    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:
348
    DimVec() {}
349

350
351
    /// Calls the corresponding constructor of FixVec
    DimVec(int dim, InitType initType = NO_INIT)
352
      : FixVec<T,PARTS>(dim, initType)
353
    {}
354

355
    /// Calls the corresponding constructor of FixVec
356
357
    DimVec(int dim, InitType initType, T* ini)
      : FixVec<T,PARTS>(dim, initType, ini)
358
    {}
359

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

365
    /// Multplication of a matrix with a vector.
366
    void multMatrixVec(DimMat<T> &m, DimVec<T> &v);
367
368
369
370
371
372
373
374
375
376
377
  };


  /** \ingroup Common
   * \brief
   * A DimMat is a VectorOfFixVecs of dim+1 DimVecs. 
   */
  template<typename T>
  class DimMat : public Matrix<T>
  {
  public:
Thomas Witkowski's avatar
Thomas Witkowski committed
378
    /// Calls the corresponding constructor of VectorOfFixVecs
379
380
    DimMat(int dim, InitType initType = NO_INIT)
      : Matrix<T>(dim + 1, dim + 1)
381
    {}
382

Thomas Witkowski's avatar
Thomas Witkowski committed
383
    /// Calls the corresponding constructor of VectorOfFixVecs
384
    DimMat(int dim, InitType initType, const T& ini)
385
      : Matrix<T>(dim + 1, dim + 1)
386
    {
387
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)
388
389
	("wrong initType or wrong initializer\n");    
      this->set(ini);
390
    }
391

Thomas Witkowski's avatar
Thomas Witkowski committed
392
    /// Calls the corresponding constructor of VectorOfFixVecs
393
    DimMat(int dim, InitType initType, T* ini)
394
      : Matrix<T>(dim + 1, dim + 1)
395
    {
396
      TEST_EXIT_DBG(initType == VALUE_LIST)("wrong initType or wrong initializer\n");
397
      setValues(ini);
398
    }
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
  };

  // ===========================================================================
  // ===== 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:
Thomas Witkowski's avatar
Thomas Witkowski committed
414
    /// Calls the corresponding constructor of AlgoVec
415
416
    WorldVector() 
      : FixVec<T, WORLD>(Global::getGeo(WORLD), NO_INIT) 
417
    {}
418

Thomas Witkowski's avatar
Thomas Witkowski committed
419
    /// Calls the corresponding constructor of AlgoVec
420
421
    WorldVector(InitType initType, T* ini) 
      : FixVec<T, WORLD>(Global::getGeo(WORLD), initType, ini)
422
    {}
423

Thomas Witkowski's avatar
Thomas Witkowski committed
424
    /// Calls the corresponding constructor of AlgoVec
425
426
    WorldVector(InitType initType, const T& ini)
      : FixVec<T, WORLD>(Global::getGeo(WORLD), initType, ini)
427
    {}
428

Thomas Witkowski's avatar
Thomas Witkowski committed
429
    /// Sets all entries to d
430
431
432
433
    inline const WorldVector<T>& operator=(const T& d)
    {
      this->set(d);
      return (*this);
434
    }
435

Thomas Witkowski's avatar
Thomas Witkowski committed
436
    /// Sets the arrays value to the geometric midpoint of the points  p1 and p2.
437
438
439
440
    inline void setMidpoint(const WorldVector<T> &p1, const WorldVector<T> &p2)
    {
      int dow = Global::getGeo(WORLD);

Thomas Witkowski's avatar
Thomas Witkowski committed
441
      for (int i = 0; i < dow; i++)
442
443
444
	this->valArray[i] = 0.5 * (p1[i] + p2[i]);
    }

Thomas Witkowski's avatar
Thomas Witkowski committed
445
    /// Multplication of a matrix with a vector.
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
    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:
467
    /// Calls the corresponding constructor of FixVec
468
469
    WorldMatrix()
      : Matrix<T>(Global::getGeo(WORLD), Global::getGeo(WORLD))
470
    {}
471

472
    /// Calls the corresponding constructor of FixVec
473
474
475
    WorldMatrix(InitType initType, T* ini)
      : Matrix<T>(Global::getGeo(WORLD), Global::getGeo(WORLD))
    {
476
      TEST_EXIT_DBG(initType == VALUE_LIST)("???\n");
477
      setValues(ini);
478
    }
479
480
481
482
483
484
485
486

    /** \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))
    {
487
      TEST_EXIT_DBG(initType == DEFAULT_VALUE)("wrong initType or wrong initializer\n");
488
      this->set(ini);
489
    }
490
  
491
    /// Returns true if the matrix is a diagonal matrix, returns false otherwise.
492
493
    bool isDiagMatrix() const;

494
    /// Returns true if the matrix is symmetric, returns false otherwise.
495
496
    bool isSymmetric() const;

497
    /// Sets the diagonal entries to the given value.
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
    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 ====================================================
  // ===========================================================================


518
  /// returns the euclidian distance of a and b
519
520
521
  template<typename T, GeoIndex d>
  double absteukl(const FixVec<T,d>& a,const FixVec<T,d>& b);

522
  /// FixVec operator for stream output
523
  template<typename T, GeoIndex d>
524
  std::ostream& operator <<(std::ostream& out, const FixVec<T,d>& fixvec)
525
  {
526
    for (int i = 0; i < fixvec.getSize()-1; i++) {
527
528
529
530
531
532
      out << fixvec[i] << " ";
    }
    out << fixvec[fixvec.getSize()-1];
    return out;
  }

533
  /// creates and inits a VectorOfFixVecs<DimVec<double> >
534
535
  VectorOfFixVecs<DimVec<double> > *createAndInit(int dim, int size, ...);

536
  /// creates and inits and double array
537
538
539
540
541
542
  double *createAndInitArray(int size, ...); 

  inline WorldVector<double> operator*(const WorldVector<double>& v, double d) {
    WorldVector<double> result = v;
    result *= d;
    return result;
543
  }
544
545
546
547
548
549
550

  inline WorldVector<double> operator+(const WorldVector<double>& v1,
				       const WorldVector<double>& v2) 
  {
    WorldVector<double> result = v1;
    result += v2;
    return result;
551
  }
552
553
554
555
556
557
558

  inline WorldVector<int> operator+(const WorldVector<int>& v1,
				    const WorldVector<int>& v2) 
  {
    WorldVector<int> result = v1;
    result += v2;
    return result;
559
  }
560
561
562
563
564
565
566

  inline WorldVector<double> operator-(const WorldVector<double>& v1,
				       const WorldVector<double>& v2) 
  {
    WorldVector<double> result = v1;
    result -= v2;
    return result;
567
  }
568
569
570
571

  inline bool operator<(const WorldVector<double>& v1,
			const WorldVector<double>& v2) 
  {
572
573
574
575
    int dow = Global::getGeo(WORLD);
    for (int i = 0; i < dow; i++) {
      if (abs(v1[i] - v2[i]) < DBL_TOL) 
	continue;
576
577
578
      return v1[i] < v2[i];
    }
    return false;
579
  }
580
581
582
583

  inline bool operator==(const WorldVector<double>& v1,
			 const WorldVector<double>& v2) 
  {
584
585
586
    int dow = Global::getGeo(WORLD);
    for (int i = 0; i < dow; i++) {
      if (abs(v1[i] - v2[i]) > DBL_TOL) return false;
587
588
    }
    return true;
589
  }
590
591
592
593
594
595
596
597
598
599
600
601
602
603

  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