ZoltanPartitioner.hpp

Go to the documentation of this file.

/**
 * MOAB, a Mesh-Oriented datABase, is a software component for creating,
 * storing and accessing finite element mesh data.
 *
 * Copyright 2004 Sandia Corporation.  Under the terms of Contract
 * DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
 * retains certain rights in this software.
 *
 * 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.
 *
 */

/**
 * Zoltan: class to get a mesh from MOAB and write a Zoltan partition set for
 * that mesh back into MOAB and to a file
 *
 */

#ifndef ZOLTANPARTITIONER_HPP
#define ZOLTANPARTITIONER_HPP

#include <cstdlib>
#include "moab/PartitionerBase.hpp"
#include "zoltan_cpp.h"
#include <ctime>

#ifdef MOAB_HAVE_CGM
#include <map>
#include "GeometryQueryTool.hpp"
#include "DLIList.hpp"
class RefEntity;
#endif

extern "C" {
int mbGetNumberOfAssignedObjects( void* userDefinedData, int* err );

void mbGetObjectList( void* userDefinedData,
                      int numGlobalIds,
                      int numLids,
                      ZOLTAN_ID_PTR gids,
                      ZOLTAN_ID_PTR lids,
                      int wgt_dim,
                      float* obj_wgts,
                      int* err );

int mbGetObjectSize( void* userDefinedData, int* err );

void mbGetObject( void* userDefinedData,
                  int numGlobalIds,
                  int numLids,
                  int numObjs,
                  ZOLTAN_ID_PTR gids,
                  ZOLTAN_ID_PTR lids,
                  int numDim,
                  double* pts,
                  int* err );

void mbGetNumberOfEdges( void* userDefinedData,
                         int numGlobalIds,
                         int numLids,
                         int numObjs,
                         ZOLTAN_ID_PTR gids,
                         ZOLTAN_ID_PTR lids,
                         int* numEdges,
                         int* err );

void mbGetEdgeList( void* userDefinedData,
                    int numGlobalIds,
                    int numLids,
                    int numObjs,
                    ZOLTAN_ID_PTR gids,
                    ZOLTAN_ID_PTR lids,
                    int* numEdges,
                    ZOLTAN_ID_PTR nborGlobalIds,
                    int* nborProcs,
                    int wgt_dim,
                    float* edge_wgts,
                    int* err );

void mbGetPart( void* userDefinedData,
                int numGlobalIds,
                int numLids,
                int numObjs,
                ZOLTAN_ID_PTR gids,
                ZOLTAN_ID_PTR lids,
                int* part,
                int* err );

void mbShowError( int val, const char* s, int me );

void mbPrintGlobalResult( const char* s, int begin, int import, int exp, int change );
}

#include <vector>

namespace moab
{

class ParallelComm;
class Interface;
class Range;
}  // namespace moab

using namespace moab;

class ZoltanPartitioner : public PartitionerBase< int >
{

  public:
    ZoltanPartitioner( Interface* impl = NULL,
#ifdef MOAB_HAVE_MPI
                       ParallelComm* parcomm = NULL,
#endif
                       const bool use_coords = false,
                       int argc              = 0,
                       char** argv           = NULL
#ifdef MOAB_HAVE_CGM
                       ,
                       GeometryQueryTool* gqt = NULL
#endif

    );

    virtual ~ZoltanPartitioner();

    ErrorCode balance_mesh( const char* zmethod,
                            const char* other_method,
                            const bool write_as_sets = true,
                            const bool write_as_tags = false );

    virtual ErrorCode partition_mesh_and_geometry( const double part_geom_mesh_size,
                                                   const int nparts,
                                                   const char* zmethod,
                                                   const char* other_method,
                                                   double imbal_tol,
                                                   const int part_dim           = 3,
                                                   const bool write_as_sets     = true,
                                                   const bool write_as_tags     = false,
                                                   const int obj_weight         = 0,
                                                   const int edge_weight        = 0,
                                                   const bool part_surf         = false,
                                                   const bool ghost             = false,
                                                   const int projection_type    = 0,
                                                   const bool recompute_rcb_box = false,
                                                   const bool print_time        = false );

    virtual ErrorCode partition_mesh( const int nparts,
                                      const char* method,
                                      const int part_dim               = 3,
                                      const bool write_as_sets         = true,
                                      const bool write_as_tags         = false,
                                      const bool partition_tagged_sets = false,
                                      const bool partition_tagged_ents = false,
                                      const char* aggregating_tag      = NULL,
                                      const bool print_time            = false );

    // given a processor assignment returned from Zoltan, use that to infer a partition
    // to generate processor assignment for a new MOAB mesh in specified fileset
    ErrorCode partition_inferred_mesh( EntityHandle sfileset,
                                       size_t num_parts,
                                       int part_dim             = 3,
                                       const bool write_as_sets = true,
                                       int projection_type      = 0 );

    // given a processor assignment returned from Zoltan, write that as a
    // processor assignment to MOAB
    virtual ErrorCode write_partition( const int nparts,
                                       Range& elems,
                                       const int* assignment,
                                       const bool write_as_sets,
                                       const bool write_as_tags );

    // given x, y, z and a starting id, return where to send to each (x[i],y[i],z[i]) point
    ErrorCode repartition( std::vector< double >& x,
                           std::vector< double >& y,
                           std::vector< double >& z,
                           int StartID,
                           const char* zmethod,
                           Range& localGIDs );

    // partition owned cell in a new number of parts, based on adjacency
    // we might have some extra adjacencies expressed in extraAdjCellsId, which could point to a
    // cell on a different task

    ErrorCode partition_owned_cells( Range& owned,
                                     std::multimap< int, int >& extraGraphEdges,
                                     std::map< int, int > procs,
                                     int& numNewPartitions,
                                     std::map< int, Range >& distribution,
                                     int met,
                                     std::vector< char >& ZoltanBuffer );

#ifdef MOAB_HAVE_CGM
    ErrorCode write_partition( const int nparts,
                               DLIList< RefEntity* > entities,
                               const int* assignment,
                               std::vector< double >& obj_weights,
                               const bool part_surf,
                               const bool ghost );

    ErrorCode partition_surface( const int nparts,
                                 DLIList< RefEntity* > entities,
                                 const int* assignment,
                                 std::vector< double >& obj_weights );
#endif

    // put closure of entities in the part sets too
    ErrorCode include_closure();

    // virtual ErrorCode write_file(const char *filename, const char *out_file);

    void SetOCTPART_Parameters( const char* oct_method );

    void SetPARMETIS_Parameters( const char* parmetis_method );

    void SetHypergraph_Parameters( const char* phg_method );

    void SetHSFC_Parameters();

    void SetRIB_Parameters();

    void SetRCB_Parameters( const bool recompute_rcb_box = false );

  private:
    Zoltan* myZZ;

    Range partSets;

    int myNumPts;

    int argcArg;

    char** argvArg;

    int mbGlobalSuccess( int rc );

    void mbPrintGlobalResult( const char* s, int begin, int import, int exp, int change );

    void mbShowError( int val, const char* s );

    // given the dimension, assemble the vertices and store in coords and
    // moab_ids
    ErrorCode assemble_graph( const int dimension,
                              std::vector< double >& coords,
                              std::vector< int >& moab_ids,
                              std::vector< int >& adjacencies,
                              std::vector< int >& length,
                              Range& elems,
                              bool part_geom            = false,
                              const int projection_type = 0 );

#ifdef MOAB_HAVE_CGM
    std::map< int, int > body_vertex_map, surf_vertex_map;

    ErrorCode assemble_graph( const int dimension,
                              std::vector< double >& coords,
                              std::vector< int >& moab_ids,
                              std::vector< int >& adjacencies,
                              std::vector< int >& length,
                              std::vector< double >& obj_weights,
                              std::vector< double >& edge_weights,
                              std::vector< int >& parts,
                              DLIList< RefEntity* >& entities,
                              const double part_geom_mesh_size,
                              const int n_part );

    ErrorCode partition_round_robin( const int n_part );

    ErrorCode partition_child_entities( const int dim,
                                        const int n_part,
                                        const bool partition_surf,
                                        const bool ghost = false );

    double estimate_face_mesh_load( RefEntity* face, const double h );
    double estimate_face_comm_load( RefEntity* face, const double h );
#endif

    void mbFinalizePoints( int npts, int numExport, ZOLTAN_ID_PTR exportLocalIDs, int* exportProcs, int** assignment );

    int mbInitializePoints( int npts,
                            double* pts,
                            int* ids,
                            int* adjs,
                            int* length,
                            double* obj_weights  = NULL,
                            double* edge_weights = NULL,
                            int* parts           = NULL,
                            bool part_geom       = false );

#ifdef MOAB_HAVE_CGM
    GeometryQueryTool* gti;
#endif
};

inline ErrorCode ZoltanPartitioner::partition_mesh( const int nparts,
                                                    const char* method,
                                                    const int part_dim,
                                                    const bool write_as_sets,
                                                    const bool write_as_tags,
                                                    const bool,
                                                    const bool,
                                                    const char*,
                                                    const bool print_time )
{
    return partition_mesh_and_geometry( -1.0, nparts, method, NULL, 1.03, part_dim, write_as_sets, write_as_tags, 0, 0,
                                        false, false, 0, false, print_time );
}

#endif