Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_ImplicitLinearOp.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_ImplicitLinearOp_hpp__
48 #define __Teko_ImplicitLinearOp_hpp__
49 
50 #include "Teko_Utilities.hpp"
51 
52 namespace Teko {
53 
60 class ImplicitLinearOp : public Thyra::LinearOpBase<double> {
61 public:
62 
64  virtual VectorSpace range() const = 0;
65 
67  virtual VectorSpace domain() const = 0;
68 
82  virtual void implicitApply(const MultiVector & x, MultiVector & y,
83  const double alpha = 1.0, const double beta = 0.0) const = 0;
84 
85 protected:
86 
88 
89 
90  virtual bool opSupportedImpl(const Thyra::EOpTransp M_trans) const;
91 
92  virtual void applyImpl(
93  const Thyra::EOpTransp M_trans,
94  const Thyra::MultiVectorBase<double> & x,
95  const Teuchos::Ptr<Thyra::MultiVectorBase<double> > & y,
96  const double alpha,
97  const double beta
98  ) const;
99 
101 };
102 
103 } // end namespace Teko
104 
105 #endif
A virtual class that simplifies the construction of custom operators.
virtual bool opSupportedImpl(const Thyra::EOpTransp M_trans) const
Functions required by Thyra::LinearOpBase.
virtual void implicitApply(const MultiVector &x, MultiVector &y, const double alpha=1.0, const double beta=0.0) const =0
Perform a matrix vector multiply with this implicitly defined blocked operator.
virtual VectorSpace domain() const =0
Domain space of this operator.
virtual VectorSpace range() const =0
Range space of this operator.