UCDUtilities.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 __UCDUtilities_H
#define __UCDUtilities_H
 
#include "Eigen/Eigen"
#include <list>
#include <string>
 
namespace Gedim
{
template <typename T> struct UCDProperty final
{
    std::string Label;
    std::string UnitLabel;
 
    unsigned int Size;
    unsigned int NumComponents;
    const T *Data;
};
 
class UCDCell final
{
  public:
    enum struct Types
    {
        Unknown = -1,
        Point = 0,
        Line = 1,
        Triangle = 2,
        Quadrilateral = 3,
        Hexahedron = 4,
        Prism = 5,
        Tetrahedron = 6,
        Pyramid = 7
    };
 
    const Types Type;
    const std::vector<unsigned int> PointIds;
    const unsigned int MaterialId;
 
    UCDCell(const Types type, const std::vector<unsigned int> pointIds, const unsigned int materialId)
        : Type(type), PointIds(pointIds), MaterialId(materialId)
    {
    }
 
    const std::string CellLabel(const UCDCell::Types type) const;
};
 
class UCDUtilities final
{
  public:
    enum ExportFormats
    {
        Ascii = 0
    };
 
  private:
    std::vector<UCDCell> CreatePointCells(const Eigen::MatrixXd &points, const Eigen::VectorXi &materials) const;
    std::vector<UCDCell> CreateLineCells(const Eigen::MatrixXi &lines, const Eigen::VectorXi &materials) const;
    std::vector<UCDCell> CreatePolygonCells(const std::vector<std::vector<unsigned int>> &polygons_vertices,
                                            const Eigen::VectorXi &materials) const;
    std::vector<UCDCell> CreatePolyhedraCells(const std::vector<std::vector<unsigned int>> &polyhedra_vertices,
                                              const Eigen::VectorXi &materials) const;
 
    void ExportUCDAscii(const Eigen::MatrixXd &points,
                        const std::vector<UCDProperty<double>> &point_properties,
                        const std::vector<UCDCell> &cells,
                        const std::vector<UCDProperty<double>> &cell_properties,
                        const std::string &filePath) const;
 
  public:
    UCDUtilities()
    {
    }
    virtual ~UCDUtilities()
    {
    }
 
    void ExportPoints(const std::string &filePath,
                      const Eigen::MatrixXd &points,
                      const std::vector<UCDProperty<double>> &points_properties = {},
                      const Eigen::VectorXi &materials = {}) const;
 
    void ExportSegments(const std::string &filePath,
                        const Eigen::MatrixXd &points,
                        const Eigen::MatrixXi &segments,
                        const std::vector<UCDProperty<double>> &points_properties = {},
                        const std::vector<UCDProperty<double>> &segmnents_properties = {},
                        const Eigen::VectorXi &materials = {}) const;
 
    void ExportPolygons(const std::string &filePath,
                        const Eigen::MatrixXd &points,
                        const std::vector<std::vector<unsigned int>> &polygons_vertices,
                        const std::vector<UCDProperty<double>> &points_properties = {},
                        const std::vector<UCDProperty<double>> &polygons_properties = {},
                        const Eigen::VectorXi &materials = {}) const;
 
    void ExportPolyhedra(const std::string &filePath,
                         const Eigen::MatrixXd &points,
                         const std::vector<std::vector<unsigned int>> &polyhedra_vertices,
                         const std::vector<UCDProperty<double>> &points_properties = {},
                         const std::vector<UCDProperty<double>> &polyhedra_properties = {},
                         const Eigen::VectorXi &materials = {}) const;
};
} // namespace Gedim
 
#endif // __UCDUtilities_H