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 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
106 throw (SALOME::SALOME_Exception);
108 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
109 throw (SALOME::SALOME_Exception);
111 SMESH::ListOfGroups* GetGroups()
112 throw (SALOME::SALOME_Exception);
114 CORBA::Long NbGroups()
115 throw (SALOME::SALOME_Exception);
117 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
118 SMESH::SMESH_GroupBase_ptr theGroup2,
119 const char* theName )
120 throw (SALOME::SALOME_Exception);
122 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
124 throw (SALOME::SALOME_Exception);
126 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
127 SMESH::SMESH_GroupBase_ptr theGroup2,
128 const char* theName )
129 throw (SALOME::SALOME_Exception);
131 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
132 const char* theName )
133 throw (SALOME::SALOME_Exception);
135 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
136 SMESH::SMESH_GroupBase_ptr theGroup2,
137 const char* theName )
138 throw (SALOME::SALOME_Exception);
140 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
141 const SMESH::ListOfGroups& theToolGroups,
142 const char* theName )
143 throw (SALOME::SALOME_Exception);
145 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
146 SMESH::ElementType theElemType,
147 const char* theName )
148 throw (SALOME::SALOME_Exception);
151 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupOnGeom_ptr theGeomGroup );
153 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
154 // throw (SALOME::SALOME_Exception);
156 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
157 throw (SALOME::SALOME_Exception);
159 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
161 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
163 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
166 throw (SALOME::SALOME_Exception);
169 throw (SALOME::SALOME_Exception);
171 CORBA::Long GetStudyId()
172 throw (SALOME::SALOME_Exception);
175 void SetImpl(::SMESH_Mesh* impl);
176 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
178 SMESH_Gen_i* GetGen() { return _gen_i; }
180 int ImportUNVFile( const char* theFileName )
181 throw (SALOME::SALOME_Exception);
183 int ImportSTLFile( const char* theFileName )
184 throw (SALOME::SALOME_Exception);
187 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
189 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
190 throw (SALOME::SALOME_Exception);
195 void SetAutoColor(CORBA::Boolean theAutoColor)
196 throw (SALOME::SALOME_Exception);
198 CORBA::Boolean GetAutoColor()
199 throw (SALOME::SALOME_Exception);
201 /*! Check group names for duplications.
202 * Consider maximum group name length stored in MED file.
204 CORBA::Boolean HasDuplicatedGroupNamesMED();
206 * Return string representation of a MED file version comprising nbDigits
208 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
210 void ExportToMEDX( const char* file,
211 CORBA::Boolean auto_groups,
212 SMESH::MED_VERSION version,
213 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
214 void ExportToMED ( const char* file,
215 CORBA::Boolean auto_groups,
216 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
217 void ExportMED ( const char* file,
218 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
220 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
221 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
222 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
224 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
226 CORBA::Boolean auto_groups,
227 SMESH::MED_VERSION version,
228 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
229 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
230 const char* file) throw (SALOME::SALOME_Exception);
231 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
232 const char* file) throw (SALOME::SALOME_Exception);
233 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
235 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
237 SALOME_MED::MESH_ptr GetMEDMesh()
238 throw (SALOME::SALOME_Exception);
240 CORBA::Long NbNodes()
241 throw (SALOME::SALOME_Exception);
243 CORBA::Long NbElements()
244 throw (SALOME::SALOME_Exception);
246 CORBA::Long Nb0DElements()
247 throw (SALOME::SALOME_Exception);
249 CORBA::Long NbEdges()
250 throw (SALOME::SALOME_Exception);
252 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
253 throw (SALOME::SALOME_Exception);
255 CORBA::Long NbFaces()
256 throw (SALOME::SALOME_Exception);
258 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
259 throw (SALOME::SALOME_Exception);
261 CORBA::Long NbTriangles()
262 throw (SALOME::SALOME_Exception);
264 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
265 throw (SALOME::SALOME_Exception);
267 CORBA::Long NbQuadrangles()
268 throw (SALOME::SALOME_Exception);
270 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
271 throw (SALOME::SALOME_Exception);
273 CORBA::Long NbPolygons()
274 throw (SALOME::SALOME_Exception);
276 CORBA::Long NbVolumes()
277 throw (SALOME::SALOME_Exception);
279 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
280 throw (SALOME::SALOME_Exception);
282 CORBA::Long NbTetras()
283 throw (SALOME::SALOME_Exception);
285 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
286 throw (SALOME::SALOME_Exception);
288 CORBA::Long NbHexas()
289 throw (SALOME::SALOME_Exception);
291 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
292 throw (SALOME::SALOME_Exception);
294 CORBA::Long NbPyramids()
295 throw (SALOME::SALOME_Exception);
297 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
298 throw (SALOME::SALOME_Exception);
300 CORBA::Long NbPrisms()
301 throw (SALOME::SALOME_Exception);
303 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
304 throw (SALOME::SALOME_Exception);
306 CORBA::Long NbPolyhedrons()
307 throw (SALOME::SALOME_Exception);
309 CORBA::Long NbSubMesh()
310 throw (SALOME::SALOME_Exception);
312 SMESH::long_array* GetElementsId()
313 throw (SALOME::SALOME_Exception);
315 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
316 throw (SALOME::SALOME_Exception);
318 SMESH::long_array* GetNodesId()
319 throw (SALOME::SALOME_Exception);
321 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
322 throw (SALOME::SALOME_Exception);
324 SMESH::EntityType GetElementGeomType( CORBA::Long id )
325 throw (SALOME::SALOME_Exception);
328 * Returns ID of elements for given submesh
330 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
331 throw (SALOME::SALOME_Exception);
334 * Returns ID of nodes for given submesh
335 * If param all==true - returns all nodes, else -
336 * returns only nodes on shapes.
338 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
339 throw (SALOME::SALOME_Exception);
342 * Returns type of elements for given submesh
344 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
345 throw (SALOME::SALOME_Exception);
349 // Internal methods not available through CORBA
350 // They are called by corresponding interface methods
351 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
352 SMESH::SMESH_Hypothesis_ptr anHyp);
354 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
355 SMESH::SMESH_Hypothesis_ptr anHyp);
357 static SMESH::Hypothesis_Status
358 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
360 static void PrepareForWriting (const char* file, bool overwrite = true);
362 //int importMEDFile( const char* theFileName, const char* theMeshName );
364 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
366 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
367 GEOM::GEOM_Object_ptr theSubShapeObject );
369 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
371 const TopoDS_Shape& theShape = TopoDS_Shape());
373 void removeGroup( const int theId );
375 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
376 // return an existing subMesh object for the shapeID. shapeID == submeshID.
378 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
379 // return an existing group object.
382 * \brief Update hypotheses assigned to geom groups if the latter change
384 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
386 void CheckGeomGroupModif();
388 CORBA::LongLong GetMeshPtr();
391 * \brief Assure that all groups are published
393 void CreateGroupServants();
396 * \brief Return groups cantained in _mapGroups by their IDs
398 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
401 * Get XYZ coordinates of node as list of double
402 * If there is not node for given ID - returns empty list
404 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
407 * For given node returns list of IDs of inverse elements
408 * If there is not node for given ID - returns empty list
410 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
413 * \brief Return position of a node on shape
415 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
418 * If given element is node returns IDs of shape from position
419 * If there is not node for given ID - returns -1
421 CORBA::Long GetShapeID(CORBA::Long id);
424 * For given element returns ID of result shape after
425 * ::FindShape() from SMESH_MeshEditor
426 * If there is not element for given ID - returns -1
428 CORBA::Long GetShapeIDForElem(CORBA::Long id);
431 * Returns number of nodes for given element
432 * If there is not element for given ID - returns -1
434 CORBA::Long GetElemNbNodes(CORBA::Long id);
437 * Returns IDs of nodes of given element
439 SMESH::long_array* GetElemNodes(CORBA::Long id);
442 * Returns ID of node by given index for given element
443 * If there is not element for given ID - returns -1
444 * If there is not node for given index - returns -2
446 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
449 * Returns true if given node is medium node
450 * in given quadratic element
452 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
455 * Returns true if given node is medium node
456 * in one of quadratic elements
458 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
459 SMESH::ElementType theElemType);
462 * Returns number of edges for given element
464 CORBA::Long ElemNbEdges(CORBA::Long id);
467 * Returns number of faces for given element
469 CORBA::Long ElemNbFaces(CORBA::Long id);
471 * Returns nodes of given face (counted from zero) for given element.
473 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
476 * Returns an element based on all given nodes.
478 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
481 * Returns true if given element is polygon
483 CORBA::Boolean IsPoly(CORBA::Long id);
486 * Returns true if given element is quadratic
488 CORBA::Boolean IsQuadratic(CORBA::Long id);
491 * Returns bary center for given element
493 SMESH::double_array* BaryCenter(CORBA::Long id);
496 * Returns information about imported MED file
498 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
501 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
503 void SetParameters (const char* theParameters);
506 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
508 char* GetParameters();
511 * Returns list of notebook variables used for last Mesh operation
513 SMESH::string_array* GetLastParameters();
516 * Collect statistic of mesh elements given by iterator
518 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
519 SMESH::long_array& theInfo);
522 * \brief Return submesh objects list in meshing order
524 virtual SMESH::submesh_array_array* GetMeshOrder();
526 * \brief Set submesh object order
528 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
531 // =========================
532 // SMESH_IDSource interface
533 // =========================
535 virtual SMESH::long_array* GetIDs();
537 * Returns statistic of mesh elements
538 * Result array of number enityties
539 * Inherited from SMESH_IDSource
541 virtual SMESH::long_array* GetMeshInfo();
543 * Returns types of elements it contains
545 virtual SMESH::array_of_ElementType* GetTypes();
549 virtual SMESH::SMESH_Mesh_ptr GetMesh();
552 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
553 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
557 * Check and correct names of mesh groups
559 void checkGroupNames();
562 * Convert submesh ids into submesh interfaces
564 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
565 SMESH::submesh_array_array& theSubMeshOrder,
566 const bool theIsDump);
570 static int myIdGenerator;
571 ::SMESH_Mesh* _impl; // :: force no namespace here
573 int _id; // id given by creator (unique within the creator instance)
575 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
576 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
577 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
578 SALOME_MED::MedFileInfo_var myFileInfo;
582 // Data used to track changes of GEOM groups
583 struct TGeomGroupData {
584 // keep study entry and not ior because GEOM_Object actually changes if
585 // number of items in a group varies (1) <-> (>1)
586 std::string _groupEntry;
587 std::set<int> _indices; // indices of group items within group's main shape
588 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
590 std::list<TGeomGroupData> _geomGroupData;
593 * Remember GEOM group data
595 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
596 CORBA::Object_ptr theSmeshObj);
598 * Remove GEOM group data relating to removed smesh object
600 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
602 * \brief Return new group contents if it has been changed and update group data
604 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);