Ifpack_OverlapSolveObject.h

/*@HEADER
// ***********************************************************************
// 
//       Ifpack: Object-Oriented Algebraic Preconditioner 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 IFPACK_SOLVEOBJECT_H
#define IFPACK_SOLVEOBJECT_H

#include "Epetra_Operator.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_Vector.h"
#include "Epetra_CombineMode.h"
class Epetra_Flops;


class Ifpack_OverlapSolveObject: public virtual Epetra_Operator {

 public:

  Ifpack_OverlapSolveObject(char * Label, const Epetra_Comm & Comm);

  Ifpack_OverlapSolveObject(const Ifpack_OverlapSolveObject & Source);

  virtual ~Ifpack_OverlapSolveObject();


  void SetOverlapMode( Epetra_CombineMode OverlapMode) {OverlapMode_ = OverlapMode; return;}

  int SetLowerOperator (Epetra_CrsMatrix * L, bool UseLTrans) {L_ = L; UseLTrans_ = UseLTrans; return(0);};

  int SetDiagonal (Epetra_Vector * D, bool UseDInv) {D_ = D; UseDInv_ = UseDInv; return(0);};

  int SetUpperOperator (Epetra_CrsMatrix * U, bool UseUTrans) {U_ = U; UseUTrans_ = UseUTrans; return(0);};

  
  

  int Solve(bool Trans, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;


  int Multiply(bool Trans, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;


  int Condest(bool Trans, double & ConditionNumberEstimate) const;



  Epetra_CombineMode OverlapMode() const {return(OverlapMode_);}
  
  int NumGlobalNonzeros() const {return(L().NumGlobalNonzeros()+U().NumGlobalNonzeros());};
  
  int NumMyNonzeros() const {return(L().NumMyNonzeros()+U().NumMyNonzeros());};
  
  const Epetra_CrsMatrix & L() const {return(*L_);};
    
  const Epetra_Vector & D() const {return(*D_);};
    
  const Epetra_CrsMatrix & U() const {return(*U_);};
  

    char * Label() const {return(Label_);};
    

  int SetUseTranspose(bool UseTranspose) {UseTranspose_ = UseTranspose; return(0);};


  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {
    return(Multiply(Ifpack_OverlapSolveObject::UseTranspose(), X, Y));};


  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {
    return(Solve(Ifpack_OverlapSolveObject::UseTranspose(), X, Y));};

    double NormInf() const {return(0.0);};

    bool HasNormInf() const {return(false);};

    bool UseTranspose() const {return(UseTranspose_);};

    const Epetra_Map & OperatorDomainMap() const {return(U_->OperatorDomainMap());};

    const Epetra_Map & OperatorRangeMap() const{return(L_->OperatorRangeMap());};

    const Epetra_Comm & Comm() const{return(Comm_);};

 protected:
    virtual int SetupXY(bool Trans, 
            const Epetra_MultiVector& Xin, const Epetra_MultiVector& Yin,
            Epetra_MultiVector * & Xout, Epetra_MultiVector * & Yout) const=0;
 private:
  char * Label_;
  Epetra_CrsMatrix * L_;
  bool UseLTrans_;
  Epetra_Vector * D_;
  bool UseDInv_;
  Epetra_CrsMatrix * U_;
  bool UseUTrans_;
  bool UseTranspose_;
  const Epetra_Comm & Comm_;
  mutable double Condest_;
  Epetra_Flops * Counter_;
  Epetra_CombineMode OverlapMode_;

};
#endif // IFPACK_SOLVEOBJECT_H