Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_DiagonalPreconditionerOp.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_DiagonalPreconditionerOp_hpp__
48 #define __Teko_DiagonalPreconditionerOp_hpp__
49 #include "Teko_Utilities.hpp"
50 
51 #include "Teko_ImplicitLinearOp.hpp"
52 
53 class EpetraExt_PointToBlockDiagPermute;
54 
55 namespace Teko {
56 
57 class DiagonalPreconditionerOp :public ImplicitLinearOp {
58 public:
59 
61  DiagonalPreconditionerOp(Teuchos::RCP<EpetraExt_PointToBlockDiagPermute> BDP, const VectorSpace range, const VectorSpace domain);
62 
64  virtual VectorSpace range() const {return range_;}
65 
67  virtual VectorSpace domain() const {return domain_;}
68 
81  virtual void implicitApply(const MultiVector & x, MultiVector & y,
82  const double alpha = 1.0, const double beta = 0.0) const;
83 
84  virtual void describe(Teuchos::FancyOStream &out_arg,
85  const Teuchos::EVerbosityLevel verbLevel) const;
86 
87  Teuchos::RCP<EpetraExt_PointToBlockDiagPermute> get_BDP() const {return BDP_;}
88 
89 private:
90 
91  Teuchos::RCP<EpetraExt_PointToBlockDiagPermute> BDP_;
92  const VectorSpace range_, domain_;
93 };
94 
95 } // end namespace Teko
96 
97 #endif