Ifpack_OverlapGraph.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_OVERLAPGRAPH_H
#define IFPACK_OVERLAPGRAPH_H

#include "Ifpack_ConfigDefs.h"
#include "Epetra_Object.h"
#include "Epetra_CrsGraph.h"
class Epetra_Comm;
class Epetra_BlockMap;
class Epetra_RowMatrix;
class Epetra_Import;

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


class Ifpack_OverlapGraph: public Epetra_Object {

 public:


  Ifpack_OverlapGraph(const Epetra_CrsGraph * UserMatrixGraph, int OverlapLevel);


  Ifpack_OverlapGraph(const Epetra_RowMatrix * UserMatrix, int OverlapLevel);
  
  Ifpack_OverlapGraph(const Ifpack_OverlapGraph & Source);

  virtual ~Ifpack_OverlapGraph();

    
#ifdef HAVE_IFPACK_TEUCHOS

  /* This method is only available if the configure argument
     '--enable-ifpack-teuchos' was used.
     This method recognizes the name: level_overlap, which is case insensitive.
     The ParameterEntry must have type int.
  */
  int SetParameters(const Teuchos::ParameterList& parameterlist,
                    bool cerr_warning_if_unused=false);
#endif

  const Epetra_CrsGraph & OverlapGraph() const {return(*OverlapGraph_);}
    
  const Epetra_BlockMap & OverlapRowMap() const {return(*OverlapRowMap_);}
    
  const Epetra_Import & OverlapImporter() const {return(*OverlapImporter_);}
    

  int OverlapLevel() const {return(OverlapLevel_);}


  void Print(ostream& os) const {

  os << endl;
  if (UserMatrix_!=0) 
    os << "Overlap Graph created using the user's Epetra_RowMatrix object" << endl;
  else
        os << "Overlap Graph created using the user's Epetra_CrsGraph object" << endl;

  os << " Level of Overlap = " << OverlapLevel_ << endl;
  OverlapGraph_->Print(os);
  return;
}

 protected:

  int ConstructOverlapGraph(const Epetra_CrsGraph * UserMatrixGraph);
  Epetra_CrsGraph * OverlapGraph_;
  const Epetra_CrsGraph * UserMatrixGraph_;
  const Epetra_RowMatrix * UserMatrix_;
  Epetra_BlockMap * OverlapRowMap_;
  Epetra_Import * OverlapImporter_;
  int OverlapLevel_;
  bool IsOverlapped_;
};
#endif // IFPACK_OVERLAPGRAPH_H

---