Global.h 14.3 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
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  crystal growth group                                                  ==
// ==                                                                        ==
// ==  Stiftung caesar                                                       ==
// ==  Ludwig-Erhard-Allee 2                                                 ==
// ==  53175 Bonn                                                            ==
// ==  germany                                                               ==
// ==                                                                        ==
// ============================================================================
// ==                                                                        ==
// ==  http://www.caesar.de/cg/AMDiS                                         ==
// ==                                                                        ==
// ============================================================================

/** \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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
#endif

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

// ============================================================================
// ===== includes =============================================================
// ============================================================================

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

namespace AMDiS {
  // ============================================================================
  // ===== forward declarations =================================================
  // ============================================================================

  class Mesh;
  class Element;

  extern const char *funcName;

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

68
  /// used by matrix vector multiplication
69
70
71
72
  typedef enum { NoTranspose,
		 Transpose,
		 ConjugateTranspose } MatrixTranspose;

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

78
  /// datatype for degrees of freedom 
79
80
  typedef signed int DegreeOfFreedom;

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
  /// Calculates factorial of i
88
89
  int fac(int i);

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

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

102
  ///  template<typename T> T max(T a,T b ) {return  ((a) > (b) ? (a) : (b));}
103
104
105
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

  // ============================================================================
  // ===== class Msg ============================================================
  // ============================================================================

  /** \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
    /// Creates a filestream and sets the message stream to this filestream
187
188
    static void open_file(const char *filename, OPENMODE);

189
    /// Changes the error stream 
190
    static void change_error_out(std::ofstream *fp);
191

192
    /// Creates a filestream and sets the error stream to this filestream
193
194
    static void open_error_file(const char *filename, OPENMODE);

195
    /// Generates a filename from path, file and ntime
196
197
    static const char *generate_filename(const char *path, 
					 const char *file, 
198
					 int ntime);
199

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

203
204
    /// Returns \ref msgInfo
    static int  getMsgInfo() { return msgInfo; }
205

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

209
210
    /// Returns \ref msgWait
    static bool getMsgWait() { return msgWait; }
211

212
    /// Waits for enter if w is true
213
214
    static void wait(bool w);

215
216
    /// Returns \ref out
    static std::ostream *getOutStream() { return out; }
217

218
219
    /// Returns \ref error
    static std::ostream *getErrorStream() { return error; }
220
221

  protected:
222
    /// Message stram
223
    static std::ostream *out;
224

225
    /// Error stream
226
    static std::ostream *error;
227
228
229
230
231
232
233

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

234
    /// Global info level
235
236
    static int msgInfo;

237
    /// Spezifies whether to wait when WAIT is called
238
239
240
241
242
243
244
245
246
247
248
249
250
251
    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;

252
  /// prints an error message 
253
254
255
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

256
  /// prints an error message and exits 
257
258
259
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

260
  /// prints a warning
261
262
263
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

264
  /// if test is false, an error message is printed
265
266
#define TEST(test) if ((test));else ERROR

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

270
  /// In debug mode, it corresponds to ERROR_EXIT, otherwise it is noop.
271
272
273
274
275
#if (DEBUG == 0) 
  #define TEST_EXIT_DBG(test) if (false) Msg::catch_error_exit
#else
#define TEST_EXIT_DBG(test) if ((test));else ERROR_EXIT
#endif
276

277
  /// prints a message
278
279
#define MSG Msg::print_funcname(funcName), Msg::print

280
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
281
#define INFO(info,noinfo)						\
282
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) MSG
283

284
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
285
#define PRINT_INFO(info,noinfo)						\
286
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) Msg::print
287
288
289
290
291
292
293
294
295
296
297
298
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


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

  // ============================================================================
  // ===== class Global =========================================================
  // ============================================================================

  /** \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.
     */
    static const Element *getReferenceElement(int dim) {
357
      FUNCNAME("Global::getReferenceElement()");
358
      TEST_EXIT((dim > 0) && (dim < 4))("invalid dim: %d\n", dim);
359
      return referenceElement[dim];
360
    }
361
362
363
364
365

    /** \brief
     * returns geometrical information. Currently this is only dimOfWorld.
     */
    static inline int getGeo(GeoIndex p) {
366
367
368
369
      if (WORLD == p) 
	return dimOfWorld; 

      ERROR_EXIT("Illegal request for geometry data: part=%d!\n", p);
370
      return 0;
371
    }
372
373
374
375
376

    /** \brief
     * returns geometrical information about elements of the dimension dim.
     * getGeo(VERTEX, 3) returns 4 because a Tetrahedron has 4 vertices.
     */
377
378
379
380
381
382
383
384
385
386
    static inline int getGeo(GeoIndex p, int dim) {
      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];
    }
387

388
    /// Inits the Global class with the help of Parameters.
389
390
    static void init();

391
392
    static void clear();

Thomas Witkowski's avatar
Thomas Witkowski committed
393
  private:
394
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
395
396
     * Global is a pure static class. So the constructor is private to avoid
     * instantiation.
397
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
398
    Global();
399
400

  private:
401
    /// Dimension of the simulated world
402
403
404
405
406
407
408
409
410
411
    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];
412

413
    /// Stores the precalculated results that should be returned by Global::getGeo.
414
    static std::vector< std::vector< int > > geoIndexTable;
415
416
417
418
419
420
  };

#define COMMA ,

  const int RescheduleErrorCode = 23;

421
  std::string memSizeStr(int size);
422
423
424
425
426
427
428
429
430
431

  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
432
433
434
435
}

#endif // AMDIS_GLOBAL_H