EpetraExt  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_MultiComm.h
Go to the documentation of this file.
1 //@HEADER
2 // ***********************************************************************
3 //
4 // EpetraExt: Epetra Extended - Linear Algebra Services Package
5 // Copyright (2011) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 
42 #ifndef EPETRAEXT_MULTICOMM_H
43 #define EPETRAEXT_MULTICOMM_H
44 
45 #include "EpetraExt_ConfigDefs.h"
46 #include "Epetra_Comm.h"
47 
52 
62 namespace EpetraExt {
63 
64 class MultiComm: public virtual Epetra_Comm {
65  public:
66 
68  MultiComm() {}
69 
71  virtual ~MultiComm() {};
72 
74  virtual Epetra_Comm& SubDomainComm() const = 0;
75 
77  virtual Epetra_Comm& TimeDomainComm() const = 0;
78 
80  virtual int NumSubDomains() const = 0;
81 
83  virtual int SubDomainRank() const = 0;
84 
86  virtual int NumTimeDomains() const = 0;
87 
89  virtual int TimeDomainRank() const = 0;
90 
92  virtual int NumTimeStepsOnDomain() const = 0;
93  virtual int FirstTimeStepOnDomain() const = 0;
94 
96  virtual int NumTimeSteps() const = 0;
97 
99  // be set later than the MultiLevel parallelism is set up.
100  virtual void ResetNumTimeSteps(int numTimeSteps) = 0;
101 
102 };
103 
104 } //namespace EpetraExt
105 
106 #endif /* EPETRAEXT_MULTICOMM_H */
107 
108 
109 
virtual ~MultiComm()
Destructor.
virtual Epetra_Comm & TimeDomainComm() const =0
Get reference to split Communicator for time domain.
virtual int TimeDomainRank() const =0
Return integer [0:numTimeDomains-1} corresponding to this time-domain's rank.
virtual void ResetNumTimeSteps(int numTimeSteps)=0
Reset total number of time steps, allowing time steps per domain to.
virtual int NumTimeDomains() const =0
Return number of time domains that the global problem is split into.
virtual Epetra_Comm & SubDomainComm() const =0
Get reference to split Communicator for sub-domain.
virtual int NumSubDomains() const =0
Return number of sub-domains that the global problem is split into.
virtual int FirstTimeStepOnDomain() const =0
virtual int NumTimeStepsOnDomain() const =0
Return number of time steps, first step number, on time domain.
virtual int NumTimeSteps() const =0
Return total number of time steps.
virtual int SubDomainRank() const =0
Return integer [0:numSubDomains-1} corresponding to this sub-domain's rank.