Thyra_DefaultDiagonalLinearOpDecl.hpp

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 "Thyra_SingleRhsLinearOpBaseDecl.hpp"
00034 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00035 
00036 namespace Thyra {
00037 
00067 template<class Scalar>
00068 class DefaultDiagonalLinearOp
00069   : virtual public DiagonalLinearOpBase<Scalar>       // Public interface
00070   , virtual protected SingleRhsLinearOpBase<Scalar>   // Implementation detail
00071 {
00072 public:
00073 
00076 
00083   DefaultDiagonalLinearOp();
00084 
00087   DefaultDiagonalLinearOp(
00088     const RCP<const VectorSpaceBase<Scalar> >  &space
00089     );
00090 
00094   DefaultDiagonalLinearOp(
00095     const RCP<VectorBase<Scalar> >   &diag
00096     );
00097 
00101   DefaultDiagonalLinearOp(
00102     const RCP<const VectorBase<Scalar> >   &diag
00103     );
00104 
00120   void initialize(
00121     const RCP<const VectorSpaceBase<Scalar> >  &space
00122     );
00123 
00139   void initialize(const RCP<VectorBase<Scalar> > &diag);
00140 
00156   void initialize(
00157     const RCP<const VectorBase<Scalar> >   &diag
00158     );
00159 
00174   void uninitialize();
00175 
00177 
00180 
00182   bool isDiagConst() const;
00184   RCP<VectorBase<Scalar> > getNonconstDiag();
00186   RCP<const VectorBase<Scalar> > getDiag() const;
00187 
00189 
00198   RCP< const VectorSpaceBase<Scalar> > range() const;
00205   RCP< const VectorSpaceBase<Scalar> > domain() const;
00207   RCP<const LinearOpBase<Scalar> > clone() const;
00209 
00210 protected:
00211 
00215   bool opSupported(EOpTransp M_trans) const;
00217 
00221   void apply(
00222     const EOpTransp                M_trans
00223     ,const VectorBase<Scalar>    &x
00224     ,VectorBase<Scalar>          *y
00225     ,const Scalar                alpha
00226     ,const Scalar                beta
00227     ) const;
00229 
00230 private:
00231 
00232   Teuchos::ConstNonconstObjectContainer<VectorBase<Scalar> > diag_;
00233 
00234 };
00235 
00236 
00241 template<class Scalar>
00242 RCP<const LinearOpBase<Scalar> >
00243 diagonal(
00244   const RCP<VectorBase<Scalar> > &diag,
00245   const std::string &label = ""
00246   )
00247 {
00248   RCP<LinearOpBase<Scalar> >
00249     dlo = Teuchos::rcp(new DefaultDiagonalLinearOp<Scalar>(diag));
00250   if (label.length())
00251     dlo->setObjectLabel(label);
00252   return dlo;
00253 }
00254 
00255 
00256 } // end namespace Thyra
00257 
00258 
00259 #endif  // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP

Generated on Wed May 12 21:26:53 2010 for Thyra Operator/Vector Support by  doxygen 1.4.7