Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_BlockedEpetraOperator.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_BlockedEpetraOperator_hpp__
48 #define __Teko_BlockedEpetraOperator_hpp__
49 
50 // Epetra includes
51 #include "Epetra_Operator.h"
52 
53 // Teuchos includes
54 #include "Teuchos_RCP.hpp"
55 
56 #include "Thyra_LinearOpBase.hpp"
57 
58 // Teko includes
59 #include "Teko_BlockedReordering.hpp"
60 #include "Teko_EpetraOperatorWrapper.hpp"
61 #include "Teko_BlockedMappingStrategy.hpp"
62 
63 namespace Teko {
64 namespace Epetra {
65 
70 public:
71 
80  BlockedEpetraOperator(const std::vector<std::vector<int> > & vars,
81  const Teuchos::RCP<const Epetra_Operator> & content,
82  const std::string & label="<ANYM>");
83 
92  virtual void SetContent(const std::vector<std::vector<int> > & vars,
93  const Teuchos::RCP<const Epetra_Operator> & content);
94 
98  virtual void RebuildOps()
99  { BuildBlockedOperator(); }
100 
101  virtual const Teuchos::RCP<const Epetra_Operator> GetContent() const
102  { return fullContent_; }
103 
104  virtual const Teuchos::RCP<const Epetra_Operator> GetContent()
105  { return fullContent_; }
106 
107  const Teuchos::RCP<const Epetra_Operator> GetBlock(int i,int j) const;
108 
112  void Reorder(const BlockReorderManager & brm);
113 
115  void RemoveReording();
116 
119  virtual void WriteBlocks(const std::string & prefix) const;
120 
121  // functions overloading Epetra_Operator
123 
124  // destructor
125  virtual ~BlockedEpetraOperator() {}
126 
127  // attribute set methods
128 
129  // don't use transpose...ever!
130  virtual int SetUseTranspose(bool /* useTranspose */)
131  { return -1; }
132 
133  virtual int ApplyInverse(const Epetra_MultiVector &/* X */, Epetra_MultiVector &/* Y */) const
134  { TEUCHOS_ASSERT(false); return -1; }
135 
136  virtual double NormInf() const
137  { TEUCHOS_ASSERT(false); return 0.0; }
138 
139  // attribute access functions
140  virtual bool UseTranspose() const { return false; }
141  virtual bool HasNormInf() const { return false; }
142  virtual const Epetra_Comm & Comm() const { return fullContent_->Comm(); }
143 
145  bool testAgainstFullOperator(int count,double tol) const;
146 
147 protected:
148  // gooey center of this shell
149  Teuchos::RCP<const Epetra_Operator> fullContent_;
150  Teuchos::RCP<BlockedMappingStrategy> blockedMapping_;
151  Teuchos::RCP<Thyra::LinearOpBase<double> > blockedOperator_;
152  Teuchos::RCP<const BlockReorderManager> reorderManager_;
153 
154  std::string label_;
155 
156  void BuildBlockedOperator();
157 };
158 
159 } // end namespace Epetra
160 } // end namespace Teko
161 
162 #endif
bool testAgainstFullOperator(int count, double tol) const
Helps perform sanity checks.
void Reorder(const BlockReorderManager &brm)
Implements the Epetra_Operator interface with a Thyra LinearOperator. This enables the use of absrtac...
virtual void SetContent(const std::vector< std::vector< int > > &vars, const Teuchos::RCP< const Epetra_Operator > &content)
void RemoveReording()
Remove any reordering on this object.
Tear about a user specified Epetra_Operator (CrsMatrix) using a vector of vectors of GIDs for each bl...
BlockedEpetraOperator(const std::vector< std::vector< int > > &vars, const Teuchos::RCP< const Epetra_Operator > &content, const std::string &label="<ANYM>")
virtual void WriteBlocks(const std::string &prefix) const