planc::NTFMPICommunicator Class Reference

#include <distntfmpicomm.hpp>

Public Member Functions
void	printConfig ()
	NTFMPICommunicator (int argc, char *argv[], const UVEC &i_dims)
	Constructor for setting up the nD grid communicators. More...
	~NTFMPICommunicator ()
const MPI_Comm &	cart_comm () const
void	coordinates (int *o_c) const
std::vector< int >	coordinates () const
const MPI_Comm &	fiber (const int i) const
	Returns the fiber communicator. More...
const MPI_Comm &	slice (const int i) const
	Returns the slice communicator. More...
int	rank (const int *i_coords) const
	Returns the rank of current MPI process given the cartesian coordinates. More...
int	size () const
	Returns the number of MPI processors. More...
int	size (const int i_d) const
int	fiber_rank (int i) const
	Returns the fiber rank on a particular fiber grid. More...
int	slice_rank (int i) const
	Returns the slice rank on a particular slice grid. More...
UVEC	proc_grids () const
	Returns the process grid for which the communicators are setup. More...
int	rank () const
	Returns the global rank. More...
int	num_slices (int mode) const
int	slice_num (int mode) const
int	slice_size (int mode) const
bool	isparticipating (unsigned int mode)
	Return true only for those processors whose coordinates are non-zero for the mode and zero non-modes. More...

Detailed Description

Definition at line 12 of file distntfmpicomm.hpp.

Constructor & Destructor Documentation

NTFMPICommunicator()

planc::NTFMPICommunicator::NTFMPICommunicator ( int  argc, char *  argv[], const UVEC &  i_dims  )

inline

Constructor for setting up the nD grid communicators.

Definition at line 70 of file distntfmpicomm.hpp.

~NTFMPICommunicator()

planc::NTFMPICommunicator::~NTFMPICommunicator ( )

inline

Definition at line 128 of file distntfmpicomm.hpp.

Member Function Documentation

cart_comm()

const MPI_Comm& planc::NTFMPICommunicator::cart_comm ( ) const

inline

Definition at line 143 of file distntfmpicomm.hpp.

coordinates() [1/2]

void planc::NTFMPICommunicator::coordinates ( int *  o_c ) const

inline

Definition at line 144 of file distntfmpicomm.hpp.

coordinates() [2/2]

std::vector<int> planc::NTFMPICommunicator::coordinates ( ) const

inline

Definition at line 147 of file distntfmpicomm.hpp.

fiber()

const MPI_Comm& planc::NTFMPICommunicator::fiber ( const int  i ) const

inline

Returns the fiber communicator.

Definition at line 149 of file distntfmpicomm.hpp.

fiber_rank()

int planc::NTFMPICommunicator::fiber_rank ( int  i ) const

inline

Returns the fiber rank on a particular fiber grid.

Definition at line 166 of file distntfmpicomm.hpp.

isparticipating()

bool planc::NTFMPICommunicator::isparticipating ( unsigned int  mode )

inline

Return true only for those processors whose coordinates are non-zero for the mode and zero non-modes.

Definition at line 182 of file distntfmpicomm.hpp.

num_slices()

int planc::NTFMPICommunicator::num_slices ( int  mode ) const

inline

Definition at line 173 of file distntfmpicomm.hpp.

printConfig()

void planc::NTFMPICommunicator::printConfig ( )

inline

Definition at line 28 of file distntfmpicomm.hpp.

proc_grids()

UVEC planc::NTFMPICommunicator::proc_grids ( ) const

inline

Returns the process grid for which the communicators are setup.

Definition at line 170 of file distntfmpicomm.hpp.

rank() [1/2]

int planc::NTFMPICommunicator::rank ( const int *  i_coords ) const

inline

Returns the rank of current MPI process given the cartesian coordinates.

Definition at line 153 of file distntfmpicomm.hpp.

rank() [2/2]

int planc::NTFMPICommunicator::rank ( ) const

inline

Returns the global rank.

Definition at line 172 of file distntfmpicomm.hpp.

size() [1/2]

int planc::NTFMPICommunicator::size ( ) const

inline

Returns the number of MPI processors.

Definition at line 159 of file distntfmpicomm.hpp.

size() [2/2]

int planc::NTFMPICommunicator::size ( const int  i_d ) const

inline

Definition at line 160 of file distntfmpicomm.hpp.

slice()

const MPI_Comm& planc::NTFMPICommunicator::slice ( const int  i ) const

inline

Returns the slice communicator.

Definition at line 151 of file distntfmpicomm.hpp.

slice_num()

int planc::NTFMPICommunicator::slice_num ( int  mode ) const

inline

Definition at line 174 of file distntfmpicomm.hpp.

slice_rank()

int planc::NTFMPICommunicator::slice_rank ( int  i ) const

inline

Returns the slice rank on a particular slice grid.

Definition at line 168 of file distntfmpicomm.hpp.

slice_size()

int planc::NTFMPICommunicator::slice_size ( int  mode ) const

inline

Definition at line 175 of file distntfmpicomm.hpp.

---

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

• /Users/rnu/Documents/research/nmflibrary/distntf/distntfmpicomm.hpp