IssmComm Class Reference

#include <IssmComm.h>

Static Public Member Functions
static void	SetComm (ISSM_MPI_Comm incomm)
static void	SetComm (void)
static ISSM_MPI_Comm	GetComm (void)
static int	GetRank (void)
static int	GetSize (void)

Static Private Attributes
static ISSM_MPI_Comm	comm
static bool	parallel

Detailed Description

Definition at line 20 of file IssmComm.h.

Member Function Documentation

SetComm() [1/2]

void IssmComm::SetComm ( ISSM_MPI_Comm  incomm )

static

Definition at line 15 of file IssmComm.cpp.

                                          { /*{{{*/
 
   /*A comm is provided, we are running in parallel (this is not a module)*/
   parallel = true;
   comm     = incomm;
 
}/*}}}*/

SetComm() [2/2]

void IssmComm::SetComm ( void  )

static

Definition at line 22 of file IssmComm.cpp.

                          { /*{{{*/
 
   /*no comm provided, This is a matlab/python module*/
   parallel = false;
 
   /*No need to initialise comm*/
 
}/*}}}*/

GetComm()

ISSM_MPI_Comm IssmComm::GetComm ( void  )

static

Definition at line 30 of file IssmComm.cpp.

                               {  /*{{{*/
   if(!parallel) _error_("Cannot return comm in serial mode");
   return comm;
}/*}}}*/

GetRank()

int IssmComm::GetRank ( void  )

static

Definition at line 34 of file IssmComm.cpp.

                     {  /*{{{*/
 
   int my_rank = 0;
 
   /*for matlab and python modules*/
   if(!parallel) return my_rank;
 
   ISSM_MPI_Comm_rank(comm,&my_rank);
 
   return my_rank;
 
}/*}}}*/

GetSize()

int IssmComm::GetSize ( void  )

static

Definition at line 46 of file IssmComm.cpp.

                     {  /*{{{*/
 
   int size = 1;
 
   /*for matlab and python modules*/
   if(!parallel) return size;
 
   ISSM_MPI_Comm_size(comm,&size);
 
   return size;
 
}/*}}}*/

Field Documentation

comm

ISSM_MPI_Comm IssmComm::comm

staticprivate

Definition at line 23 of file IssmComm.h.

parallel

bool IssmComm::parallel

staticprivate

Definition at line 24 of file IssmComm.h.

---

The documentation for this class was generated from the following files:

• src/c/shared/io/Comm/IssmComm.h
• src/c/main/globals.h
• src/c/shared/io/Comm/IssmComm.cpp