planc
Parallel Lowrank Approximation with Non-negativity Constraints
Public Member Functions | List of all members
planc::MPICommunicator Class Reference

#include <mpicomm.hpp>

Public Member Functions

 MPICommunicator (int argc, char *argv[])
 
 ~MPICommunicator ()
 
 MPICommunicator (int argc, char *argv[], int pr, int pc)
 
const int rank () const
 returns the global rank More...
 
const int size () const
 returns the total number of mpi processes More...
 
const int row_rank () const
 returns its rank in the row processor grid More...
 
const int col_rank () const
 returns the rank in the column processor grid More...
 
const int pr () const
 Total number of row processors. More...
 
const int pc () const
 Total number of column processor. More...
 
const MPI_Comm * commSubs () const
 

Detailed Description

Definition at line 21 of file mpicomm.hpp.

Constructor & Destructor Documentation

◆ MPICommunicator() [1/2]

planc::MPICommunicator::MPICommunicator ( int  argc,
char *  argv[] 
)
inline

Definition at line 49 of file mpicomm.hpp.

◆ ~MPICommunicator()

planc::MPICommunicator::~MPICommunicator ( )
inline

Definition at line 58 of file mpicomm.hpp.

◆ MPICommunicator() [2/2]

planc::MPICommunicator::MPICommunicator ( int  argc,
char *  argv[],
int  pr,
int  pc 
)
inline

Definition at line 66 of file mpicomm.hpp.

Member Function Documentation

◆ col_rank()

const int planc::MPICommunicator::col_rank ( ) const
inline

returns the rank in the column processor grid

Definition at line 124 of file mpicomm.hpp.

◆ commSubs()

const MPI_Comm* planc::MPICommunicator::commSubs ( ) const
inline

Definition at line 129 of file mpicomm.hpp.

◆ pc()

const int planc::MPICommunicator::pc ( ) const
inline

Total number of column processor.

Definition at line 128 of file mpicomm.hpp.

◆ pr()

const int planc::MPICommunicator::pr ( ) const
inline

Total number of row processors.

Definition at line 126 of file mpicomm.hpp.

◆ rank()

const int planc::MPICommunicator::rank ( ) const
inline

returns the global rank

Definition at line 118 of file mpicomm.hpp.

◆ row_rank()

const int planc::MPICommunicator::row_rank ( ) const
inline

returns its rank in the row processor grid

Definition at line 122 of file mpicomm.hpp.

◆ size()

const int planc::MPICommunicator::size ( ) const
inline

returns the total number of mpi processes

Definition at line 120 of file mpicomm.hpp.


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