1 // Copyright (C) 2007-2022 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, or (at your option) any later version.
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 "SMESH_Hypothesis.hxx"
32 #include "SMESH_Mesh.hxx"
33 #include "SMESH_subMesh.hxx"
34 #include "SMDS_ElemIterator.hxx"
36 #include <SALOME_GenericObj_i.hh>
37 #include <SALOMEconfig.h>
38 #include CORBA_SERVER_HEADER(SMESH_Gen)
39 #include CORBA_SERVER_HEADER(SMESH_Mesh)
40 #include CORBA_SERVER_HEADER(SMESH_Group)
41 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
42 #include CORBA_CLIENT_HEADER(GEOM_Gen)
47 class SMESH_GroupBase_i;
48 class SMESH_subMesh_i;
49 class SMESH_PreMeshInfo;
50 class SMESH_MeshEditor_i;
51 class DriverMED_W_Field;
54 class SMESH_I_EXPORT SMESH_Mesh_i:
55 public virtual POA_SMESH::SMESH_Mesh,
56 public virtual SALOME::GenericObj_i
59 SMESH_Mesh_i(const SMESH_Mesh_i&);
61 SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
62 SMESH_Gen_i* myGen_i );
64 virtual ~SMESH_Mesh_i();
68 void SetShape( GEOM::GEOM_Object_ptr theShapeObject );
70 CORBA::Boolean HasShapeToMesh();
72 GEOM::GEOM_Object_ptr GetShapeToMesh();
74 virtual void ReplaceShape(GEOM::GEOM_Object_ptr theNewGeom);
76 CORBA::Boolean IsLoaded();
82 void ClearSubMesh(CORBA::Long ShapeID);
84 SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShape,
85 SMESH::SMESH_Hypothesis_ptr anHyp,
86 CORBA::String_out anErrorText);
88 SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShape,
89 SMESH::SMESH_Hypothesis_ptr anHyp);
91 SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShape);
93 SMESH::submesh_array* GetSubMeshes();
95 SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShape, const char* theName);
97 void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh );
99 SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName );
101 SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType theElemType,
103 GEOM::GEOM_Object_ptr theGeomObj );
105 SMESH::SMESH_GroupOnFilter_ptr CreateGroupFromFilter(SMESH::ElementType theElemType,
107 SMESH::Filter_ptr theFilter );
109 void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup );
111 void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup );
113 SMESH::ListOfGroups* GetGroups();
115 CORBA::Long NbGroups();
117 SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
118 SMESH::SMESH_GroupBase_ptr theGroup2,
119 const char* theName );
121 SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
122 const char* theName);
124 SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
125 SMESH::SMESH_GroupBase_ptr theGroup2,
126 const char* theName );
128 SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups& theGroups,
129 const char* theName );
131 SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
132 SMESH::SMESH_GroupBase_ptr theGroup2,
133 const char* theName );
135 SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
136 const SMESH::ListOfGroups& theToolGroups,
137 const char* theName );
139 SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfIDSources& theGroups,
140 SMESH::ElementType theElemType,
142 SMESH::NB_COMMON_NODES_ENUM theNbCommonNodes,
143 CORBA::Boolean theUnderlyingOnly );
145 SMESH::ListOfGroups* FaceGroupsSeparatedByEdges( CORBA::Double theSharpAngle,
146 CORBA::Boolean theCreateEdges,
147 CORBA::Boolean theUseExistingEdges );
149 SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupBase_ptr theGroupOn );
151 SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet);
153 SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
155 SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
157 CORBA::Boolean HasModificationsToDiscard();
165 void SetImpl(::SMESH_Mesh* impl);
166 ::SMESH_Mesh& GetImpl(); // :: force no namespace here
168 SMESH_Gen_i* GetGen() { return _gen_i; }
170 int ImportUNVFile( const char* theFileName );
172 int ImportSTLFile( const char* theFileName );
174 SMESH::ComputeError* ImportGMFFile( const char* theFileName,
175 bool theMakeRequiredGroups);
178 * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
180 SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName );
182 SMESH::DriverMED_ReadStatus ImportCGNSFile( const char* theFileName,
183 const int theMeshIndex,
184 std::string& theMeshName);
189 void SetAutoColor(CORBA::Boolean theAutoColor);
191 CORBA::Boolean GetAutoColor();
193 /*! Check group names for duplications.
194 * Consider maximum group name length stored in MED file.
196 CORBA::Boolean HasDuplicatedGroupNamesMED();
199 * Return string representation of a MED file version comprising nbDigits
201 char* GetVersionString(CORBA::Long minor, CORBA::Short nbDigits);
204 * Return the list of med versions compatibles for write/append,
205 * encoded in 10*major+minor (for instance, code for med 3.2.1 is 32)
207 SMESH::long_array* GetMEDVersionsCompatibleForAppend();
209 void ExportMED( const char* file,
210 CORBA::Boolean auto_groups,
212 CORBA::Boolean overwrite,
213 CORBA::Boolean autoDimension = true);
215 CORBA::LongLong ExportMEDCoupling(CORBA::Boolean auto_groups,
216 CORBA::Boolean autoDimension = true);
218 void ExportDAT( const char* file, const CORBA::Boolean renumber );
219 void ExportUNV( const char* file, const CORBA::Boolean renumber );
220 void ExportSTL( const char* file, bool isascii );
221 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
223 CORBA::Boolean overwrite,
224 CORBA::Boolean groupElemsByType);
225 void ExportGMF(SMESH::SMESH_IDSource_ptr meshPart,
227 CORBA::Boolean withRequiredGroups);
230 template<class SPECLS>
231 void ExportPartToMEDCommon(SPECLS& speCls,
232 SMESH::SMESH_IDSource_ptr meshPart,
233 CORBA::Boolean auto_groups,
234 CORBA::Boolean autoDim,
235 const GEOM::ListOfFields& fields,
236 const char* geomAssocFields,
237 CORBA::Double ZTolerance,
238 CORBA::Boolean saveNumbers );
240 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
242 CORBA::Boolean auto_groups,
244 CORBA::Boolean overwrite,
245 CORBA::Boolean autoDim,
246 const GEOM::ListOfFields& fields,
247 const char* geomAssocFields,
248 CORBA::Double ZTolerance,
249 CORBA::Boolean saveNumbers );
251 CORBA::LongLong ExportPartToMEDCoupling(SMESH::SMESH_IDSource_ptr meshPart,
252 CORBA::Boolean auto_groups,
253 CORBA::Boolean autoDim,
254 const GEOM::ListOfFields& fields,
255 const char* geomAssocFields,
256 CORBA::Double ZTolerance,
257 CORBA::Boolean saveNumbers);
259 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
261 CORBA::Boolean renumber);
262 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
264 CORBA::Boolean renumber);
265 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
267 CORBA::Boolean isascii);
269 CORBA::Double GetComputeProgress();
271 SMESH::smIdType NbNodes();
273 SMESH::smIdType NbElements();
275 SMESH::smIdType Nb0DElements();
277 SMESH::smIdType NbBalls();
279 SMESH::smIdType NbEdges();
281 SMESH::smIdType NbEdgesOfOrder(SMESH::ElementOrder order);
283 SMESH::smIdType NbFaces();
285 SMESH::smIdType NbFacesOfOrder(SMESH::ElementOrder order);
287 SMESH::smIdType NbTriangles();
289 SMESH::smIdType NbTrianglesOfOrder(SMESH::ElementOrder order);
291 SMESH::smIdType NbBiQuadTriangles();
293 SMESH::smIdType NbQuadrangles();
295 SMESH::smIdType NbQuadranglesOfOrder(SMESH::ElementOrder order);
297 SMESH::smIdType NbBiQuadQuadrangles();
299 SMESH::smIdType NbPolygons();
301 SMESH::smIdType NbPolygonsOfOrder(SMESH::ElementOrder order = SMESH::ORDER_ANY);
303 SMESH::smIdType NbVolumes();
305 SMESH::smIdType NbVolumesOfOrder(SMESH::ElementOrder order);
307 SMESH::smIdType NbTetras();
309 SMESH::smIdType NbTetrasOfOrder(SMESH::ElementOrder order);
311 SMESH::smIdType NbHexas();
313 SMESH::smIdType NbHexasOfOrder(SMESH::ElementOrder order);
315 SMESH::smIdType NbTriQuadraticHexas();
317 SMESH::smIdType NbPyramids();
319 SMESH::smIdType NbPyramidsOfOrder(SMESH::ElementOrder order);
321 SMESH::smIdType NbPrisms();
323 SMESH::smIdType NbPrismsOfOrder(SMESH::ElementOrder order);
325 SMESH::smIdType NbHexagonalPrisms();
327 SMESH::smIdType NbPolyhedrons();
329 SMESH::smIdType NbSubMesh();
331 SMESH::smIdType_array* GetElementsId();
333 SMESH::smIdType_array* GetElementsByType( SMESH::ElementType theElemType );
335 SMESH::smIdType_array* GetNodesId();
337 SMESH::ElementType GetElementType( SMESH::smIdType id, bool iselem );
339 SMESH::EntityType GetElementGeomType( SMESH::smIdType id );
341 SMESH::GeometryType GetElementShape( SMESH::smIdType id );
344 * Returns ID of elements for given submesh
346 SMESH::smIdType_array* GetSubMeshElementsId(CORBA::Long ShapeID);
349 * Returns ID of nodes for given submesh
350 * If param all==true - returns all nodes, else -
351 * returns only nodes on shapes.
353 SMESH::smIdType_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all);
356 * Returns type of elements for given submesh
358 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID);
362 // Create groups of elements preventing computation of a sub-shape
363 SMESH::ListOfGroups* MakeGroupsOfBadInputElements( int theSubShapeID,
364 const char* theGroupName);
366 // ===================================================
367 // Internal methods not available through CORBA
368 // They are called by corresponding interface methods
369 // ===================================================
371 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShape,
372 SMESH::SMESH_Hypothesis_ptr anHyp,
373 std::string* anErrorText=0);
375 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShape,
376 SMESH::SMESH_Hypothesis_ptr anHyp);
378 static SMESH::Hypothesis_Status
379 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
381 static void PrepareForWriting (const char* file, bool overwrite = true);
383 //int importMEDFile( const char* theFileName, const char* theMeshName );
385 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
387 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
388 GEOM::GEOM_Object_ptr theSubShapeObject );
390 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
392 const int theID = -1,
393 const TopoDS_Shape& theShape = TopoDS_Shape(),
394 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
396 void removeGroup( const int theId );
398 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
399 // return an existing subMesh object for the shapeID. shapeID == submeshID.
401 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
402 // return existing group objects
404 void onHypothesisModified(int theHypID, bool updateIcons);
405 // callback from _impl to forget not loaded mesh data (issue 0021208)
408 * \brief Update data if geometry changes
412 void CheckGeomModif( bool isBreakLink = false );
414 * \brief Update hypotheses assigned to geom groups if the latter change
416 * NPAL16168: "geometrical group edition from a submesh don't modify mesh computation"
418 void CheckGeomGroupModif();
420 CORBA::LongLong GetMeshPtr();
423 * \brief Assure that all groups are published
425 void CreateGroupServants();
428 * \brief Return true if all sub-meshes are computed OK - to update an icon
433 // ====================================
434 // SMESH_Mesh interface (continuation)
435 // ====================================
438 * \brief Return groups cantained in _mapGroups by their IDs
440 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
443 * Get XYZ coordinates of node as list of double
444 * If there is not node for given ID - returns empty list
446 SMESH::double_array* GetNodeXYZ(SMESH::smIdType id);
449 * For given node returns list of IDs of inverse elements
450 * If there is not node for given ID - returns empty list
452 SMESH::smIdType_array* GetNodeInverseElements(SMESH::smIdType id,
453 SMESH::ElementType elemType);
456 * \brief Return position of a node on shape
458 SMESH::NodePosition* GetNodePosition(SMESH::smIdType NodeID);
461 * \brief Return position of an element on shape
463 SMESH::ElementPosition GetElementPosition(SMESH::smIdType ElemID);
466 * If given element is node returns IDs of shape from position
467 * If there is not node for given ID - returns -1
469 CORBA::Long GetShapeID(SMESH::smIdType id);
472 * For given element returns ID of result shape after
473 * ::FindShape() from SMESH_MeshEditor
474 * If there is not element for given ID - returns -1
476 CORBA::Long GetShapeIDForElem(SMESH::smIdType id);
479 * Returns number of nodes for given element
480 * If there is not element for given ID - returns -1
482 CORBA::Short GetElemNbNodes(SMESH::smIdType id);
485 * Returns IDs of nodes of given element
487 SMESH::smIdType_array* GetElemNodes(SMESH::smIdType id);
490 * Returns ID of node by given index for given element
491 * If there is not element for given ID - returns -1
492 * If there is not node for given index - returns -2
494 SMESH::smIdType GetElemNode(SMESH::smIdType id, CORBA::Short index);
497 * Returns true if given node is medium node
498 * in given quadratic element
500 CORBA::Boolean IsMediumNode(SMESH::smIdType ide, SMESH::smIdType idn);
503 * Returns true if given node is medium node
504 * in one of quadratic elements
506 CORBA::Boolean IsMediumNodeOfAnyElem(SMESH::smIdType idn,
507 SMESH::ElementType elemType);
510 * Returns number of edges for given element
512 CORBA::Long ElemNbEdges(SMESH::smIdType id);
515 * Returns number of faces for given element
517 CORBA::Long ElemNbFaces(SMESH::smIdType id);
519 * Returns nodes of given face (counted from zero) for given element.
521 SMESH::smIdType_array* GetElemFaceNodes(SMESH::smIdType elemId, CORBA::Short faceIndex);
524 * Returns three components of normal of given mesh face (or an empty array in KO case)
526 SMESH::double_array* GetFaceNormal(CORBA::Long faceId, CORBA::Boolean normalized);
529 * Returns an element based on all given nodes.
531 SMESH::smIdType FindElementByNodes(const SMESH::smIdType_array& nodes);
534 * Return elements including all given nodes.
536 SMESH::smIdType_array* GetElementsByNodes(const SMESH::smIdType_array& nodes,
537 SMESH::ElementType elemType);
540 * Returns true if given element is polygon
542 CORBA::Boolean IsPoly(SMESH::smIdType id);
545 * Returns true if given element is quadratic
547 CORBA::Boolean IsQuadratic(SMESH::smIdType id);
550 * Returns diameter of ball discrete element or zero in case of an invalid \a id
552 CORBA::Double GetBallDiameter(SMESH::smIdType id);
555 * Returns bary center for given element
557 SMESH::double_array* BaryCenter(SMESH::smIdType id);
560 * Returns information about imported MED file
562 virtual SMESH::MedFileInfo* GetMEDFileInfo();
565 * Persistence of file info
567 std::string FileInfoToString();
568 void FileInfoFromString(const std::string& info);
571 * Persistence of geometry tick
573 int& MainShapeTick() { return _mainShapeTick; }
577 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
579 void SetParameters (const char* theParameters);
582 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
584 char* GetParameters();
587 * Returns list of notebook variables used for last Mesh operation
589 SMESH::string_array* GetLastParameters();
592 * \brief Return \c true if a meshing order not yet set for a concurrent sub-mesh
594 CORBA::Boolean IsUnorderedSubMesh(CORBA::Long submeshID);
596 * \brief Return submesh objects list in meshing order
598 virtual SMESH::submesh_array_array* GetMeshOrder();
600 * \brief Set submesh object order
602 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
606 * Collect statistic of mesh elements given by iterator
608 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
609 SMESH::smIdType_array& theInfo);
611 * \brief Return iterator on elements of given type in given object
613 static SMDS_ElemIteratorPtr GetElements(SMESH::SMESH_IDSource_ptr obj,
614 SMESH::ElementType type);
616 // =========================
617 // SMESH_IDSource interface
618 // =========================
620 virtual SMESH::smIdType_array* GetIDs();
622 * Returns number of mesh elements of each \a EntityType
623 * Result array of number of elements per \a EntityType
624 * Inherited from SMESH_IDSource
626 virtual SMESH::smIdType_array* GetMeshInfo();
628 * Returns number of mesh elements of each \a ElementType
630 virtual SMESH::smIdType_array* GetNbElementsByType();
632 * Returns types of elements it contains
634 virtual SMESH::array_of_ElementType* GetTypes();
638 virtual SMESH::SMESH_Mesh_ptr GetMesh();
640 * Returns false if GetMeshInfo() returns incorrect information that may
641 * happen if mesh data is not yet fully loaded from the file of study.
643 bool IsMeshInfoCorrect();
645 * Returns mesh unstructed grid information.
647 virtual SALOMEDS::TMPFile* GetVtkUgStream();
650 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
651 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
654 std::string generateMeshName( );
655 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
657 * Write GEOM fields to MED file
659 void exportMEDFields( DriverMED_W_Field & writer,
660 SMESHDS_Mesh* meshDS,
661 const GEOM::ListOfFields& fields,
662 const char* geomAssocFields);
665 * Check and correct names of mesh groups
667 void checkGroupNames();
670 * Convert submesh ids into submesh interfaces
672 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
673 SMESH::submesh_array_array& theSubMeshOrder,
674 const bool theIsDump);
677 * \brief Finds concurrent sub-meshes
679 TListOfListOfInt findConcurrentSubMeshes();
683 static int _idGenerator;
684 ::SMESH_Mesh* _impl; // :: force no namespace here
686 int _id; // id given by creator (unique within the creator instance)
688 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
689 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
690 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
691 SMESH_MeshEditor_i* _editor;
692 SMESH_MeshEditor_i* _previewEditor;
693 SMESH::MedFileInfo_var _medFileInfo;
694 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
696 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
697 friend class SMESH_PreMeshInfo;
701 // Data used to track changes of GEOM groups
702 struct TGeomGroupData {
703 // keep study entry but not ior because GEOM_Object actually changes if
704 // number of items in a group varies (1) <-> (>1)
705 std::string _groupEntry;
706 std::set<int> _indices; // indices of group items within group's main shape
707 CORBA::Object_var _smeshObject; // SMESH object depending on GEOM group
709 std::list<TGeomGroupData> _geomGroupData;
710 int _mainShapeTick; // to track modifications of the meshed shape
713 * Remember GEOM group data
715 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
716 CORBA::Object_ptr theSmeshObj);
718 * Remove GEOM group data relating to removed smesh object
720 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
722 * Return new group contents if it has been changed and update group data
724 TopoDS_Shape newGroupShape( TGeomGroupData & groupData, int how );