Ifpack2_Details_OverlappingRowGraph_decl.hpp

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) 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 IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP
#define IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP

#include <Ifpack2_ConfigDefs.hpp>
#include "Ifpack2_Details_RowGraph.hpp"
#include <Tpetra_Import_decl.hpp>
#include <Tpetra_Export_decl.hpp>

namespace Ifpack2 {
namespace Details {

template<class GraphType>
class OverlappingRowGraph :
    virtual public Ifpack2::Details::RowGraph<GraphType> {
public:

  typedef typename GraphType::local_ordinal_type local_ordinal_type;
  typedef typename GraphType::global_ordinal_type global_ordinal_type;
  typedef typename GraphType::node_type node_type;

  typedef Tpetra::Export<local_ordinal_type, global_ordinal_type, node_type> export_type;
  typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> import_type;
  typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> map_type;
  typedef Tpetra::RowGraph<local_ordinal_type, global_ordinal_type, node_type> row_graph_type;


  OverlappingRowGraph (const Teuchos::RCP<const row_graph_type>& nonoverlappingGraph,
                       const Teuchos::RCP<const row_graph_type>& overlappingGraph,
                       const Teuchos::RCP<const map_type>& rowMap,
                       const Teuchos::RCP<const map_type>& colMap,
                       const Tpetra::global_size_t numGlobalRows,
                       const Tpetra::global_size_t numGlobalCols,
                       const Tpetra::global_size_t numGlobalNonzeros,
                       const size_t maxNumEntries,
                       const Teuchos::RCP<const import_type>& nonoverlappingImporter,
                       const Teuchos::RCP<const import_type>& overlappingImporter);
  virtual ~OverlappingRowGraph ();



  virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm () const;

#ifdef TPETRA_ENABLE_DEPRECATED_CODE
  virtual TPETRA_DEPRECATED Teuchos::RCP<node_type> getNode () const;
#endif // TPETRA_ENABLE_DEPRECATED_CODE

  virtual Teuchos::RCP<const map_type> getRowMap () const;

  virtual Teuchos::RCP<const map_type> getColMap () const;

  virtual Teuchos::RCP<const map_type> getDomainMap () const;

  virtual Teuchos::RCP<const map_type> getRangeMap () const;

  virtual Teuchos::RCP<const import_type> getImporter () const;

  virtual Teuchos::RCP<const export_type> getExporter () const;

  virtual global_size_t getGlobalNumRows () const;

  virtual global_size_t getGlobalNumCols () const;

  virtual size_t getNodeNumRows () const;

  virtual size_t getNodeNumCols () const;

  virtual global_ordinal_type getIndexBase () const;

  virtual global_size_t getGlobalNumEntries () const;

  virtual size_t getNodeNumEntries () const;

  virtual size_t getNumEntriesInGlobalRow (global_ordinal_type globalRow) const;

  virtual size_t getNumEntriesInLocalRow (local_ordinal_type localRow) const;

  virtual size_t getGlobalMaxNumRowEntries () const;

  virtual size_t getNodeMaxNumRowEntries() const;

  virtual bool hasColMap() const;

  virtual bool isLocallyIndexed () const;

  virtual bool isGloballyIndexed () const;

  virtual bool isFillComplete() const;



  virtual void
  getGlobalRowCopy (global_ordinal_type globalRow,
                    const Teuchos::ArrayView<global_ordinal_type>& indices,
                    size_t& numIndices) const;

  virtual void
  getLocalRowCopy (local_ordinal_type localRow,
                   const Teuchos::ArrayView<local_ordinal_type>& indices,
                   size_t& numIndices) const;
private:

  Teuchos::RCP<const row_graph_type> nonoverlappingGraph_;
  Teuchos::RCP<const row_graph_type> overlappingGraph_;
  Teuchos::RCP<const map_type> rowMap_;
  Teuchos::RCP<const map_type> colMap_;
  const Tpetra::global_size_t numGlobalRows_;
  const Tpetra::global_size_t numGlobalCols_;
  const Tpetra::global_size_t numGlobalNonzeros_;
  const size_t maxNumEntries_;
  Teuchos::RCP<const import_type> nonoverlappingImporter_;
  Teuchos::RCP<const import_type> overlappingImporter_;
};

} // namespace Details
} // namespace Ifpack2

#endif // IFPACK2_DETAILS_OVERLAPPINGROWGRAPH_DECL_HPP