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::submesh_array* GetSubMeshes()
92 throw (SALOME::SALOME_Exception);
94 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
95 throw (SALOME::SALOME_Exception);
97 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
98 throw (SALOME::SALOME_Exception);
100 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
101 throw (SALOME::SALOME_Exception);
103 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
105 GEOM::GEOM_Object_ptr theGeomObj )
106 throw (SALOME::SALOME_Exception);
108 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
110 SMESH::Filter_ptr theFilter )
111 throw (SALOME::SALOME_Exception);
113 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
114 throw (SALOME::SALOME_Exception);
116 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
117 throw (SALOME::SALOME_Exception);
119 SMESH::ListOfGroups* GetGroups()
120 throw (SALOME::SALOME_Exception);
122 CORBA::Long NbGroups()
123 throw (SALOME::SALOME_Exception);
125 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
126 SMESH::SMESH_GroupBase_ptr theGroup2,
127 const char* theName )
128 throw (SALOME::SALOME_Exception);
130 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
132 throw (SALOME::SALOME_Exception);
134 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
135 SMESH::SMESH_GroupBase_ptr theGroup2,
136 const char* theName )
137 throw (SALOME::SALOME_Exception);
139 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
140 const char* theName )
141 throw (SALOME::SALOME_Exception);
143 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
144 SMESH::SMESH_GroupBase_ptr theGroup2,
145 const char* theName )
146 throw (SALOME::SALOME_Exception);
148 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
149 const SMESH::ListOfGroups& theToolGroups,
150 const char* theName )
151 throw (SALOME::SALOME_Exception);
153 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
154 SMESH::ElementType theElemType,
155 const char* theName )
156 throw (SALOME::SALOME_Exception);
159 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn );
161 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
162 // throw (SALOME::SALOME_Exception);
164 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
165 throw (SALOME::SALOME_Exception);
167 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
169 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
171 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
174 throw (SALOME::SALOME_Exception);
177 throw (SALOME::SALOME_Exception);
179 CORBA::Long GetStudyId()
180 throw (SALOME::SALOME_Exception);
183 void SetImpl(::SMESH_Mesh* impl);
184 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
186 SMESH_Gen_i* GetGen() { return _gen_i; }
188 int ImportUNVFile( const char* theFileName )
189 throw (SALOME::SALOME_Exception);
191 int ImportSTLFile( const char* theFileName )
192 throw (SALOME::SALOME_Exception);
195 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
197 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
198 throw (SALOME::SALOME_Exception);
200 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
201 const int theMeshIndex,
202 std::string& theMeshName)
203 throw (SALOME::SALOME_Exception);
208 void SetAutoColor(CORBA::Boolean theAutoColor)
209 throw (SALOME::SALOME_Exception);
211 CORBA::Boolean GetAutoColor()
212 throw (SALOME::SALOME_Exception);
214 /*! Check group names for duplications.
215 * Consider maximum group name length stored in MED file.
217 CORBA::Boolean HasDuplicatedGroupNamesMED();
219 * Return string representation of a MED file version comprising nbDigits
221 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
223 void ExportToMEDX( const char* file,
224 CORBA::Boolean auto_groups,
225 SMESH::MED_VERSION version,
226 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
227 void ExportToMED ( const char* file,
228 CORBA::Boolean auto_groups,
229 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
230 void ExportMED ( const char* file,
231 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
233 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
234 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
235 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
236 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
238 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
240 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
242 CORBA::Boolean auto_groups,
243 SMESH::MED_VERSION version,
244 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
245 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
246 const char* file) throw (SALOME::SALOME_Exception);
247 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
248 const char* file) throw (SALOME::SALOME_Exception);
249 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
251 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
253 SALOME_MED::MESH_ptr GetMEDMesh()
254 throw (SALOME::SALOME_Exception);
256 CORBA::Long NbNodes()
257 throw (SALOME::SALOME_Exception);
259 CORBA::Long NbElements()
260 throw (SALOME::SALOME_Exception);
262 CORBA::Long Nb0DElements()
263 throw (SALOME::SALOME_Exception);
265 CORBA::Long NbEdges()
266 throw (SALOME::SALOME_Exception);
268 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
269 throw (SALOME::SALOME_Exception);
271 CORBA::Long NbFaces()
272 throw (SALOME::SALOME_Exception);
274 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
275 throw (SALOME::SALOME_Exception);
277 CORBA::Long NbTriangles()
278 throw (SALOME::SALOME_Exception);
280 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
281 throw (SALOME::SALOME_Exception);
283 CORBA::Long NbQuadrangles()
284 throw (SALOME::SALOME_Exception);
286 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
287 throw (SALOME::SALOME_Exception);
289 CORBA::Long NbPolygons()
290 throw (SALOME::SALOME_Exception);
292 CORBA::Long NbVolumes()
293 throw (SALOME::SALOME_Exception);
295 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
296 throw (SALOME::SALOME_Exception);
298 CORBA::Long NbTetras()
299 throw (SALOME::SALOME_Exception);
301 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
302 throw (SALOME::SALOME_Exception);
304 CORBA::Long NbHexas()
305 throw (SALOME::SALOME_Exception);
307 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
308 throw (SALOME::SALOME_Exception);
310 CORBA::Long NbPyramids()
311 throw (SALOME::SALOME_Exception);
313 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
314 throw (SALOME::SALOME_Exception);
316 CORBA::Long NbPrisms()
317 throw (SALOME::SALOME_Exception);
319 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
320 throw (SALOME::SALOME_Exception);
322 CORBA::Long NbPolyhedrons()
323 throw (SALOME::SALOME_Exception);
325 CORBA::Long NbSubMesh()
326 throw (SALOME::SALOME_Exception);
328 SMESH::long_array* GetElementsId()
329 throw (SALOME::SALOME_Exception);
331 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
332 throw (SALOME::SALOME_Exception);
334 SMESH::long_array* GetNodesId()
335 throw (SALOME::SALOME_Exception);
337 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
338 throw (SALOME::SALOME_Exception);
340 SMESH::EntityType GetElementGeomType( CORBA::Long id )
341 throw (SALOME::SALOME_Exception);
344 * Returns ID of elements for given submesh
346 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
347 throw (SALOME::SALOME_Exception);
350 * Returns ID of nodes for given submesh
351 * If param all==true - returns all nodes, else -
352 * returns only nodes on shapes.
354 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
355 throw (SALOME::SALOME_Exception);
358 * Returns type of elements for given submesh
360 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
361 throw (SALOME::SALOME_Exception);
365 // Internal methods not available through CORBA
366 // They are called by corresponding interface methods
367 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
368 SMESH::SMESH_Hypothesis_ptr anHyp);
370 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
371 SMESH::SMESH_Hypothesis_ptr anHyp);
373 static SMESH::Hypothesis_Status
374 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
376 static void PrepareForWriting (const char* file, bool overwrite = true);
378 //int importMEDFile( const char* theFileName, const char* theMeshName );
380 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
382 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
383 GEOM::GEOM_Object_ptr theSubShapeObject );
385 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
387 const TopoDS_Shape& theShape = TopoDS_Shape(),
388 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
390 void removeGroup( const int theId );
392 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
393 // return an existing subMesh object for the shapeID. shapeID == submeshID.
395 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
396 // return an existing group object.
399 * \brief Update hypotheses assigned to geom groups if the latter change
401 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
403 void CheckGeomGroupModif();
405 CORBA::LongLong GetMeshPtr();
408 * \brief Assure that all groups are published
410 void CreateGroupServants();
413 * \brief Return groups cantained in _mapGroups by their IDs
415 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
418 * Get XYZ coordinates of node as list of double
419 * If there is not node for given ID - returns empty list
421 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
424 * For given node returns list of IDs of inverse elements
425 * If there is not node for given ID - returns empty list
427 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
430 * \brief Return position of a node on shape
432 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
435 * If given element is node returns IDs of shape from position
436 * If there is not node for given ID - returns -1
438 CORBA::Long GetShapeID(CORBA::Long id);
441 * For given element returns ID of result shape after
442 * ::FindShape() from SMESH_MeshEditor
443 * If there is not element for given ID - returns -1
445 CORBA::Long GetShapeIDForElem(CORBA::Long id);
448 * Returns number of nodes for given element
449 * If there is not element for given ID - returns -1
451 CORBA::Long GetElemNbNodes(CORBA::Long id);
454 * Returns IDs of nodes of given element
456 SMESH::long_array* GetElemNodes(CORBA::Long id);
459 * Returns ID of node by given index for given element
460 * If there is not element for given ID - returns -1
461 * If there is not node for given index - returns -2
463 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
466 * Returns true if given node is medium node
467 * in given quadratic element
469 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
472 * Returns true if given node is medium node
473 * in one of quadratic elements
475 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
476 SMESH::ElementType theElemType);
479 * Returns number of edges for given element
481 CORBA::Long ElemNbEdges(CORBA::Long id);
484 * Returns number of faces for given element
486 CORBA::Long ElemNbFaces(CORBA::Long id);
488 * Returns nodes of given face (counted from zero) for given element.
490 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
493 * Returns an element based on all given nodes.
495 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
498 * Returns true if given element is polygon
500 CORBA::Boolean IsPoly(CORBA::Long id);
503 * Returns true if given element is quadratic
505 CORBA::Boolean IsQuadratic(CORBA::Long id);
508 * Returns bary center for given element
510 SMESH::double_array* BaryCenter(CORBA::Long id);
513 * Returns information about imported MED file
515 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
518 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
520 void SetParameters (const char* theParameters);
523 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
525 char* GetParameters();
528 * Returns list of notebook variables used for last Mesh operation
530 SMESH::string_array* GetLastParameters();
533 * Collect statistic of mesh elements given by iterator
535 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
536 SMESH::long_array& theInfo);
539 * \brief Return submesh objects list in meshing order
541 virtual SMESH::submesh_array_array* GetMeshOrder();
543 * \brief Set submesh object order
545 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
548 // =========================
549 // SMESH_IDSource interface
550 // =========================
552 virtual SMESH::long_array* GetIDs();
554 * Returns statistic of mesh elements
555 * Result array of number enityties
556 * Inherited from SMESH_IDSource
558 virtual SMESH::long_array* GetMeshInfo();
560 * Returns types of elements it contains
562 virtual SMESH::array_of_ElementType* GetTypes();
566 virtual SMESH::SMESH_Mesh_ptr GetMesh();
569 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
570 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
574 * Check and correct names of mesh groups
576 void checkGroupNames();
579 * Convert submesh ids into submesh interfaces
581 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
582 SMESH::submesh_array_array& theSubMeshOrder,
583 const bool theIsDump);
587 static int myIdGenerator;
588 ::SMESH_Mesh* _impl; // :: force no namespace here
590 int _id; // id given by creator (unique within the creator instance)
592 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
593 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
594 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
595 SALOME_MED::MedFileInfo_var myFileInfo;
599 // Data used to track changes of GEOM groups
600 struct TGeomGroupData {
601 // keep study entry and not ior because GEOM_Object actually changes if
602 // number of items in a group varies (1) <-> (>1)
603 std::string _groupEntry;
604 std::set<int> _indices; // indices of group items within group's main shape
605 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
607 std::list<TGeomGroupData> _geomGroupData;
610 * Remember GEOM group data
612 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
613 CORBA::Object_ptr theSmeshObj);
615 * Remove GEOM group data relating to removed smesh object
617 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
619 * \brief Return new group contents if it has been changed and update group data
621 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);