Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_InterlacedEpetra.hpp
1 /*
2 // @HEADER
3 //
4 // ***********************************************************************
5 //
6 // Teko: A package for block and physics based preconditioning
7 // Copyright 2010 Sandia Corporation
8 //
9 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40 //
41 // ***********************************************************************
42 //
43 // @HEADER
44 
45 */
46 
47 #ifndef __Teko_InterlacedEpetra_hpp__
48 #define __Teko_InterlacedEpetra_hpp__
49 
50 // Teuchos includes
51 #include "Teuchos_RCP.hpp"
52 
53 // include basic Epetra information
54 #ifdef HAVE_MPI
55 #include "Epetra_MpiComm.h"
56 #else
57 #include "Epetra_SerialComm.h"
58 #endif
59 #include "Epetra_Map.h"
60 #include "Epetra_CrsMatrix.h"
61 #include "Epetra_MultiVector.h"
62 #include "Epetra_Vector.h"
63 #include "Epetra_Export.h"
64 #include "Epetra_Import.h"
65 
66 #include <vector>
67 
68 namespace Teko {
69 namespace Epetra {
70 namespace Strided {
71 
91 void buildSubMaps(int numGlobals, int numVars, const Epetra_Comm& comm,
92  std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps);
93 
113 void buildSubMaps(int numGlobals, const std::vector<int>& vars, const Epetra_Comm& comm,
114  std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps);
115 
137 void buildSubMaps(int numGlobals, int numMyElements, int minMyGID, const std::vector<int>& vars,
138  const Epetra_Comm& comm,
139  std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps);
140 
161 void buildSubMaps(const Epetra_Map& globalMap, const std::vector<int>& vars,
162  const Epetra_Comm& comm,
163  std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps);
164 
165 // build conversion import and export operators
166 void buildExportImport(const Epetra_Map& baseMap,
167  const std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps,
168  std::vector<Teuchos::RCP<Epetra_Export> >& subExport,
169  std::vector<Teuchos::RCP<Epetra_Import> >& subImport);
170 
171 // build a vector of subVectors
172 void buildSubVectors(const std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps,
173  std::vector<Teuchos::RCP<Epetra_MultiVector> >& subVectors, int count);
174 
178 void associateSubVectors(const std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps,
179  std::vector<Teuchos::RCP<const Epetra_MultiVector> >& subVectors);
180 
181 // build a single subblock Epetra_CrsMatrix
182 Teuchos::RCP<Epetra_CrsMatrix> buildSubBlock(
183  int i, int j, const Epetra_CrsMatrix& A,
184  const std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps);
185 
186 // Rebuild a single subblock of a matrix
187 void rebuildSubBlock(int i, int j, const Epetra_CrsMatrix& A,
188  const std::vector<std::pair<int, Teuchos::RCP<Epetra_Map> > >& subMaps,
189  Epetra_CrsMatrix& mat);
190 
191 // copy contents of many subvectors to a single vector
192 void many2one(Epetra_MultiVector& one,
193  const std::vector<Teuchos::RCP<const Epetra_MultiVector> >& many,
194  const std::vector<Teuchos::RCP<Epetra_Export> >& subExport);
195 
196 // copy contents of a single vector to many subvectors
197 void one2many(std::vector<Teuchos::RCP<Epetra_MultiVector> >& many,
198  const Epetra_MultiVector& single,
199  const std::vector<Teuchos::RCP<Epetra_Import> >& subImport);
200 
201 } // namespace Strided
202 } // end namespace Epetra
203 } // end namespace Teko
204 
205 #endif