1 // Copyright (C) 2007-2010 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 // SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
23 // File : SMESH_Mesh_i.hxx
24 // Author : Paul RASCLE, EDF
27 #ifndef _SMESH_MESH_I_HXX_
28 #define _SMESH_MESH_I_HXX_
32 #include <SALOMEconfig.h>
33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
34 #include CORBA_SERVER_HEADER(SMESH_Group)
35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
37 #include CORBA_CLIENT_HEADER(MED)
39 #include "SMESH_Hypothesis.hxx"
40 #include "SMESH_Mesh.hxx"
41 //#include "SMESH_subMesh_i.hxx"
42 #include "SMESH_subMesh.hxx"
44 #include "SALOME_GenericObj_i.hh"
47 class SMESH_GroupBase_i;
48 class SMESH_subMesh_i;
52 class SMESH_I_EXPORT SMESH_Mesh_i:
53 public virtual POA_SMESH::SMESH_Mesh,
54 public virtual SALOME::GenericObj_i
57 SMESH_Mesh_i(const SMESH_Mesh_i&);
59 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
61 CORBA::Long studyId );
63 virtual ~SMESH_Mesh_i();
66 void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
67 throw (SALOME::SALOME_Exception);
69 CORBA::Boolean HasShapeToMesh()
70 throw (SALOME::SALOME_Exception);
72 GEOM::GEOM_Object_ptr GetShapeToMesh()
73 throw (SALOME::SALOME_Exception);
76 throw (SALOME::SALOME_Exception);
78 void ClearSubMesh(CORBA::Long ShapeID)
79 throw (SALOME::SALOME_Exception);
81 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
82 SMESH::SMESH_Hypothesis_ptr anHyp)
83 throw (SALOME::SALOME_Exception);
85 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
86 SMESH::SMESH_Hypothesis_ptr anHyp)
87 throw (SALOME::SALOME_Exception);
89 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
90 throw (SALOME::SALOME_Exception);
92 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
93 throw (SALOME::SALOME_Exception);
95 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
96 throw (SALOME::SALOME_Exception);
98 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
99 throw (SALOME::SALOME_Exception);
101 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
103 GEOM::GEOM_Object_ptr theGeomObj )
104 throw (SALOME::SALOME_Exception);
106 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
107 throw (SALOME::SALOME_Exception);
109 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
110 throw (SALOME::SALOME_Exception);
112 SMESH::ListOfGroups* GetGroups()
113 throw (SALOME::SALOME_Exception);
115 CORBA::Long NbGroups()
116 throw (SALOME::SALOME_Exception);
118 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
119 SMESH::SMESH_GroupBase_ptr theGroup2,
120 const char* theName )
121 throw (SALOME::SALOME_Exception);
123 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
125 throw (SALOME::SALOME_Exception);
127 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
128 SMESH::SMESH_GroupBase_ptr theGroup2,
129 const char* theName )
130 throw (SALOME::SALOME_Exception);
132 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
133 const char* theName )
134 throw (SALOME::SALOME_Exception);
136 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
137 SMESH::SMESH_GroupBase_ptr theGroup2,
138 const char* theName )
139 throw (SALOME::SALOME_Exception);
141 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
142 const SMESH::ListOfGroups& theToolGroups,
143 const char* theName )
144 throw (SALOME::SALOME_Exception);
146 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
147 SMESH::ElementType theElemType,
148 const char* theName )
149 throw (SALOME::SALOME_Exception);
152 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupOnGeom_ptr theGeomGroup );
154 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
155 // throw (SALOME::SALOME_Exception);
157 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
158 throw (SALOME::SALOME_Exception);
160 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
162 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
164 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
167 throw (SALOME::SALOME_Exception);
170 throw (SALOME::SALOME_Exception);
172 CORBA::Long GetStudyId()
173 throw (SALOME::SALOME_Exception);
176 void SetImpl(::SMESH_Mesh* impl);
177 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
179 SMESH_Gen_i* GetGen() { return _gen_i; }
181 int ImportUNVFile( const char* theFileName )
182 throw (SALOME::SALOME_Exception);
184 int ImportSTLFile( const char* theFileName )
185 throw (SALOME::SALOME_Exception);
188 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
190 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
191 throw (SALOME::SALOME_Exception);
196 void SetAutoColor(CORBA::Boolean theAutoColor)
197 throw (SALOME::SALOME_Exception);
199 CORBA::Boolean GetAutoColor()
200 throw (SALOME::SALOME_Exception);
202 /*! Check group names for duplications.
203 * Consider maximum group name length stored in MED file.
205 CORBA::Boolean HasDuplicatedGroupNamesMED();
207 * Return string representation of a MED file version comprising nbDigits
209 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
211 void ExportToMEDX( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion, CORBA::Boolean overwrite )
212 throw (SALOME::SALOME_Exception);
213 void ExportToMED( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion )
214 throw (SALOME::SALOME_Exception);
215 void ExportMED( const char* file, CORBA::Boolean auto_groups )
216 throw (SALOME::SALOME_Exception);
218 void ExportDAT( const char* file )
219 throw (SALOME::SALOME_Exception);
220 void ExportUNV( const char* file )
221 throw (SALOME::SALOME_Exception);
222 void ExportSTL( const char* file, bool isascii )
223 throw (SALOME::SALOME_Exception);
225 SALOME_MED::MESH_ptr GetMEDMesh()
226 throw (SALOME::SALOME_Exception);
228 CORBA::Long NbNodes()
229 throw (SALOME::SALOME_Exception);
231 CORBA::Long NbElements()
232 throw (SALOME::SALOME_Exception);
234 CORBA::Long Nb0DElements()
235 throw (SALOME::SALOME_Exception);
237 CORBA::Long NbEdges()
238 throw (SALOME::SALOME_Exception);
240 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
241 throw (SALOME::SALOME_Exception);
243 CORBA::Long NbFaces()
244 throw (SALOME::SALOME_Exception);
246 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
247 throw (SALOME::SALOME_Exception);
249 CORBA::Long NbTriangles()
250 throw (SALOME::SALOME_Exception);
252 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
253 throw (SALOME::SALOME_Exception);
255 CORBA::Long NbQuadrangles()
256 throw (SALOME::SALOME_Exception);
258 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
259 throw (SALOME::SALOME_Exception);
261 CORBA::Long NbPolygons()
262 throw (SALOME::SALOME_Exception);
264 CORBA::Long NbVolumes()
265 throw (SALOME::SALOME_Exception);
267 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
268 throw (SALOME::SALOME_Exception);
270 CORBA::Long NbTetras()
271 throw (SALOME::SALOME_Exception);
273 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
274 throw (SALOME::SALOME_Exception);
276 CORBA::Long NbHexas()
277 throw (SALOME::SALOME_Exception);
279 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
280 throw (SALOME::SALOME_Exception);
282 CORBA::Long NbPyramids()
283 throw (SALOME::SALOME_Exception);
285 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
286 throw (SALOME::SALOME_Exception);
288 CORBA::Long NbPrisms()
289 throw (SALOME::SALOME_Exception);
291 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
292 throw (SALOME::SALOME_Exception);
294 CORBA::Long NbPolyhedrons()
295 throw (SALOME::SALOME_Exception);
297 CORBA::Long NbSubMesh()
298 throw (SALOME::SALOME_Exception);
300 SMESH::long_array* GetElementsId()
301 throw (SALOME::SALOME_Exception);
303 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
304 throw (SALOME::SALOME_Exception);
306 SMESH::long_array* GetNodesId()
307 throw (SALOME::SALOME_Exception);
309 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
310 throw (SALOME::SALOME_Exception);
312 SMESH::EntityType GetElementGeomType( CORBA::Long id )
313 throw (SALOME::SALOME_Exception);
316 * Returns ID of elements for given submesh
318 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
319 throw (SALOME::SALOME_Exception);
322 * Returns ID of nodes for given submesh
323 * If param all==true - returns all nodes, else -
324 * returns only nodes on shapes.
326 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
327 throw (SALOME::SALOME_Exception);
330 * Returns type of elements for given submesh
332 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
333 throw (SALOME::SALOME_Exception);
337 // Internal methods not available through CORBA
338 // They are called by corresponding interface methods
339 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
340 SMESH::SMESH_Hypothesis_ptr anHyp);
342 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
343 SMESH::SMESH_Hypothesis_ptr anHyp);
345 static SMESH::Hypothesis_Status
346 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
348 static void PrepareForWriting (const char* file, bool overwrite = true);
350 //int importMEDFile( const char* theFileName, const char* theMeshName );
352 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
354 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
355 GEOM::GEOM_Object_ptr theSubShapeObject );
357 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
359 const TopoDS_Shape& theShape = TopoDS_Shape());
361 void removeGroup( const int theId );
363 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
364 // return an existing subMesh object for the shapeID. shapeID == submeshID.
366 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
367 // return an existing group object.
370 * \brief Update hypotheses assigned to geom groups if the latter change
372 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
374 void CheckGeomGroupModif();
376 virtual SMESH::long_array* GetIDs();
378 CORBA::LongLong GetMeshPtr();
381 * \brief Assure that all groups are published
383 void CreateGroupServants();
386 * \brief Return groups cantained in _mapGroups by their IDs
388 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
391 * Get XYZ coordinates of node as list of double
392 * If there is not node for given ID - returns empty list
394 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
397 * For given node returns list of IDs of inverse elements
398 * If there is not node for given ID - returns empty list
400 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
403 * \brief Return position of a node on shape
405 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
408 * If given element is node returns IDs of shape from position
409 * If there is not node for given ID - returns -1
411 CORBA::Long GetShapeID(CORBA::Long id);
414 * For given element returns ID of result shape after
415 * ::FindShape() from SMESH_MeshEditor
416 * If there is not element for given ID - returns -1
418 CORBA::Long GetShapeIDForElem(CORBA::Long id);
421 * Returns number of nodes for given element
422 * If there is not element for given ID - returns -1
424 CORBA::Long GetElemNbNodes(CORBA::Long id);
427 * Returns IDs of nodes of given element
429 SMESH::long_array* GetElemNodes(CORBA::Long id);
432 * Returns ID of node by given index for given element
433 * If there is not element for given ID - returns -1
434 * If there is not node for given index - returns -2
436 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
439 * Returns true if given node is medium node
440 * in given quadratic element
442 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
445 * Returns true if given node is medium node
446 * in one of quadratic elements
448 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
449 SMESH::ElementType theElemType);
452 * Returns number of edges for given element
454 CORBA::Long ElemNbEdges(CORBA::Long id);
457 * Returns number of faces for given element
459 CORBA::Long ElemNbFaces(CORBA::Long id);
461 * Returns nodes of given face (counted from zero) for given element.
463 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
466 * Returns an element based on all given nodes.
468 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
471 * Returns true if given element is polygon
473 CORBA::Boolean IsPoly(CORBA::Long id);
476 * Returns true if given element is quadratic
478 CORBA::Boolean IsQuadratic(CORBA::Long id);
481 * Returns bary center for given element
483 SMESH::double_array* BaryCenter(CORBA::Long id);
486 * Returns information about imported MED file
488 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
491 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
493 void SetParameters (const char* theParameters);
496 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
498 char* GetParameters();
501 * Returns list of notebook variables used for last Mesh operation
503 SMESH::string_array* GetLastParameters();
507 * Returns statistic of mesh elements
508 * Result array of number enityties
509 * Inherited from SMESH_IDSource
511 virtual SMESH::long_array* GetMeshInfo();
514 * Collect statistic of mesh elements given by iterator
516 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
517 SMESH::long_array& theInfo);
520 * \brief Return submesh objects list in meshing order
522 virtual SMESH::submesh_array_array* GetMeshOrder();
524 * \brief Set submesh object order
526 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
529 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
530 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
534 * Check and correct names of mesh groups
536 void checkGroupNames();
539 * Convert submesh ids into submesh interfaces
541 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
542 SMESH::submesh_array_array& theSubMeshOrder,
543 const bool theIsDump);
547 static int myIdGenerator;
548 ::SMESH_Mesh* _impl; // :: force no namespace here
550 int _id; // id given by creator (unique within the creator instance)
552 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
553 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
554 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
555 SALOME_MED::MedFileInfo_var myFileInfo;
559 // Data used to track changes of GEOM groups
560 struct TGeomGroupData {
561 // keep study entry and not ior because GEOM_Object actually changes if
562 // number of items in a group varies (1) <-> (>1)
563 std::string _groupEntry;
564 std::set<int> _indices; // indices of group items within group's main shape
565 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
567 std::list<TGeomGroupData> _geomGroupData;
570 * Remember GEOM group data
572 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
573 CORBA::Object_ptr theSmeshObj);
575 * Remove GEOM group data relating to removed smesh object
577 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
579 * \brief Return new group contents if it has been changed and update group data
581 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);