MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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

#define MERCURY_DEPRECATED   [[deprecated]]

Definition at line 37 of file GeneralDefine.h.

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

Definition at line 62 of file GeneralDefine.h.

Referenced by PeriodicBoundaryHandler::addNewParticle(), PeriodicBoundaryHandler::addNewParticles(), PeriodicBoundaryHandler::addObject(), ParticleHandler::addObject(), DeletionBoundary::checkBoundaryAfterParticleMoved(), SubcriticalMaserBoundaryTEST::checkBoundaryAfterParticlesMove(), PeriodicBoundary::checkBoundaryAfterParticlesMove(), RandomClusterInsertionBoundary::checkBoundaryBeforeTimeStep(), InsertionBoundary::checkBoundaryBeforeTimeStep(), DPMBase::checkInteractionWithBoundaries(), DPMBase::checkParticleForInteraction(), PeriodicBoundaryHandler::cleanCommunicationLists(), PeriodicBoundaryHandler::clearCommunicationLists(), PeriodicBoundaryHandler::communicateTargetDomains(), SubcriticalMaserBoundaryTEST::copyExtraParticles(), PeriodicBoundary::createPeriodicParticles(), DPMBase::decompose(), SubcriticalMaserBoundaryTEST::extendBottom(), PeriodicBoundaryHandler::flushParticles(), PeriodicBoundaryHandler::initialise(), BaseVTKWriter< H >::makeVTKFileWithHeader(), DPMBase::mpiIsInCommunicationZone(), DPMBase::performGhostParticleUpdate(), DPMBase::performGhostVelocityUpdate(), DPMBase::read(), DPMBase::readNextDataFile(), DPMBase::readRestartFile(), DPMBase::removeDuplicatePeriodicParticles(), DPMBase::removeOldFiles(), DPMBase::setName(), DPMBase::solve(), DPMBase::splitDomain(), DPMBase::updateGhostGrid(), PeriodicBoundaryHandler::updateParticles(), DPMBase::write(), and DPMBase::writePythonFileForVTKVisualisation().

#define OMP_THREAD_NUM   0

Definition at line 69 of file GeneralDefine.h.

Referenced by BaseInteractable::addForce(), and BaseInteractable::addTorque().

Typedef Documentation

typedef double Mdouble

Definition at line 34 of file GeneralDefine.h.

Enumeration Type Documentation

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 

Definition at line 76 of file GeneralDefine.h.

77 {
78  XAXIS = 0, YAXIS = 1, ZAXIS = 2
79 };