Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_TpetraBlockedMappingStrategy.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_TpetraBlockedMappingStrategy_hpp__
48 #define __Teko_TpetraBlockedMappingStrategy_hpp__
49 
50 // stl includes
51 #include <vector>
52 
53 // Teuchos includes
54 #include "Teuchos_RCP.hpp"
55 
56 // Thyra includes
57 #include "Thyra_MultiVectorBase.hpp"
58 #include "Thyra_LinearOpBase.hpp"
59 #include "Thyra_BlockedLinearOpBase.hpp"
60 
61 // Tpetra includes
62 #include "Tpetra_Map.hpp"
63 #include "Tpetra_MultiVector.hpp"
64 #include "Tpetra_Import.hpp"
65 #include "Tpetra_Export.hpp"
66 #include "Tpetra_CrsMatrix.hpp"
67 
68 // Teko includes
69 #include "Teko_TpetraOperatorWrapper.hpp"
70 #include "Teko_BlockingTpetra.hpp"
71 #include "Teko_ConfigDefs.hpp"
72 
73 namespace Teko {
74 namespace TpetraHelpers {
75 
76 class TpetraBlockedMappingStrategy : public MappingStrategy {
77 public:
79 
80 
90  TpetraBlockedMappingStrategy(const std::vector<std::vector<GO> > & vars,
91  const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);
93 
95 
96 
104  virtual void copyTpetraIntoThyra(const Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_X,
105  const Teuchos::Ptr<Thyra::MultiVectorBase<ST> > & thyra_X) const;
106 
114  virtual void copyThyraIntoTpetra(const Teuchos::RCP<const Thyra::MultiVectorBase<ST> > & thyra_Y,
115  Tpetra::MultiVector<ST,LO,GO,NT>& tpetra_Y) const;
116 
124  virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap() const
125  { return domainMap_; }
126 
134  virtual const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap() const
135  { return rangeMap_; }
136 
141  virtual std::string toString() const
142  { return std::string("TpetraBlockedMappingStrategy"); }
143 
145 
147 
148 
163  void buildBlockTransferData(const std::vector<std::vector<GO> > & vars,
164  const Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > & baseMap, const Teuchos::Comm<int> & comm);
165 
177  const std::vector<Blocking::MapPair> & getMaps() const
178  { return blockMaps_; }
179 
191  const Teuchos::RCP<Thyra::BlockedLinearOpBase<ST> >
192  buildBlockedThyraOp(const Teuchos::RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,const std::string & label="<ANYM>") const;
193 
203  void rebuildBlockedThyraOp(const RCP<const Tpetra::CrsMatrix<ST,LO,GO,NT> > & mat,
204  const RCP<Thyra::BlockedLinearOpBase<ST> > & A) const;
205 
207 
208 protected:
209  // member variables
210 
212 
213  Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > domainMap_;
214  Teuchos::RCP<const Tpetra::Map<LO,GO,NT> > rangeMap_;
216 
218 
219  std::vector<Blocking::MapPair> blockMaps_;
220  std::vector<Teuchos::RCP<Tpetra::Import<LO,GO,NT> > > blockImport_;
221  std::vector<Teuchos::RCP<Tpetra::Export<LO,GO,NT> > > blockExport_;
223 };
224 
225 } // end namespace TpetraHelpers
226 } // end namespace Teko
227 
228 #endif
virtual void copyThyraIntoTpetra(const RCP< const Thyra::MultiVectorBase< ST > > &thyraX, Tpetra::MultiVector< ST, LO, GO, NT > &tpetraX) const =0
Copy an Thyra::MultiVectorBase into a Epetra_MultiVector.