MetisUtilities.hpp

Go to the documentation of this file.

// _LICENSE_HEADER_
//
// Copyright (C) 2019 - 2025.
// Terms register on the GPL-3.0 license.
//
// This file can be redistributed and/or modified under the license terms.
//
// See top level LICENSE file for more details.
//
// This file can be used citing references in CITATION.cff file.
 
#ifndef __METIS_UTILITIES_H
#define __METIS_UTILITIES_H
 
#include "Eigen/Eigen"
#include "IMeshDAO.hpp"
#include <vector>
 
namespace Gedim
{
class MetisUtilities final
{
  public:
    struct NetworkPartitionOptions final
    {
        enum struct PartitionTypes
        {
            Unknown = -1,
            CutBalancing = 0,
            VolBalancing = 1
        };
 
        enum struct CoarseningSchemes
        {
            Default = -1, // METIS_CTYPE_SHEM
            METIS_CTYPE_RM = 0,
            METIS_CTYPE_SHEM = 1
        };
 
        enum struct InitialPartitioningSchemes
        {
            Default = -1, // METIS_IPTYPE_METISRB
            METIS_IPTYPE_GROW = 0,
            METIS_IPTYPE_RANDOM = 1,
            METIS_IPTYPE_EDGE = 2,
            METIS_IPTYPE_NODE = 3,
            METIS_IPTYPE_METISRB = 4
        };
 
        enum struct RefinementSchemes
        {
            Default = -1, // METIS_RTYPE_GREEDY
            METIS_RTYPE_FM = 0,
            METIS_RTYPE_GREEDY = 1,
            METIS_RTYPE_SEP2SIDED = 2,
            METIS_RTYPE_SEP1SIDED = 3
        };
 
        enum struct DebugLevels
        {
            None = -1,
            METIS_DBG_INFO = 1,         
            METIS_DBG_TIME = 2,         
            METIS_DBG_COARSEN = 4,      
            METIS_DBG_REFINE = 8,       
            METIS_DBG_IPART = 16,       
            METIS_DBG_MOVEINFO = 32,    
            METIS_DBG_SEPINFO = 64,     
            METIS_DBG_CONNINFO = 128,   
            METIS_DBG_CONTIGINFO = 256, 
            METIS_DBG_MEMORY = 2048     
        };
 
        PartitionTypes PartitionType = PartitionTypes::Unknown;
        CoarseningSchemes CoarseningSchema = CoarseningSchemes::Default;
        RefinementSchemes RefinementSchema = RefinementSchemes::Default;
        InitialPartitioningSchemes InitialPartitioningSchema = InitialPartitioningSchemes::Default;
        DebugLevels DebugLevel = DebugLevels::None;
        unsigned int NumberOfParts = 0;
        unsigned int NumberRefinementIterations = 10;
        bool ContigousPartitions = true;
        bool CompressGraph = false;
        bool MinimizeConnectivity = false;
        int RandomSeed = -1;
        unsigned int MasterWeight = 100; 
    };
 
    struct MetisNetwork final
    {
        struct MetisAdjacency final
        {
            std::vector<unsigned int> Rows;
            std::vector<unsigned int> Cols;
        };
 
        MetisAdjacency Adjacency;
        std::vector<bool> EdgesConstrained;
        std::vector<unsigned int> NodesWeight = {};
        std::vector<unsigned int> EdgesWeight = {};
    };
 
    struct MeshToNetwork final
    {
        std::vector<unsigned int> EdgesMeshCellIndex;
        MetisNetwork Network;
    };
 
  public:
    MetisUtilities();
    ~MetisUtilities();
 
    MetisUtilities::MeshToNetwork Mesh3DToDualGraph(
        const IMeshDAO &mesh,
        const std::vector<unsigned int> &cell3DsWeight = {},
        const std::vector<bool> &cell2DsConstrained = {},
        const Eigen::SparseMatrix<unsigned int> &networkEdgesWeight = Eigen::SparseMatrix<unsigned int>()) const;
    MetisUtilities::MeshToNetwork Mesh2DToDualGraph(
        const IMeshDAO &mesh,
        const std::vector<unsigned int> &cell2DsWeight = {},
        const std::vector<bool> &cell1DsConstrained = {},
        const Eigen::SparseMatrix<unsigned int> &networkEdgesWeight = Eigen::SparseMatrix<unsigned int>()) const;
    MetisUtilities::MetisNetwork MeshToGraph(const unsigned int &numVertices,
                                             const Eigen::MatrixXi &edges,
                                             const bool &undirectEdges,
                                             const std::vector<unsigned int> &verticesWeight = {},
                                             const std::vector<unsigned int> &edgesWeight = {}) const;
 
    MetisNetwork::MetisAdjacency GraphAdjacencyToMetisAdjacency(const std::vector<std::vector<unsigned int>> &graphAdjacency) const;
    std::vector<std::vector<unsigned int>> MetisAdjacencyToGraphAdjacency(const MetisNetwork::MetisAdjacency &metisAdjacency) const;
 
    std::vector<unsigned int> NetworkPartition(const NetworkPartitionOptions &options, const MetisNetwork &network) const;
 
    std::vector<unsigned int> PartitionCheckConstraints(const MetisNetwork &network, const std::vector<unsigned int> &partitions) const;
    std::vector<unsigned int> PartitionCheckConnectedComponents(const MetisNetwork &network,
                                                                const std::vector<unsigned int> &partitions) const;
};
} // namespace Gedim
 
#endif // __METIS_UTILITIES_H