Thyra_AztecOOLinearOpWithSolveFactory.hpp

/*@HEADER
// ***********************************************************************
// 
//        AztecOO: An Object-Oriented Aztec Linear Solver Package 
//                 Copyright (2002) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
//@HEADER
*/

#ifndef THYRA_AZTECOO_LINEAR_OP_WITH_SOLVE_FACTORY_HPP
#define THYRA_AZTECOO_LINEAR_OP_WITH_SOLVE_FACTORY_HPP

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


namespace Teuchos { class ParameterList; }


namespace Thyra {


class AztecOOLinearOpWithSolveFactory : public LinearOpWithSolveFactoryBase<double> {
public:


   AztecOOLinearOpWithSolveFactory(
     Teuchos::RCP<Teuchos::ParameterList> const& paramList = Teuchos::null
     );
  
  STANDARD_COMPOSITION_MEMBERS( EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );


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


  void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
  Teuchos::RCP<Teuchos::ParameterList> getParameterList();
  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<PreconditionerFactoryBase<double> > precFactory_;
  std::string precFactoryName_;
  Teuchos::RCP<Teuchos::ParameterList> thisValidParamList_;
  Teuchos::RCP<Teuchos::ParameterList> paramList_;

  int defaultFwdMaxIterations_;
  double defaultFwdTolerance_;
  int defaultAdjMaxIterations_;
  double defaultAdjTolerance_;
  bool outputEveryRhs_;

  bool useAztecPrec_;

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

  static Teuchos::RCP<const Teuchos::ParameterList> generateAndGetValidParameters();
  void updateThisValidParamList();

  void initializeOp_impl(
    const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc,
    const Teuchos::RCP<const PreconditionerBase<double> > &prec,
    const Teuchos::RCP<const LinearOpSourceBase<double> > &approxFwdOpSrc,
    const bool reusePrec,
    LinearOpWithSolveBase<double> *Op
    ) const;

};


} // namespace Thyra

#endif // THYRA_AZTECOO_LINEAR_OP_WITH_SOLVE_FACTORY_HPP