SystemVector.h 14.7 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \file SystemVector.h */

#ifndef AMDIS_SYSTEMVECTOR_H
#define AMDIS_SYSTEMVECTOR_H

#include "MemoryManager.h"
#include "MatrixVector.h"
#include "DOFVector.h"
#include "CreatorInterface.h"
#include "Serializable.h"
#include "OpenMP.h"

namespace AMDiS {

  // ============================================================================
  // ===== class SystemVector ===================================================
  // ============================================================================

  /** \brief
   * A system vector is a vector of dof vectors used for vector valued
   * problems.
   */
  class SystemVector : public Serializable
  {
  public:
    MEMORY_MANAGED(SystemVector);

    /** \brief
     * Creator. 
     */
    class Creator 
      : public CreatorInterface<SystemVector> {
    public:
      MEMORY_MANAGED(Creator);

      /** \brief
       * Creators constructor.
       */
58
59
      Creator(const std::string &name_,
	      std::vector<FiniteElemSpace*> feSpace_, 
60
	      int size_) 
61
62
63
	: name(name_), 
	  feSpace(feSpace_), 
	  size(size_) 
64
      {}
65
66
67
68

      /** \brief
       * Destructor
       */
69
      virtual ~Creator() {}
70
71
72
73
74
75

      /** \brief
       * Implementation of CreatorInterface::create().
       */
      SystemVector *create() { 
	char number[10];
76
	std::string numberedName;
77
	SystemVector *result = NEW SystemVector(name, feSpace, size);
78
	for (int i = 0; i < size; i++) {
79
	  sprintf(number, "[%d]", i);
80
	  numberedName = name + std::string(number);
81
82
83
	  result->setDOFVector(i, NEW DOFVector<double>(feSpace[i], numberedName));
	}
	return result; 
84
      }
85
86
87
88
89
90
91
92
93
94

      /** \brief
       * Implementation of CreatorInterface::free().
       */ 
      void free(SystemVector *vec) { 
	for (int i = 0; i < size; i++) {
	  DELETE vec->getDOFVector(i);
	  vec->setDOFVector(i, NULL);
	}
	DELETE vec;
95
      }
96
97
98
99
100

    private:
      /** \brief
       * Name of the system vector
       */
101
      std::string name;
102
103
104
105

      /** \brief
       * Finite element space used for creation.
       */
106
      std::vector<FiniteElemSpace*> feSpace;
107
108
109
110
111
112
113
114
115
116
117

      /** \brief
       * Number of component vectors to be created
       */
      int size;
    };

  public:
    /** \brief
     * Constructor.
     */
118
119
    SystemVector(const std::string& name_,
		 std::vector<FiniteElemSpace*> feSpace_, 
120
121
122
123
124
125
126
		 int size)
      : name(name_),
	feSpace(feSpace_),
	vectors(size)
      
    {
      vectors.set(NULL);
127
    }
128
129
130
131
132
133
134
135
136
137

    /** \brief
     * Copy Constructor.
     */
    SystemVector(const SystemVector& rhs)
      : name(rhs.name),
	feSpace(rhs.feSpace),
	vectors(rhs.vectors.getSize())
      
    {
138
      for (int i = 0; i < vectors.getSize(); i++) {
139
	vectors[i] = NEW DOFVector<double>(*rhs.vectors[i]);
140
      }
141
142
    }

143
144
145
146
147
148
    ~SystemVector() 
    {
      for (int i = 0; i < vectors.getSize(); i++) {
	DELETE vectors[i];
      }
    }
149

150
151
152
153
154
155
    void createNewDOFVectors(std::string name)
    {     
      for (int i = 0; i < vectors.getSize(); i++) {
	vectors[i] = NEW DOFVector<double>(feSpace[i], "tmp");
      }
    }
156
157
158
159
160

    /** \brief
     * Sets \ref vectors[index] = vec.
     */ 
    inline void setDOFVector(int index, DOFVector<double> *vec) {
161
      TEST_EXIT_DBG(index < vectors.getSize())("invalid index\n");
162
      vectors[index] = vec;
163
    }
164
165
166
167

    /** \brief
     * Returns \ref vectors[index].
     */
168
169
    inline DOFVector<double> *getDOFVector(int index) {      
      TEST_EXIT_DBG(index < vectors.getSize())("invalid index\n");
170
      return vectors[index];
171
    }
172
173
174
175
176

    /** \brief
     * Returns \ref vectors[index].
     */
    inline const DOFVector<double> *getDOFVector(int index) const {
177
      TEST_EXIT_DBG(index < vectors.getSize())("invalid index\n");
178
      return vectors[index];
179
    }
180
181
182
183
184

    /** \brief
     * Returns sum of used vector sizes.
     */
    inline int getUsedSize() const {
185
186
      int totalSize = 0;
      int size = vectors.getSize();
187
      for (int i = 0; i < size; i++) {
188
189
190
	totalSize += vectors[i]->getUsedSize();
      }
      return totalSize;
191
    }
192
193
194
195
196
197

    /** \brief
     * Returns number of contained vectors.
     */
    inline int getNumVectors() const { 
      return vectors.getSize(); 
198
    }
199
200
201

    inline int getSize() const {
      return vectors.getSize();
202
    }
203
204

    /** \brief
205
     * Returns the fe space for a given component.
206
     */
207
208
    inline FiniteElemSpace *getFESpace(int i) const { 
      return feSpace[i]; 
209
    }
210

211
212
213
    /** \brief
     * Returns the fe spaces for all components.
     */
214
215
216
217
    inline std::vector<FiniteElemSpace*> getFESpaces() const {
      return feSpace;
    }

218
219
220
221
222
223
224
225
226
227
    /** \brief
     * Here the system vector is interpreted as one large vector. The given
     * is used as a global index which indicates a local vector number and
     * a local index on this vector. The operator returns this local vector
     * at the local index.
     */
    inline double& operator[](int index) {
      int localIndex = index;
      int vectorIndex = 0;

228
      while (localIndex >= vectors[vectorIndex]->getUsedSize()) {
229
230
231
232
	localIndex -= vectors[vectorIndex++]->getUsedSize();
      }

      return (*(vectors[vectorIndex]))[localIndex];
233
    }
234
235
236
237
238
239
240
241

    /** \brief
     * For const access.
     */
    inline double operator[](int index) const {
      int localIndex = index;
      int vectorIndex = 0;

242
      while (localIndex >= vectors[vectorIndex]->getUsedSize()) {
243
244
245
246
	localIndex -= vectors[vectorIndex++]->getUsedSize();
      }

      return (*(vectors[vectorIndex]))[localIndex];
247
    }
248
249
250
251
252
253
254
255
256

    /** \brief
     * Sets all entries in all vectors to value.
     */
    inline void set(double value) {
      int size = vectors.getSize();
      for (int i = 0; i < size; i++) {
	vectors[i]->set(value);
      }
257
    }
258

259
260
261
262
263
264
265
    inline void setCoarsenOperation(CoarsenOperation op) { 
      for (int i = 0; i < static_cast<int>(vectors.getSize()); i++) {
	vectors[i]->setCoarsenOperation(op); 
      }
    }


266
267
268
269
270
271
272
273
274
    /** \brief
     * Sets all entries in all vectors to value.
     */
    inline SystemVector& operator=(double value) {
      int size = vectors.getSize();
      for (int i = 0; i < size; i++) {
	(*(vectors[i])) = value;
      }
      return *this;
275
    }
276
277
278
279
280

    /** \brief
     * Assignement operator.
     */
    inline SystemVector& operator=(const SystemVector& rhs) {
281
      TEST_EXIT_DBG(rhs.vectors.getSize() == vectors.getSize())("invalied sizes\n");
282
283
      int size = vectors.getSize();
      for (int i = 0; i < size; i++) {
284
285
286
	(*(vectors[i])) = (*(rhs.getDOFVector(i)));
      }
      return *this;
287
    }
288

289
    void serialize(std::ostream &out) {
290
      int size = vectors.getSize();
291
      out.write(reinterpret_cast<const char*>(&size), sizeof(int));
292
      for (int i = 0; i < size; i++) {
293
294
	vectors[i]->serialize(out);
      }
295
    }
296

297
    void deserialize(std::istream &in) {
298
      int size, oldSize = vectors.getSize();
299
300
      in.read(reinterpret_cast<char*>(&size), sizeof(int));
      vectors.resize(size);
301
      for (int i = oldSize; i < size; i++) {
302
303
	vectors[i] = NEW DOFVector<double>(feSpace[i], "");
      }
304
      for (int i = 0; i < size; i++) {
305
306
	vectors[i]->deserialize(in);
      }  
307
    }
308
309

    void copy(const SystemVector& rhs) {
310
      int size = vectors.getSize();
311
      TEST_EXIT_DBG(size == rhs.getNumVectors())("invalid sizes\n");
312
      for (int i = 0; i < size; i++) {
313
314
	vectors[i]->copy(*(const_cast<SystemVector&>(rhs).getDOFVector(i)));
      }
315
    }
316

317
    void interpol(std::vector<AbstractFunction<double, WorldVector<double> >*> *f) {
318
319
      int size = vectors.getSize();
      for (int i = 0; i < size; i++) {
320
321
	vectors[i]->interpol((*f)[i]);
      }
322
323
324
325
326
327
328
    }

    void interpol(SystemVector *v, double factor) {
      for (int i = 0; i < v->getSize(); i++) {
	vectors[i]->interpol(v->getDOFVector(i), factor);
      }
    }
329
330

    void print() {
331
332
      int size = vectors.getSize();
      for (int i = 0; i < size; i++) {
333
334
	vectors[i]->print();
      }
335
    }
336

337
338
339
340
341
342
343
344
345
    int calcMemoryUsage() {
      int result = 0;

      for (int i = 0; i < static_cast<int>(vectors.getSize()); i++) {
	result += vectors[i]->calcMemoryUsage();
      }

      return result;
    }
346

347
      
348
349
350
351
352

  protected:
    /** \brief
     * Name of the system vector
     */
353
    std::string name;
354
355
356
357

    /** \brief
     * Finite element space.
     */
358
    std::vector<FiniteElemSpace*> feSpace;
359
360
361
362
363
364
365

    /** \brief
     * Local dof vectors.
     */
    Vector<DOFVector<double>*> vectors;
  };

366

367
368
369
370
  /** \brief
   * multiplication with scalar
   */
  inline const SystemVector& operator*=(SystemVector& x, double d) {
371
372
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
373
374
375
      *(x.getDOFVector(i)) *= d;
    }
    return x;
376
  }
377
378
379
380
381

  /** \brief
   * scalar product
   */
  inline double operator*(SystemVector& x, SystemVector& y) {
382
383
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
          ("invalid size\n");
384
    double result = 0.0;
385
386
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
387
      result += (*x.getDOFVector(i)) * (*y.getDOFVector(i));
388
    }
389
    return result;
390
  }
391
392
393
394
395
396
397

  /** \brief
   * addition of two system vectors
   */
  inline const SystemVector& operator+=(SystemVector& x, 
					const SystemVector& y) 
  {
398
399
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
          ("invalid size\n");
400
401
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
402
403
404
      (*(x.getDOFVector(i))) += (*(y.getDOFVector(i)));
    }
    return x;
405
  }
406
407
408
409
410
411
412

  /**
   * subtraction of two system vectors.
   */
  inline const SystemVector& operator-=(SystemVector& x, 
					SystemVector& y) 
  {
413
414
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
          ("invalid size\n");
415
416
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
417
418
419
      (*(x.getDOFVector(i))) -= (*(y.getDOFVector(i)));
    }
    return x;
420
  }
421
422
423
424
425
426

  /** \brief
   * multiplication with a scalar
   */
  inline SystemVector operator*(SystemVector& x, double d) {
    SystemVector result = x;
427
428
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
429
430
431
      (*(result.getDOFVector(i))) *= d;
    }
    return result;
432
  }
433
434
435
436
437
438

  /** \brief
   * multiplication with a scalar
   */
  inline SystemVector operator*(double d, SystemVector& x) {
    SystemVector result = x;
439
440
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
441
442
443
      (*(result.getDOFVector(i))) *= d;
    }
    return result;
444
  }
445
446
447
448
449
450
451

  /** \brief
   * addition of two system vectors
   */
  inline SystemVector operator+(const SystemVector& x,
				const SystemVector& y)
  {
452
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
453
454
      ("invalid size\n");
    SystemVector result = x;
455
456
    int size = x.getNumVectors();
    for (int i = 0; i < size; i++) {
457
458
459
      (*(result.getDOFVector(i))) += (*(y.getDOFVector(i)));
    }
    return result;
460
  }
461
462
463
464
465
466

  /** \brief
   * Calls SystemVector::set(). Used for solving.
   */
  inline void set(SystemVector& x, double value) {
    x.set(value);
467
  } 
468
469
470
471
472
473

  /** \brief
   * Calls SystemVector::set(). Used for solving.
   */
  inline void setValue(SystemVector& x, double value) {
    x.set(value);
474
  }
475
476
477
478
479
480

  /** \brief
   * Norm of system vector.
   */
  inline double norm(SystemVector* x) {
    double result = 0.0;
481
482
    int size = x->getNumVectors();
    for (int i = 0; i < size; i++) {
483
484
485
      result += x->getDOFVector(i)->squareNrm2();
    }
    return sqrt(result);
486
  }
487
488
489
490
491
492

  /** \brief
   * L2 norm of system vector.
   */
  inline double L2Norm(SystemVector* x) {
    double result = 0.0;
493
494
    int size = x->getNumVectors();
    for (int i = 0; i < size; i++) {
495
496
497
      result += x->getDOFVector(i)->L2NormSquare();
    }
    return sqrt(result);
498
  }
499
500
501
502
503
504

  /** \brief
   * H1 norm of system vector.
   */
  inline double H1Norm(SystemVector* x) {
    double result = 0.0;
505
506
    int size = x->getNumVectors();
    for (int i = 0; i < size; i++) {
507
508
509
      result += x->getDOFVector(i)->H1NormSquare();
    }
    return sqrt(result);
510
  }
511
512
513
514
515
516
517

  inline void mv(Matrix<DOFMatrix*> &matrix,
		 const SystemVector &x,
		 SystemVector       &result,
		 bool               add = false)
  {
    int size = x.getNumVectors();
518
    int i;
519

520
521
522
    TEST_EXIT_DBG(size == result.getNumVectors())("incompatible sizes\n");
    TEST_EXIT_DBG(size == matrix.getNumRows())("incompatible sizes\n");
    TEST_EXIT_DBG(size == matrix.getNumCols())("incompatible sizes\n");
523

Thomas Witkowski's avatar
Thomas Witkowski committed
524
#ifdef _OPENMP
525
#pragma omp parallel for schedule(static, 1) num_threads(min(size, omp_get_max_threads()))
Thomas Witkowski's avatar
Thomas Witkowski committed
526
#endif
527
    for (i = 0; i < size; i++) {
Thomas Witkowski's avatar
Thomas Witkowski committed
528
529
530
531
      if (!add) 
	result.getDOFVector(i)->set(0.0);

      for (int j = 0; j < size; j++) {
532
533
534
535
536
537
538
539
540
	if (matrix[i][j]) {
	  mv<double>(NoTranspose, 
		     *(matrix[i][j]), 
		     *(x.getDOFVector(j)), 
		     *(result.getDOFVector(i)),
		     true);
	}
      }
    }
541
  }
542
543
544
545
546
547

  /** \brief
   * y = a*x + y;
   */
  inline void axpy(double a, SystemVector& x, SystemVector& y)
  {
548
549
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
          ("invalid size\n");
550

Thomas Witkowski's avatar
Thomas Witkowski committed
551
    int size = x.getNumVectors();
552
    int i;
Thomas Witkowski's avatar
Thomas Witkowski committed
553

Thomas Witkowski's avatar
Thomas Witkowski committed
554
#ifdef _OPENMP
555
#pragma omp parallel for schedule(static, 1) num_threads(min(size, omp_get_max_threads()))
Thomas Witkowski's avatar
Thomas Witkowski committed
556
#endif
557
    for (i = 0; i < size; i++) {
558
559
      axpy(a, *(x.getDOFVector(i)), *(y.getDOFVector(i)));
    }
560
  }
561
562
563
564
565
566

  /** \brief
   * y = x + a*y
   */
  inline void xpay(double a, SystemVector& x, SystemVector& y)
  {
567
568
    TEST_EXIT_DBG(x.getNumVectors() == y.getNumVectors())
          ("invalid size\n");
Thomas Witkowski's avatar
Thomas Witkowski committed
569
    int size = x.getNumVectors();
570

Thomas Witkowski's avatar
Thomas Witkowski committed
571
    for (int i = 0; i < size; i++) {
572
573
574
575
576
577
578
579
580
      xpay(a, *(x.getDOFVector(i)), *(y.getDOFVector(i)));
    }
  }

  /** \brief
   * Returns SystemVector::getUsedSize().
   */
  inline int size(SystemVector* vec) {
    return vec->getUsedSize();
581
  }
582
583
584

  inline void print(SystemVector* vec) {
    vec->print();
585
  }
586
587
588
589

}

#endif // AMDIS_SYSTEMVECTOR_H