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

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

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

53
#if HAVE_PARALLEL_DOMAIN_AMDIS
54
#include <mpi.h>
55
56
#endif

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

60
namespace AMDiS {
61
62
63
64
65
66
67

  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
82
83
  /// Defines type for a vector of DOF pointers.
  typedef std::vector<const DegreeOfFreedom*> DofContainer;

84
85
  typedef std::set<const DegreeOfFreedom*> DofContainerSet;

86
87
88
89
90
  /// 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;
91

92

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

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

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

105
  /// Calculates factorial of i
106
107
  int fac(int i);

108
109
  void waitSec(int seconds);

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

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

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

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

171
172
    ///
    static void catch_error_exit(const char *format, ...) {}
173

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

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

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

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

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

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

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

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

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

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

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

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

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

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

238
239
240
241
242
243
244
245
  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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

415
416
    static void clear();

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

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

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

#define COMMA ,

  const int RescheduleErrorCode = 23;

445
446
447
448
449
450
451
452
453
  /**
   * \ingroup Assembler
   * \brief
   * Specifies the type of a FirstOrderTerm 
   */
  enum FirstOrderType {
    GRD_PSI,
    GRD_PHI
  };
454
455
456
457
}

#endif // AMDIS_GLOBAL_H