src/SMESH/SMESH_Gen.hxx

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