1 // Copyright (C) 2007-2011 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.
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
22 // File : SMESH_Mesh_i.hxx
23 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_MESH_I_HXX_
27 #define _SMESH_MESH_I_HXX_
31 #include <SALOMEconfig.h>
32 #include CORBA_SERVER_HEADER(SMESH_Mesh)
33 #include CORBA_SERVER_HEADER(SMESH_Group)
34 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
35 #include CORBA_CLIENT_HEADER(GEOM_Gen)
36 #include CORBA_CLIENT_HEADER(MED)
38 #include "SMESH_Hypothesis.hxx"
39 #include "SMESH_Mesh.hxx"
40 //#include "SMESH_subMesh_i.hxx"
41 #include "SMESH_subMesh.hxx"
43 #include "SALOME_GenericObj_i.hh"
46 class SMESH_GroupBase_i;
47 class SMESH_subMesh_i;
51 class SMESH_I_EXPORT SMESH_Mesh_i:
52 public virtual POA_SMESH::SMESH_Mesh,
53 public virtual SALOME::GenericObj_i
56 SMESH_Mesh_i(const SMESH_Mesh_i&);
58 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
60 CORBA::Long studyId );
62 virtual ~SMESH_Mesh_i();
65 void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
66 throw (SALOME::SALOME_Exception);
68 CORBA::Boolean HasShapeToMesh()
69 throw (SALOME::SALOME_Exception);
71 GEOM::GEOM_Object_ptr GetShapeToMesh()
72 throw (SALOME::SALOME_Exception);
75 throw (SALOME::SALOME_Exception);
77 void ClearSubMesh(CORBA::Long ShapeID)
78 throw (SALOME::SALOME_Exception);
80 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
81 SMESH::SMESH_Hypothesis_ptr anHyp)
82 throw (SALOME::SALOME_Exception);
84 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
85 SMESH::SMESH_Hypothesis_ptr anHyp)
86 throw (SALOME::SALOME_Exception);
88 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
89 throw (SALOME::SALOME_Exception);
91 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
92 throw (SALOME::SALOME_Exception);
94 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
95 throw (SALOME::SALOME_Exception);
97 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
98 throw (SALOME::SALOME_Exception);
100 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
102 GEOM::GEOM_Object_ptr theGeomObj )
103 throw (SALOME::SALOME_Exception);
105 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
107 SMESH::Filter_ptr theFilter )
108 throw (SALOME::SALOME_Exception);
110 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
111 throw (SALOME::SALOME_Exception);
113 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
114 throw (SALOME::SALOME_Exception);
116 SMESH::ListOfGroups* GetGroups()
117 throw (SALOME::SALOME_Exception);
119 CORBA::Long NbGroups()
120 throw (SALOME::SALOME_Exception);
122 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
123 SMESH::SMESH_GroupBase_ptr theGroup2,
124 const char* theName )
125 throw (SALOME::SALOME_Exception);
127 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
129 throw (SALOME::SALOME_Exception);
131 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
132 SMESH::SMESH_GroupBase_ptr theGroup2,
133 const char* theName )
134 throw (SALOME::SALOME_Exception);
136 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
137 const char* theName )
138 throw (SALOME::SALOME_Exception);
140 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
141 SMESH::SMESH_GroupBase_ptr theGroup2,
142 const char* theName )
143 throw (SALOME::SALOME_Exception);
145 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
146 const SMESH::ListOfGroups& theToolGroups,
147 const char* theName )
148 throw (SALOME::SALOME_Exception);
150 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
151 SMESH::ElementType theElemType,
152 const char* theName )
153 throw (SALOME::SALOME_Exception);
156 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn );
158 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
159 // throw (SALOME::SALOME_Exception);
161 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
162 throw (SALOME::SALOME_Exception);
164 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
166 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
168 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
171 throw (SALOME::SALOME_Exception);
174 throw (SALOME::SALOME_Exception);
176 CORBA::Long GetStudyId()
177 throw (SALOME::SALOME_Exception);
180 void SetImpl(::SMESH_Mesh* impl);
181 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
183 SMESH_Gen_i* GetGen() { return _gen_i; }
185 int ImportUNVFile( const char* theFileName )
186 throw (SALOME::SALOME_Exception);
188 int ImportSTLFile( const char* theFileName )
189 throw (SALOME::SALOME_Exception);
192 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
194 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
195 throw (SALOME::SALOME_Exception);
200 void SetAutoColor(CORBA::Boolean theAutoColor)
201 throw (SALOME::SALOME_Exception);
203 CORBA::Boolean GetAutoColor()
204 throw (SALOME::SALOME_Exception);
206 /*! Check group names for duplications.
207 * Consider maximum group name length stored in MED file.
209 CORBA::Boolean HasDuplicatedGroupNamesMED();
211 * Return string representation of a MED file version comprising nbDigits
213 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
215 void ExportToMEDX( const char* file,
216 CORBA::Boolean auto_groups,
217 SMESH::MED_VERSION version,
218 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
219 void ExportToMED ( const char* file,
220 CORBA::Boolean auto_groups,
221 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
222 void ExportMED ( const char* file,
223 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
225 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
226 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
227 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
229 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
231 CORBA::Boolean auto_groups,
232 SMESH::MED_VERSION version,
233 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
234 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
235 const char* file) throw (SALOME::SALOME_Exception);
236 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
237 const char* file) throw (SALOME::SALOME_Exception);
238 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
240 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
242 SALOME_MED::MESH_ptr GetMEDMesh()
243 throw (SALOME::SALOME_Exception);
245 CORBA::Long NbNodes()
246 throw (SALOME::SALOME_Exception);
248 CORBA::Long NbElements()
249 throw (SALOME::SALOME_Exception);
251 CORBA::Long Nb0DElements()
252 throw (SALOME::SALOME_Exception);
254 CORBA::Long NbEdges()
255 throw (SALOME::SALOME_Exception);
257 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
258 throw (SALOME::SALOME_Exception);
260 CORBA::Long NbFaces()
261 throw (SALOME::SALOME_Exception);
263 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
264 throw (SALOME::SALOME_Exception);
266 CORBA::Long NbTriangles()
267 throw (SALOME::SALOME_Exception);
269 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
270 throw (SALOME::SALOME_Exception);
272 CORBA::Long NbQuadrangles()
273 throw (SALOME::SALOME_Exception);
275 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
276 throw (SALOME::SALOME_Exception);
278 CORBA::Long NbPolygons()
279 throw (SALOME::SALOME_Exception);
281 CORBA::Long NbVolumes()
282 throw (SALOME::SALOME_Exception);
284 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
285 throw (SALOME::SALOME_Exception);
287 CORBA::Long NbTetras()
288 throw (SALOME::SALOME_Exception);
290 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
291 throw (SALOME::SALOME_Exception);
293 CORBA::Long NbHexas()
294 throw (SALOME::SALOME_Exception);
296 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
297 throw (SALOME::SALOME_Exception);
299 CORBA::Long NbPyramids()
300 throw (SALOME::SALOME_Exception);
302 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
303 throw (SALOME::SALOME_Exception);
305 CORBA::Long NbPrisms()
306 throw (SALOME::SALOME_Exception);
308 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
309 throw (SALOME::SALOME_Exception);
311 CORBA::Long NbPolyhedrons()
312 throw (SALOME::SALOME_Exception);
314 CORBA::Long NbSubMesh()
315 throw (SALOME::SALOME_Exception);
317 SMESH::long_array* GetElementsId()
318 throw (SALOME::SALOME_Exception);
320 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
321 throw (SALOME::SALOME_Exception);
323 SMESH::long_array* GetNodesId()
324 throw (SALOME::SALOME_Exception);
326 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
327 throw (SALOME::SALOME_Exception);
329 SMESH::EntityType GetElementGeomType( CORBA::Long id )
330 throw (SALOME::SALOME_Exception);
333 * Returns ID of elements for given submesh
335 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
336 throw (SALOME::SALOME_Exception);
339 * Returns ID of nodes for given submesh
340 * If param all==true - returns all nodes, else -
341 * returns only nodes on shapes.
343 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
344 throw (SALOME::SALOME_Exception);
347 * Returns type of elements for given submesh
349 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
350 throw (SALOME::SALOME_Exception);
354 // Internal methods not available through CORBA
355 // They are called by corresponding interface methods
356 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
357 SMESH::SMESH_Hypothesis_ptr anHyp);
359 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
360 SMESH::SMESH_Hypothesis_ptr anHyp);
362 static SMESH::Hypothesis_Status
363 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
365 static void PrepareForWriting (const char* file, bool overwrite = true);
367 //int importMEDFile( const char* theFileName, const char* theMeshName );
369 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
371 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
372 GEOM::GEOM_Object_ptr theSubShapeObject );
374 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
376 const TopoDS_Shape& theShape = TopoDS_Shape(),
377 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
379 void removeGroup( const int theId );
381 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
382 // return an existing subMesh object for the shapeID. shapeID == submeshID.
384 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
385 // return an existing group object.
388 * \brief Update hypotheses assigned to geom groups if the latter change
390 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
392 void CheckGeomGroupModif();
394 CORBA::LongLong GetMeshPtr();
397 * \brief Assure that all groups are published
399 void CreateGroupServants();
402 * \brief Return groups cantained in _mapGroups by their IDs
404 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
407 * Get XYZ coordinates of node as list of double
408 * If there is not node for given ID - returns empty list
410 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
413 * For given node returns list of IDs of inverse elements
414 * If there is not node for given ID - returns empty list
416 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
419 * \brief Return position of a node on shape
421 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
424 * If given element is node returns IDs of shape from position
425 * If there is not node for given ID - returns -1
427 CORBA::Long GetShapeID(CORBA::Long id);
430 * For given element returns ID of result shape after
431 * ::FindShape() from SMESH_MeshEditor
432 * If there is not element for given ID - returns -1
434 CORBA::Long GetShapeIDForElem(CORBA::Long id);
437 * Returns number of nodes for given element
438 * If there is not element for given ID - returns -1
440 CORBA::Long GetElemNbNodes(CORBA::Long id);
443 * Returns IDs of nodes of given element
445 SMESH::long_array* GetElemNodes(CORBA::Long id);
448 * Returns ID of node by given index for given element
449 * If there is not element for given ID - returns -1
450 * If there is not node for given index - returns -2
452 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
455 * Returns true if given node is medium node
456 * in given quadratic element
458 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
461 * Returns true if given node is medium node
462 * in one of quadratic elements
464 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
465 SMESH::ElementType theElemType);
468 * Returns number of edges for given element
470 CORBA::Long ElemNbEdges(CORBA::Long id);
473 * Returns number of faces for given element
475 CORBA::Long ElemNbFaces(CORBA::Long id);
477 * Returns nodes of given face (counted from zero) for given element.
479 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
482 * Returns an element based on all given nodes.
484 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
487 * Returns true if given element is polygon
489 CORBA::Boolean IsPoly(CORBA::Long id);
492 * Returns true if given element is quadratic
494 CORBA::Boolean IsQuadratic(CORBA::Long id);
497 * Returns bary center for given element
499 SMESH::double_array* BaryCenter(CORBA::Long id);
502 * Returns information about imported MED file
504 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
507 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
509 void SetParameters (const char* theParameters);
512 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
514 char* GetParameters();
517 * Returns list of notebook variables used for last Mesh operation
519 SMESH::string_array* GetLastParameters();
522 * Collect statistic of mesh elements given by iterator
524 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
525 SMESH::long_array& theInfo);
528 * \brief Return submesh objects list in meshing order
530 virtual SMESH::submesh_array_array* GetMeshOrder();
532 * \brief Set submesh object order
534 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
537 // =========================
538 // SMESH_IDSource interface
539 // =========================
541 virtual SMESH::long_array* GetIDs();
543 * Returns statistic of mesh elements
544 * Result array of number enityties
545 * Inherited from SMESH_IDSource
547 virtual SMESH::long_array* GetMeshInfo();
549 * Returns types of elements it contains
551 virtual SMESH::array_of_ElementType* GetTypes();
555 virtual SMESH::SMESH_Mesh_ptr GetMesh();
558 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
559 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
563 * Check and correct names of mesh groups
565 void checkGroupNames();
568 * Convert submesh ids into submesh interfaces
570 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
571 SMESH::submesh_array_array& theSubMeshOrder,
572 const bool theIsDump);
576 static int myIdGenerator;
577 ::SMESH_Mesh* _impl; // :: force no namespace here
579 int _id; // id given by creator (unique within the creator instance)
581 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
582 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
583 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
584 SALOME_MED::MedFileInfo_var myFileInfo;
588 // Data used to track changes of GEOM groups
589 struct TGeomGroupData {
590 // keep study entry and not ior because GEOM_Object actually changes if
591 // number of items in a group varies (1) <-> (>1)
592 std::string _groupEntry;
593 std::set<int> _indices; // indices of group items within group's main shape
594 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
596 std::list<TGeomGroupData> _geomGroupData;
599 * Remember GEOM group data
601 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
602 CORBA::Object_ptr theSmeshObj);
604 * Remove GEOM group data relating to removed smesh object
606 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
608 * \brief Return new group contents if it has been changed and update group data
610 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);