Thyra_DefaultIdentityLinearOpDecl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP
#define THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP

#include "Thyra_IdentityLinearOpBase.hpp"
#include "Thyra_SingleScalarLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"
#include "Teuchos_arrayArg.hpp"

namespace Thyra {

template<class Scalar>
class DefaultIdentityLinearOp
  : virtual public IdentityLinearOpBase<Scalar>          // Public interface
  , virtual protected SingleScalarLinearOpBase<Scalar>   // Implementation detail
{
public:

  using SingleScalarLinearOpBase<Scalar>::apply;


  DefaultIdentityLinearOp();

  DefaultIdentityLinearOp(
    const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
    );

  void initialize(
    const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
    );

  void uninitialize();


  
  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > range() const;
  
  Teuchos::RefCountPtr< const VectorSpaceBase<Scalar> > domain() const;
  
  Teuchos::RefCountPtr<const LinearOpBase<Scalar> > clone() const;
  
  
                                                
  std::string description() const;


protected:


  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp                     M_trans
    ,const MultiVectorBase<Scalar>    &X
    ,MultiVectorBase<Scalar>          *Y
    ,const Scalar                     alpha
    ,const Scalar                     beta
    ) const;


private:

  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >  space_;

  // Not defined and not to be called
  DefaultIdentityLinearOp(const DefaultIdentityLinearOp&);
  DefaultIdentityLinearOp& operator=(const DefaultIdentityLinearOp&);

};

template<class Scalar>
Teuchos::RefCountPtr<const LinearOpBase<Scalar> >
identity(
  const Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> >   &space
  );

} // end namespace Thyra

#endif  // THYRA_DEFAULT_IDENTITY_LINEAR_OP_DECL_HPP

---