Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_StridedTpetraOperator.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_StridedTpetraOperator_hpp__
48 #define __Teko_StridedTpetraOperator_hpp__
49 
50 // Tpetra includes
51 #include "Tpetra_Operator.hpp"
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_TpetraOperatorWrapper.hpp"
61 #include "Teko_TpetraStridedMappingStrategy.hpp"
62 #include "Teko_ConfigDefs.hpp"
63 
64 namespace Teko {
65 namespace TpetraHelpers {
66 
67 class StridedTpetraOperator : public TpetraOperatorWrapper {
68 public:
69  enum eNormType { Inf, One, Frobenius};
70 
71  StridedTpetraOperator(int numVars,const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & content,
72  const std::string & label="<ANYM>");
73  StridedTpetraOperator(const std::vector<int> & vars,const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & content,
74  const std::string & label="<ANYM>");
75 
76  virtual void SetContent(const std::vector<int> & vars,const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & content);
77 
78  virtual void RebuildOps()
79  { BuildBlockedOperator(); }
80 
81  virtual const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > GetContent() const
82  { return fullContent_; }
83 
84  // virtual const Teuchos::RCP<Tpetra::Operator<ST,LO,GO,NT> > GetContent()
85  // { return fullContent_; }
86 
87  const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > GetBlock(int i,int j) const;
88 
92  void Reorder(const BlockReorderManager & brm);
93 
95  void RemoveReording();
96 
99  virtual void WriteBlocks(const std::string & prefix) const;
100 
108  virtual std::string PrintNorm(const eNormType & nrmType=Frobenius,const char newline='\n');
109 
110  // functions overloading Tpetra::Operator<ST,LO,GO,NT>
112 
113  // destructor
114  virtual ~StridedTpetraOperator() {}
115 
116  // attribute set methods
117 
118  // don't use transpose...ever!
119  virtual int SetUseTranspose(bool /* useTranspose */)
120  { return -1; }
121 
122  virtual int applyInverse(const Tpetra::MultiVector<ST,LO,GO,NT> &/* X */, Tpetra::MultiVector<ST,LO,GO,NT> &/* Y */) const
123  { TEUCHOS_ASSERT(false); return -1; }
124 
125  virtual ST NormInf() const
126  { TEUCHOS_ASSERT(false); return 0.0; }
127 
128  // attribute access functions
129  virtual bool UseTranspose() const { return false; }
130  virtual bool HasNormInf() const { return false; }
131  virtual const Teuchos::Comm<int> & Comm() const { return *fullContent_->getRangeMap()->getComm(); }
132 
133 
134  #ifndef Teko_DEBUG_OFF
135  bool testAgainstFullOperator(int count,ST tol) const;
137  #endif
138 
139 protected:
140  // gooey center of this shell
141  Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > fullContent_;
142  Teuchos::RCP<TpetraStridedMappingStrategy> stridedMapping_;
143  Teuchos::RCP<Thyra::LinearOpBase<ST> > stridedOperator_;
144  Teuchos::RCP<const BlockReorderManager> reorderManager_;
145 
146  std::string label_;
147 
148  void BuildBlockedOperator();
149 };
150 
151 } // end namespace TpetraHelpers
152 } // end namespace Teko
153 
154 #endif