Ifpack_CrsRick.h

Go to the documentation of this file.

/*@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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// 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;

namespace Teuchos {
  class ParameterList;
}


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 std::ostream& operator << (std::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;}

  /* 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);


  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;
  // Attribute 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_);};


    const 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_;


};

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

#endif /* _IFPACK_CRSRICK_H_ */