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
23 // SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
24 // File : SMESH_Mesh_i.hxx
25 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_MESH_I_HXX_
29 #define _SMESH_MESH_I_HXX_
33 #include <SALOMEconfig.h>
34 #include CORBA_SERVER_HEADER(SMESH_Mesh)
35 #include CORBA_SERVER_HEADER(SMESH_Group)
36 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
37 #include CORBA_CLIENT_HEADER(GEOM_Gen)
38 #include CORBA_CLIENT_HEADER(MED)
40 #include "SMESH_Hypothesis.hxx"
41 #include "SMESH_Mesh.hxx"
42 //#include "SMESH_subMesh_i.hxx"
43 #include "SMESH_subMesh.hxx"
45 #include "SALOME_GenericObj_i.hh"
48 class SMESH_GroupBase_i;
49 class SMESH_subMesh_i;
53 class SMESH_I_EXPORT SMESH_Mesh_i:
54 public virtual POA_SMESH::SMESH_Mesh,
55 public virtual SALOME::GenericObj_i
58 SMESH_Mesh_i(const SMESH_Mesh_i&);
60 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
62 CORBA::Long studyId );
64 virtual ~SMESH_Mesh_i();
67 void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
68 throw (SALOME::SALOME_Exception);
70 CORBA::Boolean HasShapeToMesh()
71 throw (SALOME::SALOME_Exception);
73 GEOM::GEOM_Object_ptr GetShapeToMesh()
74 throw (SALOME::SALOME_Exception);
77 throw (SALOME::SALOME_Exception);
79 void ClearSubMesh(CORBA::Long ShapeID)
80 throw (SALOME::SALOME_Exception);
82 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
83 SMESH::SMESH_Hypothesis_ptr anHyp)
84 throw (SALOME::SALOME_Exception);
86 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
87 SMESH::SMESH_Hypothesis_ptr anHyp)
88 throw (SALOME::SALOME_Exception);
90 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
91 throw (SALOME::SALOME_Exception);
93 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
94 throw (SALOME::SALOME_Exception);
96 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
97 throw (SALOME::SALOME_Exception);
99 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
100 throw (SALOME::SALOME_Exception);
102 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
104 GEOM::GEOM_Object_ptr theGeomObj )
105 throw (SALOME::SALOME_Exception);
107 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
108 throw (SALOME::SALOME_Exception);
110 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
111 throw (SALOME::SALOME_Exception);
113 SMESH::ListOfGroups* GetGroups()
114 throw (SALOME::SALOME_Exception);
116 CORBA::Long NbGroups()
117 throw (SALOME::SALOME_Exception);
119 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
120 SMESH::SMESH_GroupBase_ptr theGroup2,
121 const char* theName )
122 throw (SALOME::SALOME_Exception);
124 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
126 throw (SALOME::SALOME_Exception);
128 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
129 SMESH::SMESH_GroupBase_ptr theGroup2,
130 const char* theName )
131 throw (SALOME::SALOME_Exception);
133 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
134 const char* theName )
135 throw (SALOME::SALOME_Exception);
137 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
138 SMESH::SMESH_GroupBase_ptr theGroup2,
139 const char* theName )
140 throw (SALOME::SALOME_Exception);
142 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
143 const SMESH::ListOfGroups& theToolGroups,
144 const char* theName )
145 throw (SALOME::SALOME_Exception);
147 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
148 SMESH::ElementType theElemType,
149 const char* theName )
150 throw (SALOME::SALOME_Exception);
153 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupOnGeom_ptr theGeomGroup );
155 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
156 // throw (SALOME::SALOME_Exception);
158 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
159 throw (SALOME::SALOME_Exception);
161 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
163 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
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, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion, CORBA::Boolean overwrite )
211 throw (SALOME::SALOME_Exception);
212 void ExportToMED( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion )
213 throw (SALOME::SALOME_Exception);
214 void ExportMED( const char* file, CORBA::Boolean auto_groups )
215 throw (SALOME::SALOME_Exception);
217 void ExportDAT( const char* file )
218 throw (SALOME::SALOME_Exception);
219 void ExportUNV( const char* file )
220 throw (SALOME::SALOME_Exception);
221 void ExportSTL( const char* file, bool isascii )
222 throw (SALOME::SALOME_Exception);
224 SALOME_MED::MESH_ptr GetMEDMesh()
225 throw (SALOME::SALOME_Exception);
227 CORBA::Long NbNodes()
228 throw (SALOME::SALOME_Exception);
230 CORBA::Long NbElements()
231 throw (SALOME::SALOME_Exception);
233 CORBA::Long Nb0DElements()
234 throw (SALOME::SALOME_Exception);
236 CORBA::Long NbEdges()
237 throw (SALOME::SALOME_Exception);
239 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
240 throw (SALOME::SALOME_Exception);
242 CORBA::Long NbFaces()
243 throw (SALOME::SALOME_Exception);
245 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
246 throw (SALOME::SALOME_Exception);
248 CORBA::Long NbTriangles()
249 throw (SALOME::SALOME_Exception);
251 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
252 throw (SALOME::SALOME_Exception);
254 CORBA::Long NbQuadrangles()
255 throw (SALOME::SALOME_Exception);
257 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
258 throw (SALOME::SALOME_Exception);
260 CORBA::Long NbPolygons()
261 throw (SALOME::SALOME_Exception);
263 CORBA::Long NbVolumes()
264 throw (SALOME::SALOME_Exception);
266 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
267 throw (SALOME::SALOME_Exception);
269 CORBA::Long NbTetras()
270 throw (SALOME::SALOME_Exception);
272 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
273 throw (SALOME::SALOME_Exception);
275 CORBA::Long NbHexas()
276 throw (SALOME::SALOME_Exception);
278 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
279 throw (SALOME::SALOME_Exception);
281 CORBA::Long NbPyramids()
282 throw (SALOME::SALOME_Exception);
284 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
285 throw (SALOME::SALOME_Exception);
287 CORBA::Long NbPrisms()
288 throw (SALOME::SALOME_Exception);
290 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
291 throw (SALOME::SALOME_Exception);
293 CORBA::Long NbPolyhedrons()
294 throw (SALOME::SALOME_Exception);
296 CORBA::Long NbSubMesh()
297 throw (SALOME::SALOME_Exception);
299 SMESH::long_array* GetElementsId()
300 throw (SALOME::SALOME_Exception);
302 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
303 throw (SALOME::SALOME_Exception);
305 SMESH::long_array* GetNodesId()
306 throw (SALOME::SALOME_Exception);
308 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
309 throw (SALOME::SALOME_Exception);
311 SMESH::EntityType GetElementGeomType( CORBA::Long id )
312 throw (SALOME::SALOME_Exception);
315 * Returns ID of elements for given submesh
317 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
318 throw (SALOME::SALOME_Exception);
321 * Returns ID of nodes for given submesh
322 * If param all==true - returns all nodes, else -
323 * returns only nodes on shapes.
325 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
326 throw (SALOME::SALOME_Exception);
329 * Returns type of elements for given submesh
331 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
332 throw (SALOME::SALOME_Exception);
336 // Internal methods not available through CORBA
337 // They are called by corresponding interface methods
338 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
339 SMESH::SMESH_Hypothesis_ptr anHyp);
341 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
342 SMESH::SMESH_Hypothesis_ptr anHyp);
344 static SMESH::Hypothesis_Status
345 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
347 static void PrepareForWriting (const char* file, bool overwrite = true);
349 //int importMEDFile( const char* theFileName, const char* theMeshName );
351 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
353 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
354 GEOM::GEOM_Object_ptr theSubShapeObject );
356 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
358 const TopoDS_Shape& theShape = TopoDS_Shape());
360 void removeGroup( const int theId );
362 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
363 // return an existing subMesh object for the shapeID. shapeID == submeshID.
365 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
366 // return an existing group object.
369 * \brief Update hypotheses assigned to geom groups if the latter change
371 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
373 void CheckGeomGroupModif();
375 virtual SMESH::long_array* GetIDs();
377 CORBA::LongLong GetMeshPtr();
380 * \brief Assure that all groups are published
382 void CreateGroupServants();
385 * \brief Return groups cantained in _mapGroups by their IDs
387 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
390 * Get XYZ coordinates of node as list of double
391 * If there is not node for given ID - returns empty list
393 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
396 * For given node returns list of IDs of inverse elements
397 * If there is not node for given ID - returns empty list
399 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
402 * \brief Return position of a node on shape
404 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
407 * If given element is node returns IDs of shape from position
408 * If there is not node for given ID - returns -1
410 CORBA::Long GetShapeID(CORBA::Long id);
413 * For given element returns ID of result shape after
414 * ::FindShape() from SMESH_MeshEditor
415 * If there is not element for given ID - returns -1
417 CORBA::Long GetShapeIDForElem(CORBA::Long id);
420 * Returns number of nodes for given element
421 * If there is not element for given ID - returns -1
423 CORBA::Long GetElemNbNodes(CORBA::Long id);
426 * Returns IDs of nodes of given element
428 SMESH::long_array* GetElemNodes(CORBA::Long id);
431 * Returns ID of node by given index for given element
432 * If there is not element for given ID - returns -1
433 * If there is not node for given index - returns -2
435 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
438 * Returns true if given node is medium node
439 * in given quadratic element
441 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
444 * Returns true if given node is medium node
445 * in one of quadratic elements
447 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
448 SMESH::ElementType theElemType);
451 * Returns number of edges for given element
453 CORBA::Long ElemNbEdges(CORBA::Long id);
456 * Returns number of faces for given element
458 CORBA::Long ElemNbFaces(CORBA::Long id);
460 * Returns nodes of given face (counted from zero) for given element.
462 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
465 * Returns an element based on all given nodes.
467 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
470 * Returns true if given element is polygon
472 CORBA::Boolean IsPoly(CORBA::Long id);
475 * Returns true if given element is quadratic
477 CORBA::Boolean IsQuadratic(CORBA::Long id);
480 * Returns bary center for given element
482 SMESH::double_array* BaryCenter(CORBA::Long id);
485 * Returns information about imported MED file
487 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
490 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
492 void SetParameters (const char* theParameters);
495 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
497 char* GetParameters();
500 * Returns list of notebook variables used for last Mesh operation
502 SMESH::string_array* GetLastParameters();
506 * Returns statistic of mesh elements
507 * Result array of number enityties
508 * Inherited from SMESH_IDSource
510 virtual SMESH::long_array* GetMeshInfo();
513 * Collect statistic of mesh elements given by iterator
515 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
516 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);