Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Static Public Member Functions | Static Private Attributes
Teuchos::MPISession Class Reference

This class provides methods for initializing, finalizing, and querying the global MPI session. More...

#include <Teuchos_MPISession.hpp>

List of all members.

Static Public Member Functions

static void init (int *argc, void ***argv)
 Initializer, calls MPI_Init() if necessary.
static int getRank ()
 Returns the process rank relative to MPI_COMM_WORLD.
static int getNProc ()
 Returns the number of processors in MPI_COMM_WORLD.
static void finalize ()
 Finalizer, calls MPI_Finalize() if necessary.
static bool & showStartupMessage ()

Static Private Attributes

static int rank_ = 0
static int nProc_ = 1

Detailed Description

This class provides methods for initializing, finalizing, and querying the global MPI session.

Definition at line 48 of file Teuchos_MPISession.hpp.


Member Function Documentation

void MPISession::init ( int *  argc,
void ***  argv 
) [static]

Initializer, calls MPI_Init() if necessary.

Definition at line 37 of file Teuchos_MPISession.cpp.

static int Teuchos::MPISession::getRank ( ) [inline, static]

Returns the process rank relative to MPI_COMM_WORLD.

Definition at line 55 of file Teuchos_MPISession.hpp.

static int Teuchos::MPISession::getNProc ( ) [inline, static]

Returns the number of processors in MPI_COMM_WORLD.

Definition at line 58 of file Teuchos_MPISession.hpp.

void MPISession::finalize ( ) [static]

Finalizer, calls MPI_Finalize() if necessary.

Definition at line 89 of file Teuchos_MPISession.cpp.

static bool& Teuchos::MPISession::showStartupMessage ( ) [inline, static]

Set to true if a message should be written by each processor at startup.

Definition at line 65 of file Teuchos_MPISession.hpp.


Member Data Documentation

int MPISession::rank_ = 0 [static, private]

Definition at line 69 of file Teuchos_MPISession.hpp.

int MPISession::nProc_ = 1 [static, private]

Definition at line 70 of file Teuchos_MPISession.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines