Ifpack_IlukGraph.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_ILUK_GRAPH_H_
#define _IFPACK_ILUK_GRAPH_H_

#include "Ifpack_ConfigDefs.h"
#include "Epetra_Object.h"
#include "Epetra_CrsGraph.h"
#include "Epetra_Import.h"

#include "Teuchos_RefCountPtr.hpp"

namespace Teuchos {
  class ParameterList;
}


class Ifpack_IlukGraph {

  // Give ostream << function some access to private and protected data/functions.

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

 public:


  Ifpack_IlukGraph(const Epetra_CrsGraph & Graph_in, int LevelFill_in, int LevelOverlap_in);

  Ifpack_IlukGraph(const Ifpack_IlukGraph & Graph_in);

  virtual ~Ifpack_IlukGraph();

  /* This method is only available if the Teuchos package is enabled.
     This method recogizes two parameter names: Level_fill and Level_overlap.
     Both are case insensitive, and in both cases the ParameterEntry must
     have type int.
  */
  int SetParameters(const Teuchos::ParameterList& parameterlist,
                    bool cerr_warning_if_unused=false);

  /*
    \return Integer error code, set to 0 if successful.

  */
  virtual int ConstructFilledGraph();

  /*
    \return Integer error code, set to 0 if successful.

  */
  virtual int ConstructOverlapGraph();

  virtual int LevelFill() const {return(LevelFill_);};

  virtual int LevelOverlap() const {return(LevelOverlap_);};

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
  int NumGlobalBlockRows() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalBlockRows_);
    else
      throw "Ifpack_IlukGraph::NumGlobalBlockRows: GlobalIndices not int.";
  }

  int NumGlobalBlockCols() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalBlockCols_);
    else
      throw "Ifpack_IlukGraph::NumGlobalBlockCols: GlobalIndices not int.";
  }

  int NumGlobalRows() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalRows_);
    else
      throw "Ifpack_IlukGraph::NumGlobalRows: GlobalIndices not int.";
  }

  int NumGlobalCols() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalCols_);
    else
      throw "Ifpack_IlukGraph::NumGlobalCols: GlobalIndices not int.";
  }
  int NumGlobalNonzeros() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalNonzeros_);
    else
      throw "Ifpack_IlukGraph::NumGlobalNonzeros: GlobalIndices not int.";
  }

  virtual int NumGlobalBlockDiagonals() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int)(NumGlobalBlockDiagonals_);
    else
      throw "Ifpack_IlukGraph::NumGlobalBlockDiagonals: GlobalIndices not int.";
  }
#endif

  long long NumGlobalBlockRows64() const {return(NumGlobalBlockRows_);};

  long long NumGlobalBlockCols64() const {return(NumGlobalBlockCols_);};

  long long NumGlobalRows64() const {return(NumGlobalRows_);};

  long long NumGlobalCols64() const {return(NumGlobalCols_);};
  long long NumGlobalNonzeros64() const {return(NumGlobalNonzeros_);};

  virtual long long NumGlobalBlockDiagonals64() const {return(NumGlobalBlockDiagonals_);};

  int NumMyBlockRows() const {return(NumMyBlockRows_);};

  int NumMyBlockCols() const {return(NumMyBlockCols_);};


  int NumMyRows() const {return(NumMyRows_);};

  int NumMyCols() const {return(NumMyCols_);};

  int NumMyNonzeros() const {return(NumMyNonzeros_);};

  virtual int NumMyBlockDiagonals() const {return(NumMyBlockDiagonals_);};

#ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
  int IndexBase() const {
    if(Graph_.RowMap().GlobalIndicesInt())
      return (int) IndexBase64();
    throw "Ifpack_IlukGraph::IndexBase: GlobalIndices not int.";
  }
#endif
  long long IndexBase64() const {return(IndexBase_);};

  virtual Epetra_CrsGraph & L_Graph() {return(*L_Graph_);};

  virtual Epetra_CrsGraph & U_Graph() {return(*U_Graph_);};

  virtual Epetra_CrsGraph & L_Graph() const {return(*L_Graph_);};

  virtual Epetra_CrsGraph & U_Graph() const {return(*U_Graph_);};

  virtual Epetra_Import * OverlapImporter() const  {return(&*OverlapImporter_);};

  virtual Epetra_CrsGraph * OverlapGraph() const  {return(&*OverlapGraph_);};

    virtual const Epetra_BlockMap & DomainMap() const {return(DomainMap_);};

    virtual const Epetra_BlockMap & RangeMap() const{return(RangeMap_);};

    virtual const Epetra_Comm & Comm() const{return(Comm_);};

 private:


  const Epetra_CrsGraph & Graph_;
  const Epetra_BlockMap & DomainMap_;
  const Epetra_BlockMap & RangeMap_;
  const Epetra_Comm & Comm_;
  Teuchos::RefCountPtr<Epetra_CrsGraph> OverlapGraph_;
  Teuchos::RefCountPtr<Epetra_BlockMap> OverlapRowMap_;
  Teuchos::RefCountPtr<Epetra_Import> OverlapImporter_;
  int LevelFill_;
  int LevelOverlap_;
  Teuchos::RefCountPtr<Epetra_CrsGraph> L_Graph_;
  Teuchos::RefCountPtr<Epetra_CrsGraph> U_Graph_;
  long long IndexBase_;
  long long NumGlobalRows_;
  long long NumGlobalCols_;
  long long NumGlobalBlockRows_;
  long long NumGlobalBlockCols_;
  long long NumGlobalBlockDiagonals_;
  long long NumGlobalNonzeros_;
  long long NumGlobalEntries_;
  int NumMyBlockRows_;
  int NumMyBlockCols_;
  int NumMyRows_;
  int NumMyCols_;
  int NumMyBlockDiagonals_;
  int NumMyNonzeros_;
  int NumMyEntries_;


 };

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

#endif /* _IFPACK_ILUK_GRAPH_H_ */