src/SMESH/SMESH_Gen.hxx

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