Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ScaledLinearOpBase.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_SCALED_LINEAR_OP_BASE_HPP
43#define THYRA_SCALED_LINEAR_OP_BASE_HPP
44
45#include "Thyra_LinearOpBase_decl.hpp"
46
47
48namespace Thyra {
49
50
81template<class Scalar>
82class ScaledLinearOpBase : virtual public LinearOpBase<Scalar> {
83public:
84
87
90 bool supportsScaleLeft() const
91 { return supportsScaleLeftImpl(); }
92
95 bool supportsScaleRight() const
96 { return supportsScaleRightImpl(); }
97
102 void scaleLeft(const VectorBase<Scalar> &row_scaling)
103 { scaleLeftImpl(row_scaling); }
104
109 void scaleRight(const VectorBase<Scalar> &col_scaling)
110 { scaleRightImpl(col_scaling); }
111
113
114protected:
115
118
120 virtual bool supportsScaleLeftImpl() const = 0;
121
123 virtual bool supportsScaleRightImpl() const = 0;
124
126 virtual void scaleLeftImpl(const VectorBase<Scalar> &row_scaling) = 0;
127
129 virtual void scaleRightImpl(const VectorBase<Scalar> &col_scaling) = 0;
130
132
133};
134
135
136} // end namespace Thyra
137
138
139#endif // THYRA_SCALED_LINEAR_OP_BASE_HPP
Base class for all linear operators.
Applies left or right sclaing to the linear operator.
virtual bool supportsScaleLeftImpl() const =0
virtual void scaleLeftImpl(const VectorBase< Scalar > &row_scaling)=0
void scaleLeft(const VectorBase< Scalar > &row_scaling)
Left scales operator with diagonal scaling operator.
bool supportsScaleRight() const
Determines if this objects supports right scaling.
bool supportsScaleLeft() const
Determines if this objects supports left scaling.
virtual void scaleRightImpl(const VectorBase< Scalar > &col_scaling)=0
void scaleRight(const VectorBase< Scalar > &col_scaling)
Right scales operator with diagonal scaling operator.
virtual bool supportsScaleRightImpl() const =0
Abstract interface for finite-dimensional dense vectors.