EpetraExt  Development
Public Member Functions | List of all members
EpetraExt::MultiComm Class Referenceabstract

#include <EpetraExt_MultiComm.h>

Inheritance diagram for EpetraExt::MultiComm:
Inheritance graph
[legend]

Public Member Functions

 MultiComm ()
 Constructor. More...
 
virtual ~MultiComm ()
 Destructor. More...
 
virtual Epetra_Comm & SubDomainComm () const =0
 Get reference to split Communicator for sub-domain. More...
 
virtual Epetra_Comm & TimeDomainComm () const =0
 Get reference to split Communicator for time domain. More...
 
virtual int NumSubDomains () const =0
 Return number of sub-domains that the global problem is split into. More...
 
virtual int SubDomainRank () const =0
 Return integer [0:numSubDomains-1} corresponding to this sub-domain's rank. More...
 
virtual int NumTimeDomains () const =0
 Return number of time domains that the global problem is split into. More...
 
virtual int TimeDomainRank () const =0
 Return integer [0:numTimeDomains-1} corresponding to this time-domain's rank. More...
 
virtual int NumTimeStepsOnDomain () const =0
 Return number of time steps, first step number, on time domain. More...
 
virtual int FirstTimeStepOnDomain () const =0
 
virtual int NumTimeSteps () const =0
 Return total number of time steps. More...
 
virtual void ResetNumTimeSteps (int numTimeSteps)=0
 Reset total number of time steps, allowing time steps per domain to. More...
 

Detailed Description

Definition at line 64 of file EpetraExt_MultiComm.h.

Constructor & Destructor Documentation

◆ MultiComm()

EpetraExt::MultiComm::MultiComm ( )
inline

Constructor.

Definition at line 68 of file EpetraExt_MultiComm.h.

◆ ~MultiComm()

virtual EpetraExt::MultiComm::~MultiComm ( )
inlinevirtual

Destructor.

Definition at line 71 of file EpetraExt_MultiComm.h.

Member Function Documentation

◆ SubDomainComm()

virtual Epetra_Comm& EpetraExt::MultiComm::SubDomainComm ( ) const
pure virtual

Get reference to split Communicator for sub-domain.

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ TimeDomainComm()

virtual Epetra_Comm& EpetraExt::MultiComm::TimeDomainComm ( ) const
pure virtual

Get reference to split Communicator for time domain.

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ NumSubDomains()

virtual int EpetraExt::MultiComm::NumSubDomains ( ) const
pure virtual

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

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ SubDomainRank()

virtual int EpetraExt::MultiComm::SubDomainRank ( ) const
pure virtual

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

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ NumTimeDomains()

virtual int EpetraExt::MultiComm::NumTimeDomains ( ) const
pure virtual

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

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ TimeDomainRank()

virtual int EpetraExt::MultiComm::TimeDomainRank ( ) const
pure virtual

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

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ NumTimeStepsOnDomain()

virtual int EpetraExt::MultiComm::NumTimeStepsOnDomain ( ) const
pure virtual

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

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ FirstTimeStepOnDomain()

virtual int EpetraExt::MultiComm::FirstTimeStepOnDomain ( ) const
pure virtual

◆ NumTimeSteps()

virtual int EpetraExt::MultiComm::NumTimeSteps ( ) const
pure virtual

Return total number of time steps.

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.

◆ ResetNumTimeSteps()

virtual void EpetraExt::MultiComm::ResetNumTimeSteps ( int  numTimeSteps)
pure virtual

Reset total number of time steps, allowing time steps per domain to.

Implemented in EpetraExt::MultiMpiComm, and EpetraExt::MultiSerialComm.


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