Salome HOME
bos #20553: EDF 22656 - Error after computation but mesh seems OK
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
1 // Copyright (C) 2007-2020  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 #include <TopTools_IndexedMapOfShape.hxx>
46
47 class SMESHDS_Document;
48 class SMESH_Algo;
49 class SMESH_Mesh;
50 class TopoDS_Shape;
51 class SMESH_subMesh;
52
53 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
54
55 typedef struct studyContextStruct
56 {
57   std::map < int, SMESH_Hypothesis * >mapHypothesis;
58   std::map < int, SMESH_Mesh * >mapMesh;
59   SMESHDS_Document * myDocument;
60 } StudyContextStruct;
61
62 typedef std::set<int> TSetOfInt;
63
64 class SMESH_EXPORT SMESH_Gen
65 {
66 public:
67   SMESH_Gen();
68   ~SMESH_Gen();
69
70   SMESH_Mesh* CreateMesh(bool theIsEmbeddedMode);
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    *  \param anAllowedSubShapes - shapes to mesh only. Mesh all if empty or nullptr
87    *  \retval bool - true if none sub-mesh failed to compute
88    */
89   bool Compute(::SMESH_Mesh &              aMesh,
90                const TopoDS_Shape &        aShape,
91                const int                   aFlags = COMPACT_MESH,
92                const ::MeshDimension       aDim=::MeshDim_3D,
93                TSetOfInt*                  aShapesId=0,
94                TopTools_IndexedMapOfShape* anAllowedSubShapes=0);
95
96   void PrepareCompute(::SMESH_Mesh &        aMesh,
97                       const TopoDS_Shape &  aShape);
98   void CancelCompute(::SMESH_Mesh &        aMesh,
99                      const TopoDS_Shape &  aShape);
100
101   const SMESH_subMesh* GetCurrentSubMesh() const;
102
103   /*!
104    * \brief evaluates size of prospective mesh on a shape 
105    * \param aMesh - the mesh
106    * \param aShape - the shape
107    * \param aResMap - map for prospective numbers of elements
108    * \retval bool - is a success
109    */
110   bool Evaluate(::SMESH_Mesh &        aMesh,
111                 const TopoDS_Shape &  aShape,
112                 MapShapeNbElems&      aResMap,
113                 const bool            anUpward=false,
114                 TSetOfInt*            aShapesId=0);
115
116   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
117   // notify on bad state of attached algos, return false
118   // if Compute() would fail because of some algo bad state
119
120   /*!
121    * \brief Sets number of segments per diagonal of boundary box of geometry by which
122    *        default segment length of appropriate 1D hypotheses is defined
123    */
124   void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
125   int  GetBoundaryBoxSegmentation() const { return _segmentation; }
126   /*!
127    * \brief Sets default number of segments per edge
128    */
129   void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
130   int GetDefaultNbSegments() const { return _nbSegments; }
131
132   struct TAlgoStateError
133   {
134     TAlgoStateErrorName _name;
135     const SMESH_Algo*   _algo;
136     int                 _algoDim;
137     bool                _isGlobalAlgo;
138
139     TAlgoStateError(): _name(SMESH_Hypothesis::HYP_OK), _algo(0), _algoDim(0) {}
140     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
141     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
142     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
143     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
144   };
145
146   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
147                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
148   // notify on bad state of attached algos, return false
149   // if Compute() would fail because of some algo bad state
150   // theErrors list contains problems description
151
152   StudyContextStruct *GetStudyContext();
153
154   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
155   static int GetShapeDim(const TopoDS_Shape &     aShape)
156   { return GetShapeDim( aShape.ShapeType() ); }
157
158   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
159   SMESH_Algo* GetAlgo(SMESH_subMesh * aSubMesh, TopoDS_Shape* assignedTo=0);
160
161   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
162
163   static std::vector< std::string > GetPluginXMLPaths();
164
165   int GetANewId();
166
167 private:
168
169   int _localId;                         // unique Id of created objects, within SMESH_Gen entity
170   StudyContextStruct* _studyContext;
171
172   // hypotheses managing
173   int _hypId;
174
175   // number of segments per diagonal of boundary box of geometry by which
176   // default segment length of appropriate 1D hypotheses is defined
177   int _segmentation;
178   // default number of segments
179   int _nbSegments;
180
181   void setCurrentSubMesh(SMESH_subMesh* sm);
182   void resetCurrentSubMesh();
183
184   volatile bool               _compute_canceled;
185   std::list< SMESH_subMesh* > _sm_current;
186 };
187
188 #endif