EpetraExt::MultiMpiComm Class Reference

#include <EpetraExt_MultiMpiComm.h>

Inheritance diagram for EpetraExt::MultiMpiComm:

[legend]
List of all members.

Constructors/Destructor.

 MultiMpiComm (MPI_Comm globalComm, int subDomainProcs, int numTimeSteps_=-1)
 MultiMpiComm constuctor.
 MultiMpiComm (const MultiMpiComm &MMC)
 Copy constructor.
virtual ~MultiMpiComm ()
 Destructor.

Public Member Functions

Epetra_MpiCommSubDomainComm () const
 Get reference to split Communicator for sub-domain.
int NumSubDomains () const
 Return number of sub-domains that the global problem is split into.
int SubDomainRank () const
 Return integer [0:numSubDomains-1} corresponding to this sub-domain's rank.
int NumTimeStepsOnDomain () const
 Return number of time steps, first step number, on time domain.
int FirstTimeStepOnDomain () const
int NumTimeSteps () const
 Return total number of time steps.

Protected Attributes

Epetra_MpiCommsubComm
int numSubDomains
int subDomainRank
const int numTimeSteps
int numTimeStepsOnDomain
int firstTimeStepOnDomain

Constructor & Destructor Documentation

EpetraExt::MultiMpiComm::MultiMpiComm MPI_Comm  globalComm,
int  subDomainProcs,
int  numTimeSteps_ = -1
 

MultiMpiComm constuctor.

Creates a MultiMpiComm object and communicators for the global and sub- problems.

Parameters:
In globalComm - MPI communciator (usually MPI_COMM_WORLD)
In subDomainProcss - number of processors in each subdomain. This must divide evenly into the total number of processors of the globalComm.
In numTimeSteps (Default=-1) - Piece of partitioning data needed specifically for parallel space-time project, corresponding to the total number of time steps.

Definition at line 35 of file EpetraExt_MultiMpiComm.cpp.

EpetraExt::MultiMpiComm::MultiMpiComm const MultiMpiComm MMC  ) 
 

Copy constructor.

Definition at line 80 of file EpetraExt_MultiMpiComm.cpp.

EpetraExt::MultiMpiComm::~MultiMpiComm  )  [virtual]
 

Destructor.

Definition at line 89 of file EpetraExt_MultiMpiComm.cpp.


Member Function Documentation

Epetra_MpiComm& EpetraExt::MultiMpiComm::SubDomainComm  )  const [inline]
 

Get reference to split Communicator for sub-domain.

Definition at line 77 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::NumSubDomains  )  const [inline]
 

Return number of sub-domains that the global problem is split into.

Definition at line 80 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::SubDomainRank  )  const [inline]
 

Return integer [0:numSubDomains-1} corresponding to this sub-domain's rank.

Definition at line 83 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::NumTimeStepsOnDomain  )  const [inline]
 

Return number of time steps, first step number, on time domain.

Definition at line 86 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::FirstTimeStepOnDomain  )  const [inline]
 

Definition at line 87 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::NumTimeSteps  )  const [inline]
 

Return total number of time steps.

Definition at line 90 of file EpetraExt_MultiMpiComm.h.


Member Data Documentation

Epetra_MpiComm* EpetraExt::MultiMpiComm::subComm [protected]
 

Definition at line 94 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::numSubDomains [protected]
 

Definition at line 95 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::subDomainRank [protected]
 

Definition at line 96 of file EpetraExt_MultiMpiComm.h.

const int EpetraExt::MultiMpiComm::numTimeSteps [protected]
 

Definition at line 97 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::numTimeStepsOnDomain [protected]
 

Definition at line 98 of file EpetraExt_MultiMpiComm.h.

int EpetraExt::MultiMpiComm::firstTimeStepOnDomain [protected]
 

Definition at line 99 of file EpetraExt_MultiMpiComm.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:31:47 2008 for EpetraExt by doxygen 1.3.9.1