【网格生成】Gmsh快速入门教程 --3.Gmsh API

在前面两篇文章1、2中我们分别介绍了图形化界面和内置解析器geo脚本的使用方式。今天来介绍下Gmsh的第三种使用方式：使用Gmsh API将其集成到其他软件中。

意义

将网格生成器与求解器等软件对接形成整体框架。

获取Gmsh API几种方式

• 通过官网下载SDK http://www.gmsh.info/bin/Windows/gmsh-git-Windows64-sdk.zip
• pip install --upgrade gmsh (Python)
• 在编译时加上 cmake -DENABLE_BUILD_DYNAMIC=1 …选项

使用

使用Gmsh API时只需引入导入其对应的库即可，下面以c++版本为例。代码是官方教程的x1.cpp基础上稍作修改，在一些需关注的部分添加了中文注释。在编译时需加上-lgmsh选项以包括动态链接库。

// -----------------------------------------------------------------------------
//
//  Gmsh C++ extended tutorial 1
//
//  Geometry and mesh data
//
// -----------------------------------------------------------------------------

// The C++ API allows to do much more than what can be done in .geo files. These
// additional features are introduced gradually in the extended tutorials,
// starting with `x1.cpp'.

// In this first extended tutorial, we start by using the API to access basic
// geometrical and mesh data.

#include <iostream>
#include <gmsh.h>

int main(int argc, char **argv)
{
  // 判断输入参数数量是否符合要求。
  if(argc < 2) {
    std::cout << "Usage: " << argv[0] << " file" << std::endl;
    return 0;
  }
  std::cout<<"modify by djm"<<std::endl;
  // 在使用Gmsh API之前必须调用的初试函数
  gmsh::initialize();
  // 命令行输出相关信息
  gmsh::option::setNumber("General.Terminal", 1);

  // You can run this tutorial on any file that Gmsh can read, e.g. a mesh file
  // in the MSH format: `t1.exe file.msh'
  // 使用open方法打开参数1的文件
  gmsh::open(argv[1]); 

  // Print the model name and dimension:
  std::string name;
  gmsh::model::getCurrent(name);
  // 生成三维网格
  gmsh::model::mesh::generate(3);

  // Geometrical data is made of elementary model `entities', called `points'
  // (entities of dimension 0), `curves' (entities of dimension 1), `surfaces'
  // (entities of dimension 2) and `volumes' (entities of dimension 3). As we
  // have seen in the other C++ tutorials, elementary model entities are
  // identified by their dimension and by a `tag': a strictly positive
  // identification number. Model entities can be either CAD entities (from the
  // built-in `geo' kernel or from the OpenCASCADE `occ' kernel) or `discrete'
  // entities (defined by a mesh). `Physical groups' are collections of model
  // entities and are also identified by their dimension and by a tag.

  // Get all the elementary entities in the model, as a vector of (dimension,
  // tag) pairs:
  std::vector<std::pair<int, int> > entities;
  // 获取实例。在Gmsh中点、边、面、体都称之为实例。
  gmsh::model::getEntities(entities);

  for(std::size_t i = 0; i < entities.size(); i++) {
    // Mesh data is made of `elements' (points, lines, triangles, ...), defined
    // by an ordered list of their `nodes'. Elements and nodes are identified by
    // `tags' as well (strictly positive identification numbers), and are stored
    // ("classified") in the model entity they discretize. Tags for elements and
    // nodes are globally unique (and not only per dimension, like entities).

    // A model entity of dimension 0 (a geometrical point) will contain a mesh
    // element of type point, as well as a mesh node. A model curve will contain
    // line elements as well as its interior nodes, while its boundary nodes
    // will be stored in the bounding model points. A model surface will contain
    // triangular and/or quadrangular elements and all the nodes not classified
    // on its boundary or on its embedded entities. A model volume will contain
    // tetrahedra, hexahedra, etc. and all the nodes not classified on its
    // boundary or on its embedded entities.

    // Dimension and tag of the entity:
    int dim = entities[i].first, tag = entities[i].second;

    // Get the mesh nodes for the entity (dim, tag):
    std::vector<std::size_t> nodeTags;
    std::vector<double> nodeCoords, nodeParams;
    gmsh::model::mesh::getNodes(nodeTags, nodeCoords, nodeParams, dim, tag);

    // Get the mesh elements for the entity (dim, tag):
    std::vector<int> elemTypes;
    std::vector<std::vector<std::size_t> > elemTags, elemNodeTags;
    gmsh::model::mesh::getElements(elemTypes, elemTags, elemNodeTags, dim, tag);

    // Let's print a summary of the information available on the entity and its
    // mesh.
    std::cout<<"******************************************************" <<std::endl;
    // * Type of the entity:
    std::string type;
    gmsh::model::getType(dim, tag, type);
    std::string name;
    gmsh::model::getEntityName(dim, tag, name);
    if(name.size()) name += " ";
    std::cout << "Entity " << name << "(" << dim << "," << tag << ") of type "
              << type << "\n";

    // * Number of mesh nodes and elements:
    int numElem = 0;
    for(std::size_t j = 0; j < elemTags.size(); j++)
      numElem += elemTags[j].size();
    std::cout << " - Mesh has " << nodeTags.size() << " nodes and " << numElem
              << " elements\n";
    std::cout<<"-----------------------------------------------------" <<std::endl;
    // * Entities on its boundary:
    std::vector<std::pair<int, int> > boundary;
    gmsh::model::getBoundary({{dim, tag}}, boundary);
    if(boundary.size()) {
      std::cout << " - Boundary entities: ";
      for(std::size_t j = 0; j < boundary.size(); j++)
        std::cout << "(" << boundary[j].first << "," << boundary[j].second
                  << ") ";
      std::cout << "\n";
    }
    std::cout<<"-----------------------------------------------------" <<std::endl;
    // * Does the entity belong to physical groups?
    std::vector<int> physicalTags;
    gmsh::model::getPhysicalGroupsForEntity(dim, tag, physicalTags);
    if(physicalTags.size()) {
      std::cout << " - Physical group: ";
      for(std::size_t j = 0; j < physicalTags.size(); j++) {
        std::string n;
        gmsh::model::getPhysicalName(dim, physicalTags[j], n);
        if(n.size()) n += " ";
        std::cout << n << "(" << dim << ", " << physicalTags[j] << ") ";
      }
      std::cout << "\n";
    }
  }
  // 将内存中的网格写入文件
  gmsh::write("yz.msh");
  // We can use this to clear all the model data:
  gmsh::clear();
  // 使用完毕后，调用终止函数
  gmsh::finalize();
  return 0;
}

总结

Gmsh API的使用方式还是比较简单的，通过查看官方的示例文件基本可以了解常用的函数。

全局的函数，如open、merge、write等一般直接在一级命名空间下，与几何相关的函数往往在model命名空间下，与网格划分相关的函数通常在mesh命名空间下。

如果后续涉及的是对网格数据结构的操作的话，需要明白Gmsh的网格是存储在对应的各个实体中的。举个例子，一个立方体划分完三维网格（其实会首先调用一维和二维网格划分），一维的线单元会保存在单元所在的边的对象内，二维单元保存在所在的面对象内，三维单元保存在体对象内。