Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_ProbingPreconditionerFactory.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_ProbingPreconditionerFactory_hpp__
48 #define __Teko_ProbingPreconditionerFactory_hpp__
49 
50 #include "Teko_Config.h"
51 
52 #ifdef Teko_ENABLE_Isorropia
53 
54 // Teko includes
55 #include "Teko_PreconditionerState.hpp"
56 #include "Teko_PreconditionerFactory.hpp"
57 
58 // Isorropia includes
59 #include "Isorropia_EpetraProber.hpp"
60 
61 namespace Teko {
62 
67 class ProbingPreconditionerFactory
68  : public virtual Teko::PreconditionerFactory {
69 public:
70 
72 
73 
76  ProbingPreconditionerFactory();
77 
79 
82  LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;
83 
85  virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
86 
87  void setGraphOperator(const Teko::LinearOp & graphOp);
88  void setGraph(const Teuchos::RCP<const Epetra_CrsGraph> & graph);
89 
90  void setProberList(const Teuchos::ParameterList & list);
91 
92  void setInverseFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory)
93  { invFactory_ = invFactory; }
94 
95 protected:
97  Teuchos::RCP<Isorropia::Epetra::Prober> prober;
98  Teuchos::RCP<Teko::InverseFactory> invFactory_;
99 };
100 
101 } // end namespace Teko
102 
103 #endif
104 #endif
Abstract class which block preconditioner factories in Teko should be based on.