Ifpack_LocalFilter.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.
//
// 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_LOCALFILTER_H
#define IFPACK_LOCALFILTER_H
 
#if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Ifpack package is deprecated"
#endif
#endif
 
#include "Ifpack_ConfigDefs.h"
#ifdef HAVE_MPI
#include "Epetra_MpiComm.h"
#else
#include "Epetra_SerialComm.h"
#endif
#include "Epetra_RowMatrix.h"
#include "Teuchos_RefCountPtr.hpp"
 
class Epetra_Map;
class Epetra_MultiVector;
class Epetra_Vector;
class Epetra_Import;
class Epetra_BlockMap;
 
 
class Ifpack_LocalFilter : public virtual Epetra_RowMatrix {
 
public:
 
  Ifpack_LocalFilter(const Teuchos::RefCountPtr<const Epetra_RowMatrix>& Matrix);
 
 
 
  virtual ~Ifpack_LocalFilter() {};
 
 
 
 
  virtual int NumMyRowEntries(int MyRow, int & NumEntries) const
  {
    NumEntries = NumEntries_[MyRow];
    return(0);
  }
 
  virtual int MaxNumEntries() const
  {
    return(MaxNumEntries_);
  }
 
 
  virtual int ExtractMyRowCopy(int MyRow, int Length, int & NumEntries, double *Values, int * Indices) const;
 
 
  virtual int ExtractDiagonalCopy(Epetra_Vector & Diagonal) const;
 
 
 
  virtual int Multiply(bool TransA, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const
  {
    if (TransA == true) {
      IFPACK_CHK_ERR(-1);
    }
 
    IFPACK_CHK_ERR(Apply(X,Y));
    return(0);
  }
 
  virtual int Solve(bool /* Upper */, bool /* Trans */, bool /* UnitDiagonal */, const Epetra_MultiVector& /* X */,
                    Epetra_MultiVector& /* Y */) const
  {
    IFPACK_RETURN(-1); // not implemented
  }
 
  virtual int Apply(const Epetra_MultiVector& X,
                    Epetra_MultiVector& Y) const;
 
  virtual int ApplyInverse(const Epetra_MultiVector& X,
                           Epetra_MultiVector& Y) const;
  virtual int InvRowSums(Epetra_Vector& /* x */) const
  {
    IFPACK_RETURN(-1); // not implemented
  }
 
  virtual int LeftScale(const Epetra_Vector& /* x */)
  {
    IFPACK_RETURN(-1); // not implemented
  }
 
  virtual int InvColSums(Epetra_Vector& /* x */) const
  {
    IFPACK_RETURN(-1); // not implemented
  }
 
 
  virtual int RightScale(const Epetra_Vector& /* x */)
  {
    IFPACK_RETURN(-1); // not implemented
  }
 
 
 
  virtual bool Filled() const
  {
    return true;
  }
 
  /* Returns the quantity \f$ \| A \|_\infty\f$ such that
     \f[\| A \|_\infty = \max_{1\lei\len} \sum_{i=1}^m |a_{ij}| \f].
     */
  virtual double NormInf() const
  {
    return(-1.0);
  }
 
  /* Returns the quantity \f$ \| A \|_1\f$ such that
     \f[\| A \|_1= \max_{1\lej\len} \sum_{j=1}^n |a_{ij}| \f].
     */
  virtual double NormOne() const
  {
    IFPACK_RETURN(-1.0);
  }
 
#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
  virtual int NumGlobalNonzeros() const
  {
    return(NumNonzeros_);
  }
 
  virtual int NumGlobalRows() const
  {
    return(NumRows_);
  }
 
  virtual int NumGlobalCols() const
  {
    return(NumRows_);
  }
 
  virtual int NumGlobalDiagonals() const
  {
    return(NumRows_);
  }
#endif
 
  virtual long long NumGlobalNonzeros64() const
  {
    return(NumNonzeros_);
  }
 
  virtual long long NumGlobalRows64() const
  {
    return(NumRows_);
  }
 
  virtual long long NumGlobalCols64() const
  {
    return(NumRows_);
  }
 
  virtual long long NumGlobalDiagonals64() const
  {
    return(NumRows_);
  }
 
  virtual int NumMyNonzeros() const
  {
    return(NumNonzeros_);
  }
 
  virtual int NumMyRows() const
  {
    return(NumRows_);
  }
 
  virtual int NumMyCols() const
  {
    return(NumRows_);
  }
 
  virtual int NumMyDiagonals() const
  {
    return(NumRows_);
  }
 
  virtual bool LowerTriangular() const
  {
    return(Matrix_->LowerTriangular());
  }
 
  virtual bool UpperTriangular() const
  {
    return(Matrix_->UpperTriangular());
  }
 
  virtual const Epetra_Map & RowMatrixRowMap() const
  {
    return(*Map_);
  }
 
  virtual const Epetra_Map & RowMatrixColMap() const
  {
    return(*Map_);
  }
 
  virtual const Epetra_Import * RowMatrixImporter() const
  {
    return(0);
  }
 
  // following functions are required to derive Epetra_RowMatrix objects.
 
  int SetOwnership(bool /* ownership */)
  {
    IFPACK_RETURN(-1);
  }
 
  int SetUseTranspose(bool UseTranspose_in)
  {
    UseTranspose_ = UseTranspose_in;
    return(0);
  }
 
  bool UseTranspose() const
  {
    return(UseTranspose_);
  }
 
  bool HasNormInf() const
  {
    return(false);
  }
 
  const Epetra_Comm & Comm() const
  {
    return(*SerialComm_);
  }
 
  const Epetra_Map & OperatorDomainMap() const
  {
    return(*Map_);
  }
 
  const Epetra_Map & OperatorRangeMap() const
  {
    return(*Map_);
  }
 
const Epetra_BlockMap& Map() const;
 
const char* Label() const{
  return(Label_);
};
 
private:
 
  Teuchos::RefCountPtr<const Epetra_RowMatrix> Matrix_;
#ifdef HAVE_MPI
  Teuchos::RefCountPtr<Epetra_MpiComm> SerialComm_;
#else
  Teuchos::RefCountPtr<Epetra_SerialComm> SerialComm_;
#endif
  Teuchos::RefCountPtr<Epetra_Map> Map_;
  int NumRows_;
  int NumNonzeros_;
  int MaxNumEntries_;
  int MaxNumEntriesA_;
  std::vector<int> NumEntries_;
  mutable std::vector<int> Indices_;
  mutable std::vector<double> Values_;
  bool UseTranspose_;
  char Label_[80];
  Teuchos::RefCountPtr<Epetra_Vector> Diagonal_;
  /* unused (comment out to avoid build warnings)
  double NormOne_;
  double NormInf_;
  */
};
 
#endif /* IFPACK_LOCALFILTER_H */