Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_EpetraHelpers.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_EpetraHelpers_hpp__
48 #define __Teko_EpetraHelpers_hpp__
49 
50 // stl includes
51 #include <string>
52 
53 // Epetra includes
54 #include "Epetra_Operator.h"
55 #include "Epetra_CrsMatrix.h"
56 #include "Epetra_MultiVector.h"
57 
58 // Teuchos includes
59 #include "Teuchos_RCP.hpp"
60 
61 // Thyra includes
62 #include "Thyra_VectorBase.hpp"
63 #include "Thyra_DefaultSpmdMultiVector.hpp"
64 
65 namespace Teko {
66 
67 namespace Epetra {
68 
78 void fillDefaultSpmdMultiVector(Teuchos::RCP<Thyra::DefaultSpmdMultiVector<double> >& spmdMV,
79  Teuchos::RCP<Epetra_MultiVector>& epetraMV);
80 
91 const Teuchos::RCP<const Thyra::LinearOpBase<double> > thyraDiagOp(
92  const Teuchos::RCP<const Epetra_Vector>& ev, const Epetra_Map& map,
93  const std::string& lbl = "ANYM");
94 
105 const Teuchos::RCP<Thyra::LinearOpBase<double> > thyraDiagOp(const Teuchos::RCP<Epetra_Vector>& ev,
106  const Epetra_Map& map,
107  const std::string& lbl = "ANYM");
108 
118 void identityRowIndices(const Epetra_Map& rowMap, const Epetra_CrsMatrix& mat,
119  std::vector<int>& outIndices);
120 
131 void zeroMultiVectorRowIndices(Epetra_MultiVector& mv, const std::vector<int>& zeroIndices);
132 
136 class ZeroedOperator : public Epetra_Operator {
137  public:
147  ZeroedOperator(const std::vector<int>& zeroIndices,
148  const Teuchos::RCP<const Epetra_Operator>& op);
149 
151 
152 
154  virtual ~ZeroedOperator() {}
155 
157  int SetUseTranspose(bool /* useTranspose */) { return -1; }
158 
160  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
161 
163  int ApplyInverse(const Epetra_MultiVector& /* X */, Epetra_MultiVector& /* Y */) const {
164  return -1;
165  }
166 
168  double NormInf() const { return -1.0; }
169 
171  const char* Label() const { return label_.c_str(); }
172 
174  bool UseTranspose() const { return false; }
175 
177  bool HasNormInf() const { return false; }
178 
180  const Epetra_Comm& Comm() const { return epetraOp_->Comm(); }
181 
183  const Epetra_Map& OperatorDomainMap() const { return epetraOp_->OperatorDomainMap(); }
184 
186  const Epetra_Map& OperatorRangeMap() const { return epetraOp_->OperatorRangeMap(); }
187 
189 
190  protected:
191  std::vector<int> zeroIndices_;
192  const Teuchos::RCP<const Epetra_Operator> epetraOp_;
193  std::string label_;
194 };
195 
196 } // end namespace Epetra
197 } // end namespace Teko
198 
199 #endif
int SetUseTranspose(bool)
Can&#39;t transpose a ZeroedOperator.
int ApplyInverse(const Epetra_MultiVector &, Epetra_MultiVector &) const
Can&#39;t call ApplyInverse on a zeroed operator.
ZeroedOperator(const std::vector< int > &zeroIndices, const Teuchos::RCP< const Epetra_Operator > &op)
Constructor for a ZeroedOperator.
int Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Perform a matrix-vector product with certain rows zeroed out.
virtual ~ZeroedOperator()
Do nothing destructor.