gmshMesh.H

Go to the documentation of this file.

/*******************************************************************************
* Promesh                                                                      *
* Copyright (C) 2022, IllinoisRocstar LLC. All rights reserved.                *
*                                                                              *
* Promesh is the property of IllinoisRocstar LLC.                              *
*                                                                              *
* IllinoisRocstar LLC                                                          *
* Champaign, IL                                                                *
* www.illinoisrocstar.com                                                      *
* promesh@illinoisrocstar.com                                                  *
*******************************************************************************/
/*******************************************************************************
* This file is part of Promesh                                                 *
*                                                                              *
* This version of Promesh 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 3 of the License,  *
* or (at your option) any later version.                                       *
*                                                                              *
* Promesh is distributed in the hope that it will be useful, but WITHOUT ANY   *
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    *
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more *
* details.                                                                     *
*                                                                              *
* You should have received a copy of the GNU Lesser General Public License     *
* along with this program. If not, see <https://www.gnu.org/licenses/>.        *
*                                                                              *
*******************************************************************************/
#ifndef NEMOSYS_GMSHMESH_H_
#define NEMOSYS_GMSHMESH_H_

#include "nemosys_export.h"

#include <gmsh/GModel.h>

#include "Mesh/meshBase.H"

class NEMOSYS_EXPORT gmshMesh : public meshBase {
  // --- constructors and destructors
  public:
    // default constructor
    gmshMesh();

    // construct from dataset
    gmshMesh(meshBase* mb);

    // initialize from a file name
    explicit gmshMesh(const std::string &fname);

    ~gmshMesh() override;

  // --- diagnostics
  public:
    void report() const override;

  // --- access
  public:
    // get point with id
    std::vector<double> getPoint(nemId_t id) const override;
    // get 3 vecs with x,y and z coords
    std::vector<std::vector<double>> getVertCrds() const override;
    // get cell with id : returns point indices and respective coordinates
    std::map<nemId_t, std::vector<double>>
    getCell(nemId_t id) const override;
    // get vector of coords of cell with id
    std::vector<std::vector<double>> getCellVec(nemId_t id) const override;
    // get edge lengths of dataSet
    void inspectEdges(const std::string& ofname) const override;
    // extract the surface mesh
    vtkSmartPointer<vtkDataSet> extractSurface() override;
    // get diameter of circumsphere of each cell
    std::vector<double> getCellLengths() const override;
    // get center of a cell
    std::vector<double> getCellCenter(nemId_t cellID) const override;
    // get cell type as an integer
    // assumes all elements are the same type
    int getCellType() const override;
    // get connectivities. this is only safe to use if mesh has cells of the same type
    // or you have information on the number of cells of each type and the order in
    // which they appear (for look up in resulting vector)
    std::vector<nemId_t> getConnectivities() const override;

  // --- read, write and conversion
  public:
    // intended to be used only for reading gmsh mesh files
    void read(const std::string &fname);    
    // write the mesh to file named fname
    using meshBase::write;
    void write(const std::string &fname) const override;
    void write(const std::string &fname, double mshFileVersion,
               bool binary) const;

  //   --- Gmsh data types
  private:
//    GModel _gmshGModel;
};

#endif  // NEMOSYS_GMSHMESH_H_