src/NETGENPlugin/NETGENPlugin_NETGEN_3D_SA.cxx

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //=============================================================================
  24 // File      : NETGENPlugin_NETGEN_3D_SA.cxx
  25 // Created   : lundi 19 Septembre 2022
  26 // Author    : Yoann AUDOUIN (CEA)
  27 // Project   : SALOME
  28 //=============================================================================
  29 //
  30 //
  31 #include "NETGENPlugin_NETGEN_3D_SA.hxx"
  32
  33 #include "NETGENPlugin_DriverParam.hxx"
  34 #include "NETGENPlugin_Hypothesis.hxx"
  35 #include "StdMeshers_MaxElementVolume.hxx"
  36
  37 #include <SMESH_Gen.hxx>
  38 #include <SMESH_Mesh.hxx>
  39 #include <SMESH_MesherHelper.hxx>
  40 #include <SMESH_DriverShape.hxx>
  41 #include <SMESH_DriverMesh.hxx>
  42 #include <SMESHDS_Mesh.hxx>
  43
  44
  45 #ifdef WIN32
  46 #include <filesystem>
  47 namespace fs = std::filesystem;
  48 #else
  49 #include <boost/filesystem.hpp>
  50 namespace fs = boost::filesystem;
  51 #endif
  52
  53 /*
  54   Netgen include files
  55 */
  56
  57 #ifndef OCCGEOMETRY
  58 #define OCCGEOMETRY
  59 #endif
  60 #include <occgeom.hpp>
  61
  62 #ifdef NETGEN_V5
  63 #include <ngexception.hpp>
  64 #endif
  65 #ifdef NETGEN_V6
  66 #include <core/exception.hpp>
  67 #endif
  68
  69 namespace nglib {
  70 #include <nglib.h>
  71 }
  72 namespace netgen {
  73
  74   NETGENPLUGIN_DLL_HEADER
  75   extern MeshingParameters mparam;
  76
  77   NETGENPLUGIN_DLL_HEADER
  78   extern volatile multithreadt multithread;
  79 }
  80 using namespace nglib;
  81
  82 //=============================================================================
  83 /*!
  84  * Constructor
  85  */
  86 //=============================================================================
  87
  88 NETGENPlugin_NETGEN_3D_SA::NETGENPlugin_NETGEN_3D_SA()
  89   :  NETGENPlugin_NETGEN_3D(0, new SMESH_Gen())
  90 {
  91   _name = "NETGEN_3D_SA";
  92 }
  93
  94 //=============================================================================
  95 /*!
  96  * Destructor
  97  */
  98 //=============================================================================
  99
 100 NETGENPlugin_NETGEN_3D_SA::~NETGENPlugin_NETGEN_3D_SA()
 101 {
 102   if(_gen)
 103     delete _gen;
 104 }
 105
 106 /**
 107  * @brief fill plugin hypothesis from the netgen_params structure
 108  *
 109  * @param aParams the structure
 110  * @param gen SMESH_Gen associate with the SA
 111  */
 112 void NETGENPlugin_NETGEN_3D_SA::fillHyp(netgen_params aParams)
 113 {
 114   if(aParams.has_netgen_param){
 115     NETGENPlugin_Hypothesis * hypParameters = new NETGENPlugin_Hypothesis(0, GetGen());
 116
 117     hypParameters->SetMaxSize(aParams.maxh);
 118     hypParameters->SetMinSize(aParams.minh);
 119     hypParameters->SetNbSegPerEdge(aParams.segmentsperedge);
 120     hypParameters->SetGrowthRate(aParams.grading);
 121     hypParameters->SetNbSegPerRadius(aParams.curvaturesafety);
 122     hypParameters->SetSecondOrder(aParams.secondorder);
 123     hypParameters->SetQuadAllowed(aParams.quad);
 124     hypParameters->SetOptimize(aParams.optimize);
 125     hypParameters->SetFineness((NETGENPlugin_Hypothesis::Fineness)aParams.fineness);
 126     hypParameters->SetSurfaceCurvature(aParams.uselocalh);
 127     hypParameters->SetFuseEdges(aParams.merge_solids);
 128     hypParameters->SetChordalErrorEnabled(aParams.chordalError);
 129     if(aParams.optimize){
 130       hypParameters->SetNbSurfOptSteps(aParams.optsteps2d);
 131       hypParameters->SetNbVolOptSteps(aParams.optsteps3d);
 132     }
 133     hypParameters->SetElemSizeWeight(aParams.elsizeweight);
 134     hypParameters->SetWorstElemMeasure(aParams.opterrpow);
 135     hypParameters->SetUseDelauney(aParams.delaunay);
 136     hypParameters->SetCheckOverlapping(aParams.checkoverlap);
 137     hypParameters->SetCheckChartBoundary(aParams.checkchartboundary);
 138     hypParameters->SetMeshSizeFile(aParams.meshsizefilename);
 139
 140     _hypParameters = dynamic_cast< const NETGENPlugin_Hypothesis *> (hypParameters);
 141   }
 142   if(aParams.has_maxelementvolume_hyp){
 143     _hypMaxElementVolume = new StdMeshers_MaxElementVolume(1, GetGen());
 144     _maxElementVolume = aParams.maxElementVolume;
 145   }
 146   // TODO: Handle viscous layer
 147 }
 148
 149 /**
 150  * @brief Write a binary file containing information on the elements/nodes
 151  *        created by the mesher
 152  *
 153  * @param nodeVec mapping between the mesh id and the netgen structure id
 154  * @param ngLib Wrapper on netgen library
 155  * @param new_element_file Name of the output file
 156  * @param Netgen_NbOfNodes Number of nodes in the netgen structure
 157  * @return true if there are some error
 158  */
 159 bool NETGENPlugin_NETGEN_3D_SA::computeFillNewElementFile(
 160     std::vector< const SMDS_MeshNode* > &nodeVec,
 161     NETGENPlugin_NetgenLibWrapper &ngLib,
 162     std::string new_element_file,
 163     int &Netgen_NbOfNodes
 164 )
 165 {
 166   Ng_Mesh* Netgen_mesh = ngLib.ngMesh();
 167
 168   int Netgen_NbOfNodesNew = Ng_GetNP(Netgen_mesh);
 169   int Netgen_NbOfTetra    = Ng_GetNE(Netgen_mesh);
 170
 171   bool isOK = ( Netgen_NbOfTetra > 0 );
 172   if ( isOK && !new_element_file.empty() )
 173   {
 174     std::ofstream df(new_element_file, ios::out|ios::binary);
 175
 176     double Netgen_point[3];
 177     int    Netgen_tetrahedron[4];
 178
 179     // Writing nodevec (correspondence netgen numbering mesh numbering)
 180     // Number of nodes
 181     df.write((char*) &Netgen_NbOfNodes, sizeof(int));
 182     df.write((char*) &Netgen_NbOfNodesNew, sizeof(int));
 183     for (int nodeIndex = 1 ; nodeIndex <= Netgen_NbOfNodes; ++nodeIndex )
 184     {
 185       //Id of the point
 186       int id = nodeVec.at(nodeIndex)->GetID();
 187       df.write((char*) &id, sizeof(int));
 188     }
 189
 190     // Writing info on new points
 191     for (int nodeIndex = Netgen_NbOfNodes +1 ; nodeIndex <= Netgen_NbOfNodesNew; ++nodeIndex )
 192     {
 193       Ng_GetPoint(Netgen_mesh, nodeIndex, Netgen_point );
 194       // Coordinates of the point
 195       df.write((char *) &Netgen_point, sizeof(double)*3);
 196     }
 197
 198     // create tetrahedrons
 199     df.write((char*) &Netgen_NbOfTetra, sizeof(int));
 200     for ( int elemIndex = 1; elemIndex <= Netgen_NbOfTetra; ++elemIndex )
 201     {
 202       Ng_GetVolumeElement(Netgen_mesh, elemIndex, Netgen_tetrahedron);
 203       df.write((char*) &Netgen_tetrahedron, sizeof(int)*4);
 204     }
 205   }
 206   return false;
 207 }
 208
 209 /**
 210  * @brief Compute mesh associated to shape
 211  *
 212  * @param aShape the shape
 213  * @param aMesh the mesh
 214  * @param aParams netgen_params structure
 215  * @param new_element_file Name of the file containing new element
 216  * @param output_mesh Name of the output mesh (if empty it will not be written)
 217  * @return true if there are some error
 218  */
 219 bool NETGENPlugin_NETGEN_3D_SA::Compute(
 220         TopoDS_Shape &aShape,
 221         SMESH_Mesh& aMesh,
 222         netgen_params& aParams,
 223         std::string new_element_file,
 224         bool output_mesh)
 225 {
 226   // vector of nodes in which node index == netgen ID
 227   vector< const SMDS_MeshNode* > nodeVec;
 228   NETGENPlugin_NetgenLibWrapper ngLib;
 229   SMESH_MesherHelper helper(aMesh);
 230   int startWith = netgen::MESHCONST_MESHVOLUME;
 231   int endWith   = netgen::MESHCONST_OPTVOLUME;
 232   int Netgen_NbOfNodes=0;
 233
 234   // Changing netgen log_file putting it next to new_element_file
 235   fs::path netgen_log_file = fs::path(new_element_file).remove_filename() / fs::path("NETGEN.out");
 236
 237   ngLib.setOutputFile(netgen_log_file.string());
 238
 239   NETGENPlugin_NETGEN_3D::computeFillNgMesh(aMesh, aShape, nodeVec, ngLib, helper, Netgen_NbOfNodes);
 240
 241   netgen::OCCGeometry occgeo;
 242   NETGENPlugin_NETGEN_3D::computePrepareParam(aMesh, ngLib, occgeo, helper, endWith);
 243
 244   NETGENPlugin_NETGEN_3D::computeRunMesher(occgeo, nodeVec, ngLib._ngMesh, ngLib, startWith, endWith);
 245
 246   computeFillNewElementFile(nodeVec, ngLib, new_element_file, Netgen_NbOfNodes);
 247
 248   if(output_mesh)
 249     NETGENPlugin_NETGEN_3D::computeFillMesh(nodeVec, ngLib, helper, Netgen_NbOfNodes);
 250
 251   return false;
 252 }
 253
 254
 255 /**
 256  * @brief Running the mesher on the given files
 257  *
 258  * @param input_mesh_file Mesh file (containing 2D elements)
 259  * @param shape_file Shape file (BREP or STEP format)
 260  * @param hypo_file Ascii file containing the netgen parameters
 261  * @param element_orientation_file Binary file containing the orientation of surface elemnts
 262  * @param new_element_file output file containing info the elements created by the mesher
 263  * @param output_mesh_file output mesh file (if empty it will not be created)
 264  * @return int
 265  */
 266 int NETGENPlugin_NETGEN_3D_SA::run(const std::string input_mesh_file,
 267           const std::string shape_file,
 268           const std::string hypo_file,
 269           const std::string element_orientation_file,
 270           const std::string new_element_file,
 271           const std::string output_mesh_file)
 272 {
 273
 274   _element_orientation_file = element_orientation_file;
 275
 276   std::unique_ptr<SMESH_Mesh> myMesh(_gen->CreateMesh(false));
 277
 278   SMESH_DriverMesh::importMesh(input_mesh_file, *myMesh);
 279
 280   // Importing shape
 281   TopoDS_Shape myShape;
 282   SMESH_DriverShape::importShape(shape_file, myShape);
 283
 284   // Importing hypothesis
 285   netgen_params myParams;
 286
 287   importNetgenParams(hypo_file, myParams);
 288   fillHyp(myParams);
 289
 290   MESSAGE("Meshing with netgen3d");
 291   int ret = Compute(myShape, *myMesh, myParams,
 292                       new_element_file,
 293                       !output_mesh_file.empty());
 294
 295
 296   if(ret){
 297     std::cerr << "Meshing failed" << std::endl;
 298     return ret;
 299   }
 300
 301   if(!output_mesh_file.empty()){
 302     std::string meshName = "MESH";
 303     SMESH_DriverMesh::exportMesh(output_mesh_file, *myMesh, meshName);
 304   }
 305
 306   return ret;
 307 }
 308
 309 /**
 310  * @brief Compute the list of already meshed Surface elements and info
 311  *        on their orientation and if they are internal
 312  *
 313  * @param aMesh Global Mesh
 314  * @param aShape Shape associated to the mesh
 315  * @param proxyMesh pointer to mesh used fo find the elements
 316  * @param internals information on internal sub shapes
 317  * @param helper helper associated to the mesh
 318  * @param listElements map of surface element associated with
 319  *                     their orientation and internal status
 320  * @return true if their was some error
 321  */
 322 bool NETGENPlugin_NETGEN_3D_SA::getSurfaceElements(
 323     SMESH_Mesh&         aMesh,
 324     const TopoDS_Shape& aShape,
 325     SMESH_ProxyMesh::Ptr proxyMesh,
 326     NETGENPlugin_Internals &internals,
 327     SMESH_MesherHelper &helper,
 328     std::map<const SMDS_MeshElement*, tuple<bool, bool>, TIDCompare>& listElements
 329     )
 330 {
 331   // To remove compilation warnings
 332   (void) aShape;
 333   (void) proxyMesh;
 334   (void) internals;
 335   (void) helper;
 336   SMESHDS_Mesh* meshDS = aMesh.GetMeshDS();
 337
 338   // Get list of elements + their orientation from element_orientation file
 339   std::map<vtkIdType, bool> elemOrientation;
 340   {
 341     // Setting all element orientation to false if there no element orientation file
 342     if(_element_orientation_file.empty()){
 343       MESSAGE("No element orientation file");
 344
 345       SMDS_ElemIteratorPtr iteratorElem = meshDS->elementsIterator(SMDSAbs_Face);
 346       while ( iteratorElem->more() ) // loop on elements on a geom face
 347         {
 348           // check mesh face
 349           const SMDS_MeshElement* elem = iteratorElem->next();
 350           elemOrientation[elem->GetID()] = false;
 351         }
 352     } else {
 353       MESSAGE("Reading from elements from file: " << _element_orientation_file);
 354       std::ifstream df(_element_orientation_file, ios::binary|ios::in);
 355       int nbElement;
 356       bool orient;
 357
 358       // Warning of the use of vtkIdType (I had issue when run_mesher was compiled with internal vtk) and salome not
 359       // Sizeof was the same but how he othered the type was different
 360       // Maybe using another type (uint64_t) instead would be better
 361       vtkIdType id;
 362       df.read((char*)&nbElement, sizeof(int));
 363
 364       for(int ielem=0;ielem<nbElement;++ielem){
 365         df.read((char*) &id, sizeof(vtkIdType));
 366         df.read((char*) &orient, sizeof(bool));
 367         elemOrientation[id] = orient;
 368       }
 369     }
 370   }
 371
 372   // Adding elements from Mesh
 373   SMDS_ElemIteratorPtr iteratorElem = meshDS->elementsIterator(SMDSAbs_Face);
 374   bool isRev;
 375
 376   bool isIn;
 377
 378   while ( iteratorElem->more() ) // loop on elements on a geom face
 379   {
 380     // check mesh face
 381     const SMDS_MeshElement* elem = iteratorElem->next();
 382     if ( !elem ){
 383       return error( COMPERR_BAD_INPUT_MESH, "Null element encounters");
 384     }
 385     if ( elem->NbCornerNodes() != 3 ){
 386       return error( COMPERR_BAD_INPUT_MESH, "Not triangle element encounters");
 387     }
 388     // Keeping only element that are in the element orientation file
 389     isIn = elemOrientation.count(elem->GetID())==1;
 390     if(!isIn)
 391       continue;
 392     // Get orientation
 393     // Netgen requires that all the triangle point outside
 394     isRev = elemOrientation[elem->GetID()];
 395     listElements[elem] = tuple(isRev, false);
 396   }
 397
 398   return false;
 399 }