Thyra_AztecOOLinearOpWithSolve.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_HPP
#define THYRA_AZTECOO_LINEAR_OP_WITH_SOLVE_HPP

#include "Thyra_SingleScalarLinearOpWithSolveBase.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Thyra_SingleRhsLinearOpBase.hpp"
#include "Thyra_EpetraLinearOp.hpp"
#include "Thyra_PreconditionerBase.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "AztecOO.h"


namespace Thyra {


class AztecOOLinearOpWithSolve
  : virtual public LinearOpWithSolveBase<double>                  // Public interface
  , virtual protected SingleRhsLinearOpBase<double>               // Implementation detail
  , virtual protected SingleScalarLinearOpWithSolveBase<double>   // Implementation detail
{
public:


   AztecOOLinearOpWithSolve(
     const int fwdDefaultMaxIterations = 400,
     const double fwdDefaultTol = 1e-6,
     const int adjDefaultMaxIterations = 400,
     const double adjDefaultTol = 1e-6,
     const bool outputEveryRhs = false
     );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, fwdDefaultMaxIterations );
   STANDARD_MEMBER_COMPOSITION_MEMBERS( double, fwdDefaultTol );
  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, adjDefaultMaxIterations );
   STANDARD_MEMBER_COMPOSITION_MEMBERS( double, adjDefaultTol );
   STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, outputEveryRhs );

  void initialize(
    const Teuchos::RCP<const LinearOpBase<double> > &fwdOp,
    const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc,
    const Teuchos::RCP<const PreconditionerBase<double> > &prec,
    const bool isExternalPrec,
    const Teuchos::RCP<const LinearOpSourceBase<double> > &approxFwdOpSrc,
    const Teuchos::RCP<AztecOO> &aztecFwdSolver,
    const bool allowInexactFwdSolve = false,
    const Teuchos::RCP<AztecOO> &aztecAdjSolver = Teuchos::null,
    const bool allowInexactAdjSolve = false,
    const double aztecSolverScalar = 1.0
    );
  
  Teuchos::RCP<const LinearOpSourceBase<double> > extract_fwdOpSrc();

  Teuchos::RCP<const PreconditionerBase<double> > extract_prec();

  bool isExternalPrec() const;


  Teuchos::RCP<const LinearOpSourceBase<double> > extract_approxFwdOpSrc();
  
  void uninitialize(
    Teuchos::RCP<const LinearOpBase<double> > *fwdOp = NULL,
    Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOpSrc = NULL,
    Teuchos::RCP<const PreconditionerBase<double> > *prec = NULL,
    bool *isExternalPrec = NULL,
    Teuchos::RCP<const LinearOpSourceBase<double> > *approxFwdOpSrc = NULL,
    Teuchos::RCP<AztecOO> *aztecFwdSolver = NULL,
    bool *allowInexactFwdSolve = NULL,
    Teuchos::RCP<AztecOO> *aztecAdjSolver = NULL,
    bool *allowInexactAdjSolve = NULL,
    double *aztecSolverScalar = NULL
    );


  Teuchos::RCP< const VectorSpaceBase<double> > range() const;
  Teuchos::RCP< const VectorSpaceBase<double> > domain() const;
  Teuchos::RCP<const LinearOpBase<double> > clone() const;

  std::string description() const;
  void describe(
    Teuchos::FancyOStream &out,
    const Teuchos::EVerbosityLevel verbLevel
    ) const;

protected:

  bool opSupported(ETransp M_trans) const;

  void apply(
    const ETransp M_trans,
    const VectorBase<double> &x,
    VectorBase<double> *y,
    const double alpha,
    const double beta
    ) const;

  bool solveSupportsTrans(ETransp M_trans) const;
  bool solveSupportsSolveMeasureType(
    ETransp M_trans, const SolveMeasureType& solveMeasureType
    ) const;
  void solve(
    const ETransp M_trans,
    const MultiVectorBase<double> &B,
    MultiVectorBase<double> *X,
    const int numBlocks,
    const BlockSolveCriteria<double> blockSolveCriteria[],
    SolveStatus<double> blockSolveStatus[]
    ) const;
  
private:
  
  Teuchos::RCP<const LinearOpBase<double> > fwdOp_;
  Teuchos::RCP<const LinearOpSourceBase<double> > fwdOpSrc_;
  Teuchos::RCP<const PreconditionerBase<double> > prec_;
  bool isExternalPrec_;
  Teuchos::RCP<const LinearOpSourceBase<double> > approxFwdOpSrc_;
  Teuchos::RCP<AztecOO> aztecFwdSolver_;
  bool allowInexactFwdSolve_;
  Teuchos::RCP<AztecOO> aztecAdjSolver_;
  bool allowInexactAdjSolve_;
  double aztecSolverScalar_;
  
  void assertInitialized() const;

};


} // namespace Thyra

#endif  // THYRA_AZTECOO_LINEAR_OP_WITH_SOLVE_HPP