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   if(!keepingTmpFolfer())
  65   {
  66     MESSAGE("Set SMESH_KEEP_TMP to > 0 to keep temporary folders")
  67     DeleteTmpFolder();
  68   }
  69 };
  70
  71 //=============================================================================
  72 /*!
  73  * \brief Checking if we should keep the temporary folder
  74  *        They are kept if the variable SMESH_KEEP_TMP is set to higher than 0
  75  */
  76 //=============================================================================
  77 bool SMESH_ParallelMesh::keepingTmpFolfer()
  78 {
  79   const char* envVar = std::getenv("SMESH_KEEP_TMP");
  80
  81   if (envVar && (envVar[0] != '\0'))
  82   {
  83     try
  84     {
  85       const long long numValue = std::stoll(envVar);
  86       return numValue > 0;
  87     }
  88     catch(const std::exception& e)
  89     {
  90       std::cerr << e.what() << '\n';
  91     }
  92   }
  93
  94   return false;
  95 };
  96
  97
  98 //=============================================================================
  99 /*!
 100  * \brief Build folder for parallel computation
 101  */
 102 //=============================================================================
 103 void SMESH_ParallelMesh::CreateTmpFolder()
 104 {
 105   // Temporary folder that will be used by parallel computation
 106   tmp_folder = fs::temp_directory_path()/fs::unique_path(fs::path("SMESH_%%%%-%%%%"));
 107   fs::create_directories(tmp_folder);
 108 }
 109 //
 110 //=============================================================================
 111 /*!
 112  * \brief Delete temporary folder used for parallel computation
 113  */
 114 //=============================================================================
 115 void SMESH_ParallelMesh::DeleteTmpFolder()
 116 {
 117     MESSAGE("Deleting temporary folder" << tmp_folder.string());
 118     fs::remove_all(tmp_folder);
 119 }
 120
 121 //=============================================================================
 122 /*!
 123  * \brief Get the number of Threads to be used for the pool of Threads
 124  */
 125 //=============================================================================
 126 int SMESH_ParallelMesh::GetPoolNbThreads()
 127 {
 128   int nbThreads = -1;
 129
 130   if(_method == ParallelismMethod::MultiThread){
 131     nbThreads = _NbThreads;
 132   }else if( _method == ParallelismMethod::MultiNode){
 133     //TODO: Check of that is the right way
 134     nbThreads = std::max(_nbProc, _nbNode*_nbProcPerNode);
 135   } else {
 136     throw SALOME_Exception("Unknown method "+std::to_string(_method));
 137   }
 138
 139   return nbThreads;
 140 }
 141
 142 //=============================================================================
 143 /*!
 144  * \brief Set Number of thread for multithread run
 145  */
 146 //=============================================================================
 147 void SMESH_ParallelMesh::SetNbThreads(long nbThreads)
 148 {
 149   if(nbThreads < 1)
 150     throw SALOME_Exception("Number of threads should be higher than 1");
 151   _NbThreads=nbThreads;
 152 };
 153
 154 //=============================================================================
 155 /*!
 156  * \brief Get the element associated to the dimension of the parallelism
 157  */
 158 //=============================================================================
 159 int SMESH_ParallelMesh::GetParallelElement()
 160 {
 161   if (_paraDim==2){
 162     return TopAbs_FACE;
 163   }else{
 164     return TopAbs_SOLID;
 165   }
 166 };
 167
 168 //=============================================================================
 169 /*!
 170  * \brief Get the element associated to the dimension of the parallelism
 171  */
 172 //=============================================================================
 173 int SMESH_ParallelMesh::GetDumpElement()
 174 {
 175   if (_paraDim==2){
 176     return TopAbs_EDGE;
 177   }else{
 178     return TopAbs_FACE;
 179   }
 180 };
 181
 182 bool SMESH_ParallelMesh::ComputeSubMeshes(
 183           SMESH_Gen* gen,
 184           SMESH_Mesh & aMesh,
 185           const TopoDS_Shape & aShape,
 186           const ::MeshDimension       aDim,
 187           TSetOfInt*                  aShapesId /*=0*/,
 188           TopTools_IndexedMapOfShape* allowedSubShapes,
 189           SMESH_subMesh::compute_event &computeEvent,
 190           const bool includeSelf,
 191           const bool complexShapeFirst,
 192           const bool   aShapeOnly)
 193 {
 194   InitPoolThreads();
 195   return gen->parallelComputeSubMeshes(
 196             aMesh, aShape, aDim,
 197             aShapesId, allowedSubShapes,
 198             computeEvent,
 199             includeSelf,
 200             complexShapeFirst,
 201             aShapeOnly);
 202 }