Global.h 13.7 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
82
83
  /// Defines a type for global edge identification.
  typedef std::pair<DegreeOfFreedom, DegreeOfFreedom> GlobalEdge;

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

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

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

96
  /// Calculates factorial of i
97
98
  int fac(int i);

99
100
  void waitSec(int seconds);

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

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

114
  ///  template<typename T> T max(T a,T b ) {return  ((a) > (b) ? (a) : (b));}
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
161
162
163
  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:
164
    /// Prints a formated message to the message stream
165
166
    static void print(const char *format, ...);

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

170
    /// Prints a formated message to the error stream and exits 
171
172
    static void print_error_exit(const char *format, ...);

173
174
    ///
    static void catch_error_exit(const char *format, ...) {}
175

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

181
    /// Prints a warning to the message stream
182
183
    static void print_warn(const char *format, ...);

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

189
    /// Prints the funcname to the message stream
190
191
    static void print_funcname(const char *funcname);

192
    /// Changes the message stream
193
    static void change_out(std::ostream*);
194

195
    /// Changes the error stream 
196
    static void change_error_out(std::ofstream *fp);
197

198
    /// Creates a filestream and sets the error stream to this filestream
199
200
    static void open_error_file(const char *filename, OPENMODE);

201
    /// Sets \ref msgInfo
202
203
204
205
    static void setMsgInfo(int info) 
    { 
      msgInfo = info; 
    }
206

207
    /// Returns \ref msgInfo
208
209
210
211
    static int  getMsgInfo() 
    { 
      return msgInfo; 
    }
212

213
    /// Sets \ref msgWait
214
215
216
217
    static void setMsgWait(bool wait) 
    { 
      msgWait = wait; 
    }
218

219
    /// Returns \ref msgWait
220
221
222
223
    static bool getMsgWait() 
    { 
      return msgWait; 
    }
224

225
    /// Waits for enter if w is true
226
227
    static void wait(bool w);

228
    /// Returns \ref out
229
230
231
232
    static std::ostream *getOutStream() 
    { 
      return out; 
    }
233

234
    /// Returns \ref error
235
236
237
238
    static std::ostream *getErrorStream() 
    { 
      return error; 
    }
239
240

  protected:
241
    /// Message stram
242
    static std::ostream *out;
243

244
    /// Error stream
245
    static std::ostream *error;
246
247
248
249
250
251
252

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

253
    /// Global info level
254
255
    static int msgInfo;

256
    /// Spezifies whether to wait when WAIT is called
257
258
259
260
261
262
263
264
265
266
267
268
269
270
    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;

271
  /// prints an error message 
272
273
274
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

275
  /// prints an error message and exits 
276
277
278
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

279
  /// prints a warning
280
281
282
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

283
  /// if test is false, an error message is printed
284
285
#define TEST(test) if ((test));else ERROR

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

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

298
  /// prints a message
299
300
#define MSG Msg::print_funcname(funcName), Msg::print

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

305
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
306
#define PRINT_INFO(info,noinfo)						\
307
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) Msg::print
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
370
371
372


  /** \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.
     */
373
374
    static const Element *getReferenceElement(int dim) 
    {
375
      FUNCNAME("Global::getReferenceElement()");
376
      TEST_EXIT(dim > 0 && dim < 4)("invalid dim: %d\n", dim);
377
      return referenceElement[dim];
378
    }
379

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

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

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

406
    /// Inits the Global class with the help of Parameters.
407
408
    static void init();

409
410
    static void clear();

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

  private:
419
    /// Dimension of the simulated world
420
421
422
423
424
425
426
427
428
429
    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];
430

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

#define COMMA ,

  const int RescheduleErrorCode = 23;

439
  std::string memSizeStr(int size);
440
441
442
443
444
445
446
447
448
449

  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
450
451
452
453
}

#endif // AMDIS_GLOBAL_H