1 // Copyright (C) 2007-2020 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SMESH_subMesh.hxx
24 // Author : Paul RASCLE, EDF
27 #ifndef _SMESH_SUBMESH_HXX_
28 #define _SMESH_SUBMESH_HXX_
30 #include "SMESH_SMESH.hxx"
32 #include "SMDS_Iterator.hxx"
33 #include "SMESH_ComputeError.hxx"
34 #include "SMESH_Algo.hxx"
36 #include "Utils_SALOME_Exception.hxx"
38 #include <TopoDS_Shape.hxx>
39 #include <TopTools_IndexedMapOfShape.hxx>
45 class SMESHDS_SubMesh;
48 class SMESH_Hypothesis;
51 class SMESH_subMeshEventListener;
52 struct SMESH_subMeshEventListenerData;
54 typedef SMESH_subMeshEventListener EventListener;
55 typedef SMESH_subMeshEventListenerData EventListenerData;
57 typedef boost::shared_ptr< SMDS_Iterator<SMESH_subMesh*> > SMESH_subMeshIteratorPtr;
60 class SMESH_EXPORT SMESH_subMesh
65 SMESHDS_Mesh * meshDS,
66 const TopoDS_Shape & aSubShape);
67 virtual ~ SMESH_subMesh();
69 int GetId() const; // == meshDS->ShapeToIndex( aSubShape )
71 SMESH_Mesh* GetFather() { return _father; }
73 SMESHDS_SubMesh * GetSubMeshDS();
74 const SMESHDS_SubMesh * GetSubMeshDS() const;
76 SMESHDS_SubMesh* CreateSubMeshDS();
77 // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
79 SMESH_subMesh *GetFirstToCompute();
81 SMESH_Algo* GetAlgo() const;
83 const std::map < int, SMESH_subMesh * >& DependsOn();
84 bool DependsOn( const SMESH_subMesh* other ) const;
85 bool DependsOn( const int shapeID ) const;
87 * \brief Return iterator on the sub-meshes this one depends on. By default
88 * most simple sub-meshes go first.
90 SMESH_subMeshIteratorPtr getDependsOnIterator(const bool includeSelf,
91 const bool complexShapeFirst=false) const;
93 const std::vector< SMESH_subMesh * > & GetAncestors() const;
94 void ClearAncestors();
96 const TopoDS_Shape & GetSubShape() const;
100 NOT_READY, READY_TO_COMPUTE, COMPUTE_OK, FAILED_TO_COMPUTE
104 NO_ALGO, MISSING_HYP, HYP_OK
109 REMOVE_HYP , REMOVE_ALGO,
110 ADD_FATHER_HYP , ADD_FATHER_ALGO,
111 REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO,
116 MODIF_ALGO_STATE, COMPUTE, COMPUTE_SUBMESH, COMPUTE_NOGEOM, COMPUTE_CANCELED,
117 CLEAN, SUBMESH_COMPUTED, SUBMESH_RESTORED, SUBMESH_LOADED,
118 MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
122 ALGO_EVENT, COMPUTE_EVENT
125 // ==================================================================
126 // Members to track non hierarchical dependencies between sub-meshes
127 // ==================================================================
130 * \brief Set an event listener and its data to a submesh
131 * \param listener - the listener to store
132 * \param data - the listener data to store
133 * \param where - the submesh to store the listener and it's data
135 * The method remembers the submesh \awhere it puts the listener in order to delete
136 * it when HYP_OK algo_state is lost
137 * After being set, event listener is notified on each event of \awhere submesh.
139 void SetEventListener(EventListener* listener,
140 EventListenerData* data,
141 SMESH_subMesh* where);
144 * \brief Return an event listener data
145 * \param listener - the listener whose data is
146 * \param myOwn - if \c true, returns a listener set by this sub-mesh,
147 * else returns a listener listening to events of this sub-mesh
148 * \retval EventListenerData* - found data, maybe NULL
150 EventListenerData* GetEventListenerData(EventListener* listener,
151 const bool myOwn=false) const;
154 * \brief Return an event listener data
155 * \param listenerName - the listener name
156 * \param myOwn - if \c true, returns a listener set by this sub-mesh,
157 * else returns a listener listening to events of this sub-mesh
158 * \retval EventListenerData* - found data, maybe NULL
160 EventListenerData* GetEventListenerData(const std::string& listenerName,
161 const bool myOwn=false) const;
164 * \brief Unregister the listener and delete it and it's data
165 * \param listener - the event listener to delete
167 void DeleteEventListener(EventListener* listener);
171 //!< event listeners to notify
172 std::map< EventListener*, EventListenerData* > _eventListeners;
174 //!< event listeners to delete when HYP_OK algo_state is lost
175 struct OwnListenerData {
176 SMESH_subMesh* mySubMesh;
177 int myMeshID; // id of mySubMesh->GetFather()
179 EventListener* myListener;
180 OwnListenerData( SMESH_subMesh* sm=0, EventListener* el=0);
182 std::list< OwnListenerData > _ownListeners;
185 * \brief Sets an event listener and its data to a submesh
186 * \param listener - the listener to store
187 * \param data - the listener data to store
189 * After being set, event listener is notified on each event of a submesh.
191 void setEventListener(EventListener* listener, EventListenerData* data);
194 * \brief Notify stored event listeners on the occurred event
195 * \param event - algo_event or compute_event itself
196 * \param eventType - algo_event or compute_event
197 * \param hyp - hypothesis, if eventType is algo_event
199 void notifyListenersOnEvent( const int event,
200 const event_type eventType,
201 SMESH_Hypothesis* hyp = 0);
204 * \brief Delete event listeners depending on algo of this submesh
206 void deleteOwnListeners();
209 * \brief loads dependent meshes on SUBMESH_LOADED event
211 void loadDependentMeshes();
213 // END: Members to track non hierarchical dependencies between submeshes
214 // =====================================================================
218 SMESH_Hypothesis::Hypothesis_Status
219 AlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp);
221 SMESH_Hypothesis::Hypothesis_Status
222 SubMeshesAlgoStateEngine(algo_event event, SMESH_Hypothesis * anHyp, bool exitOnFatal=false);
224 algo_state GetAlgoState() const { return _algoState; }
225 compute_state GetComputeState() const { return _computeState; }
226 SMESH_ComputeErrorPtr& GetComputeError() { return _computeError; }
228 void DumpAlgoState(bool isMain);
230 bool ComputeStateEngine(compute_event event);
231 void ComputeSubMeshStateEngine(compute_event event, const bool includeSelf=false);
233 bool Evaluate(MapShapeNbElems& aResMap);
235 bool IsConform(const SMESH_Algo* theAlgo);
236 // check if a conform mesh will be produced by the Algo
238 bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
239 // return true if theHypothesis can be attached to me:
240 // its dimension is checked
242 static bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis,
243 const TopAbs_ShapeEnum theShapeType);
245 bool IsApplicableHypothesis(const SMESH_Hypothesis* theHypothesis) const;
246 // return true if theHypothesis can be used to mesh me:
247 // its shape type is checked
249 SMESH_Hypothesis::Hypothesis_Status CheckConcurrentHypothesis (const int theHypType);
250 // check if there are several applicable hypothesis on fathers
253 * \brief Return true if no mesh entities is bound to the submesh
255 bool IsEmpty() const;
257 bool IsMeshComputed() const;
258 // check if _subMeshDS contains mesh elements unless _alwaysComputed==true
261 * \brief Set sub-shapes that are allowed to compute at once by a multidimensional algo
263 void SetAllowedSubShapes( const TopTools_IndexedMapOfShape* subShapes )
264 { _allowedSubShapes = subShapes; }
267 * \brief Allow algo->Compute() if a subshape of lower dim is meshed but
268 * none mesh entity is bound to it
270 void SetIsAlwaysComputed(bool isAlCo);
271 bool IsAlwaysComputed() const { return _alwaysComputed; }
273 bool SubMeshesComputed(bool * isFailedToCompute=0) const;
275 int GetComputeCost() const;
276 // how costly is to compute this sub-mesh
279 * \brief Find common submeshes (based on shared subshapes with other
280 * \param theOther submesh to check
281 * \param theCommonIds set of common submesh IDs
282 * NOTE: this method does not cleat set before collect common IDs
284 bool FindIntersection( const SMESH_subMesh * theOther,
285 std::set<const SMESH_subMesh*>& theSetOfCommon ) const;
288 // ==================================================================
289 void insertDependence(const TopoDS_Shape aShape,
290 TopAbs_ShapeEnum aSubType,
291 TopAbs_ShapeEnum avoidType=TopAbs_SHAPE);
293 void removeSubMeshElementsAndNodes();
294 void updateDependantsState(const compute_event theEvent);
295 void updateSubMeshState(const compute_state theState);
296 void cleanDependants();
297 void cleanDependsOn( SMESH_Algo* algoRequiringCleaning=0 );
298 void setAlgoState(algo_state state);
301 * \brief Return a shape containing all sub-shapes of the MainShape that can be
302 * meshed at once along with _subShape
304 TopoDS_Shape getCollection(SMESH_Gen * theGen,
306 bool & theSubComputed,
308 std::vector<SMESH_subMesh*>& theSubs);
310 * \brief Update compute_state by _computeError
311 * \retval bool - false if there are errors
313 bool checkComputeError(SMESH_Algo* theAlgo,
314 const bool theComputeOK,
315 const TopoDS_Shape& theShape=TopoDS_Shape());
318 * \brief Return a hypothesis attached to theShape.
320 * If theHyp is provided, similar but not same hypotheses
321 * is returned; else an applicable ones having theHypType
324 const SMESH_Hypothesis* getSimilarAttached(const TopoDS_Shape& theShape,
325 const SMESH_Hypothesis * theHyp,
326 const int theHypType = 0);
328 int computeCost() const;
332 TopoDS_Shape _subShape;
333 SMESHDS_SubMesh * _subMeshDS;
334 SMESH_Mesh * _father;
337 std::map < int, SMESH_subMesh * >_mapDepend;
338 bool _dependenceAnalysed;
339 std::vector< SMESH_subMesh * > _ancestors;
341 SMESH_Algo * _algo; // the algorithm found by last *StateEngine() call
342 TopoDS_Shape _algoShape; // shape the algorithm is assigned to
343 algo_state _algoState;
344 compute_state _computeState;
345 SMESH_ComputeErrorPtr _computeError;
346 int _computeCost; // how costly is to compute this sub-mesh
347 int _realComputeCost; // _computeCost depending on presence of needed hypotheses
349 // allow algo->Compute() if a sub-shape of lower dim is meshed but
350 // none mesh entity is bound to it. Eg StdMeshers_CompositeSegment_1D can
351 // mesh several edges as a whole and leave some of them without mesh entities
352 bool _alwaysComputed;
354 const TopTools_IndexedMapOfShape* _allowedSubShapes; // allowed to be returned by getCollection()