en/latest/parallelEnv_8h_source.html

 #ifndef PARALLEL_ENV_H
 #define PARALLEL_ENV_H

 #include <mpi.h>
 #include "platformEnv.h"


 class ParallelEnv : public PlatformEnv
 {
     public:
         MPI_Comm mpiCartesianComm;
     MPI_Info mpiInfo;

         ParallelEnv(int *argcP, char **argvP[], int nxRanks, int nyRanks, int nzRanks, int testing=0);

         virtual ~ParallelEnv();


     int isNeighbourExternal(int dimension, int direction);


         void setParallelDecomposition(int xPeriodic, int yPeriodic, int zPeriodic);
 };

 #endif
ParallelEnv::isNeighbourExternal
int isNeighbourExternal(int dimension, int direction)
Check for external boundary.

PlatformEnv::nxRanks
int nxRanks
Number of processes in each dimension of the cartesian grid of processes.
Definition: platformEnv.h:20

PlatformEnv
 PlatformEnv
Definition: platformEnv.h:16

ParallelEnv::mpiCartesianComm
MPI_Comm mpiCartesianComm
Cartesian MPI communicator that maps processes to the simulation grid.
Definition: parallelEnv.h:22

platformEnv.h

PlatformEnv::testing
int testing
boolean flag used to disable MPI init/finalise during unit testing
Definition: platformEnv.h:20

ParallelEnv::mpiInfo
MPI_Info mpiInfo
MPI information channel.
Definition: parallelEnv.h:23

ParallelEnv::setParallelDecomposition
void setParallelDecomposition(int xPeriodic, int yPeriodic, int zPeriodic)
Create cartesian grid of processes and calculate neighbours along that grid for each process...

PlatformEnv::nyRanks
int nyRanks
Number of processes in each dimension of the cartesian grid of processes.
Definition: platformEnv.h:20

ParallelEnv::~ParallelEnv
virtual ~ParallelEnv()
Destructor.

PlatformEnv::nzRanks
int nzRanks
Number of processes in each dimension of the cartesian grid of processes.
Definition: platformEnv.h:20

ParallelEnv::ParallelEnv
ParallelEnv(int *argcP, char **argvP[], int nxRanks, int nyRanks, int nzRanks, int testing=0)
Constructor – Initialize global MPI communicator.

ParallelEnv
 ParallelEnv
Definition: parallelEnv.h:19