1 // Copyright (C) 2007-2012 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;
48 class SMESH_PreMeshInfo;
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);
75 CORBA::Boolean IsLoaded()
76 throw (SALOME::SALOME_Exception);
79 throw (SALOME::SALOME_Exception);
82 throw (SALOME::SALOME_Exception);
84 void ClearSubMesh(CORBA::Long ShapeID)
85 throw (SALOME::SALOME_Exception);
87 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
88 SMESH::SMESH_Hypothesis_ptr anHyp)
89 throw (SALOME::SALOME_Exception);
91 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
92 SMESH::SMESH_Hypothesis_ptr anHyp)
93 throw (SALOME::SALOME_Exception);
95 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
96 throw (SALOME::SALOME_Exception);
98 SMESH::submesh_array* GetSubMeshes()
99 throw (SALOME::SALOME_Exception);
101 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
102 throw (SALOME::SALOME_Exception);
104 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
105 throw (SALOME::SALOME_Exception);
107 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
108 throw (SALOME::SALOME_Exception);
110 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
112 GEOM::GEOM_Object_ptr theGeomObj )
113 throw (SALOME::SALOME_Exception);
115 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
117 SMESH::Filter_ptr theFilter )
118 throw (SALOME::SALOME_Exception);
120 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
121 throw (SALOME::SALOME_Exception);
123 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
124 throw (SALOME::SALOME_Exception);
126 SMESH::ListOfGroups* GetGroups()
127 throw (SALOME::SALOME_Exception);
129 CORBA::Long NbGroups()
130 throw (SALOME::SALOME_Exception);
132 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
133 SMESH::SMESH_GroupBase_ptr theGroup2,
134 const char* theName )
135 throw (SALOME::SALOME_Exception);
137 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
139 throw (SALOME::SALOME_Exception);
141 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
142 SMESH::SMESH_GroupBase_ptr theGroup2,
143 const char* theName )
144 throw (SALOME::SALOME_Exception);
146 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
147 const char* theName )
148 throw (SALOME::SALOME_Exception);
150 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
151 SMESH::SMESH_GroupBase_ptr theGroup2,
152 const char* theName )
153 throw (SALOME::SALOME_Exception);
155 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
156 const SMESH::ListOfGroups& theToolGroups,
157 const char* theName )
158 throw (SALOME::SALOME_Exception);
160 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
161 SMESH::ElementType theElemType,
162 const char* theName )
163 throw (SALOME::SALOME_Exception);
166 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn );
168 // SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
169 // throw (SALOME::SALOME_Exception);
171 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
172 throw (SALOME::SALOME_Exception);
174 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
176 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
178 CORBA::Boolean HasModificationsToDiscard() throw (SALOME::SALOME_Exception);
181 throw (SALOME::SALOME_Exception);
184 throw (SALOME::SALOME_Exception);
186 CORBA::Long GetStudyId()
187 throw (SALOME::SALOME_Exception);
190 void SetImpl(::SMESH_Mesh* impl);
191 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
193 SMESH_Gen_i* GetGen() { return _gen_i; }
195 int ImportUNVFile( const char* theFileName )
196 throw (SALOME::SALOME_Exception);
198 int ImportSTLFile( const char* theFileName )
199 throw (SALOME::SALOME_Exception);
202 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
204 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
205 throw (SALOME::SALOME_Exception);
207 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
208 const int theMeshIndex,
209 std::string& theMeshName)
210 throw (SALOME::SALOME_Exception);
215 void SetAutoColor(CORBA::Boolean theAutoColor)
216 throw (SALOME::SALOME_Exception);
218 CORBA::Boolean GetAutoColor()
219 throw (SALOME::SALOME_Exception);
221 /*! Check group names for duplications.
222 * Consider maximum group name length stored in MED file.
224 CORBA::Boolean HasDuplicatedGroupNamesMED();
226 * Return string representation of a MED file version comprising nbDigits
228 char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
230 void ExportToMEDX( const char* file,
231 CORBA::Boolean auto_groups,
232 SMESH::MED_VERSION version,
233 CORBA::Boolean overwrite ) throw (SALOME::SALOME_Exception);
234 void ExportToMED ( const char* file,
235 CORBA::Boolean auto_groups,
236 SMESH::MED_VERSION version ) throw (SALOME::SALOME_Exception);
237 void ExportMED ( const char* file,
238 CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
240 void ExportSAUV( const char* file, CORBA::Boolean auto_groups ) throw (SALOME::SALOME_Exception);
242 void ExportDAT( const char* file ) throw (SALOME::SALOME_Exception);
243 void ExportUNV( const char* file ) throw (SALOME::SALOME_Exception);
244 void ExportSTL( const char* file, bool isascii ) throw (SALOME::SALOME_Exception);
245 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
247 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
249 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
251 CORBA::Boolean auto_groups,
252 SMESH::MED_VERSION version,
253 CORBA::Boolean overwrite) throw (SALOME::SALOME_Exception);
254 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
255 const char* file) throw (SALOME::SALOME_Exception);
256 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
257 const char* file) throw (SALOME::SALOME_Exception);
258 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
260 CORBA::Boolean isascii) throw (SALOME::SALOME_Exception);
262 SALOME_MED::MESH_ptr GetMEDMesh()
263 throw (SALOME::SALOME_Exception);
265 CORBA::Long NbNodes()
266 throw (SALOME::SALOME_Exception);
268 CORBA::Long NbElements()
269 throw (SALOME::SALOME_Exception);
271 CORBA::Long Nb0DElements()
272 throw (SALOME::SALOME_Exception);
274 CORBA::Long NbBalls()
275 throw (SALOME::SALOME_Exception);
277 CORBA::Long NbEdges()
278 throw (SALOME::SALOME_Exception);
280 CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
281 throw (SALOME::SALOME_Exception);
283 CORBA::Long NbFaces()
284 throw (SALOME::SALOME_Exception);
286 CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
287 throw (SALOME::SALOME_Exception);
289 CORBA::Long NbTriangles()
290 throw (SALOME::SALOME_Exception);
292 CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
293 throw (SALOME::SALOME_Exception);
295 CORBA::Long NbQuadrangles()
296 throw (SALOME::SALOME_Exception);
298 CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
299 throw (SALOME::SALOME_Exception);
301 CORBA::Long NbBiQuadQuadrangles()
302 throw (SALOME::SALOME_Exception);
304 CORBA::Long NbPolygons()
305 throw (SALOME::SALOME_Exception);
307 CORBA::Long NbVolumes()
308 throw (SALOME::SALOME_Exception);
310 CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
311 throw (SALOME::SALOME_Exception);
313 CORBA::Long NbTetras()
314 throw (SALOME::SALOME_Exception);
316 CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
317 throw (SALOME::SALOME_Exception);
319 CORBA::Long NbHexas()
320 throw (SALOME::SALOME_Exception);
322 CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
323 throw (SALOME::SALOME_Exception);
325 CORBA::Long NbTriQuadraticHexas()
326 throw (SALOME::SALOME_Exception);
328 CORBA::Long NbPyramids()
329 throw (SALOME::SALOME_Exception);
331 CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
332 throw (SALOME::SALOME_Exception);
334 CORBA::Long NbPrisms()
335 throw (SALOME::SALOME_Exception);
337 CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
338 throw (SALOME::SALOME_Exception);
340 CORBA::Long NbHexagonalPrisms()
341 throw (SALOME::SALOME_Exception);
343 CORBA::Long NbPolyhedrons()
344 throw (SALOME::SALOME_Exception);
346 CORBA::Long NbSubMesh()
347 throw (SALOME::SALOME_Exception);
349 SMESH::long_array* GetElementsId()
350 throw (SALOME::SALOME_Exception);
352 SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
353 throw (SALOME::SALOME_Exception);
355 SMESH::long_array* GetNodesId()
356 throw (SALOME::SALOME_Exception);
358 SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
359 throw (SALOME::SALOME_Exception);
361 SMESH::EntityType GetElementGeomType( CORBA::Long id )
362 throw (SALOME::SALOME_Exception);
365 * Returns ID of elements for given submesh
367 SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
368 throw (SALOME::SALOME_Exception);
371 * Returns ID of nodes for given submesh
372 * If param all==true - returns all nodes, else -
373 * returns only nodes on shapes.
375 SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
376 throw (SALOME::SALOME_Exception);
379 * Returns type of elements for given submesh
381 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
382 throw (SALOME::SALOME_Exception);
386 // Internal methods not available through CORBA
387 // They are called by corresponding interface methods
388 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
389 SMESH::SMESH_Hypothesis_ptr anHyp);
391 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
392 SMESH::SMESH_Hypothesis_ptr anHyp);
394 static SMESH::Hypothesis_Status
395 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
397 static void PrepareForWriting (const char* file, bool overwrite = true);
399 //int importMEDFile( const char* theFileName, const char* theMeshName );
401 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
403 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
404 GEOM::GEOM_Object_ptr theSubShapeObject );
406 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
408 const TopoDS_Shape& theShape = TopoDS_Shape(),
409 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
411 void removeGroup( const int theId );
413 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
414 // return an existing subMesh object for the shapeID. shapeID == submeshID.
416 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
417 // return an existing group object.
419 void onHypothesisModified();
420 // callback from _impl to forget not loaded mesh data (issue 0021208)
422 void checkMeshLoaded();
425 * \brief Update hypotheses assigned to geom groups if the latter change
427 * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
429 void CheckGeomGroupModif();
431 CORBA::LongLong GetMeshPtr();
434 * \brief Assure that all groups are published
436 void CreateGroupServants();
439 * \brief Return groups cantained in _mapGroups by their IDs
441 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
444 * Get XYZ coordinates of node as list of double
445 * If there is not node for given ID - returns empty list
447 SMESH::double_array* GetNodeXYZ(CORBA::Long id);
450 * For given node returns list of IDs of inverse elements
451 * If there is not node for given ID - returns empty list
453 SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
456 * \brief Return position of a node on shape
458 SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
461 * If given element is node returns IDs of shape from position
462 * If there is not node for given ID - returns -1
464 CORBA::Long GetShapeID(CORBA::Long id);
467 * For given element returns ID of result shape after
468 * ::FindShape() from SMESH_MeshEditor
469 * If there is not element for given ID - returns -1
471 CORBA::Long GetShapeIDForElem(CORBA::Long id);
474 * Returns number of nodes for given element
475 * If there is not element for given ID - returns -1
477 CORBA::Long GetElemNbNodes(CORBA::Long id);
480 * Returns IDs of nodes of given element
482 SMESH::long_array* GetElemNodes(CORBA::Long id);
485 * Returns ID of node by given index for given element
486 * If there is not element for given ID - returns -1
487 * If there is not node for given index - returns -2
489 CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
492 * Returns true if given node is medium node
493 * in given quadratic element
495 CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
498 * Returns true if given node is medium node
499 * in one of quadratic elements
501 CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
502 SMESH::ElementType theElemType);
505 * Returns number of edges for given element
507 CORBA::Long ElemNbEdges(CORBA::Long id);
510 * Returns number of faces for given element
512 CORBA::Long ElemNbFaces(CORBA::Long id);
514 * Returns nodes of given face (counted from zero) for given element.
516 SMESH::long_array* GetElemFaceNodes(CORBA::Long elemId, CORBA::Short faceIndex);
519 * Returns an element based on all given nodes.
521 CORBA::Long FindElementByNodes(const SMESH::long_array& nodes);
524 * Returns true if given element is polygon
526 CORBA::Boolean IsPoly(CORBA::Long id);
529 * Returns true if given element is quadratic
531 CORBA::Boolean IsQuadratic(CORBA::Long id);
534 * Returns diameter of ball discrete element or zero in case of an invalid \a id
536 CORBA::Double GetBallDiameter(CORBA::Long id);
539 * Returns bary center for given element
541 SMESH::double_array* BaryCenter(CORBA::Long id);
544 * Returns information about imported MED file
546 virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
549 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
551 void SetParameters (const char* theParameters);
554 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
556 char* GetParameters();
559 * Returns list of notebook variables used for last Mesh operation
561 SMESH::string_array* GetLastParameters();
564 * Collect statistic of mesh elements given by iterator
566 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
567 SMESH::long_array& theInfo);
570 * \brief Return submesh objects list in meshing order
572 virtual SMESH::submesh_array_array* GetMeshOrder();
574 * \brief Set submesh object order
576 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
579 // =========================
580 // SMESH_IDSource interface
581 // =========================
583 virtual SMESH::long_array* GetIDs();
585 * Returns statistic of mesh elements
586 * Result array of number enityties
587 * Inherited from SMESH_IDSource
589 virtual SMESH::long_array* GetMeshInfo();
591 * Returns types of elements it contains
593 virtual SMESH::array_of_ElementType* GetTypes();
597 virtual SMESH::SMESH_Mesh_ptr GetMesh();
599 * Returns false if GetMeshInfo() returns incorrect information that may
600 * happen if mesh data is not yet fully loaded from the file of study.
602 bool IsMeshInfoCorrect();
604 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
605 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
608 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
611 * Check and correct names of mesh groups
613 void checkGroupNames();
616 * Convert submesh ids into submesh interfaces
618 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
619 SMESH::submesh_array_array& theSubMeshOrder,
620 const bool theIsDump);
624 static int _idGenerator;
625 ::SMESH_Mesh* _impl; // :: force no namespace here
627 int _id; // id given by creator (unique within the creator instance)
629 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
630 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
631 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
632 SALOME_MED::MedFileInfo_var _medFileInfo;
633 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
635 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
636 friend class SMESH_PreMeshInfo;
640 // Data used to track changes of GEOM groups
641 struct TGeomGroupData {
642 // keep study entry but not ior because GEOM_Object actually changes if
643 // number of items in a group varies (1) <-> (>1)
644 std::string _groupEntry;
645 std::set<int> _indices; // indices of group items within group's main shape
646 CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
648 std::list<TGeomGroupData> _geomGroupData;
651 * Remember GEOM group data
653 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
654 CORBA::Object_ptr theSmeshObj);
656 * Remove GEOM group data relating to removed smesh object
658 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
660 * \brief Return new group contents if it has been changed and update group data
662 TopoDS_Shape newGroupShape( TGeomGroupData & groupData);