Thyra_DefaultDiagonalLinearOpDecl.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 "Thyra_SingleRhsLinearOpBaseDecl.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"

namespace Thyra {

template<class Scalar>
class DefaultDiagonalLinearOp
  : virtual public DiagonalLinearOpBase<Scalar>       // Public interface
  , virtual protected SingleRhsLinearOpBase<Scalar>   // Implementation detail
{
public:


  DefaultDiagonalLinearOp();

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

  DefaultDiagonalLinearOp(
    const Teuchos::RefCountPtr<VectorBase<Scalar> >   &diag
    );

  DefaultDiagonalLinearOp(
    const Teuchos::RefCountPtr<const VectorBase<Scalar> >   &diag
    );

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

  void initialize(
    const Teuchos::RefCountPtr<VectorBase<Scalar> >   &diag
    );

  void initialize(
    const Teuchos::RefCountPtr<const VectorBase<Scalar> >   &diag
    );

  void uninitialize();



  bool isDiagConst() const;
  Teuchos::RefCountPtr<VectorBase<Scalar> > getNonconstDiag();
  Teuchos::RefCountPtr<const VectorBase<Scalar> > getDiag() const;


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

protected:

  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp                M_trans
    ,const VectorBase<Scalar>    &x
    ,VectorBase<Scalar>          *y
    ,const Scalar                alpha
    ,const Scalar                beta
    ) const;

private:

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

};

} // end namespace Thyra

#endif  // THYRA_DIAGONAL_LINEAR_OP_DECL_HPP

---