Thyra_BelosLinearOpWithSolveFactoryDecl.hpp

Go to the documentation of this file.

#ifndef THYRA_BELOS_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
#define THYRA_BELOS_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP

#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"

namespace Teuchos { class ParameterList; }

namespace Thyra {

template<class Scalar>
class BelosLinearOpWithSolveFactory : public LinearOpWithSolveFactoryBase<Scalar> {
public:

  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType  MagnitudeType;



  static const std::string  SolverType_name;
  static const std::string  SolverType_default;
  static const std::string  MaxIters_name;
  static const int          MaxIters_default;
  static const std::string  MaxRestarts_name;
  static const int          MaxRestarts_default;
  static const std::string  BlockSize_name;
  static const int          BlockSize_default;
  static const std::string  AdjustableBlockSize_name;
  static const bool         AdjustableBlockSize_default;
  static const std::string  DefaultRelResNorm_name;
  static const MagnitudeType DefaultRelResNorm_default;
  static const std::string  GMRES_name;
  static const std::string  GMRES_MaxNumberOfKrylovVectors_name;
  static const int          GMRES_MaxNumberOfKrylovVectors_default;
  static const std::string  GMRES_Variant_name;
  static const std::string  GMRES_Variant_default;
  static const std::string  Outputter_name;
  static const std::string  Outputter_OutputFrequency_name;
  static const int          Outputter_OutputFrequency_default;
  static const std::string  Outputter_OutputMaxResOnly_name;
  static const bool         Outputter_OutputMaxResOnly_default;



  BelosLinearOpWithSolveFactory();

  BelosLinearOpWithSolveFactory(
    const Teuchos::RefCountPtr<PreconditionerFactoryBase<Scalar> >  &precFactory
    );


  bool acceptsPreconditionerFactory() const;
  void setPreconditionerFactory(
    const Teuchos::RefCountPtr<PreconditionerFactoryBase<Scalar> >  &precFactory
    ,const std::string                                              &precFactoryName
    );
  Teuchos::RefCountPtr<PreconditionerFactoryBase<Scalar> > getPreconditionerFactory() const;
  void unsetPreconditionerFactory(
    Teuchos::RefCountPtr<PreconditionerFactoryBase<Scalar> >  *precFactory
    ,std::string                                              *precFactoryName
    );
  bool isCompatible( const LinearOpSourceBase<Scalar> &fwdOpSrc ) const;
  Teuchos::RefCountPtr<LinearOpWithSolveBase<Scalar> > createOp() const;
  void initializeOp(
    const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >    &fwdOpSrc
    ,LinearOpWithSolveBase<Scalar>                                   *Op
    ,const ESupportSolveUse                                          supportSolveUse
    ) const;
  void initializeAndReuseOp(
    const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >    &fwdOpSrc
    ,LinearOpWithSolveBase<Scalar>                                   *Op
    ) const;
  void uninitializeOp(
    LinearOpWithSolveBase<Scalar>                               *Op
    ,Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >    *fwdOpSrc
    ,Teuchos::RefCountPtr<const PreconditionerBase<Scalar> >    *prec
    ,Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >    *approxFwdOpSrc
    ,ESupportSolveUse                                           *supportSolveUse
    ) const;
  bool supportsPreconditionerInputType(const EPreconditionerInputType precOpType) const;
  void initializePreconditionedOp(
    const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >       &fwdOpSrc
    ,const Teuchos::RefCountPtr<const PreconditionerBase<Scalar> >      &prec
    ,LinearOpWithSolveBase<Scalar>                                      *Op
    ,const ESupportSolveUse                                             supportSolveUse
    ) const;
  void initializeApproxPreconditionedOp(
    const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >       &fwdOpSrc
    ,const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >      &approxFwdOpSrc
    ,LinearOpWithSolveBase<Scalar>                                      *Op
    ,const ESupportSolveUse                                             supportSolveUse
    ) const;


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



  std::string description() const;


private:

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

  Teuchos::RefCountPtr<PreconditionerFactoryBase<Scalar> >  precFactory_;
  std::string                                               precFactoryName_;
  Teuchos::RefCountPtr<Teuchos::ParameterList>              thisValidParamList_;
  Teuchos::RefCountPtr<Teuchos::ParameterList>              paramList_;
  bool                                                      useGmres_;

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

  static Teuchos::RefCountPtr<const Teuchos::ParameterList> generateAndGetValidParameters();

  void updateThisValidParamList();

  void initializeOpImpl(
    const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >       &fwdOpSrc
    ,const Teuchos::RefCountPtr<const LinearOpSourceBase<Scalar> >      &approxFwdOpSrc
    ,const Teuchos::RefCountPtr<const PreconditionerBase<Scalar> >      &prec
    ,const bool                                                         reusePrec
    ,LinearOpWithSolveBase<Scalar>                                      *Op
    ,const ESupportSolveUse                                             supportSolveUse
    ) const;

};


} // namespace Thyra

#endif // THYRA_BELOS_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP

---