Thyra_DefaultZeroLinearOpDecl.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_DEFAULT_ZERO_LINEAR_OP_DECL_HPP
00030 #define THYRA_DEFAULT_ZERO_LINEAR_OP_DECL_HPP
00031 
00032 #include "Thyra_ZeroLinearOpBase.hpp"
00033 #include "Thyra_SingleScalarLinearOpBase.hpp"
00034 #include "Teuchos_ConstNonconstObjectContainer.hpp"
00035 #include "Teuchos_arrayArg.hpp"
00036 
00037 namespace Thyra {
00038 
00055 template<class Scalar>
00056 class DefaultZeroLinearOp
00057   : virtual public ZeroLinearOpBase<Scalar>              // Public interface
00058   , virtual protected SingleScalarLinearOpBase<Scalar>   // Implementation detail
00059 {
00060 public:
00061 
00062 #ifdef THYRA_INJECT_USING_DECLARATIONS
00063   using SingleScalarLinearOpBase<Scalar>::apply;
00064 #endif
00065 
00068 
00075   DefaultZeroLinearOp();
00076 
00079   DefaultZeroLinearOp(
00080     const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &range
00081     ,const Teuchos::RCP<const VectorSpaceBase<Scalar> >  &domain
00082     );
00083 
00099   void initialize(
00100     const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &range
00101     ,const Teuchos::RCP<const VectorSpaceBase<Scalar> >  &domain
00102     );
00103 
00110   void uninitialize();
00111 
00113 
00116   
00118   Teuchos::RCP< const VectorSpaceBase<Scalar> > range() const;
00119   
00121   Teuchos::RCP< const VectorSpaceBase<Scalar> > domain() const;
00122   
00124   Teuchos::RCP<const LinearOpBase<Scalar> > clone() const;
00125   
00127   
00130                                                 
00134   std::string description() const;
00135 
00137 
00138 protected:
00139 
00142 
00144   bool opSupported(EOpTransp M_trans) const;
00145 
00147   void apply(
00148     const EOpTransp                     M_trans
00149     ,const MultiVectorBase<Scalar>    &X
00150     ,MultiVectorBase<Scalar>          *Y
00151     ,const Scalar                     alpha
00152     ,const Scalar                     beta
00153     ) const;
00154 
00156 
00157 private:
00158 
00159   Teuchos::RCP<const VectorSpaceBase<Scalar> >  range_;
00160   Teuchos::RCP<const VectorSpaceBase<Scalar> >  domain_;
00161 
00162   // Not defined and not to be called
00163   DefaultZeroLinearOp(const DefaultZeroLinearOp&);
00164   DefaultZeroLinearOp& operator=(const DefaultZeroLinearOp&);
00165 
00166 };
00167 
00172 template<class Scalar>
00173 Teuchos::RCP<const LinearOpBase<Scalar> >
00174 zero(
00175   const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &range
00176   ,const Teuchos::RCP<const VectorSpaceBase<Scalar> >  &domain
00177   );
00178 
00179 } // end namespace Thyra
00180 
00181 #endif  // THYRA_DEFAULT_ZERO_LINEAR_OP_DECL_HPP

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