Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_DefaultDiagonalLinearOp_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_DIAGONAL_LINEAR_OP_DECL_HPP
43 #define THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
44 
45 #include "Thyra_DiagonalLinearOpBase.hpp"
46 #include "Teuchos_ConstNonconstObjectContainer.hpp"
47 
48 
49 namespace Thyra {
50 
51 
81 template<class Scalar>
82 class DefaultDiagonalLinearOp : virtual public DiagonalLinearOpBase<Scalar>
83 {
84 public:
85 
88 
96 
100  const RCP<const VectorSpaceBase<Scalar> > &space
101  );
102 
107  const RCP<VectorBase<Scalar> > &diag
108  );
109 
114  const RCP<const VectorBase<Scalar> > &diag
115  );
116 
132  void initialize(
133  const RCP<const VectorSpaceBase<Scalar> > &space
134  );
135 
151  void initialize(const RCP<VectorBase<Scalar> > &diag);
152 
168  void initialize(
169  const RCP<const VectorBase<Scalar> > &diag
170  );
171 
186  void uninitialize();
187 
189 
192 
194  bool isDiagConst() const;
199 
201 
221 
222 protected:
223 
227  bool opSupportedImpl(EOpTransp M_trans) const;
229  void applyImpl(
230  const EOpTransp M_trans,
231  const MultiVectorBase<Scalar> &X,
232  const Ptr<MultiVectorBase<Scalar> > &Y,
233  const Scalar alpha,
234  const Scalar beta
235  ) const;
237 
238 private:
239 
241 
242 };
243 
244 
249 template<class Scalar>
252  const RCP<VectorBase<Scalar> > &diag,
253  const std::string &label = ""
254  )
255 {
258  if (label.length())
259  dlo->setObjectLabel(label);
260  return dlo;
261 }
262 
263 
264 } // end namespace Thyra
265 
266 
267 #endif // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
RCP< const VectorSpaceBase< Scalar > > domain() const
Returns this-&gt;getDiag()-&gt;space().
RCP< const LinearOpBase< Scalar > > diagonal(const RCP< VectorBase< Scalar > > &diag, const std::string &label="")
Nonmember constructor function.
RCP< const VectorBase< Scalar > > getDiag() const
Abstract interface for objects that represent a space for vectors.
RCP< const LinearOpBase< Scalar > > clone() const
void initialize(const RCP< const VectorSpaceBase< Scalar > > &space)
Initialize given a vector space which allocates a vector internally.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Interface for a collection of column vectors called a multi-vector.
Abstract interface for finite-dimensional dense vectors.
DefaultDiagonalLinearOp()
Constructs to uninitialized.
RCP< const VectorSpaceBase< Scalar > > range() const
Returns this-&gt;getDiag()-&gt;space().
void applyImpl(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
Interface class for for diagonal linear operators.
Default concrete LinearOpBase subclass for diagonal linear operators.