Zoltan2_Model.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//
// Copyright 2012 NTESS and the Zoltan2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef _ZOLTAN2_MODEL_HPP_
#define _ZOLTAN2_MODEL_HPP_

#include <Zoltan2_Standards.hpp>
#include <bitset>

namespace Zoltan2 {

enum ModelType
{
  HypergraphModelType,
  GraphModelType,
  CoordinateModelType,
  IdentifierModelType,
  MAX_NUM_MODEL_TYPES
};



enum ModelFlags{
  // General flags
  GENERATE_CONSECUTIVE_IDS, 
  // Graph model flags
  BUILD_LOCAL_GRAPH, 
  SYMMETRIZE_INPUT_TRANSPOSE, 
  SYMMETRIZE_INPUT_BIPARTITE, 
  VERTICES_ARE_MATRIX_ROWS,   
  VERTICES_ARE_MATRIX_COLUMNS,
  VERTICES_ARE_MATRIX_NONZEROS, 
  VERTICES_ARE_MESH_NODES,    
  VERTICES_ARE_MESH_ELEMENTS, 
  REMOVE_SELF_EDGES,     
  BUILD_SUBSET_GRAPH,    
  NUM_MODEL_FLAGS
};

typedef std::bitset<NUM_MODEL_FLAGS> modelFlag_t;

template <typename Adapter>
class Model
{
public:

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef typename Adapter::lno_t       lno_t;
  typedef typename Adapter::gno_t       gno_t;
  typedef typename Adapter::scalar_t    scalar_t;
  typedef typename Adapter::user_t      user_t;
  typedef typename Adapter::userCoord_t userCoord_t;
#endif

  virtual ~Model() {};

  Model() {}

  virtual size_t getLocalNumObjects() const = 0;

  virtual global_size_t getGlobalNumObjects() const = 0;

protected:

private:

};

}   //  namespace Zoltan2

#endif