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
49
#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>

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

54
#include "AMDiS_fwd.h"
55

56
namespace AMDiS {
57
58
59
60
61
62
63

  extern const char *funcName;

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

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

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

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

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

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

83
#if HAVE_PARALLEL_DOMAIN_AMDIS
84
#define PRINT_LINE(stream, line) stream << "[" << MPI::COMM_WORLD.Get_rank() << "] " << line
85
#else
86
#define PRINT_LINE(stream, line) stream << line
87
88
#endif

89
  /// Calculates factorial of i
90
91
  int fac(int i);

92
  /// Content comparision of two pointers. Used e.g. for std::find_if
93
  template<typename T>
94
  struct comparePtrContents : public std::binary_function<T*, T*, bool>
95
  {
96
    /// Overrides binary_function::operator()
97
98
    bool operator()(T* a, T* b) const 
    {
99
      return (*a == *b);
100
    }
101
102
103
104
  };

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

105
  ///  template<typename T> T max(T a,T b ) {return  ((a) > (b) ? (a) : (b));}
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
  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:
155
    /// Prints a formated message to the message stream
156
157
    static void print(const char *format, ...);

158
    /// Prints a formated message to the error stream
159
160
    static void print_error(const char *format, ...);

161
    /// Prints a formated message to the error stream and exits 
162
163
    static void print_error_exit(const char *format, ...);

164
165
    ///
    static void catch_error_exit(const char *format, ...) {}
166

167
    /// Prints an error message with funcname, file, and line to the error stream
168
169
170
171
    static void print_error_funcname(const char *funcname,
				     const char *file, 
				     int line);

172
    /// Prints a warning to the message stream
173
174
    static void print_warn(const char *format, ...);

175
    /// Prints a warning with funcname, file, and line to the message stream
176
177
178
179
    static void print_warn_funcname(const char *funcname,
				    const char *file, 
				    int line);

180
    /// Prints the funcname to the message stream
181
182
    static void print_funcname(const char *funcname);

183
    /// Changes the message stream
184
    static void change_out(std::ostream*);
185

186
    /// Changes the error stream 
187
    static void change_error_out(std::ofstream *fp);
188

189
    /// Creates a filestream and sets the error stream to this filestream
190
191
    static void open_error_file(const char *filename, OPENMODE);

192
    /// Sets \ref msgInfo
193
194
195
196
    static void setMsgInfo(int info) 
    { 
      msgInfo = info; 
    }
197

198
    /// Returns \ref msgInfo
199
200
201
202
    static int  getMsgInfo() 
    { 
      return msgInfo; 
    }
203

204
    /// Sets \ref msgWait
205
206
207
208
    static void setMsgWait(bool wait) 
    { 
      msgWait = wait; 
    }
209

210
    /// Returns \ref msgWait
211
212
213
214
    static bool getMsgWait() 
    { 
      return msgWait; 
    }
215

216
    /// Waits for enter if w is true
217
218
    static void wait(bool w);

219
    /// Returns \ref out
220
221
222
223
    static std::ostream *getOutStream() 
    { 
      return out; 
    }
224

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

  protected:
232
    /// Message stram
233
    static std::ostream *out;
234

235
    /// Error stream
236
    static std::ostream *error;
237
238
239
240
241
242
243

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

244
    /// Global info level
245
246
    static int msgInfo;

247
    /// Spezifies whether to wait when WAIT is called
248
249
250
251
252
253
254
255
256
257
258
259
260
261
    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;

262
  /// prints an error message 
263
264
265
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

266
  /// prints an error message and exits 
267
268
269
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

270
  /// prints a warning
271
272
273
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

274
  /// if test is false, an error message is printed
275
276
#define TEST(test) if ((test));else ERROR

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

280
  /// In debug mode, it corresponds to ERROR_EXIT, otherwise it is noop.
281
282
#if (DEBUG == 0) 
  #define TEST_EXIT_DBG(test) if (false) Msg::catch_error_exit
283
  #define DBG_VAR(var)
284
285
#else
#define TEST_EXIT_DBG(test) if ((test));else ERROR_EXIT
286
  #define DBG_VAR(var) var
287
#endif
288

289
  /// prints a message
290
291
#define MSG Msg::print_funcname(funcName), Msg::print

292
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
293
#define INFO(info,noinfo)						\
294
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) MSG
295

296
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
297
#define PRINT_INFO(info,noinfo)						\
298
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) Msg::print
299
300
301
302
303
304
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


  /** \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)

#include <time.h>
#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.
     */
365
366
    static const Element *getReferenceElement(int dim) 
    {
367
      FUNCNAME("Global::getReferenceElement()");
368
      TEST_EXIT((dim > 0) && (dim < 4))("invalid dim: %d\n", dim);
369
      return referenceElement[dim];
370
    }
371

372
    /// returns geometrical information. Currently this is only dimOfWorld.
373
374
    static inline int getGeo(GeoIndex p) 
    {
375
376
377
      if (WORLD == p) 
	return dimOfWorld; 

378
      ERROR_EXIT("Illegal request for geometry data: part = %d!\n", p);
379
      return 0;
380
    }
381
382

    /** \brief
383
     * Returns geometrical information about elements of the dimension dim.
384
385
     * getGeo(VERTEX, 3) returns 4 because a Tetrahedron has 4 vertices.
     */
386
387
    static inline int getGeo(GeoIndex p, int dim) 
    {
388
389
390
391
392
393
394
395
396
      TEST_EXIT_DBG((p >= MINPART) && (p <= MAXPART))
	("Calling for invalid geometry value %d\n",p);
      TEST_EXIT_DBG((dim >= 0) && (dim < 4))
	("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];
    }
397

398
    /// Inits the Global class with the help of Parameters.
399
400
    static void init();

401
402
    static void clear();

Thomas Witkowski's avatar
Thomas Witkowski committed
403
  private:
404
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
405
406
     * Global is a pure static class. So the constructor is private to avoid
     * instantiation.
407
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
408
    Global();
409
410

  private:
411
    /// Dimension of the simulated world
412
413
414
415
416
417
418
419
420
421
    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];
422

423
    /// Stores the precalculated results that should be returned by Global::getGeo.
424
    static std::vector< std::vector< int > > geoIndexTable;
425
426
427
428
429
430
  };

#define COMMA ,

  const int RescheduleErrorCode = 23;

431
  std::string memSizeStr(int size);
432
433
434
435
436
437
438
439
440
441

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

#define MEMORY_MANAGED(className) ;
Thomas Witkowski's avatar
bugfix  
Thomas Witkowski committed
444
445
#define NEW new
#define DELETE delete
Thomas Witkowski's avatar
Thomas Witkowski committed
446
447
448
#define GET_MEMORY(typename, number) new typename[number]
#define FREE_MEMORY(ptr, typename, number) delete [] ptr

449
450
451
452
}

#endif // AMDIS_GLOBAL_H