Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_LinearOpTransformerBase.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef THYRA_LINEAR_OP_TRANSFORMER_BASE_HPP
43 #define THYRA_LINEAR_OP_TRANSFORMER_BASE_HPP
44 
45 
46 #include "Thyra_LinearOpBase.hpp"
47 #include "Teuchos_VerboseObject.hpp"
48 
49 
50 namespace Thyra {
51 
52 
54 template<class Scalar>
56  : virtual public Teuchos::Describable,
57  virtual public Teuchos::VerboseObject<LinearOpTransformerBase<Scalar> >
58 {
59 public:
60 
62  virtual bool isCompatible(const LinearOpBase<Scalar> &op_in) const = 0;
63 
65  virtual RCP<LinearOpBase<Scalar> > createOutputOp() const = 0;
66 
80  virtual void transform(
81  const LinearOpBase<Scalar> &op_in,
82  const Ptr<LinearOpBase<Scalar> > &op_inout
83  ) const = 0;
84 
85 };
86 
87 
88 } // namespace Thyra
89 
90 
91 #endif // THYRA_LINEAR_OP_TRANSFORMER_BASE_HPP
virtual RCP< LinearOpBase< Scalar > > createOutputOp() const =0
Create an uninitialized op.
virtual void transform(const LinearOpBase< Scalar > &op_in, const Ptr< LinearOpBase< Scalar > > &op_inout) const =0
Do the transformation to a pre-created output LinearOpBase object.
Base class for all linear operators.
Base interface for transforming a LinearOpBase object.
virtual bool isCompatible(const LinearOpBase< Scalar > &op_in) const =0
Create an uninitialized op.