Thyra_PreconditionerFactoryBase_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_PRECONDITIONER_FACTORY_BASE_DECL_HPP
#define THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP

#include "Thyra_PreconditionerBase.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_VerboseObject.hpp"


namespace Thyra {


template<class Scalar>
class PreconditionerFactoryBase
  : virtual public Teuchos::Describable,
    virtual public Teuchos::ParameterListAcceptor,
    virtual public Teuchos::VerboseObject<PreconditionerFactoryBase<Scalar> >
{
public:


  virtual bool isCompatible(const LinearOpSourceBase<Scalar> &fwdOpSrc) const = 0;

  virtual RCP<PreconditionerBase<Scalar> > createPrec() const = 0;

  virtual void initializePrec(
    const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    PreconditionerBase<Scalar> *precOp,
    const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const = 0;

  virtual void uninitializePrec(
    PreconditionerBase<Scalar> *prec,
    RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc = NULL,
    ESupportSolveUse *supportSolveUse = NULL
    ) const = 0;



  virtual bool applySupportsConj(EConj conj) const;

  virtual bool applyTransposeSupportsConj(EConj conj) const;


private:

  // Not defined and not to be called
  PreconditionerFactoryBase<Scalar>&
  operator=(const PreconditionerFactoryBase<Scalar>&);

};


} // namespace Thyra


#endif // THYRA_PRECONDITIONER_FACTORY_BASE_DECL_HPP