Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_DefaultIdentityLinearOp_decl.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 "Teuchos_ConstNonconstObjectContainer.hpp"
00034 
00035 namespace Thyra {
00036 
00053 template<class Scalar>
00054 class DefaultIdentityLinearOp : virtual public IdentityLinearOpBase<Scalar>
00055 {
00056 public:
00057 
00060 
00067   DefaultIdentityLinearOp();
00068 
00071   DefaultIdentityLinearOp(const RCP<const VectorSpaceBase<Scalar> > &space);
00072 
00089   void initialize(const RCP<const VectorSpaceBase<Scalar> > &space);
00090 
00097   void uninitialize();
00098 
00100 
00103   
00105   RCP< const VectorSpaceBase<Scalar> > range() const;
00106   
00108   RCP< const VectorSpaceBase<Scalar> > domain() const;
00109   
00111   RCP<const LinearOpBase<Scalar> > clone() const;
00112   
00114   
00117                                                 
00121   std::string description() const;
00122 
00124 
00125 protected:
00126 
00129 
00131   bool opSupportedImpl(EOpTransp M_trans) const;
00132 
00134   void applyImpl(
00135     const EOpTransp M_trans,
00136     const MultiVectorBase<Scalar> &X,
00137     const Ptr<MultiVectorBase<Scalar> > &Y,
00138     const Scalar alpha,
00139     const Scalar beta
00140     ) const;
00141 
00143 
00144 private:
00145 
00146   RCP<const VectorSpaceBase<Scalar> >  space_;
00147 
00148   // Not defined and not to be called
00149   DefaultIdentityLinearOp(const DefaultIdentityLinearOp&);
00150   DefaultIdentityLinearOp& operator=(const DefaultIdentityLinearOp&);
00151 
00152 };
00153 
00154 
00159 template<class Scalar>
00160 RCP<const LinearOpBase<Scalar> >
00161 identity(
00162   const RCP<const VectorSpaceBase<Scalar> > &space,
00163   const std::string &label = ""
00164   );
00165 
00166 
00167 } // end namespace Thyra
00168 
00169 
00170 #endif  // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines