Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_LinearOpScalarProd_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_LINEAR_OP_SCALAR_PROD_DECL_HPP
43#define THYRA_LINEAR_OP_SCALAR_PROD_DECL_HPP
44
45
46#include "Thyra_ScalarProdBase_decl.hpp"
47
48
49namespace Thyra {
50
60template<class Scalar>
61class LinearOpScalarProd : public ScalarProdBase<Scalar> {
62public:
63
66
69
72
74 void initialize( const RCP<const LinearOpBase<Scalar> > &op );
75
77 const RCP<const LinearOpBase<Scalar> >& op() const;
78
80 void uninitialize(
81 const Ptr<RCP<const LinearOpBase<Scalar> > > &op = Teuchos::null );
82
84
85protected:
86
89
91 virtual bool isEuclideanImpl() const;
92
94 void scalarProdsImpl(
96 const ArrayView<Scalar> &scalarProds_out
97 ) const;
98
101
103
104private:
105
107
108};
109
110
111// //////////////////////////////////
112// Inline members
113
114
115template<class Scalar>
116inline
118{
119 return op_;
120}
121
122
123} // end namespace Thyra
124
125
126#endif // THYRA_LINEAR_OP_SCALAR_PROD_DECL_HPP
Base class for all linear operators.
Concrete implementation of a scalar product using a symmetric positive-definite linear operator.
void scalarProdsImpl(const MultiVectorBase< Scalar > &X, const MultiVectorBase< Scalar > &Y, const ArrayView< Scalar > &scalarProds_out) const
RCP< const LinearOpBase< Scalar > > getLinearOpImpl() const
void uninitialize(const Ptr< RCP< const LinearOpBase< Scalar > > > &op=Teuchos::null)
void initialize(const RCP< const LinearOpBase< Scalar > > &op)
const RCP< const LinearOpBase< Scalar > > & op() const
virtual bool isEuclideanImpl() const
Returns false.
Interface for a collection of column vectors called a multi-vector.
Abstract interface for scalar products.