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);
197 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
198 const int theMeshIndex,
199 std::string& theMeshName)
200 throw (SALOME::SALOME_Exception);
205 void SetAutoColor(CORBA::Boolean theAutoColor)
206 throw (SALOME::SALOME_Exception);
208 CORBA::Boolean GetAutoColor()
209 throw (SALOME::SALOME_Exception);
211 /*! Check group names for duplications.
212 * Consider maximum group name length stored in MED file.
214 CORBA::Boolean HasDuplicatedGroupNamesMED();
216 * Return string representation of a MED file version comprising nbDigits
218 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
220 void ExportToMEDX( const char* file,
221 CORBA::Boolean auto_groups,
222 SMESH::MED_VERSION version,
223 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
224 void ExportToMED ( const char* file,
225 CORBA::Boolean auto_groups,
226 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
227 void ExportMED ( const char* file,
228 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
230 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
231 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
232 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
233 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
235 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
237 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
239 CORBA::Boolean auto_groups,
240 SMESH::MED_VERSION version,
241 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
242 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
243 const char* file) throw (SALOME::SALOME_Exception);
244 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
245 const char* file) throw (SALOME::SALOME_Exception);
246 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
248 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
250 SALOME_MED::MESH_ptr GetMEDMesh()
251 throw (SALOME::SALOME_Exception);
253 CORBA::Long NbNodes()
254 throw (SALOME::SALOME_Exception);
256 CORBA::Long NbElements()
257 throw (SALOME::SALOME_Exception);
259 CORBA::Long Nb0DElements()
260 throw (SALOME::SALOME_Exception);
262 CORBA::Long NbEdges()
263 throw (SALOME::SALOME_Exception);
265 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
266 throw (SALOME::SALOME_Exception);
268 CORBA::Long NbFaces()
269 throw (SALOME::SALOME_Exception);
271 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
272 throw (SALOME::SALOME_Exception);
274 CORBA::Long NbTriangles()
275 throw (SALOME::SALOME_Exception);
277 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
278 throw (SALOME::SALOME_Exception);
280 CORBA::Long NbQuadrangles()
281 throw (SALOME::SALOME_Exception);
283 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
284 throw (SALOME::SALOME_Exception);
286 CORBA::Long NbPolygons()
287 throw (SALOME::SALOME_Exception);
289 CORBA::Long NbVolumes()
290 throw (SALOME::SALOME_Exception);
292 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
293 throw (SALOME::SALOME_Exception);
295 CORBA::Long NbTetras()
296 throw (SALOME::SALOME_Exception);
298 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
299 throw (SALOME::SALOME_Exception);
301 CORBA::Long NbHexas()
302 throw (SALOME::SALOME_Exception);
304 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
305 throw (SALOME::SALOME_Exception);
307 CORBA::Long NbPyramids()
308 throw (SALOME::SALOME_Exception);
310 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
311 throw (SALOME::SALOME_Exception);
313 CORBA::Long NbPrisms()
314 throw (SALOME::SALOME_Exception);
316 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
317 throw (SALOME::SALOME_Exception);
319 CORBA::Long NbPolyhedrons()
320 throw (SALOME::SALOME_Exception);
322 CORBA::Long NbSubMesh()
323 throw (SALOME::SALOME_Exception);
325 SMESH::long_array* GetElementsId()
326 throw (SALOME::SALOME_Exception);
328 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
329 throw (SALOME::SALOME_Exception);
331 SMESH::long_array* GetNodesId()
332 throw (SALOME::SALOME_Exception);
334 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
335 throw (SALOME::SALOME_Exception);
337 SMESH::EntityType GetElementGeomType( CORBA::Long id )
338 throw (SALOME::SALOME_Exception);
341 * Returns ID of elements for given submesh
343 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
344 throw (SALOME::SALOME_Exception);
347 * Returns ID of nodes for given submesh
348 * If param all==true - returns all nodes, else -
349 * returns only nodes on shapes.
351 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
352 throw (SALOME::SALOME_Exception);
355 * Returns type of elements for given submesh
357 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
358 throw (SALOME::SALOME_Exception);
362 // Internal methods not available through CORBA
363 // They are called by corresponding interface methods
364 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
365 SMESH::SMESH_Hypothesis_ptr anHyp);
367 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
368 SMESH::SMESH_Hypothesis_ptr anHyp);
370 static SMESH::Hypothesis_Status
371 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
373 static void PrepareForWriting (const char* file, bool overwrite = true);
375 //int importMEDFile( const char* theFileName, const char* theMeshName );
377 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
379 void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
380 GEOM::GEOM_Object_ptr theSubShapeObject );
382 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
384 const TopoDS_Shape& theShape = TopoDS_Shape(),
385 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
387 void removeGroup( const int theId );
389 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
390 // return an existing subMesh object for the shapeID. shapeID == submeshID.
392 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
393 // return an existing group object.
396 * \brief Update hypotheses assigned to geom groups if the latter change
398 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
400 void CheckGeomGroupModif();
402 CORBA::LongLong GetMeshPtr();
405 * \brief Assure that all groups are published
407 void CreateGroupServants();
410 * \brief Return groups cantained in _mapGroups by their IDs
412 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
415 * Get XYZ coordinates of node as list of double
416 * If there is not node for given ID - returns empty list
418 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
421 * For given node returns list of IDs of inverse elements
422 * If there is not node for given ID - returns empty list
424 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
427 * \brief Return position of a node on shape
429 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
432 * If given element is node returns IDs of shape from position
433 * If there is not node for given ID - returns -1
435 CORBA::Long GetShapeID(CORBA::Long id);
438 * For given element returns ID of result shape after
439 * ::FindShape() from SMESH_MeshEditor
440 * If there is not element for given ID - returns -1
442 CORBA::Long GetShapeIDForElem(CORBA::Long id);
445 * Returns number of nodes for given element
446 * If there is not element for given ID - returns -1
448 CORBA::Long GetElemNbNodes(CORBA::Long id);
451 * Returns IDs of nodes of given element
453 SMESH::long_array* GetElemNodes(CORBA::Long id);
456 * Returns ID of node by given index for given element
457 * If there is not element for given ID - returns -1
458 * If there is not node for given index - returns -2
460 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
463 * Returns true if given node is medium node
464 * in given quadratic element
466 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
469 * Returns true if given node is medium node
470 * in one of quadratic elements
472 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
473 SMESH::ElementType theElemType);
476 * Returns number of edges for given element
478 CORBA::Long ElemNbEdges(CORBA::Long id);
481 * Returns number of faces for given element
483 CORBA::Long ElemNbFaces(CORBA::Long id);
485 * Returns nodes of given face (counted from zero) for given element.
487 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
490 * Returns an element based on all given nodes.
492 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
495 * Returns true if given element is polygon
497 CORBA::Boolean IsPoly(CORBA::Long id);
500 * Returns true if given element is quadratic
502 CORBA::Boolean IsQuadratic(CORBA::Long id);
505 * Returns bary center for given element
507 SMESH::double_array* BaryCenter(CORBA::Long id);
510 * Returns information about imported MED file
512 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
515 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
517 void SetParameters (const char* theParameters);
520 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
522 char* GetParameters();
525 * Returns list of notebook variables used for last Mesh operation
527 SMESH::string_array* GetLastParameters();
530 * Collect statistic of mesh elements given by iterator
532 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
533 SMESH::long_array& theInfo);
536 * \brief Return submesh objects list in meshing order
538 virtual SMESH::submesh_array_array* GetMeshOrder();
540 * \brief Set submesh object order
542 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
545 // =========================
546 // SMESH_IDSource interface
547 // =========================
549 virtual SMESH::long_array* GetIDs();
551 * Returns statistic of mesh elements
552 * Result array of number enityties
553 * Inherited from SMESH_IDSource
555 virtual SMESH::long_array* GetMeshInfo();
557 * Returns types of elements it contains
559 virtual SMESH::array_of_ElementType* GetTypes();
563 virtual SMESH::SMESH_Mesh_ptr GetMesh();
566 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
567 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
571 * Check and correct names of mesh groups
573 void checkGroupNames();
576 * Convert submesh ids into submesh interfaces
578 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
579 SMESH::submesh_array_array& theSubMeshOrder,
580 const bool theIsDump);
584 static int myIdGenerator;
585 ::SMESH_Mesh* _impl; // :: force no namespace here
587 int _id; // id given by creator (unique within the creator instance)
589 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
590 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
591 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
592 SALOME_MED::MedFileInfo_var myFileInfo;
596 // Data used to track changes of GEOM groups
597 struct TGeomGroupData {
598 // keep study entry and not ior because GEOM_Object actually changes if
599 // number of items in a group varies (1) <-> (>1)
600 std::string _groupEntry;
601 std::set<int> _indices; // indices of group items within group's main shape
602 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
604 std::list<TGeomGroupData> _geomGroupData;
607 * Remember GEOM group data
609 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
610 CORBA::Object_ptr theSmeshObj);
612 * Remove GEOM group data relating to removed smesh object
614 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
616 * \brief Return new group contents if it has been changed and update group data
618 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);