#include <platformEnv.h>
Public Member Functions | |
| PlatformEnv (int testing=0) | |
| virtual | ~PlatformEnv () |
Public Attributes | |
| int | nProc |
| int | rank |
| int | testing |
| int | nxRanks |
| int | nyRanks |
| int | nzRanks |
| int | xRankId |
| int | yRankId |
| int | zRankId |
| int | leftXNeighbourRank |
| int | rightXNeighbourRank |
| int | leftYNeighbourRank |
| int | rightYNeighbourRank |
| int | leftZNeighbourRank |
| int | rightZNeighbourRank |
Detailed Description
- For keeping track of parameters related to the platform that the code is running on – currently serial on a single core or multi-core using MPI. For the MPI version, processes are mapped onto a cartesian grid with the number of processes in each dimension specified by the user.
For a 2D problem, specify nzRanks = 1 For a 1D problem, specify nzRanks = 1, nyRanks = 1
The number of ranks in each dimension must be a factor of the number of cells in the dimension
Definition at line 16 of file platformEnv.h.
Constructor & Destructor Documentation
◆ PlatformEnv()
|
inline |
Constructor – Initialize global MPI communicator.
Definition at line 40 of file platformEnv.h.
◆ ~PlatformEnv()
|
inlinevirtual |
Destructor.
Definition at line 43 of file platformEnv.h.
Member Data Documentation
◆ leftXNeighbourRank
| int PlatformEnv::leftXNeighbourRank |
Global ids of this process's left and right neighbours.
Definition at line 20 of file platformEnv.h.
◆ leftYNeighbourRank
| int PlatformEnv::leftYNeighbourRank |
Global ids of this process's front and back neighbours.
Definition at line 20 of file platformEnv.h.
◆ leftZNeighbourRank
| int PlatformEnv::leftZNeighbourRank |
Global ids of this process's bottom and top neighbour.
Definition at line 20 of file platformEnv.h.
◆ nProc
| int PlatformEnv::nProc |
Number of MPI processes in total (1 for serial job)
Definition at line 20 of file platformEnv.h.
◆ nxRanks
| int PlatformEnv::nxRanks |
Number of processes in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
◆ nyRanks
| int PlatformEnv::nyRanks |
Number of processes in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
◆ nzRanks
| int PlatformEnv::nzRanks |
Number of processes in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
◆ rank
| int PlatformEnv::rank |
Global id of this MPI process (0 for serial job)
Definition at line 20 of file platformEnv.h.
◆ rightXNeighbourRank
| int PlatformEnv::rightXNeighbourRank |
Global ids of this process's left and right neighbours.
Definition at line 20 of file platformEnv.h.
◆ rightYNeighbourRank
| int PlatformEnv::rightYNeighbourRank |
Global ids of this process's front and back neighbours.
Definition at line 20 of file platformEnv.h.
◆ rightZNeighbourRank
| int PlatformEnv::rightZNeighbourRank |
Global ids of this process's bottom and top neighbour.
Definition at line 20 of file platformEnv.h.
◆ testing
| int PlatformEnv::testing |
boolean flag used to disable MPI init/finalise during unit testing
Definition at line 20 of file platformEnv.h.
◆ xRankId
| int PlatformEnv::xRankId |
Id of this MPI process in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
◆ yRankId
| int PlatformEnv::yRankId |
Id of this MPI process in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
◆ zRankId
| int PlatformEnv::zRankId |
Id of this MPI process in each dimension of the cartesian grid of processes.
Definition at line 20 of file platformEnv.h.
The documentation for this class was generated from the following file:
