src/SMESH/SMESH_ParallelMesh.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 //  File   : SMESH_ParallelMesh.cxx
  24 //  Author : Yoann AUDOUIN, EDF
  25 //  Module : SMESH
  26 //
  27 #include "SMESH_ParallelMesh.hxx"
  28
  29 #include "SMESH_Gen.hxx"
  30
  31 #ifdef WIN32
  32   #include <windows.h>
  33 #endif
  34
  35 #include <boost/filesystem.hpp>
  36 namespace fs=boost::filesystem;
  37
  38 #ifndef WIN32
  39 #include <boost/asio.hpp>
  40 #endif
  41
  42 #include <utilities.h>
  43
  44 SMESH_ParallelMesh::SMESH_ParallelMesh(int               theLocalId,
  45                        SMESH_Gen*        theGen,
  46                        bool              theIsEmbeddedMode,
  47                        SMESHDS_Document* theDocument) :SMESH_Mesh(theLocalId,
  48                                                                   theGen,
  49                                                                   theIsEmbeddedMode,
  50                                                                   theDocument)
  51 {
  52   MESSAGE("SMESH_ParallelMesh::SMESH_ParallelMesh(int localId)");
  53   CreateTmpFolder();
  54 };
  55
  56 SMESH_ParallelMesh::~SMESH_ParallelMesh()
  57 {
  58   cleanup();
  59 };
  60
  61 void SMESH_ParallelMesh::cleanup()
  62 {
  63   DeletePoolThreads();
  64   std::cout << "Keeping tmp folder" << keepingTmpFolfer() << std::endl;
  65   if(!keepingTmpFolfer())
  66   {
  67     MESSAGE("Set SMESH_KEEP_TMP to > 0 to keep temporary folders")
  68     DeleteTmpFolder();
  69   }
  70 };
  71
  72 //=============================================================================
  73 /*!
  74  * \brief Checking if we should keep the temporary folder
  75  *        They are kept if the variable SMESH_KEEP_TMP is set to higher than 0
  76  */
  77 //=============================================================================
  78 bool SMESH_ParallelMesh::keepingTmpFolfer()
  79 {
  80   const char* envVar = std::getenv("SMESH_KEEP_TMP");
  81   std::cout << "smesh_keep_tmp: " << envVar << std::endl;
  82
  83   if (envVar && (envVar[0] != '\0'))
  84   {
  85     try
  86     {
  87       const long long numValue = std::stoll(envVar);
  88       return numValue > 0;
  89     }
  90     catch(const std::exception& e)
  91     {
  92       std::cerr << e.what() << '\n';
  93     }
  94   }
  95
  96   return false;
  97 };
  98
  99
 100 //=============================================================================
 101 /*!
 102  * \brief Build folder for parallel computation
 103  */
 104 //=============================================================================
 105 void SMESH_ParallelMesh::CreateTmpFolder()
 106 {
 107   // Temporary folder that will be used by parallel computation
 108   tmp_folder = fs::temp_directory_path()/fs::unique_path(fs::path("SMESH_%%%%-%%%%"));
 109   fs::create_directories(tmp_folder);
 110 }
 111 //
 112 //=============================================================================
 113 /*!
 114  * \brief Delete temporary folder used for parallel computation
 115  */
 116 //=============================================================================
 117 void SMESH_ParallelMesh::DeleteTmpFolder()
 118 {
 119     MESSAGE("Deleting temporary folder" << tmp_folder.string());
 120     fs::remove_all(tmp_folder);
 121 }
 122
 123 //=============================================================================
 124 /*!
 125  * \brief Get the number of Threads to be used for the pool of Threads
 126  */
 127 //=============================================================================
 128 int SMESH_ParallelMesh::GetPoolNbThreads()
 129 {
 130   int nbThreads = -1;
 131
 132   if(_method == ParallelismMethod::MultiThread){
 133     nbThreads = _NbThreads;
 134   }else if( _method == ParallelismMethod::MultiNode){
 135     //TODO: Check of that is the right way
 136     nbThreads = std::max(_nbProc, _nbNode*_nbProcPerNode);
 137   } else {
 138     throw SALOME_Exception("Unknown method "+std::to_string(_method));
 139   }
 140
 141   return nbThreads;
 142 }
 143
 144 //=============================================================================
 145 /*!
 146  * \brief Set Number of thread for multithread run
 147  */
 148 //=============================================================================
 149 void SMESH_ParallelMesh::SetNbThreads(long nbThreads)
 150 {
 151   if(nbThreads < 1)
 152     throw SALOME_Exception("Number of threads should be higher than 1");
 153   _NbThreads=nbThreads;
 154 };
 155
 156 bool SMESH_ParallelMesh::ComputeSubMeshes(
 157           SMESH_Gen* gen,
 158           SMESH_Mesh & aMesh,
 159           const TopoDS_Shape & aShape,
 160           const ::MeshDimension       aDim,
 161           TSetOfInt*                  aShapesId /*=0*/,
 162           TopTools_IndexedMapOfShape* allowedSubShapes,
 163           SMESH_subMesh::compute_event &computeEvent,
 164           const bool includeSelf,
 165           const bool complexShapeFirst,
 166           const bool   aShapeOnly)
 167 {
 168   InitPoolThreads();
 169   return gen->parallelComputeSubMeshes(
 170             aMesh, aShape, aDim,
 171             aShapesId, allowedSubShapes,
 172             computeEvent,
 173             includeSelf,
 174             complexShapeFirst,
 175             aShapeOnly);
 176 }