SerialEnv Class Reference
#include <serialEnv.h>
Inheritance diagram for SerialEnv:
Collaboration diagram for SerialEnv:
Public Member Functions | |
| SerialEnv (int *argcP, char **argvP[], int nxRanks, int nyRanks, int nzRanks, int testing=0) | |
| virtual | ~SerialEnv () |
 Public Member Functions inherited from PlatformEnv | |
| PlatformEnv (int testing=0) | |
| virtual | ~PlatformEnv () |
Additional Inherited Members | |
| Public Attributes inherited from PlatformEnv | |
| 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 18 of file serialEnv.h.
Constructor & Destructor Documentation
◆ SerialEnv()
| SerialEnv::SerialEnv | ( | int * | argcP, |
| char ** | argvP[], | ||
| int | nxRanks, | ||
| int | nyRanks, | ||
| int | nzRanks, | ||
| int | testing = 0 |
||
| ) |
Constructor – record that we are running on only a single process.
◆ ~SerialEnv()
|
virtual |
Destructor.
The documentation for this class was generated from the following file:
