src/SMESH/SMESH_Gen.hxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, 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.
  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 //  SMESH SMESH : implementaion of SMESH idl descriptions
  24 //  File   : SMESH_Gen.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_GEN_HXX_
  29 #define _SMESH_GEN_HXX_
  30
  31 #include "SMESH_SMESH.hxx"
  32
  33 #include "Utils_SALOME_Exception.hxx"
  34
  35 #include "SMESH_Hypothesis.hxx"
  36 #include "SMESH_ComputeError.hxx"
  37 #include "SMESH_Algo.hxx"
  38 #include "SMESH_Mesh.hxx"
  39
  40 #include "chrono.hxx"
  41
  42 #include <TopoDS_Shape.hxx>
  43
  44 #include <map>
  45 #include <list>
  46 #include <vector>
  47 #include <string>
  48
  49 class SMESHDS_Document;
  50
  51 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
  52
  53 typedef struct studyContextStruct
  54 {
  55   std::map < int, SMESH_Hypothesis * >mapHypothesis;
  56   std::map < int, SMESH_Mesh * >mapMesh;
  57   SMESHDS_Document * myDocument;
  58 } StudyContextStruct;
  59
  60 typedef std::set<int> TSetOfInt;
  61
  62 class SMESH_EXPORT  SMESH_Gen
  63 {
  64 public:
  65   SMESH_Gen();
  66   ~SMESH_Gen();
  67
  68   SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
  69     throw(SALOME_Exception);
  70
  71   /*!
  72    * \brief Computes aMesh on aShape
  73    *  \param anUpward - compute from vertices up to more complex shape (internal usage)
  74    *  \param aDim - upper level dimension of the mesh computation
  75    *  \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
  76    *  \retval bool - true if none submesh failed to compute
  77    */
  78   bool Compute(::SMESH_Mesh &        aMesh,
  79                const TopoDS_Shape &  aShape,
  80                const bool            anUpward=false,
  81                const ::MeshDimension aDim=::MeshDim_3D,
  82                TSetOfInt*            aShapesId=0);
  83
  84 #ifdef WITH_SMESH_CANCEL_COMPUTE
  85   void PrepareCompute(::SMESH_Mesh &        aMesh,
  86                       const TopoDS_Shape &  aShape);
  87   void CancelCompute(::SMESH_Mesh &        aMesh,
  88                      const TopoDS_Shape &  aShape);
  89 #endif
  90
  91   /*!
  92    * \brief evaluates size of prospective mesh on a shape
  93    * \param aMesh - the mesh
  94    * \param aShape - the shape
  95    * \param aResMap - map for prospective numbers of elements
  96    * \retval bool - is a success
  97    */
  98   bool Evaluate(::SMESH_Mesh &        aMesh,
  99                 const TopoDS_Shape &  aShape,
 100                 MapShapeNbElems&      aResMap,
 101                 const bool            anUpward=false,
 102                 TSetOfInt*            aShapesId=0);
 103
 104   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
 105   // notify on bad state of attached algos, return false
 106   // if Compute() would fail because of some algo bad state
 107
 108   /*!
 109    * \brief Sets number of segments per diagonal of boundary box of geometry by which
 110    *        default segment length of appropriate 1D hypotheses is defined
 111    */
 112   void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
 113   int  GetBoundaryBoxSegmentation() const { return _segmentation; }
 114   /*!
 115    * \brief Sets default number of segments per edge
 116    */
 117   void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
 118   int GetDefaultNbSegments() const { return _nbSegments; }
 119
 120   struct TAlgoStateError
 121   {
 122     TAlgoStateErrorName _name;
 123     const SMESH_Algo*   _algo;
 124     int                 _algoDim;
 125     bool                _isGlobalAlgo;
 126
 127     TAlgoStateError(): _algoDim(0),_algo(0),_name(SMESH_Hypothesis::HYP_OK) {}
 128     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
 129     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
 130     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
 131     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
 132   };
 133
 134   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
 135                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
 136   // notify on bad state of attached algos, return false
 137   // if Compute() would fail because of some algo bad state
 138   // theErrors list contains problems description
 139
 140   StudyContextStruct *GetStudyContext(int studyId);
 141
 142   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
 143   static int GetShapeDim(const TopoDS_Shape & aShape)
 144   { return GetShapeDim( aShape.ShapeType() ); }
 145
 146   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
 147
 148   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
 149
 150   static std::vector< std::string > GetPluginXMLPaths();
 151
 152   int GetANewId();
 153
 154   std::map < int, SMESH_Algo * >_mapAlgo;
 155   std::map < int, SMESH_0D_Algo * >_map0D_Algo;
 156   std::map < int, SMESH_1D_Algo * >_map1D_Algo;
 157   std::map < int, SMESH_2D_Algo * >_map2D_Algo;
 158   std::map < int, SMESH_3D_Algo * >_map3D_Algo;
 159
 160 private:
 161
 162   int _localId;                         // unique Id of created objects, within SMESH_Gen entity
 163   std::map < int, StudyContextStruct * >_mapStudyContext;
 164
 165   // hypotheses managing
 166   int _hypId;
 167
 168   // number of segments per diagonal of boundary box of geometry by which
 169   // default segment length of appropriate 1D hypotheses is defined
 170   int _segmentation;
 171   // default of segments
 172   int _nbSegments;
 173   counters *_counters;
 174
 175 #ifdef WITH_SMESH_CANCEL_COMPUTE
 176   volatile bool _compute_canceled;
 177   SMESH_subMesh* _sm_current;
 178 #endif
 179 };
 180
 181 #endif