Global.h 13.6 KB
Newer Older
1
2
3
4
5
6
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
7
// ==  TU Dresden                                                            ==
8
// ==                                                                        ==
9
10
11
// ==  Institut für Wissenschaftliches Rechnen                               ==
// ==  Zellescher Weg 12-14                                                  ==
// ==  01069 Dresden                                                         ==
12
13
14
15
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
16
// ==  https://gforge.zih.tu-dresden.de/projects/amdis/                      ==
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// ==                                                                        ==
// ============================================================================

/** \file Global.h */

/** \mainpage AMDiS
 * @{ <img src="vis.png"> @}
 */

/** \defgroup Common Common
 */

#ifndef AMDIS_GLOBAL_H
#define AMDIS_GLOBAL_H

#if (__GNUC__) && (__GNUC__ > 2) 
33
#define OPENMODE std::ios::openmode
34
#else
35
#define OPENMODE std::ios::open_mode
36
37
38
39
40
41
42
43
44
45
46
47
48
#endif

/** \brief current AMDiS version */
#define AMDIS_VERSION  "AMDiS: Version 0.100"

#include <string>
#include <vector>
#include <fstream>
#include <math.h>
#include <iostream>
#include <stdio.h>
#include <functional>
#include <float.h>
49
#include <time.h>
50

51
52
53
54
#if HAVE_PARALLEL_DOMAIN_AMDIS
#include "mpi.h"
#endif

55
#include "AMDiS_fwd.h"
56

57
namespace AMDiS {
58
59
60
61
62
63
64

  extern const char *funcName;

  // ============================================================================
  // ===== definitions ==========================================================
  // ============================================================================

65
  /// used by matrix vector multiplication
66
67
68
69
  typedef enum { NoTranspose,
		 Transpose,
		 ConjugateTranspose } MatrixTranspose;

70
  /// speciefies the norm used by Estimator.
71
72
73
  typedef enum { NO_NORM = 0, 
		 H1_NORM = 1, 
		 L2_NORM = 2 } Norm;
74

75
  /// datatype for degrees of freedom 
76
77
  typedef signed int DegreeOfFreedom;

78
79
80
  /// Defines type for a vector of DOF pointers.
  typedef std::vector<const DegreeOfFreedom*> DofContainer;

81
  /// returns the GeoIndex of d for dimension dim.
82
83
#define INDEX_OF_DIM(d, dim) (static_cast<GeoIndex>((d == dim) ? CENTER : d + 1))

84
  /// returns the dimension of GeoIndex ind for dimension dim
85
86
#define DIM_OF_INDEX(ind, dim) ((static_cast<int>(ind) == 0) ? dim : static_cast<int>(ind) - 1)

87
#if HAVE_PARALLEL_DOMAIN_AMDIS
88
#define PRINT_LINE(stream, line) stream << "[" << MPI::COMM_WORLD.Get_rank() << "] " << line
89
#else
90
#define PRINT_LINE(stream, line) stream << line
91
92
#endif

93
  /// Calculates factorial of i
94
95
  int fac(int i);

96
97
  void waitSec(int seconds);

98
  /// Content comparision of two pointers. Used e.g. for std::find_if
99
  template<typename T>
100
  struct comparePtrContents : public std::binary_function<T*, T*, bool>
101
  {
102
    /// Overrides binary_function::operator()
103
104
    bool operator()(T* a, T* b) const 
    {
105
      return (*a == *b);
106
    }
107
108
109
110
  };

  // ===== some simple template functions ====================================== 

111
  ///  template<typename T> T max(T a,T b ) {return  ((a) > (b) ? (a) : (b));}
112
113
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
  template<typename T,typename S> inline T max(T a,S b )
  {
    return  ((a) > (b) ? (a) : (b));
  }

  template<typename T> inline T min(T a,T b) 
  {
    return  ((a) < (b)) ? (a) : (b);
  }

  template<typename T> inline T abs(T a) 
  {
    return  ((a) >= 0 ? (a) : -(a));
  }

  template<typename T> inline T sqr(T a) 
  {
    return  ((a)*(a));
  }

  // ===== some predefined values ===============================================
  const double m_e = 		2.7182818284590452354;
  const double m_log2e = 		1.4426950408889634074;
  const double m_log10e = 	0.43429448190325182765;
  const double m_ln2 = 		0.69314718055994530942;
  const double m_ln10 = 		2.30258509299404568402;
  const double m_pi = 		3.14159265358979323846;
  const double m_pi_2 = 		1.57079632679489661923;
  const double m_pi_4 = 		0.78539816339744830962;
  const double m_1_pi = 		0.31830988618379067154;
  const double m_2_pi = 		0.63661977236758134308;
  const double m_2_sqrtpi = 	1.12837916709551257390;
  const double m_sqrt2 = 		1.41421356237309504880;
  const double m_sqrt1_2 = 	0.70710678118654752440;

  // ===== tolerance for floating point comparison ==============================
#define DBL_TOL DBL_EPSILON
#define FLT_TOL FLT_EPSILON


  /** \brief
   * Manages the output of messages, warnings, errors, ...
   * Used by the macros FUNCNAME, ERROR, ERROR_EXIT, WARNING, TEST, MSG, INFO,
   * PRINT_INFO, WAIT, WAIT_REALLY.
   * Don't use this class directly but only via these macros!
   */
  class Msg
  {
  public:
161
    /// Prints a formated message to the message stream
162
163
    static void print(const char *format, ...);

164
    /// Prints a formated message to the error stream
165
166
    static void print_error(const char *format, ...);

167
    /// Prints a formated message to the error stream and exits 
168
169
    static void print_error_exit(const char *format, ...);

170
171
    ///
    static void catch_error_exit(const char *format, ...) {}
172

173
    /// Prints an error message with funcname, file, and line to the error stream
174
175
176
177
    static void print_error_funcname(const char *funcname,
				     const char *file, 
				     int line);

178
    /// Prints a warning to the message stream
179
180
    static void print_warn(const char *format, ...);

181
    /// Prints a warning with funcname, file, and line to the message stream
182
183
184
185
    static void print_warn_funcname(const char *funcname,
				    const char *file, 
				    int line);

186
    /// Prints the funcname to the message stream
187
188
    static void print_funcname(const char *funcname);

189
    /// Changes the message stream
190
    static void change_out(std::ostream*);
191

192
    /// Changes the error stream 
193
    static void change_error_out(std::ofstream *fp);
194

195
    /// Creates a filestream and sets the error stream to this filestream
196
197
    static void open_error_file(const char *filename, OPENMODE);

198
    /// Sets \ref msgInfo
199
200
201
202
    static void setMsgInfo(int info) 
    { 
      msgInfo = info; 
    }
203

204
    /// Returns \ref msgInfo
205
206
207
208
    static int  getMsgInfo() 
    { 
      return msgInfo; 
    }
209

210
    /// Sets \ref msgWait
211
212
213
214
    static void setMsgWait(bool wait) 
    { 
      msgWait = wait; 
    }
215

216
    /// Returns \ref msgWait
217
218
219
220
    static bool getMsgWait() 
    { 
      return msgWait; 
    }
221

222
    /// Waits for enter if w is true
223
224
    static void wait(bool w);

225
    /// Returns \ref out
226
227
228
229
    static std::ostream *getOutStream() 
    { 
      return out; 
    }
230

231
    /// Returns \ref error
232
233
234
235
    static std::ostream *getErrorStream() 
    { 
      return error; 
    }
236
237

  protected:
238
    /// Message stram
239
    static std::ostream *out;
240

241
    /// Error stream
242
    static std::ostream *error;
243
244
245
246
247
248
249

    /** \brief
     * Remember funcName to avoid multiple output of funcName within the same
     * function call
     */
    static const char *oldFuncName;

250
    /// Global info level
251
252
    static int msgInfo;

253
    /// Spezifies whether to wait when WAIT is called
254
255
256
257
258
259
260
261
262
263
264
265
266
267
    static bool msgWait;
  };

  // ============================================================================
  // ===== message macros =======================================================
  // ============================================================================

  /** \brief 
   * Should be the first call in every functions. It defines the current function
   * name nn for message output via MSG, WARNING, ...
   */

#define FUNCNAME(nn) const char *funcName; funcName = nn;

268
  /// prints an error message 
269
270
271
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

272
  /// prints an error message and exits 
273
274
275
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

276
  /// prints a warning
277
278
279
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

280
  /// if test is false, an error message is printed
281
282
#define TEST(test) if ((test));else ERROR

283
  /// if test is false, an error message is printed and the program exits
Thomas Witkowski's avatar
Thomas Witkowski committed
284
#define TEST_EXIT(test) if ((test));else ERROR_EXIT
285

286
  /// In debug mode, it corresponds to ERROR_EXIT, otherwise it is noop.
287
288
#if (DEBUG == 0) 
  #define TEST_EXIT_DBG(test) if (false) Msg::catch_error_exit
289
  #define DBG_VAR(var)
290
291
#else
#define TEST_EXIT_DBG(test) if ((test));else ERROR_EXIT
292
  #define DBG_VAR(var) var
293
#endif
294

295
  /// prints a message
296
297
#define MSG Msg::print_funcname(funcName), Msg::print

298
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
299
#define INFO(info,noinfo)						\
300
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) MSG
301

302
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
303
#define PRINT_INFO(info,noinfo)						\
304
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) Msg::print
305
306
307
308
309
310
311
312
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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369


  /** \brief 
   * If the value of Msg::wait is not zero the macro will produce the message 
   * 'wait for <enter> ...' and will continue after pressing the return or enter
   * key. Otherwise the program continues without a message.
   */
#define WAIT Msg::wait(Msg::getMsgWait())

  /** \brief
   * produces the message 'wait for <enter> ...' and will continue after pressing
   * the return or enter key.
   */
#define WAIT_REALLY Msg::wait(true)

#define TIME_USED(f,s) ((double)((s)-(f))/(double)CLOCKS_PER_SEC)

  /** \brief
   * internal used indices to represent the different geometrical objects.
   * Used as parameter for getGeo() and as template parameter for FixVec. 
   */
  typedef enum
    {
      CENTER   = 0, /**< in 1d the center is at the edge, in 2d at the face, in 3d 
		     * at the interior of an element. So a Line has no edge but
		     * only a center, a Triangle has no face but only a center.
		     */
      VERTEX   = 1, /**< index for element vertices.
		     * number of vertices is equal to number of parts and 
		     * neighbours.
		     */
      EDGE     = 2, /**< index for element edges */
      FACE     = 3, /**< index for element faces */
      DIMEN    =-1, /**< index for problem dimension */
      PARTS    =-2, /**< index for parts of an element (vertices in 1d, edges in 2d
		     * , faces in 3d). Number of element parts is equal to number
		     * of vertices and neighbours. 
		     */
      NEIGH    =-3, /**< index for neighbours of an element.
		     * Number of element neighbours is equal to number of 
		     * vertices and parts.
		     */
      WORLD    =-4, /**< index for world dimension */
      BOUNDARY =-5, /**< index for boundary nodes of an element. This could be
		     * vertices, edges or faces.
		     */
      PROJECTION=-6 /**< index for element and boundary projections */
    } GeoIndex;

#define MAXPART FACE
#define MINPART PROJECTION


  /** \ingroup Common
   * \brief
   * Static class wich holds global information about the world and all types of
   * elements.
   */
  class Global
  {
  public:
    /** \brief
     * returns a pointer to \ref referenceElement [dim]. With this pointer you
     * can get information about the element via Element's getGeo method.
     */
370
371
    static const Element *getReferenceElement(int dim) 
    {
372
      FUNCNAME("Global::getReferenceElement()");
373
      TEST_EXIT(dim > 0 && dim < 4)("invalid dim: %d\n", dim);
374
      return referenceElement[dim];
375
    }
376

377
    /// returns geometrical information. Currently this is only dimOfWorld.
378
379
    static inline int getGeo(GeoIndex p) 
    {
380
381
382
      if (WORLD == p) 
	return dimOfWorld; 

383
      ERROR_EXIT("Illegal request for geometry data: part = %d!\n", p);
384
      return 0;
385
    }
386
387

    /** \brief
388
     * Returns geometrical information about elements of the dimension dim.
389
390
     * getGeo(VERTEX, 3) returns 4 because a Tetrahedron has 4 vertices.
     */
391
392
    static inline int getGeo(GeoIndex p, int dim) 
    {
393
      TEST_EXIT_DBG(p >= MINPART && p <= MAXPART)
394
	("Calling for invalid geometry value %d\n",p);
395
      TEST_EXIT_DBG(dim >= 0 && dim < 4)
396
397
398
399
400
401
	("invalid dim: %d\n", dim);
      TEST_EXIT_DBG((dim != 0) || (p == PARTS || p == VERTEX || p == EDGE || p == FACE))
	("dim = 0\n");

      return geoIndexTable[dim][p - MINPART];
    }
402

403
    /// Inits the Global class with the help of Parameters.
404
405
    static void init();

406
407
    static void clear();

Thomas Witkowski's avatar
Thomas Witkowski committed
408
  private:
409
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
410
411
     * Global is a pure static class. So the constructor is private to avoid
     * instantiation.
412
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
413
    Global();
414
415

  private:
416
    /// Dimension of the simulated world
417
418
419
420
421
422
423
424
425
426
    static int dimOfWorld;

    /** \brief
     * contains a pointer to a Line, a Triangle, and a Tetrahedron.
     * This allows the access to information of the concrete elements via
     * the dimension index.
     * referenceElement[3]->getGeo(VERTEX) gives the number of vertices of a
     * Tetrahedron wich is 4 => no switch statement is necessary.
     */
    static Element *referenceElement[4];
427

428
    /// Stores the precalculated results that should be returned by Global::getGeo.
429
    static std::vector< std::vector< int > > geoIndexTable;
430
431
432
433
434
435
  };

#define COMMA ,

  const int RescheduleErrorCode = 23;

436
  std::string memSizeStr(int size);
437
438
439
440
441
442
443
444
445
446

  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
Thomas Witkowski's avatar
Thomas Witkowski committed
447

Thomas Witkowski's avatar
bugfix    
Thomas Witkowski committed
448
449
#define NEW new
#define DELETE delete
450
451
452
453
}

#endif // AMDIS_GLOBAL_H