Thyra_DefaultIdentityLinearOpDecl.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_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 
00063   using SingleScalarLinearOpBase<Scalar>::apply;
00064 
00067 
00074   DefaultIdentityLinearOp();
00075 
00078   DefaultIdentityLinearOp(
00079     const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
00080     );
00081 
00097   void initialize(
00098     const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
00099     );
00100 
00107   void uninitialize();
00108 
00110 
00113   
00115   Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > range() const;
00116   
00118   Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > domain() const;
00119   
00121   Teuchos::RefCountPtr<const LinearOpBase<Scalar> > clone() const;
00122   
00124   
00127                                                 
00131   std::string description() const;
00132 
00134 
00135 protected:
00136 
00139 
00141   bool opSupported(ETransp M_trans) const;
00142 
00144   void apply(
00145     const ETransp                     M_trans
00146     ,const MultiVectorBase<Scalar>    &X
00147     ,MultiVectorBase<Scalar>          *Y
00148     ,const Scalar                     alpha
00149     ,const Scalar                     beta
00150     ) const;
00151 
00153 
00154 private:
00155 
00156   Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >  space_;
00157 
00158   // Not defined and not to be called
00159   DefaultIdentityLinearOp(const DefaultIdentityLinearOp&);
00160   DefaultIdentityLinearOp& operator=(const DefaultIdentityLinearOp&);
00161 
00162 };
00163 
00168 template<class Scalar>
00169 Teuchos::RefCountPtr<const LinearOpBase<Scalar> >
00170 identity(
00171   const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
00172   );
00173 
00174 } // end namespace Thyra
00175 
00176 #endif  // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP

Generated on Thu Sep 18 12:33:02 2008 for Thyra Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1