Ifpack_CrsRick.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_CRSRICK_H_
#define _IFPACK_CRSRICK_H_

#include "Ifpack_ScalingType.h"
#include "Ifpack_IlukGraph.h"
#include "Epetra_CompObject.h"
#include "Epetra_Operator.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_Object.h"
class Epetra_Comm;
class Epetra_Map;
class Epetra_CrsMatrix;
class Epetra_Vector;
class Epetra_MultiVector;

#ifdef HAVE_IFPACK_TEUCHOS
namespace Teuchos {
  class ParameterList;
}
#endif


class Ifpack_CrsRick: public Epetra_Object, public Epetra_CompObject, public virtual Epetra_Operator {
      
  // Give ostream << function some access to private and protected data/functions.

  friend ostream& operator << (ostream& os, const Ifpack_CrsRick& A);

 public:

  Ifpack_CrsRick(const Epetra_CrsMatrix &A, const Ifpack_IlukGraph & Graph);
  
  Ifpack_CrsRick(const Ifpack_CrsRick & Matrix);

  virtual ~Ifpack_CrsRick();


  int InitValues();

  bool ValuesInitialized() const {return(ValuesInitialized_);};

  void SetRelaxValue( double RelaxValue) {RelaxValue_ = RelaxValue; return;}

  void SetAbsoluteThreshold( double Athresh) {Athresh_ = Athresh; return;}

  void SetRelativeThreshold( double Rthresh) {Rthresh_ = Rthresh; return;}

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

#ifdef HAVE_IFPACK_TEUCHOS

  /* This method is only available if the Teuchos package is enabled.
     This method recognizes four parameter names: relax_value,
     absolute_threshold, relative_threshold and overlap_mode. These names
     are case insensitive. The ParameterEntry must have type double for all
     except overlap_mode, which must have type Epetra_CombineMode.
  */
  int SetParameters(const Teuchos::ParameterList& parameterlist,
                    bool cerr_warning_if_unused=false);
#endif


  int Factor();

  bool Factored() const {return(Factored_);};
  

  // Mathematical functions.
  
  

  int Solve(bool Trans, const Epetra_Vector& x, Epetra_Vector& y) const;
  

  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;
  // Atribute access functions
  
    
  double GetRelaxValue() {return RelaxValue_;}

  double GetAbsoluteThreshold() {return Athresh_;}

  double GetRelativeThreshold() {return Rthresh_;}

  Epetra_CombineMode GetOverlapMode() {return OverlapMode_;}

  int NumGlobalRows() const {return(Graph().NumGlobalRows());};
  
  int NumGlobalCols() const {return(Graph().NumGlobalCols());};
  
  int NumGlobalNonzeros() const {return(Graph().NumGlobalNonzeros());};
  
  virtual int NumGlobalDiagonals() const {return(Graph().NumGlobalDiagonals());};
  
  int NumMyRows() const {return(Graph().NumMyRows());};
  
  int NumMyCols() const {return(Graph().NumMyCols());};
  
  int NumMyNonzeros() const {return(Graph().NumMyNonzeros());};
  
  virtual int NumMyDiagonals() const {return(Graph().NumMyDiagonals());};
  
  int IndexBase() const {return(Graph().IndexBase());};
  
  const Ifpack_IlukGraph & Graph() const {return(Graph_);};
    
  const Epetra_Vector & D() const {return(*D_);};
    
  const Epetra_CrsMatrix & U() const {return(*U_);};


    char * Label() const {return(Epetra_Object::Label());};
    

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


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


  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const {
    return(Solve(Ifpack_CrsRick::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(A_.DomainMap());};

    const Epetra_Map & OperatorRangeMap() const{return(A_.RangeMap());};

 protected:
  void SetFactored(bool Flag) {Factored_ = Flag;};
  void SetValuesInitialized(bool Flag) {ValuesInitialized_ = Flag;};
  bool Allocated() const {return(Allocated_);};
  int SetAllocated(bool Flag) {Allocated_ = Flag; return(0);};
  
 private:
  
  
  int Allocate();
    
  const Epetra_CrsMatrix &A_;
  const Ifpack_IlukGraph & Graph_;
  Epetra_CrsMatrix * U_;
  Epetra_Vector * D_;
  bool UseTranspose_;

  
  bool Allocated_;
  bool ValuesInitialized_;
  bool Factored_;
  double RelaxValue_;
  double Athresh_;
  double Rthresh_;
  mutable double Condest_;

  mutable Epetra_MultiVector * OverlapX_;
  mutable Epetra_MultiVector * OverlapY_;
  Epetra_CombineMode OverlapMode_;


};

ostream& operator << (ostream& os, const Ifpack_CrsRick& A);

#endif /* _IFPACK_CRSRICK_H_ */

---