Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_DefaultDiagonalLinearOp_decl.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
00030 #define THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
00031 
00032 #include "Thyra_DiagonalLinearOpBase.hpp"
00033 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00034 
00035 
00036 namespace Thyra {
00037 
00038 
00068 template<class Scalar>
00069 class DefaultDiagonalLinearOp : virtual public DiagonalLinearOpBase<Scalar>
00070 {
00071 public:
00072 
00075 
00082   DefaultDiagonalLinearOp();
00083 
00086   DefaultDiagonalLinearOp(
00087     const RCP<const VectorSpaceBase<Scalar> >  &space
00088     );
00089 
00093   DefaultDiagonalLinearOp(
00094     const RCP<VectorBase<Scalar> >   &diag
00095     );
00096 
00100   DefaultDiagonalLinearOp(
00101     const RCP<const VectorBase<Scalar> >   &diag
00102     );
00103 
00119   void initialize(
00120     const RCP<const VectorSpaceBase<Scalar> >  &space
00121     );
00122 
00138   void initialize(const RCP<VectorBase<Scalar> > &diag);
00139 
00155   void initialize(
00156     const RCP<const VectorBase<Scalar> >   &diag
00157     );
00158 
00173   void uninitialize();
00174 
00176 
00179 
00181   bool isDiagConst() const;
00183   RCP<VectorBase<Scalar> > getNonconstDiag();
00185   RCP<const VectorBase<Scalar> > getDiag() const;
00186 
00188 
00197   RCP< const VectorSpaceBase<Scalar> > range() const;
00204   RCP< const VectorSpaceBase<Scalar> > domain() const;
00206   RCP<const LinearOpBase<Scalar> > clone() const;
00208 
00209 protected:
00210 
00214   bool opSupportedImpl(EOpTransp M_trans) const;
00216   void applyImpl(
00217     const EOpTransp M_trans,
00218     const MultiVectorBase<Scalar> &X,
00219     const Ptr<MultiVectorBase<Scalar> > &Y,
00220     const Scalar alpha,
00221     const Scalar beta
00222     ) const;
00224 
00225 private:
00226 
00227   Teuchos::ConstNonconstObjectContainer<VectorBase<Scalar> > diag_;
00228 
00229 };
00230 
00231 
00236 template<class Scalar>
00237 RCP<const LinearOpBase<Scalar> >
00238 diagonal(
00239   const RCP<VectorBase<Scalar> > &diag,
00240   const std::string &label = ""
00241   )
00242 {
00243   RCP<LinearOpBase<Scalar> > dlo =
00244     Teuchos::rcp(new DefaultDiagonalLinearOp<Scalar>(diag));
00245   if (label.length())
00246     dlo->setObjectLabel(label);
00247   return dlo;
00248 }
00249 
00250 
00251 } // end namespace Thyra
00252 
00253 
00254 #endif  // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines