Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultIdentityLinearOp_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_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
43#define THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
44
45#include "Thyra_IdentityLinearOpBase.hpp"
46#include "Teuchos_ConstNonconstObjectContainer.hpp"
47
48namespace Thyra {
49
66template<class Scalar>
67class DefaultIdentityLinearOp : virtual public IdentityLinearOpBase<Scalar>
68{
69public:
70
73
81
85
102 void initialize(const RCP<const VectorSpaceBase<Scalar> > &space);
103
110 void uninitialize();
111
113
116
119
122
125
127
130
134 std::string description() const;
135
137
138protected:
139
142
144 bool opSupportedImpl(EOpTransp M_trans) const;
145
147 void applyImpl(
148 const EOpTransp M_trans,
150 const Ptr<MultiVectorBase<Scalar> > &Y,
151 const Scalar alpha,
152 const Scalar beta
153 ) const;
154
156
157private:
158
160
161 // Not defined and not to be called
164
165};
166
167
172template<class Scalar>
175 const RCP<const VectorSpaceBase<Scalar> > &space,
176 const std::string &label = ""
177 );
178
179
180} // end namespace Thyra
181
182
183#endif // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
Represents a identity linear operator M = I.
RCP< const VectorSpaceBase< Scalar > > domain() const
Returns Teuchos::null if uninitialized.
DefaultIdentityLinearOp()
Constructs to uninitialized.
bool opSupportedImpl(EOpTransp M_trans) const
Returns true .
RCP< const LinearOpBase< Scalar > > clone() const
RCP< const LinearOpBase< Scalar > > identity(const RCP< const VectorSpaceBase< Scalar > > &space, const std::string &label="")
Create an identity linear operator with given a vector space.
void applyImpl(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
RCP< const VectorSpaceBase< Scalar > > range() const
Returns Teuchos::null if uninitialized.
void initialize(const RCP< const VectorSpaceBase< Scalar > > &space)
Initialize given a list of non-const linear operators.
std::string description() const
Prints just the name DefaultIdentityLinearOp along with the overall dimensions.
Interface class for identity linear operators.
Interface for a collection of column vectors called a multi-vector.
Abstract interface for objects that represent a space for vectors.
EOpTransp
Enumeration for determining how a linear operator is applied. `*.