Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_TpetraBlockPreconditioner.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_TpetraBlockPreconditioner_hpp__
48 #define __Teko_TpetraBlockPreconditioner_hpp__
49 
50 // #include "Teko_BlockPreconditionerFactory.hpp"
51 #include "Teko_PreconditionerFactory.hpp"
52 #include "Teko_TpetraInverseOpWrapper.hpp"
53 #include "Teko_ConfigDefs.hpp"
54 
55 namespace Teko {
56 namespace TpetraHelpers {
57 
67 class TpetraBlockPreconditioner : public TpetraInverseOpWrapper {
68  public:
75  TpetraBlockPreconditioner(const Teuchos::RCP<const PreconditionerFactory> &bfp);
76 
91  virtual void initPreconditioner(bool clearOld = false);
92 
105  virtual void buildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A,
106  bool clear = true);
107 
121  virtual void buildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A,
122  const Tpetra::MultiVector<ST, LO, GO, NT> &mv,
123  bool clear = true);
124 
137  virtual void rebuildPreconditioner(
138  const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A);
139 
153  virtual void rebuildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A,
154  const Tpetra::MultiVector<ST, LO, GO, NT> &mv);
155 
165  virtual Teuchos::RCP<PreconditionerState> getPreconditionerState();
166 
176  virtual Teuchos::RCP<const PreconditionerState> getPreconditionerState() const;
177 
178  protected:
179  Teuchos::RCP<const Thyra::LinearOpBase<ST> > extractLinearOp(
180  const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A) const;
181  Teuchos::RCP<const MappingStrategy> extractMappingStrategy(
182  const Teuchos::RCP<const Tpetra::Operator<ST, LO, GO, NT> > &A) const;
183 
186 
187  // Teuchos::RCP<const BlockPreconditionerFactory> preconFactory_;
188  Teuchos::RCP<const PreconditionerFactory> preconFactory_;
189  Teuchos::RCP<Thyra::PreconditionerBase<ST> > preconObj_;
190  bool firstBuildComplete_;
191 };
192 
193 } // end namespace TpetraHelpers
194 } // end namespace Teko
195 
196 #endif
virtual void buildPreconditioner(const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A, bool clear=true)
Build this preconditioner from an Epetra_Operator passed in to this object.
virtual Teuchos::RCP< PreconditionerState > getPreconditionerState()
A single Epetra wrapper for all the BlockPreconditioners.
virtual void initPreconditioner(bool clearOld=false)
Build the underlying data structure for the preconditioner.
virtual void rebuildPreconditioner(const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &A)
Rebuild this preconditioner from an Epetra_Operator passed in this to object.