Ifpack_SPARSKIT.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_SPARSKIT_H
#define IFPACK_SPARSKIT_H
 
#include "Ifpack_ConfigDefs.h"
#ifdef HAVE_IFPACK_SPARSKIT
#include "Ifpack_CondestType.h"
#include "Ifpack_ScalingType.h"
#include "Ifpack_Preconditioner.h"
#include "Epetra_Vector.h"
#include "Epetra_RowMatrix.h"
class Epetra_Comm;
class Epetra_Map;
class Epetra_MultiVector;
namespace Teuchos {
  class ParameterList;
}

 
class Ifpack_SPARSKIT: public Ifpack_Preconditioner {
 
 public:
  Ifpack_SPARSKIT(Epetra_RowMatrix* A);

  virtual ~Ifpack_SPARSKIT();

  /* This method is only available if the Teuchos package is enabled.
     This method recognizes five parameter names: level_fill, drop_tolerance,
     absolute_threshold, relative_threshold and overlap_mode. These names are
     case insensitive. For level_fill the ParameterEntry must have type int, the
     threshold entries must have type double and overlap_mode must have type
     Epetra_CombineMode.
  */
  int SetParameters(Teuchos::ParameterList& parameterlis);
 
  int SetParameter(const std::string Name, const int Value)
  {
    IFPACK_CHK_ERR(-98);
  }
  int SetParameter(const std::string Name, const double Value)
  {
    IFPACK_CHK_ERR(-98);
  }
 
  const Epetra_RowMatrix& Matrix() const
  {
    return(A_);
  }
 
  Epetra_RowMatrix& Matrix()
  {
    return(A_);
  }
 
  bool IsInitialized() const
  {
    return(IsInitialized_);
  }

  int Initialize();

  int Compute();

  bool IsComputed() const
  {
    return(IsComputed_);
  }
 
  // Mathematical functions.


  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;
 
  int Apply(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const
  {
    IFPACK_CHK_ERR(-1);
  }


  double Condest(const Ifpack_CondestType CT = Ifpack_Cheap,
                 const int MaxIters = 1550,
                 const double Tol = 1e-9,
                 Epetra_RowMatrix* Matrix = 0);
 
  double Condest() const
  {
    return(Condest_);
  }
 
  // Attribute access functions



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

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

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

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

    const Epetra_Map & OperatorDomainMap() const {return(A_.OperatorDomainMap());};

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

    const Epetra_Comm & Comm() const{return(Comm_);};
 
    const char* Label() const
    {
      return(Label_.c_str());
    }
 
    int SetLabel(const char* Label)
    {
      Label_ = Label;
      return(0);
    }

  virtual std::ostream& Print(std::ostream& os) const;

  virtual int NumInitialize() const
  {
    return(NumInitialize_);
  }

  virtual int NumCompute() const
  {
    return(NumCompute_);
  }

  virtual int NumApplyInverse() const
  {
    return(NumApplyInverse_);
  }

  virtual double InitializeTime() const
  {
    return(InitializeTime_);
  }

  virtual double ComputeTime() const
  {
    return(ComputeTime_);
  }

  virtual double ApplyInverseTime() const
  {
    return(ApplyInverseTime_);
  }

  virtual double InitializeFlops() const
  {
    return(0.0);
  }
 
  virtual double ComputeFlops() const
  {
    return(0.0);
  }
 
  virtual double ApplyInverseFlops() const
  {
    return(0.0);
  }
 
private:
  Epetra_RowMatrix& A_;
  const Epetra_Comm& Comm_;
  bool UseTranspose_;
  int lfil_;
  double droptol_;
  double tol_;
  double permtol_;
  double alph_;
  int mbloc_;
  std::string Type_;
 
  // Factorization in MSR format.
  std::vector<double> alu_;
  std::vector<int> jlu_;
  std::vector<int> ju_;
 
  std::string Label_;
  // Permutation vector if required by ILUTP and ILUDP.
  std::vector<int> iperm_;
 
  double Condest_;
 
  bool IsInitialized_;
  bool IsComputed_;

  int NumInitialize_;
  int NumCompute_;
  mutable int NumApplyInverse_;

  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyInverseTime_;

  double ComputeFlops_;
  mutable double ApplyInverseFlops_;
 
};
 
#endif // HAVE_IFPACK_SPARSKIT
#endif /* IFPACK_SPARSKIT_H */