Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_TpetraInverseFactoryOperator.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_TpetraInverseFactoryOperator_hpp__
48 #define __Teko_TpetraInverseFactoryOperator_hpp__
49 
50 #include "Teuchos_ConstNonconstObjectContainer.hpp"
51 
52 #include "Teko_ConfigDefs.hpp"
53 #include "Teko_InverseFactory.hpp"
54 #include "Teko_TpetraInverseOpWrapper.hpp"
55 
56 namespace Teko {
57 namespace TpetraHelpers {
58 
69 class InverseFactoryOperator : public TpetraInverseOpWrapper {
70 public:
77  InverseFactoryOperator(const Teuchos::RCP<const InverseFactory> & bfp);
78 
91  virtual void initInverse(bool clearOld=false);
92 
105  virtual void buildInverseOperator(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A,bool clear=true);
106 
119  virtual void buildInverseOperator(const Teuchos::RCP<Tpetra::Operator<ST,LO,GO,NT> > & A,bool clear=true);
120 
133  virtual void rebuildInverseOperator(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A);
134 
147  virtual void rebuildInverseOperator(const Teuchos::RCP<Tpetra::Operator<ST,LO,GO,NT> > & A);
148 
152  Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > getForwardOp() const { return fwdOp_.getConstObj(); }
153 
157  Teuchos::RCP<Tpetra::Operator<ST,LO,GO,NT> > getNonconstForwardOp() const { return fwdOp_.getNonconstObj(); }
158 
159 protected:
160  Teuchos::RCP<const Thyra::LinearOpBase<ST> > extractLinearOp(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A) const;
161  Teuchos::RCP<const MappingStrategy> extractMappingStrategy(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A) const;
162 
165 
166  Teuchos::RCP<const Teko::InverseFactory> inverseFactory_;
167  Teko::ModifiableLinearOp invOperator_;
168  bool firstBuildComplete_;
169 
170  Teuchos::ConstNonconstObjectContainer<Tpetra::Operator<ST,LO,GO,NT> > fwdOp_;
171  bool setConstFwdOp_;
172 };
173 
174 } // end namespace TpetraHelpers
175 } // end namespace Teko
176 
177 #endif
virtual void initInverse(bool clearOld=false)
Build the underlying data structure for the inverse operator.
virtual void buildInverseOperator(const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A, bool clear=true)
Build this inverse operator from an Epetra_Operator passed in to this object.
A single Epetra wrapper for all operators constructed from an inverse operator.
Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > getForwardOp() const
virtual void rebuildInverseOperator(const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A)
Rebuild this inverse from an Epetra_Operator passed in this to object.
Teuchos::RCP< Tpetra::Operator< ST, LO, GO, NT > > getNonconstForwardOp() const