Teko_PreconditionerLinearOpDecl.hpp

// @HEADER
// *****************************************************************************
//      Teko: A package for block and physics based preconditioning
//
// Copyright 2010 NTESS and the Teko contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef __Teko_PreconditionerLinearOpDecl_hpp__
#define __Teko_PreconditionerLinearOpDecl_hpp__
 
#include "Thyra_LinearOpBase.hpp"
#include "Thyra_PreconditionerBase.hpp"
#include "Thyra_VectorSpaceBase.hpp"
 
#include "Teuchos_ConstNonconstObjectContainer.hpp"
 
namespace Teko {

template <typename ScalarT>
class PreconditionerLinearOp : public Thyra::LinearOpBase<ScalarT> {
 public:
  PreconditionerLinearOp();
  PreconditionerLinearOp(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> >& prec);
  PreconditionerLinearOp(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> >& prec);

  void initialize(const Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> >& prec);

  void initialize(const Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> >& prec);

  void uninitialize();

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > range() const;

  virtual Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > domain() const;
 
  virtual bool opSupportedImpl(const Thyra::EOpTransp M_trans) const;

  virtual void applyImpl(const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase<ScalarT>& x,
                         const Teuchos::Ptr<Thyra::MultiVectorBase<ScalarT> >& y,
                         const ScalarT alpha, const ScalarT beta) const;

  virtual Teuchos::RCP<Thyra::PreconditionerBase<ScalarT> > getNonconstPreconditioner();

  virtual Teuchos::RCP<const Thyra::PreconditionerBase<ScalarT> > getPreconditioner() const;

  Teko::LinearOp getOperator() const { return getOperator_cnoc().getConstObj(); }
 
  // Inherited from Teuchos::Describable
  void describe(Teuchos::FancyOStream& out_arg, const Teuchos::EVerbosityLevel verbLevel) const;
 
 protected:
  Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc() const;

  Teuchos::ConstNonconstObjectContainer<Thyra::LinearOpBase<ScalarT> > getOperator_cnoc();
 
  Teuchos::ConstNonconstObjectContainer<Thyra::PreconditionerBase<ScalarT> > preconditioner_;
};

inline Teko::LinearOp extractOperatorFromPrecOp(const Teko::LinearOp& lo);
 
}  // end namespace Teko
 
#endif