EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_RestrictedMultiVectorWrapper.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_RESTRICTEDMULTIVECTORWRAPPER_H
43 #define EPETRAEXT_RESTRICTEDMULTIVECTORWRAPPER_H
44 
45 #if defined(EpetraExt_SHOW_DEPRECATED_WARNINGS)
46 #ifdef __GNUC__
47 #warning "The EpetraExt package is deprecated"
48 #endif
49 #endif
50 #include <EpetraExt_ConfigDefs.h>
51 #include <Teuchos_RCP.hpp>
52 #include <mpi.h>
53 
54 #ifdef HAVE_MPI
55 class Epetra_Comm;
56 class Epetra_MpiComm;
57 class Epetra_BlockMap;
58 class Epetra_MultiVector;
59 
60 namespace EpetraExt {
61 class RestrictedMultiVectorWrapper{
62 
63 public:
64  RestrictedMultiVectorWrapper();
65 
66  ~RestrictedMultiVectorWrapper();
67 
79  int SetMPISubComm(MPI_Comm MPI_SubComm);
80 
82  MPI_Comm GetMPISubComm(){return MPI_SubComm_;}
83 
85  const Epetra_MpiComm & RestrictedComm(){return *RestrictedComm_;}
86 
88  bool RestrictedProcIsActive(){return proc_is_active;}
89 
91  Teuchos::RCP<Epetra_MultiVector> InputMultiVector(){return input_mv_;}
92 
94  Teuchos::RCP<Epetra_MultiVector> RestrictedMultiVector(){return restricted_mv_;}
95 
111  int restrict_comm(Teuchos::RCP<Epetra_MultiVector> input_mv);
112 
113 private:
115  bool proc_is_active;
117  bool subcomm_is_set;
118 
119  MPI_Comm MPI_SubComm_;
120  Epetra_MpiComm *RestrictedComm_;
121  Epetra_BlockMap *ResMap_;
122 
124  Teuchos::RCP<Epetra_MultiVector> restricted_mv_;
125 };
126 
127 
128 } // namespace EpetraExt
129 
130 
131 #endif
132 #endif /* EPETRAEXT_RESTRICTEDMULTIVECTORWRAPPER_H */