Teko_Preconditioner.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_Preconditioner_hpp__
#define __Teko_Preconditioner_hpp__

// Thyra includes
#include "Thyra_DefaultPreconditioner.hpp"

// Teko includes
#include "Teko_Utilities.hpp"
#include "Teko_PreconditionerState.hpp"

namespace Teko {

using Teuchos::RCP;
using Thyra::DefaultPreconditioner;
using Thyra::LinearOpBase;

class Preconditioner : public DefaultPreconditioner<double> {
 public:

  Preconditioner() : DefaultPreconditioner<double>() {}
  Preconditioner(const RCP<LinearOpBase<double> >& leftPrecOp,
                 const RCP<LinearOpBase<double> >& rightPrecOp)
      : DefaultPreconditioner<double>(leftPrecOp, rightPrecOp) {}
  Preconditioner(const RCP<const LinearOpBase<double> >& leftPrecOp,
                 const RCP<const LinearOpBase<double> >& rightPrecOp)
      : DefaultPreconditioner<double>(leftPrecOp, rightPrecOp) {}
  Preconditioner(const RCP<LinearOpBase<double> >& unspecifiedPrecOp)
      : DefaultPreconditioner<double>(unspecifiedPrecOp) {}
  Preconditioner(const RCP<const LinearOpBase<double> >& unspecifiedPrecOp)
      : DefaultPreconditioner<double>(unspecifiedPrecOp) {}

  virtual void setSourceVector(const RCP<Thyra::MultiVectorBase<double> >& srcVec) {
    if (srcVec != Teuchos::null)
      state_->setSourceVector(srcVec);
    else
      state_->setSourceVector(Teuchos::null);
  }

  virtual void setStateObject(const RCP<PreconditionerState>& state) { state_ = state; }

  virtual const RCP<PreconditionerState> getStateObject() { return state_; }

  virtual const RCP<const PreconditionerState> getStateObject() const { return state_; }

  virtual void mergeStateObject(const PreconditionerState& state) { state_->merge(state); }

 protected:
  RCP<PreconditionerState> state_;
};

}  // end namespace Teko

#endif