Thyra_DefaultDiagonalLinearOp_decl.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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