Thyra_MLPreconditionerFactory.hpp

// @HEADER
// *****************************************************************************
//         Stratimikos: Thyra-based strategies for linear solvers
//
// Copyright 2006 NTESS and the Stratimikos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
#define THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
 
 
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
 
namespace Thyra {
 

class MLPreconditionerFactory : public PreconditionerFactoryBase<double> {
public:


  MLPreconditionerFactory();
    
  STANDARD_COMPOSITION_MEMBERS(
    EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );



  bool isCompatible( const LinearOpSourceBase<double> &fwdOp ) const;
  bool applySupportsConj(EConj conj) const;
  bool applyTransposeSupportsConj(EConj conj) const;
  Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
  void initializePrec(
    const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOp,
    PreconditionerBase<double> *prec,
    const ESupportSolveUse supportSolveUse
    ) const;
  void uninitializePrec(
    PreconditionerBase<double> *prec
    ,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOp
    ,ESupportSolveUse *supportSolveUse
    ) const;



  void setParameterList(
    Teuchos::RCP<Teuchos::ParameterList> const& paramList);
  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
  Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;


  std::string description() const;
 
  // ToDo: Add an override of describe(...) to give more detail!

 
private:
 
  Teuchos::RCP<Teuchos::ParameterList> paramList_;
 
};
 
 
} // namespace Thyra
 
 
#endif // THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP