Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_LinearOpBase_def.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_BASE_DEF_HPP
43 #define THYRA_LINEAR_OP_BASE_DEF_HPP
44 
45 #include "Thyra_LinearOpBase_decl.hpp"
46 #include "Thyra_MultiVectorBase.hpp"
47 #include "Thyra_VectorSpaceBase.hpp"
48 
49 
50 namespace Thyra {
51 
52 
53 // Public interface functions
54 
55 
56 template<class Scalar>
57 RCP<const LinearOpBase<Scalar> >
59 {
60  return Teuchos::null;
61 }
62 
63 
64 } // end namespace Thyra
65 
66 
67 // ToDo: You can move this back to the decl file after you have refactored
68 // apply(...) to not use raw pointers. Otherwise the Y.ptr() call needs to have
69 // the definition of MultiVectorBase.
70 
71 
72 template<class Scalar>
73 void Thyra::apply(
74  const LinearOpBase<Scalar> &M,
75  const EOpTransp M_trans,
76  const MultiVectorBase<Scalar> &X,
77  const Ptr<MultiVectorBase<Scalar> > &Y,
78  const Scalar alpha,
79  const Scalar beta
80  )
81 {
82  M.apply(M_trans, X, Y, alpha, beta);
83 }
84 
85 
86 //
87 // Explicit instantiation macro
88 //
89 
90 #define THYRA_LINEAR_OP_BASE_INSTANT(SCALAR) \
91  \
92  template class LinearOpBase<SCALAR >; \
93  \
94  template void apply( \
95  const LinearOpBase<SCALAR > &M, \
96  const EOpTransp M_trans, \
97  const MultiVectorBase<SCALAR > &X, \
98  const Ptr<MultiVectorBase<SCALAR > > &Y, \
99  const SCALAR alpha, \
100  const SCALAR beta \
101  );
102 
103 
104 #endif // THYRA_LINEAR_OP_BASE_DEF_HPP
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
virtual RCP< const LinearOpBase< Scalar > > clone() const
Clone the linear operator object (if supported).