Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_SolveInverseFactory.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_SolveInverseFactory_hpp__
48 #define __Teko_SolveInverseFactory_hpp__
49 
50 #include "Teko_InverseFactory.hpp"
51 
52 namespace Teko {
53 
54 class SolveInverseFactory : public InverseFactory {
55  public:
57 
58 
68  SolveInverseFactory(
69  const Teuchos::RCP<Thyra::LinearOpWithSolveFactoryBase<double> >& lowsFactory);
70 
72  SolveInverseFactory(const SolveInverseFactory& siFactory);
74 
75  virtual ~SolveInverseFactory() {}
76 
86  virtual InverseLinearOp buildInverse(const LinearOp& linearOp) const;
87 
100  virtual InverseLinearOp buildInverse(const LinearOp& linearOp, const LinearOp& precOp) const;
101 
113  virtual void rebuildInverse(const LinearOp& source, InverseLinearOp& dest) const;
114 
127  virtual void rebuildInverse(const LinearOp& source, const LinearOp& precOp,
128  InverseLinearOp& dest) const;
129 
138  virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
139 
141  Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<double> > getLowsFactory() const {
142  return lowsFactory_;
143  }
144 
146  virtual std::string toString() const { return lowsFactory_->description(); }
147 
148  protected:
149  Teuchos::RCP<Thyra::LinearOpWithSolveFactoryBase<double> > lowsFactory_;
150 
151  private:
152  // hide me!
153  SolveInverseFactory();
154 };
155 
156 } // end namespace Teko
157 
158 #endif
InverseLinearOp buildInverse(const InverseFactory &factory, const LinearOp &A, const LinearOp &precOp)
void rebuildInverse(const InverseFactory &factory, const LinearOp &A, const LinearOp &precOp, InverseLinearOp &invA)