Ioex_DecompositionData.h

Go to the documentation of this file.

/*
 * Copyright(C) 1999-2025 National Technology & Engineering Solutions
 * of Sandia, LLC (NTESS).  Under the terms of Contract DE-NA0003525 with
 * NTESS, the U.S. Government retains certain rights in this software.
 *
 * See packages/seacas/LICENSE for details
 */
#pragma once
 
#include <exodusII.h>
#if defined PARALLEL_AWARE_EXODUS
 
#include "Ioss_CodeTypes.h"
#include <vector>
 
#include "ioex_export.h"
#if !defined(NO_PARMETIS_SUPPORT)
#include <parmetis.h>
#endif
 
#undef MPICPP
#if !defined(NO_ZOLTAN_SUPPORT)
#include <zoltan_cpp.h>
#endif
#include "Ioss_Decomposition.h"
#include "Ioss_Map.h"
#include "Ioss_PropertyManager.h"
 
namespace Ioss {
  class Field;
  class ElementBlock;
} // namespace Ioss
namespace Ioex {
  struct IOEX_EXPORT BlockFieldData
  {
    int64_t             id{0};
    size_t              comp_count{0};
    Ioss::NameList      var_name;
    std::vector<size_t> var_index;
 
    BlockFieldData() : id(0), comp_count(0) {}
    BlockFieldData(const int64_t id_) : id(id_), comp_count(0) {}
    BlockFieldData(const int64_t id_, size_t comp_count_) : id(id_), comp_count(comp_count_) {}
  };
 
  class IOEX_EXPORT DecompositionDataBase
  {
  public:
    DecompositionDataBase(Ioss_MPI_Comm comm) : comm_(comm) {}
    DecompositionDataBase(const DecompositionDataBase &)            = delete;
    DecompositionDataBase &operator=(const DecompositionDataBase &) = delete;
 
    virtual ~DecompositionDataBase()               = default;
    IOSS_NODISCARD virtual int    int_size() const = 0;
    virtual void                  decompose_model(int filePtr, const std::string &filename) = 0;
    IOSS_NODISCARD virtual size_t ioss_node_count() const                                   = 0;
    IOSS_NODISCARD virtual size_t ioss_elem_count() const                                   = 0;
 
    IOSS_NODISCARD virtual int    spatial_dimension() const = 0;
    IOSS_NODISCARD virtual size_t global_node_count() const = 0;
    IOSS_NODISCARD virtual size_t global_elem_count() const = 0;
 
    IOSS_NODISCARD virtual size_t decomp_node_offset() const = 0;
    IOSS_NODISCARD virtual size_t decomp_node_count() const  = 0;
    IOSS_NODISCARD virtual size_t decomp_elem_offset() const = 0;
    IOSS_NODISCARD virtual size_t decomp_elem_count() const  = 0;
 
    IOSS_NODISCARD virtual std::vector<double> &centroids() = 0;
    IOSS_NODISCARD virtual std::vector<float>  &weights()   = 0;
 
    virtual void set_block_omissions(const Ioss::NameList &omissions) = 0;
 
    Ioss_MPI_Comm comm_;
 
    int m_processor{0};
    int m_processorCount{0};
 
    std::vector<Ioss::BlockDecompositionData> el_blocks;
    std::vector<Ioss::SetDecompositionData>   node_sets;
    std::vector<Ioss::SetDecompositionData>   side_sets;
 
    IOSS_NODISCARD const Ioss::SetDecompositionData &get_decomp_set(ex_entity_type type,
                                                                    ex_entity_id   id) const;
 
    template <typename T>
    void communicate_node_data(T *file_data, T *ioss_data, size_t comp_count) const;
 
    template <typename T>
    void communicate_element_data(T *file_data, T *ioss_data, size_t comp_count) const;
 
    void get_block_connectivity(int filePtr, void *data, int64_t id, size_t blk_seq,
                                size_t nnpe) const;
 
    void read_elem_proc_map(int filePtr, void *data) const;
 
    void get_node_entity_proc_data(void *entity_proc, const Ioss::MapContainer &node_map,
                                   bool do_map) const;
 
    int get_set_mesh_var(int filePtr, ex_entity_type type, ex_entity_id id,
                         const Ioss::Field &field, void *ioss_data) const;
 
    int get_set_mesh_double(int filePtr, ex_entity_type type, ex_entity_id id,
                            const Ioss::Field &field, double *ioss_data) const;
 
    IOSS_NODISCARD virtual size_t get_commset_node_size() const = 0;
 
    virtual int get_node_coordinates(int filePtr, double *ioss_data,
                                     const Ioss::Field &field) const                 = 0;
    virtual int get_one_attr(int exoid, ex_entity_type obj_type, ex_entity_id obj_id,
                             int attrib_index, double *attrib) const                 = 0;
    virtual int get_attr(int exoid, ex_entity_type obj_type, ex_entity_id obj_id, size_t attr_count,
                         double *attrib) const                                       = 0;
    virtual int get_var(int filePtr, int step, ex_entity_type type, int var_index, ex_entity_id id,
                        int64_t num_entity, std::vector<double> &data) const         = 0;
    virtual int get_user_map(int exoid, ex_entity_type obj_type, ex_entity_id id, int map_index,
                             size_t offset, size_t num_entity, void *map_data) const = 0;
  };
 
  template <typename INT> class DecompositionData : public DecompositionDataBase
  {
  public:
    DecompositionData(const Ioss::PropertyManager &props, Ioss_MPI_Comm communicator);
 
    IOSS_NODISCARD int int_size() const { return sizeof(INT); }
 
    void decompose_model(int filePtr, const std::string &filename);
 
    IOSS_NODISCARD int spatial_dimension() const { return m_decomposition.m_spatialDimension; }
 
    IOSS_NODISCARD size_t global_node_count() const { return m_decomposition.global_node_count(); }
    IOSS_NODISCARD size_t global_elem_count() const { return m_decomposition.global_elem_count(); }
 
    IOSS_NODISCARD size_t ioss_node_count() const { return m_decomposition.ioss_node_count(); }
    IOSS_NODISCARD size_t ioss_elem_count() const { return m_decomposition.ioss_elem_count(); }
 
    IOSS_NODISCARD size_t decomp_node_offset() const { return m_decomposition.file_node_offset(); }
    IOSS_NODISCARD size_t decomp_node_count() const { return m_decomposition.file_node_count(); }
    IOSS_NODISCARD size_t decomp_elem_offset() const { return m_decomposition.file_elem_offset(); }
    IOSS_NODISCARD size_t decomp_elem_count() const { return m_decomposition.file_elem_count(); }
 
    IOSS_NODISCARD std::vector<double> &centroids() { return m_decomposition.m_centroids; }
    IOSS_NODISCARD std::vector<float> &weights() { return m_decomposition.m_weights; }
 
    void set_block_omissions(const Ioss::NameList &omissions)
    {
      m_decomposition.set_block_omissions(omissions);
    }
 
    template <typename T>
    void communicate_element_data(T *file_data, T *ioss_data, size_t comp_count) const
    {
      m_decomposition.communicate_element_data(file_data, ioss_data, comp_count);
    }
 
    template <typename T>
    void communicate_set_data(T *file_data, T *ioss_data, const Ioss::SetDecompositionData &set,
                              size_t comp_count) const
    {
      m_decomposition.communicate_set_data(file_data, ioss_data, set, comp_count);
    }
 
    template <typename T>
    void communicate_node_data(T *file_data, T *ioss_data, size_t comp_count) const
    {
      m_decomposition.communicate_node_data(file_data, ioss_data, comp_count);
    }
 
    void get_block_connectivity(int filePtr, INT *data, int64_t id, size_t blk_seq,
                                size_t nnpe) const;
 
    IOSS_NODISCARD size_t get_commset_node_size() const
    {
      return m_decomposition.m_nodeCommMap.size() / 2;
    }
 
    int get_attr(int filePtr, ex_entity_type obj_type, ex_entity_id id, size_t attr_count,
                 double *attrib) const;
    int get_one_attr(int filePtr, ex_entity_type obj_type, ex_entity_id id, int attrib_index,
                     double *attrib) const;
 
    int get_var(int filePtr, int step, ex_entity_type type, int var_index, ex_entity_id id,
                int64_t num_entity, std::vector<double> &data) const;
 
    int get_user_map(int exoid, ex_entity_type obj_type, ex_entity_id id, int map_index,
                     size_t offset, size_t num_entity, void *map_data) const;
 
    template <typename T>
    int get_set_mesh_var(int filePtr, ex_entity_type type, ex_entity_id id,
                         const Ioss::Field &field, T *ioss_data) const;
 
    IOSS_NODISCARD size_t get_block_seq(ex_entity_type type, ex_entity_id id) const;
    IOSS_NODISCARD size_t get_block_element_count(size_t blk_seq) const;
    IOSS_NODISCARD size_t get_block_element_offset(size_t blk_seq) const;
 
    void create_implicit_global_map(const std::vector<int> &owning_proc,
                                    std::vector<int64_t> &global_implicit_map, Ioss::Map &node_map,
                                    int64_t *locally_owned_count, int64_t *processor_offset);
 
    // global_index is 1-based index into global list of nodes [1..global_node_count]
    // return value is 1-based index into local list of nodes on this
    // processor (ioss-decomposition)
    IOSS_NODISCARD size_t node_global_to_local(size_t global_index) const
    {
      return m_decomposition.node_global_to_local(global_index);
    }
 
    IOSS_NODISCARD size_t elem_global_to_local(size_t global_index) const
    {
      return m_decomposition.elem_global_to_local(global_index);
    }
 
  private:
#if !defined(NO_ZOLTAN_SUPPORT)
    void zoltan_decompose(const std::string &method);
#endif
 
#if !defined(NO_PARMETIS_SUPPORT)
    void metis_decompose(const std::string &method, const std::vector<INT> &element_dist);
 
    void internal_metis_decompose(const std::string &method, idx_t *element_dist, idx_t *pointer,
                                  idx_t *adjacency, idx_t *elem_partition);
#endif
 
    void simple_decompose(const std::string &method, const std::vector<INT> &element_dist)
    {
      m_decomposition.simple_decompose(method, element_dist);
    }
 
    void simple_node_decompose(const std::string &method, const std::vector<INT> &node_dist);
 
    template <typename T>
    int handle_sset_df(int filePtr, ex_entity_id id, const Ioss::Field &field, T *ioss_data) const;
 
    int get_one_set_attr(int filePtr, ex_entity_type type, ex_entity_id id, int attr_index,
                         double *ioss_data) const;
    int get_one_node_attr(int filePtr, ex_entity_id id, int attr_index, double *ioss_data) const;
    int get_one_elem_attr(int filePtr, ex_entity_id id, int attr_index, double *ioss_data) const;
 
    int get_set_attr(int filePtr, ex_entity_type type, ex_entity_id id, size_t comp_count,
                     double *ioss_data) const;
    int get_node_attr(int filePtr, ex_entity_id id, size_t comp_count, double *ioss_data) const;
    int get_elem_attr(int filePtr, ex_entity_id id, size_t comp_count, double *ioss_data) const;
 
    int get_elem_map(int filePtr, ex_entity_id blk_id, int map_index, size_t offset, size_t count,
                     void *ioss_data) const;
    int get_node_map(int filePtr, int map_index, size_t offset, size_t count,
                     void *ioss_data) const;
 
    int get_node_var(int filePtr, int step, int var_index, ex_entity_id id, int64_t num_entity,
                     std::vector<double> &ioss_data) const;
 
    int get_elem_var(int filePtr, int step, int var_index, ex_entity_id id, int64_t num_entity,
                     std::vector<double> &ioss_data) const;
 
    int get_set_var(int filePtr, int step, int var_index, ex_entity_type type, ex_entity_id id,
                    int64_t num_entity, std::vector<double> &ioss_data) const;
 
    IOSS_NODISCARD bool i_own_node(size_t node) const
    {
      // T/F if the node with global index `node` is owned by this processors ioss-decomp.
      return m_decomposition.i_own_node(node);
    }
 
    IOSS_NODISCARD bool i_own_elem(size_t elem) const
    // T/F if the element with global index `elem` is owned by this processors ioss-decomp.
    {
      return m_decomposition.i_own_elem(elem);
    }
 
    void build_global_to_local_elem_map() { m_decomposition.build_global_to_local_elem_map(); }
 
    void get_element_block_communication()
    {
      m_decomposition.get_element_block_communication(el_blocks);
    }
 
    void generate_adjacency_list(int filePtr, Ioss::Decomposition<INT> &decomposition);
    void generate_omitted_block_weights(int filePtr, Ioss::Decomposition<INT> &decomposition);
 
    void get_common_set_data(int filePtr, ex_entity_type set_type,
                             std::vector<Ioss::SetDecompositionData> &sets,
                             const std::string                       &set_type_name);
 
    void get_nodeset_data(int filePtr, size_t set_count);
 
    void get_sideset_data(int filePtr, size_t set_count);
 
    void calculate_element_centroids(int filePtr, const std::vector<INT> &node_dist);
#if !defined(NO_ZOLTAN_SUPPORT)
    void get_local_element_list(const ZOLTAN_ID_PTR &export_global_ids, size_t export_count);
#endif
 
    void get_shared_node_list() { m_decomposition.get_shared_node_list(); }
 
    int get_node_coordinates(int filePtr, double *ioss_data, const Ioss::Field &field) const;
 
    void get_local_node_list() { m_decomposition.get_local_node_list(); }
 
  public:
    Ioss::Decomposition<INT> m_decomposition;
  };
 
  class IOEX_EXPORT ElementBlockBatchReader
  {
  public:
    ElementBlockBatchReader(const DecompositionDataBase *decompDB);
 
    IOSS_NODISCARD size_t
    get_connectivity_size(const std::vector<int64_t> &blocks_subset_index) const;
 
    IOSS_NODISCARD std::vector<size_t>
                   get_connectivity(int filePtr, const std::vector<int64_t> &blocks_subset_index,
                                    void *data) const;
 
    IOSS_NODISCARD std::vector<size_t>
                   get_offset(const std::vector<int64_t> &blocks_subset_index,
                              const std::vector<int>     &block_component_count) const;
 
    void get_field_data(int filePtr, void *data, const std::vector<int64_t> &blocks_subset_index,
                        size_t step, const std::vector<BlockFieldData> &block_data) const;
 
  private:
    const DecompositionDataBase  *m_decompositionDB{nullptr};
    Ioss::ElementBlockBatchOffset m_batchOffset;
 
    template <typename INT>
    std::vector<size_t> get_connectivity_impl(int                         filePtr,
                                              const std::vector<int64_t> &blocks_subset_index,
                                              void                       *data) const;
 
    template <typename INT>
    void get_field_data_impl(int filePtr, void *iossData,
                             const std::vector<int64_t> &blocks_subset_index, size_t step,
                             const std::vector<BlockFieldData> &block_data) const;
 
    template <typename INT>
    std::vector<size_t>
    get_connectivity_file_offset(const std::vector<int64_t> &blocks_subset_index) const;
 
    template <typename INT>
    std::vector<size_t> get_file_offset(const std::vector<int64_t> &blocks_subset_index,
                                        const std::vector<int>     &block_component_count) const;
 
    std::vector<int>
    get_connectivity_component_count(const std::vector<int64_t> &blocks_subset_index) const;
 
    std::vector<int>
    get_block_component_count(const std::vector<int64_t>        &blockSubsetIndex,
                              const std::vector<BlockFieldData> &blockFieldData) const;
 
    template <typename INT>
    void load_field_data(int filePtr, double *fileData,
                         const std::vector<int64_t> &blockSubsetIndex, size_t step,
                         const std::vector<BlockFieldData> &blockFieldData,
                         const std::vector<int>            &blockComponentCount,
                         const std::vector<size_t>         &fileConnOffset) const;
  };
} // namespace Ioex
#endif