Thyra_DefaultIdentityLinearOpDecl.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_IDENTITY_LINEAR_OP_DECL_HPP
00030 #define THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
00031 
00032 #include "Thyra_IdentityLinearOpBase.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 DefaultIdentityLinearOp
00057   : virtual public IdentityLinearOpBase<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   DefaultIdentityLinearOp();
00076 
00079   DefaultIdentityLinearOp(
00080     const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &space
00081     );
00082 
00098   void initialize(
00099     const Teuchos::RCP<const VectorSpaceBase<Scalar> >   &space
00100     );
00101 
00108   void uninitialize();
00109 
00111 
00114   
00116   Teuchos::RCP< const VectorSpaceBase<Scalar> > range() const;
00117   
00119   Teuchos::RCP< const VectorSpaceBase<Scalar> > domain() const;
00120   
00122   Teuchos::RCP<const LinearOpBase<Scalar> > clone() const;
00123   
00125   
00128                                                 
00132   std::string description() const;
00133 
00135 
00136 protected:
00137 
00140 
00142   bool opSupported(EOpTransp M_trans) const;
00143 
00145   void apply(
00146     const EOpTransp                     M_trans
00147     ,const MultiVectorBase<Scalar>    &X
00148     ,MultiVectorBase<Scalar>          *Y
00149     ,const Scalar                     alpha
00150     ,const Scalar                     beta
00151     ) const;
00152 
00154 
00155 private:
00156 
00157   Teuchos::RCP<const VectorSpaceBase<Scalar> >  space_;
00158 
00159   // Not defined and not to be called
00160   DefaultIdentityLinearOp(const DefaultIdentityLinearOp&);
00161   DefaultIdentityLinearOp& operator=(const DefaultIdentityLinearOp&);
00162 
00163 };
00164 
00165 
00170 template<class Scalar>
00171 Teuchos::RCP<const LinearOpBase<Scalar> >
00172 identity(
00173   const Teuchos::RCP<const VectorSpaceBase<Scalar> > &space,
00174   const std::string &label = ""
00175   );
00176 
00177 
00178 } // end namespace Thyra
00179 
00180 
00181 #endif  // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP

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