Thyra_DefaultDiagonalLinearOp_decl.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_DIAGONAL_LINEAR_OP_DECL_HPP
#define THYRA_DIAGONAL_LINEAR_OP_DECL_HPP

#include "Thyra_DiagonalLinearOpBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"


namespace Thyra {


template<class Scalar>
class DefaultDiagonalLinearOp : virtual public DiagonalLinearOpBase<Scalar>
{
public:


  DefaultDiagonalLinearOp();

  DefaultDiagonalLinearOp(
    const RCP<const VectorSpaceBase<Scalar> >  &space
    );

  DefaultDiagonalLinearOp(
    const RCP<VectorBase<Scalar> >   &diag
    );

  DefaultDiagonalLinearOp(
    const RCP<const VectorBase<Scalar> >   &diag
    );

  void initialize(
    const RCP<const VectorSpaceBase<Scalar> >  &space
    );

  void initialize(const RCP<VectorBase<Scalar> > &diag);

  void initialize(
    const RCP<const VectorBase<Scalar> >   &diag
    );

  void uninitialize();



  bool isDiagConst() const;
  RCP<VectorBase<Scalar> > getNonconstDiag();
  RCP<const VectorBase<Scalar> > getDiag() const;


  RCP< const VectorSpaceBase<Scalar> > range() const;
  RCP< const VectorSpaceBase<Scalar> > domain() const;
  RCP<const LinearOpBase<Scalar> > clone() const;

protected:

  bool opSupportedImpl(EOpTransp M_trans) const;
  void applyImpl(
    const EOpTransp M_trans,
    const MultiVectorBase<Scalar> &X,
    const Ptr<MultiVectorBase<Scalar> > &Y,
    const Scalar alpha,
    const Scalar beta
    ) const;

private:

  Teuchos::ConstNonconstObjectContainer<VectorBase<Scalar> > diag_;

};


template<class Scalar>
RCP<const LinearOpBase<Scalar> >
diagonal(
  const RCP<VectorBase<Scalar> > &diag,
  const std::string &label = ""
  )
{
  RCP<LinearOpBase<Scalar> > dlo =
    Teuchos::rcp(new DefaultDiagonalLinearOp<Scalar>(diag));
  if (label.length())
    dlo->setObjectLabel(label);
  return dlo;
}


} // end namespace Thyra


#endif  // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP