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
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
#include <time.h>
51

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

56
#include "boost/tuple/tuple.hpp"
57
#include "AMDiS_fwd.h"
58

59
namespace AMDiS {
60
61
62
63
64
65
66

  extern const char *funcName;

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

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

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

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

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

83
84
85
86
87
  /// Defines a type for global edge identification via its DOFs.
  typedef std::pair<DegreeOfFreedom, DegreeOfFreedom> DofEdge;

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

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

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

95
#if HAVE_PARALLEL_DOMAIN_AMDIS
96
#define PRINT_LINE(stream, line) stream << "[" << MPI::COMM_WORLD.Get_rank() << "] " << line
97
#else
98
#define PRINT_LINE(stream, line) stream << line
99
100
#endif

101
  /// Calculates factorial of i
102
103
  int fac(int i);

104
105
  void waitSec(int seconds);

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

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

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

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

175
    /// Prints a formated message to the error stream and exits 
176
177
    static void print_error_exit(const char *format, ...);

178
179
    ///
    static void catch_error_exit(const char *format, ...) {}
180

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

186
    /// Prints a warning to the message stream
187
188
    static void print_warn(const char *format, ...);

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

194
    /// Prints the funcname to the message stream
195
196
    static void print_funcname(const char *funcname);

197
    /// Changes the message stream
198
    static void change_out(std::ostream*);
199

200
    /// Changes the error stream 
201
    static void change_error_out(std::ofstream *fp);
202

203
    /// Creates a filestream and sets the error stream to this filestream
204
205
    static void open_error_file(const char *filename, OPENMODE);

206
    /// Sets \ref msgInfo
207
208
209
210
    static void setMsgInfo(int info) 
    { 
      msgInfo = info; 
    }
211

212
    /// Returns \ref msgInfo
213
214
215
216
    static int  getMsgInfo() 
    { 
      return msgInfo; 
    }
217

218
    /// Sets \ref msgWait
219
220
221
222
    static void setMsgWait(bool wait) 
    { 
      msgWait = wait; 
    }
223

224
    /// Returns \ref msgWait
225
226
227
228
    static bool getMsgWait() 
    { 
      return msgWait; 
    }
229

230
    /// Waits for enter if w is true
231
232
    static void wait(bool w);

233
    /// Returns \ref out
234
235
236
237
    static std::ostream *getOutStream() 
    { 
      return out; 
    }
238

239
    /// Returns \ref error
240
241
242
243
    static std::ostream *getErrorStream() 
    { 
      return error; 
    }
244
245

  protected:
246
    /// Message stram
247
    static std::ostream *out;
248

249
    /// Error stream
250
    static std::ostream *error;
251
252
253
254
255
256
257

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

258
    /// Global info level
259
260
    static int msgInfo;

261
    /// Spezifies whether to wait when WAIT is called
262
263
264
265
266
267
268
269
270
271
272
273
274
275
    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;

276
  /// prints an error message 
277
278
279
#define ERROR Msg::print_error_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_error

280
  /// prints an error message and exits 
281
282
283
#define ERROR_EXIT Msg::print_error_funcname(funcName,__FILE__, __LINE__), \
    Msg::print_error_exit

284
  /// prints a warning
285
286
287
#define WARNING Msg::print_warn_funcname(funcName,__FILE__, __LINE__),	\
    Msg::print_warn

288
  /// if test is false, an error message is printed
289
290
#define TEST(test) if ((test));else ERROR

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

294
  /// In debug mode, it corresponds to ERROR_EXIT, otherwise it is noop.
295
296
#if (DEBUG == 0) 
  #define TEST_EXIT_DBG(test) if (false) Msg::catch_error_exit
297
  #define DBG_VAR(var)
298
299
#else
#define TEST_EXIT_DBG(test) if ((test));else ERROR_EXIT
300
  #define DBG_VAR(var) var
301
#endif
302

303
  /// prints a message
304
305
#define MSG Msg::print_funcname(funcName), Msg::print

306
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
307
#define INFO(info,noinfo)						\
308
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) MSG
309

310
  /// prints a message, if min(Msg::msgInfo, info) >= noinfo
311
#define PRINT_INFO(info,noinfo)						\
312
  if (Msg::getMsgInfo()&&(std::min(Msg::getMsgInfo(),(info))>=(noinfo))) Msg::print
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
373
374
375
376
377


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

385
    /// returns geometrical information. Currently this is only dimOfWorld.
386
387
    static inline int getGeo(GeoIndex p) 
    {
388
389
390
      if (WORLD == p) 
	return dimOfWorld; 

391
      ERROR_EXIT("Illegal request for geometry data: part = %d!\n", p);
392
      return 0;
393
    }
394
395

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

411
    /// Inits the Global class with the help of Parameters.
412
413
    static void init();

414
415
    static void clear();

Thomas Witkowski's avatar
Thomas Witkowski committed
416
  private:
417
    /** \brief
Thomas Witkowski's avatar
Thomas Witkowski committed
418
419
     * Global is a pure static class. So the constructor is private to avoid
     * instantiation.
420
     */
Thomas Witkowski's avatar
Thomas Witkowski committed
421
    Global();
422
423

  private:
424
    /// Dimension of the simulated world
425
426
427
428
429
430
431
432
433
434
    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];
435

436
    /// Stores the precalculated results that should be returned by Global::getGeo.
437
    static std::vector< std::vector< int > > geoIndexTable;
438
439
440
441
442
443
  };

#define COMMA ,

  const int RescheduleErrorCode = 23;

444
  std::string memSizeStr(int size);
445
446
447
448
449
450
451
452
453
454

  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
455
456
457
458
}

#endif // AMDIS_GLOBAL_H