Thyra_IfpackPreconditionerFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//         Stratimikos: Thyra-based strategies for linear solvers
//
// Copyright 2006 NTESS and the Stratimikos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
#define THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP

#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Ifpack.h"

namespace Thyra {

class IfpackPreconditionerFactory : public PreconditionerFactoryBase<double> {
public:


  IfpackPreconditionerFactory();
    
  STANDARD_COMPOSITION_MEMBERS( EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );



  bool isCompatible( const LinearOpSourceBase<double> &fwdOpSrc ) 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> >    &fwdOpSrc
    ,PreconditionerBase<double>                                      *prec
    ,const ESupportSolveUse                                           supportSolveUse
    ) const;
  void uninitializePrec(
    PreconditionerBase<double>                                *prec
    ,Teuchos::RCP<const LinearOpSourceBase<double> >  *fwdOpSrc
    ,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;


private:

  // ////////////////////////////////
  // Private data members

  Teuchos::RCP<Teuchos::ParameterList>       paramList_;
  ::Ifpack::EPrecType                                precType_;
  int                                                overlap_;

  // ////////////////////////////////
  // Private member functions

  static void initializeTimers();

};

} // namespace Thyra

#endif // THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP