Thyra Version of the Day
Thyra_DefaultDiagonalLinearOp_decl.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 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
00043 #define THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
00044 
00045 #include "Thyra_DiagonalLinearOpBase.hpp"
00046 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00081 template<class Scalar>
00082 class DefaultDiagonalLinearOp : virtual public DiagonalLinearOpBase<Scalar>
00083 {
00084 public:
00085 
00088 
00095   DefaultDiagonalLinearOp();
00096 
00099   DefaultDiagonalLinearOp(
00100     const RCP<const VectorSpaceBase<Scalar> >  &space
00101     );
00102 
00106   DefaultDiagonalLinearOp(
00107     const RCP<VectorBase<Scalar> >   &diag
00108     );
00109 
00113   DefaultDiagonalLinearOp(
00114     const RCP<const VectorBase<Scalar> >   &diag
00115     );
00116 
00132   void initialize(
00133     const RCP<const VectorSpaceBase<Scalar> >  &space
00134     );
00135 
00151   void initialize(const RCP<VectorBase<Scalar> > &diag);
00152 
00168   void initialize(
00169     const RCP<const VectorBase<Scalar> >   &diag
00170     );
00171 
00186   void uninitialize();
00187 
00189 
00192 
00194   bool isDiagConst() const;
00196   RCP<VectorBase<Scalar> > getNonconstDiag();
00198   RCP<const VectorBase<Scalar> > getDiag() const;
00199 
00201 
00210   RCP< const VectorSpaceBase<Scalar> > range() const;
00217   RCP< const VectorSpaceBase<Scalar> > domain() const;
00219   RCP<const LinearOpBase<Scalar> > clone() const;
00221 
00222 protected:
00223 
00227   bool opSupportedImpl(EOpTransp M_trans) const;
00229   void applyImpl(
00230     const EOpTransp M_trans,
00231     const MultiVectorBase<Scalar> &X,
00232     const Ptr<MultiVectorBase<Scalar> > &Y,
00233     const Scalar alpha,
00234     const Scalar beta
00235     ) const;
00237 
00238 private:
00239 
00240   Teuchos::ConstNonconstObjectContainer<VectorBase<Scalar> > diag_;
00241 
00242 };
00243 
00244 
00249 template<class Scalar>
00250 RCP<const LinearOpBase<Scalar> >
00251 diagonal(
00252   const RCP<VectorBase<Scalar> > &diag,
00253   const std::string &label = ""
00254   )
00255 {
00256   RCP<LinearOpBase<Scalar> > dlo =
00257     Teuchos::rcp(new DefaultDiagonalLinearOp<Scalar>(diag));
00258   if (label.length())
00259     dlo->setObjectLabel(label);
00260   return dlo;
00261 }
00262 
00263 
00264 } // end namespace Thyra
00265 
00266 
00267 #endif  // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines