Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_MultiVectorAdapterBase_decl.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_MULTI_VECTOR_ADAPTER_BASE_DECL_HPP
43 #define THYRA_MULTI_VECTOR_ADAPTER_BASE_DECL_HPP
44 
45 #include "Thyra_MultiVectorDefaultBase.hpp"
46 
47 
48 namespace Thyra {
49 
50 
52 template<class Scalar> class ScalarProdVectorSpaceBase;
53 
54 
66 template<class Scalar>
67 class MultiVectorAdapterBase : virtual public MultiVectorDefaultBase<Scalar>
68 {
69 public:
70 
73 
76  rangeScalarProdVecSpc() const = 0;
77 
80  domainScalarProdVecSpc() const = 0;
81 
90  virtual void euclideanApply(
91  const EOpTransp M_trans,
92  const MultiVectorBase<Scalar> &X,
93  const Ptr<MultiVectorBase<Scalar> > &Y,
94  const Scalar alpha,
95  const Scalar beta
96  ) const = 0;
97 
99 
107 
108 protected:
109 
113  bool opSupportedImpl(EOpTransp M_trans) const;
115  void applyImpl(
116  const EOpTransp M_trans,
117  const MultiVectorBase<Scalar> &X,
118  const Ptr<MultiVectorBase<Scalar> > &Y,
119  const Scalar alpha,
120  const Scalar beta
121  ) const;
123 
124 };
125 
126 
127 } // namespace Thyra
128 
129 
130 #endif // THYRA_MULTI_VECTOR_ADAPTER_BASE_DECL_HPP
RCP< const VectorSpaceBase< Scalar > > domain() const
Returns this-&gt;domainScalarProdVecSpc()
void applyImpl(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
Node subclass that uses a default MultiVectorBase implementation to provide default implementations f...
Interface for a collection of column vectors called a multi-vector.
virtual RCP< const ScalarProdVectorSpaceBase< Scalar > > domainScalarProdVecSpc() const =0
bool opSupportedImpl(EOpTransp M_trans) const
virtual void euclideanApply(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const =0
Apply the linear operator to a multi-vector with respect to a Euclidean vector space where the scalar...
Node subclass for MultiVectorBase subclasses that allows the insertion of an application defined scal...
RCP< const VectorSpaceBase< Scalar > > range() const
Returns this-&gt;rangeScalarProdVecSpc()
virtual RCP< const ScalarProdVectorSpaceBase< Scalar > > rangeScalarProdVecSpc() const =0