Thyra_LinearOpWithSolveFactoryBase_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_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP
#define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP
 
#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_VerboseObject.hpp"
 
 
namespace Thyra {
 
 
template<class Scalar>
class LinearOpWithSolveFactoryBase
  : virtual public Teuchos::Describable, 
    virtual public Teuchos::VerboseObject<LinearOpWithSolveFactoryBase<Scalar> >,
    virtual public Teuchos::ParameterListAcceptor
{
public:
 
 
  virtual bool acceptsPreconditionerFactory() const;
 
  virtual void setPreconditionerFactory(
    const RCP<PreconditionerFactoryBase<Scalar> >  &precFactory,
    const std::string &precFactoryName
    );
 
  virtual RCP<PreconditionerFactoryBase<Scalar> >
  getPreconditionerFactory() const;
 
  virtual void unsetPreconditionerFactory(
    RCP<PreconditionerFactoryBase<Scalar> >  *precFactory = NULL,
    std::string *precFactoryName = NULL
    );
 
 
 
  virtual bool isCompatible(
    const LinearOpSourceBase<Scalar> &fwdOpSrc ) const = 0;
 
  virtual RCP<LinearOpWithSolveBase<Scalar> >
  createOp() const = 0;
 
  virtual void initializeOp(
    const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const = 0;
 
  virtual void initializeAndReuseOp(
    const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    LinearOpWithSolveBase<Scalar> *Op
    ) const;
 
  virtual void uninitializeOp(
    LinearOpWithSolveBase<Scalar> *Op,
    RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc = NULL,
    RCP<const PreconditionerBase<Scalar> > *prec = NULL,
    RCP<const LinearOpSourceBase<Scalar> > *approxFwdOpSrc = NULL,
    ESupportSolveUse *supportSolveUse = NULL
    ) const = 0;
  
 
 
  virtual bool supportsPreconditionerInputType(const EPreconditionerInputType precOpType) const;
 
  virtual void initializePreconditionedOp(
    const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    const RCP<const PreconditionerBase<Scalar> > &prec,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const;
 
  virtual void initializeApproxPreconditionedOp(
    const RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    const RCP<const LinearOpSourceBase<Scalar> > &approxFwdOpSrc,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED
    ) const;
  
 
private:
  
  // Not defined and not to be called
  LinearOpWithSolveFactoryBase<Scalar>&
  operator=(const LinearOpWithSolveFactoryBase<Scalar>&);
 
};
 
 
} // namespace Thyra
 
 
#endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_BASE_DECL_HPP