Global.h 13.3 KB
Newer Older
1
2
3
4
// ============================================================================
// ==                                                                        ==
// == AMDiS - Adaptive multidimensional simulations                          ==
// ==                                                                        ==
5
// ==  http://www.amdis-fem.org                                              ==
6
7
// ==                                                                        ==
// ============================================================================
8
9
10
11
12
13
14
15
16
17
18
19
//
// Software License for AMDiS
//
// Copyright (c) 2010 Dresden University of Technology 
// All rights reserved.
// Authors: Simon Vey, Thomas Witkowski et al.
//
// This file is part of AMDiS
//
// See also license.opensource.txt in the distribution.


20
21
22
23
24
25
26
27
28
29
30
31
32
33

/** \file Global.h */

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

/** \defgroup Common Common
 */

#ifndef AMDIS_GLOBAL_H
#define AMDIS_GLOBAL_H

#if (__GNUC__) && (__GNUC__ > 2) 
34
#define OPENMODE std::ios::openmode
35
#else
36
#define OPENMODE std::ios::open_mode
37
38
39
#endif

/** \brief current AMDiS version */
40
41
42
#ifndef AMDIS_VERSION
#define AMDIS_VERSION  "AMDiS: Version 0.9.1"
#endif
43
44
45

#include <string>
#include <vector>
46
#include <set>
47
48
49
50
51
52
#include <fstream>
#include <math.h>
#include <iostream>
#include <stdio.h>
#include <functional>
#include <float.h>
53
#include <time.h>
54

55
#if HAVE_PARALLEL_DOMAIN_AMDIS
56
#include <mpi.h>
57
58
#endif

59
#include "boost/tuple/tuple.hpp"
60
#include "AMDiS_fwd.h"
61

62
namespace AMDiS {
63

64
65
  using namespace std;

66
67
  extern const char *funcName;

68
  const int amdisRevisionNumber = 1700;
69

70
  /// Used by matrix vector multiplication
71
72
73
74
  typedef enum { NoTranspose,
		 Transpose,
		 ConjugateTranspose } MatrixTranspose;

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

80
  /// Datatype for degrees of freedom 
81
82
  typedef signed int DegreeOfFreedom;

83
  /// Defines type for a vector of DOF pointers.
84
  typedef vector<const DegreeOfFreedom*> DofContainer;
85

86
87
  typedef std::set<const DegreeOfFreedom*> DofContainerSet;

88
  /// Defines a type for global edge identification via its DOFs.
89
  typedef pair<DegreeOfFreedom, DegreeOfFreedom> DofEdge;
90
91
92

  /// Defines a tzpe for global face identiication via its DOFs.
  typedef boost::tuple<DegreeOfFreedom, DegreeOfFreedom, DegreeOfFreedom> DofFace;
93

94

95
  /// Returns the GeoIndex of d for dimension dim.
96
97
#define INDEX_OF_DIM(d, dim) (static_cast<GeoIndex>((d == dim) ? CENTER : d + 1))

98
  /// Returns the dimension of GeoIndex ind for dimension dim
99
100
#define DIM_OF_INDEX(ind, dim) ((static_cast<int>(ind) == 0) ? dim : static_cast<int>(ind) - 1)

101
#if HAVE_PARALLEL_DOMAIN_AMDIS
102
#define PRINT_LINE(stream, line) stream << "[" << MPI::COMM_WORLD.Get_rank() << "] " << line
103
#else
104
#define PRINT_LINE(stream, line) stream << line
105
106
#endif

107
  /// Calculates factorial of i
108
109
  int fac(int i);

110
111
  void waitSec(int seconds);

112
113
  void processMemUsage(double& vm_usage, double& resident_set);

114
  /// Content comparision of two pointers. Used e.g. for find_if
115
  template<typename T>
116
  struct comparePtrContents : public binary_function<T*, T*, bool>
117
  {
118
    /// Overrides binary_function::operator()
119
120
    bool operator()(T* a, T* b) const 
    {
121
      return (*a == *b);
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
164
165
  };

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

  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:
166
    /// Prints a formated message to the message stream
167
168
    static void print(const char *format, ...);

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

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

175
176
    ///
    static void catch_error_exit(const char *format, ...) {}
177

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

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

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

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

194
    /// Changes the message stream
195
    static void change_out(ostream*);
196

197
    /// Changes the error stream 
198
    static void change_error_out(ofstream *fp);
199

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

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

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

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

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

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

230
    /// Returns \ref out
231
    static ostream *getOutStream() 
232
233
234
    { 
      return out; 
    }
235

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

242
243
244
245
246
247
248
249
  public:
#if HAVE_PARALLEL_DOMAIN_AMDIS
    /// In parallel computations, when this variable is true, only the 0 rank will
    /// print messages to the output stream. Error messages and warnings are always
    /// printed from all ranks.
    static bool outputMainRank;
#endif

250
  protected:
251
    /// Message stram
252
    static ostream *out;
253

254
    /// Error stream
255
    static ostream *error;
256
257
258
259
260
261
262

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

263
    /// Global info level
264
265
    static int msgInfo;

266
    /// Spezifies whether to wait when WAIT is called
267
268
269
270
271
272
273
274
275
276
277
278
279
280
    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;

281
  /// prints an error message 
282
283
284
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

285
  /// prints an error message and exits 
286
287
288
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

289
  /// prints a warning
290
291
292
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

293
  /// if test is false, an error message is printed
294
295
#define TEST(test) if ((test));else ERROR

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

299
  /// In debug mode, it corresponds to ERROR_EXIT, otherwise it is noop.
300
301
#if (DEBUG == 0) 
  #define TEST_EXIT_DBG(test) if (false) Msg::catch_error_exit
302
  #define DBG_VAR(var)
303
304
#else
#define TEST_EXIT_DBG(test) if ((test));else ERROR_EXIT
305
  #define DBG_VAR(var) var
306
#endif
307

308
  /// prints a message
309
310
#define MSG Msg::print_funcname(funcName), Msg::print

311
312
313
314
315
316
#if (DEBUG == 0) 
  #define MSG_DBG
#else
  #define MSG_DBG Msg::print_funcname(funcName), Msg::print
#endif

317
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
318
#define INFO(info,noinfo)						\
319
  if (Msg::getMsgInfo() && (std::min(Msg::getMsgInfo(), (info)) >= (noinfo))) MSG
320

321
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
322
#define PRINT_INFO(info,noinfo)						\
323
  if (Msg::getMsgInfo() && (std::min(Msg::getMsgInfo(), (info)) >= (noinfo))) Msg::print
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388


  /** \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.
     */
389
390
    static const Element *getReferenceElement(int dim) 
    {
391
      FUNCNAME("Global::getReferenceElement()");
392
      TEST_EXIT(dim > 0 && dim < 4)("invalid dim: %d\n", dim);
393
      return referenceElement[dim];
394
    }
395

396
    /// returns geometrical information. Currently this is only dimOfWorld.
397
398
    static inline int getGeo(GeoIndex p) 
    {
399
400
401
      if (WORLD == p) 
	return dimOfWorld; 

402
      ERROR_EXIT("Illegal request for geometry data: part = %d!\n", p);
403
      return 0;
404
    }
405
406

    /** \brief
407
     * Returns geometrical information about elements of the dimension dim.
408
409
     * getGeo(VERTEX, 3) returns 4 because a Tetrahedron has 4 vertices.
     */
410
411
    static inline int getGeo(GeoIndex p, int dim) 
    {
412
      TEST_EXIT_DBG(p >= MINPART && p <= MAXPART)
413
	("Calling for invalid geometry value %d\n",p);
414
      TEST_EXIT_DBG(dim >= 0 && dim < 4)
415
416
417
418
419
420
	("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];
    }
421

422
    /// Inits the Global class with the help of Parameters.
423
424
    static void init();

425
426
    static void clear();

Thomas Witkowski's avatar
Thomas Witkowski committed
427
  private:
428
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
429
430
     * Global is a pure static class. So the constructor is private to avoid
     * instantiation.
431
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
432
    Global();
433
434

  private:
435
    /// Dimension of the simulated world
436
437
438
439
440
441
442
443
444
445
    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];
446

447
    /// Stores the precalculated results that should be returned by Global::getGeo.
448
    static vector<vector<int> > geoIndexTable;
449
450
451
452
453
454
  };

#define COMMA ,

  const int RescheduleErrorCode = 23;

455
456
457
458
459
460
461
462
463
  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
464
465
466
467
}

#endif // AMDIS_GLOBAL_H