revision: v0.14
GeneralDefine.h File Reference
#include <limits>

Go to the source code of this file.

Namespaces

 constants
 

Macros

#define MERCURY_DEPRECATED   [[deprecated]]
 
#define UNUSED   __attribute__ ((__unused__))
 
#define MAX_PROC   1000
 
#define NUMBER_OF_PROCESSORS   1
 For the MPI communication routines this quantity is often required. defining this macro makes the code a bit cleaner. Sadly it can't be defind as a constant global variable as on compile time it is not known what it should be. More...
 
#define PROCESSOR_ID   0
 
#define OMP_THREAD_NUM   0
 

Typedefs

typedef double Mdouble
 

Enumerations

enum  Direction { XAXIS = 0, YAXIS = 1, ZAXIS = 2 }
 An enum that indicates the direction in Cartesian coordinates. More...
 

Variables

const Mdouble constants::NaN = std::numeric_limits<Mdouble>::quiet_NaN()
 
const Mdouble constants::inf = std::numeric_limits<Mdouble>::infinity()
 
const int constants::intMax = std::numeric_limits<int>::max()
 
const unsigned constants::unsignedMax = std::numeric_limits<unsigned>::max()
 

Macro Definition Documentation

◆ MAX_PROC

#define MAX_PROC   1000

◆ MERCURY_DEPRECATED

#define MERCURY_DEPRECATED   [[deprecated]]

◆ NUMBER_OF_PROCESSORS

#define NUMBER_OF_PROCESSORS   1

For the MPI communication routines this quantity is often required. defining this macro makes the code a bit cleaner. Sadly it can't be defind as a constant global variable as on compile time it is not known what it should be.

◆ OMP_THREAD_NUM

#define OMP_THREAD_NUM   0

◆ PROCESSOR_ID

#define PROCESSOR_ID   0

◆ UNUSED

#define UNUSED   __attribute__ ((__unused__))

Typedef Documentation

◆ Mdouble

typedef double Mdouble

Enumeration Type Documentation

◆ Direction

enum Direction

An enum that indicates the direction in Cartesian coordinates.

This is heavily used in the parallel code to avoid confusion with numbers

Enumerator
XAXIS 
YAXIS 
ZAXIS 
77 {
78  XAXIS = 0, YAXIS = 1, ZAXIS = 2
79 };
YAXIS
@ YAXIS
Definition: GeneralDefine.h:78
XAXIS
@ XAXIS
Definition: GeneralDefine.h:78
ZAXIS
@ ZAXIS
Definition: GeneralDefine.h:78