QueryObject.hpp

Go to the documentation of this file.

//@HEADER
//************************************************************************
//
//              Isorropia: Partitioning and Load Balancing Package
//                Copyright (2006) 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.
//
//************************************************************************
//@HEADER

#ifndef ISORROPIA_EPETRA_ZOLTAN_QUERYOBJECT_H
#define ISORROPIA_EPETRA_ZOLTAN_QUERYOBJECT_H

#include "Isorropia_ConfigDefs.hpp"

#include <Teuchos_RCP.hpp>

#include <zoltan_cpp.h>

#include <set>
#include <map>

class Epetra_BlockMap;
class Epetra_CrsGraph;
class Epetra_RowMatrix;
class Epetra_MultiVector;

namespace Isorropia {

namespace Epetra {

  class CostDescriber;

namespace ZoltanLib {

class QueryObject
{

  const bool haveGraph_;

  Teuchos::RCP<const Epetra_CrsGraph> graph_;

  Teuchos::RCP<const Epetra_RowMatrix> matrix_;

  Teuchos::RCP<const Epetra_MultiVector> coords_;

  const Epetra_BlockMap *rowMap_;

  const Epetra_BlockMap *colMap_;

  Teuchos::RCP<const Isorropia::Epetra::CostDescriber> costs_;

  Teuchos::RCP<const Epetra_MultiVector> weights_;

  std::map<int,int> procmap_;
  std::set<int> graph_self_edges_;

  unsigned int myProc_;
  unsigned int base_;

  void fill_procmap();

  int My_Number_Objects(int *ierr);

  void My_Object_List  (int num_gid_entries, int num_lid_entries,
         ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int weight_dim, float * object_weights, int * ierr );

  void My_Number_Edges_Multi  (int num_gid_entries, int num_lid_entries,
         int num_obj, ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int *num_edges, int * ierr );

  void My_Edge_List_Multi(int num_gid_entries, int num_lid_entries,
         int num_obj, ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int *num_edges, ZOLTAN_ID_PTR neighbor_global_ids, int * neighbor_procs,
         int weight_dim, float * edge_weights, int * ierr );

  void My_HG_Size_CS (int* num_lists, int* num_pins, int* format,
        int * ierr );

  void My_HG_CS (int num_gid_entries, int num_row_or_col, int num_pins,
     int format, ZOLTAN_ID_PTR vtxedge_GID, int* vtxedge_ptr, ZOLTAN_ID_PTR pin_GID,
               int * ierr );


  void My_FGHG_CS (int num_gid_entries, int num_row_or_col, int num_pins,
     int format, ZOLTAN_ID_PTR vtxedge_GID, int* vtxedge_ptr, ZOLTAN_ID_PTR pin_GID,
               int * ierr );

  void My_HG_Size_Edge_Weights(int* num_edges, int* ierr);
  
  void My_HG_Edge_Weights(int num_gid_entries, int num_lid_entries, int num_edges, int edge_weight_dim,
        ZOLTAN_ID_PTR edge_GID, ZOLTAN_ID_PTR edge_LID, float* edge_weights, int* ierr);

  int My_Number_Geom(int *ierr);

  void My_Geom_Multi(int num_gid_entries, int num_lid_entries,
        int num_obj, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int num_dim,
        double *geom_vec, int *ierr);

 public:

  QueryObject( Teuchos::RCP<const Epetra_CrsGraph> graph,
         Teuchos::RCP<const Isorropia::Epetra::CostDescriber> costs,
         int inputType);


  QueryObject( Teuchos::RCP<const Epetra_RowMatrix> matrix,
         Teuchos::RCP<const Isorropia::Epetra::CostDescriber> costs,
         int inputType);

  QueryObject( Teuchos::RCP<const Epetra_MultiVector> coords,
               Teuchos::RCP<const Epetra_MultiVector> weights);


  QueryObject(Teuchos::RCP<const Epetra_CrsGraph> graph,
        Teuchos::RCP<const Isorropia::Epetra::CostDescriber> costs, 
              Teuchos::RCP<const Epetra_MultiVector> coords,
              Teuchos::RCP<const Epetra_MultiVector> weights,
              int inputType);


  QueryObject(Teuchos::RCP<const Epetra_RowMatrix> matrix,
        Teuchos::RCP<const Isorropia::Epetra::CostDescriber> costs,
              Teuchos::RCP<const Epetra_MultiVector> coords,
              Teuchos::RCP<const Epetra_MultiVector> weights,
              int inputType);


  QueryObject( Teuchos::RCP<const Epetra_BlockMap> inputMap,
         int inputType);




  virtual ~QueryObject();

  static const int hgraph_input_ = 1;

  static const int hgraph2d_finegrain_input_ = 2;

  static const int graph_input_ = 3;

  static const int geometric_input_ = 4;

  static const int hgraph_graph_input_ = 5;

  static const int hgraph_geometric_input_ = 6;

  static const int graph_geometric_input_ = 7;

  static const int hgraph_graph_geometric_input_ = 8;

  static const int simple_input_ = 9;


  static const int unspecified_input_ = 10;



  int input_type_;

  const Epetra_BlockMap &RowMap(void){ return *rowMap_;};

  bool haveVertexWeights();

  bool haveGraphEdgeWeights();

  bool haveHypergraphEdgeWeights();

  // General query functions

  static int Number_Objects(void *data, int *ierr);
  
  static void Object_List  ( void * data, int num_gid_entries, int num_lid_entries,
         ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int weight_dim, float * object_weights, int * ierr );

  // Query functions for graph partitioning only
  
  static void Number_Edges_Multi  ( void * data, int num_gid_entries, int num_lid_entries,
         int num_obj, ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int *num_edges, int * ierr );

  static void Edge_List_Multi( void * data, int num_gid_entries, int num_lid_entries,
         int num_obj, ZOLTAN_ID_PTR global_ids, ZOLTAN_ID_PTR local_ids,
         int *num_edges, ZOLTAN_ID_PTR neighbor_global_ids, int * neighbor_procs,
         int weight_dim, float * edge_weights, int * ierr );

  // Query functions for hypergraph partitioning only
  
  static void HG_Size_CS ( void * data, int* num_lists, int* num_pins, int* format,
        int * ierr );
  static void HG_CS ( void * data, int num_gid_entries, int num_row_or_col, int num_pins,
     int format, ZOLTAN_ID_PTR vtxedge_GID, int* vtxedge_ptr, ZOLTAN_ID_PTR pin_GID,
               int * ierr );
  static void HG_Size_Edge_Weights(void * data, int* num_edges, int* ierr);
  
  static void HG_Edge_Weights(void * data,
        int num_gid_entries, int num_lid_entries, int num_edges, int edge_weight_dim,
        ZOLTAN_ID_PTR edge_GID, ZOLTAN_ID_PTR edge_LID, float* edge_weights, int* ierr);

  static int Number_Geom(void *data, int *ierr);

  static void Geom_Multi(void *data, int num_gid_entries, int num_lid_entries,
        int num_obj, ZOLTAN_ID_PTR gids, ZOLTAN_ID_PTR lids, int num_dim,
        double *geom_vec, int *ierr);


  //M.M.W. need to add hierarchical query functions

};

} //namespace ZoltanLib
} //namespace Epetra
} //namespace Isorropia

#endif //ISORROPIA_EPETRA_ZOLTAN_QUERYOBJECT_H

#if defined(Isorropia_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Isorropia package is deprecated"
#endif
#endif