1 // Copyright (C) 2007-2021 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
219 void ExportSAUV( const char* file, CORBA::Boolean auto_groups );
221 void ExportDAT( const char* file );
222 void ExportUNV( const char* file );
223 void ExportSTL( const char* file, bool isascii );
224 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
226 CORBA::Boolean overwrite,
227 CORBA::Boolean groupElemsByType);
228 void ExportGMF(SMESH::SMESH_IDSource_ptr meshPart,
230 CORBA::Boolean withRequiredGroups);
233 template<class SPECLS>
234 void ExportPartToMEDCommon(SPECLS& speCls,
235 SMESH::SMESH_IDSource_ptr meshPart,
236 CORBA::Boolean auto_groups,
237 CORBA::Boolean autoDim,
238 const GEOM::ListOfFields& fields,
239 const char* geomAssocFields,
240 CORBA::Double ZTolerance);
242 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
244 CORBA::Boolean auto_groups,
246 CORBA::Boolean overwrite,
247 CORBA::Boolean autoDim,
248 const GEOM::ListOfFields& fields,
249 const char* geomAssocFields,
250 CORBA::Double ZTolerance);
252 CORBA::LongLong ExportPartToMEDCoupling(SMESH::SMESH_IDSource_ptr meshPart,
253 CORBA::Boolean auto_groups,
254 CORBA::Boolean autoDim,
255 const GEOM::ListOfFields& fields,
256 const char* geomAssocFields,
257 CORBA::Double ZTolerance);
259 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
261 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
263 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
265 CORBA::Boolean isascii);
267 CORBA::Double GetComputeProgress();
269 SMESH::smIdType NbNodes();
271 SMESH::smIdType NbElements();
273 SMESH::smIdType Nb0DElements();
275 SMESH::smIdType NbBalls();
277 SMESH::smIdType NbEdges();
279 SMESH::smIdType NbEdgesOfOrder(SMESH::ElementOrder order);
281 SMESH::smIdType NbFaces();
283 SMESH::smIdType NbFacesOfOrder(SMESH::ElementOrder order);
285 SMESH::smIdType NbTriangles();
287 SMESH::smIdType NbTrianglesOfOrder(SMESH::ElementOrder order);
289 SMESH::smIdType NbBiQuadTriangles();
291 SMESH::smIdType NbQuadrangles();
293 SMESH::smIdType NbQuadranglesOfOrder(SMESH::ElementOrder order);
295 SMESH::smIdType NbBiQuadQuadrangles();
297 SMESH::smIdType NbPolygons();
299 SMESH::smIdType NbPolygonsOfOrder(SMESH::ElementOrder order = SMESH::ORDER_ANY);
301 SMESH::smIdType NbVolumes();
303 SMESH::smIdType NbVolumesOfOrder(SMESH::ElementOrder order);
305 SMESH::smIdType NbTetras();
307 SMESH::smIdType NbTetrasOfOrder(SMESH::ElementOrder order);
309 SMESH::smIdType NbHexas();
311 SMESH::smIdType NbHexasOfOrder(SMESH::ElementOrder order);
313 SMESH::smIdType NbTriQuadraticHexas();
315 SMESH::smIdType NbPyramids();
317 SMESH::smIdType NbPyramidsOfOrder(SMESH::ElementOrder order);
319 SMESH::smIdType NbPrisms();
321 SMESH::smIdType NbPrismsOfOrder(SMESH::ElementOrder order);
323 SMESH::smIdType NbHexagonalPrisms();
325 SMESH::smIdType NbPolyhedrons();
327 SMESH::smIdType NbSubMesh();
329 SMESH::smIdType_array* GetElementsId();
331 SMESH::smIdType_array* GetElementsByType( SMESH::ElementType theElemType );
333 SMESH::smIdType_array* GetNodesId();
335 SMESH::ElementType GetElementType( SMESH::smIdType id, bool iselem );
337 SMESH::EntityType GetElementGeomType( SMESH::smIdType id );
339 SMESH::GeometryType GetElementShape( SMESH::smIdType id );
342 * Returns ID of elements for given submesh
344 SMESH::smIdType_array* GetSubMeshElementsId(CORBA::Long ShapeID);
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::smIdType_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all);
354 * Returns type of elements for given submesh
356 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID);
360 // Create groups of elements preventing computation of a sub-shape
361 SMESH::ListOfGroups* MakeGroupsOfBadInputElements( int theSubShapeID,
362 const char* theGroupName);
364 // ===================================================
365 // Internal methods not available through CORBA
366 // They are called by corresponding interface methods
367 // ===================================================
369 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShape,
370 SMESH::SMESH_Hypothesis_ptr anHyp,
371 std::string* anErrorText=0);
373 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShape,
374 SMESH::SMESH_Hypothesis_ptr anHyp);
376 static SMESH::Hypothesis_Status
377 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
379 static void PrepareForWriting (const char* file, bool overwrite = true);
381 //int importMEDFile( const char* theFileName, const char* theMeshName );
383 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
385 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
386 GEOM::GEOM_Object_ptr theSubShapeObject );
388 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
390 const int theID = -1,
391 const TopoDS_Shape& theShape = TopoDS_Shape(),
392 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
394 void removeGroup( const int theId );
396 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
397 // return an existing subMesh object for the shapeID. shapeID == submeshID.
399 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
400 // return existing group objects
402 void onHypothesisModified(int theHypID, bool updateIcons);
403 // callback from _impl to forget not loaded mesh data (issue 0021208)
406 * \brief Update data if geometry changes
410 void CheckGeomModif( bool isBreakLink = false );
412 * \brief Update hypotheses assigned to geom groups if the latter change
414 * NPAL16168: "geometrical group edition from a submesh don't modify mesh computation"
416 void CheckGeomGroupModif();
418 CORBA::LongLong GetMeshPtr();
421 * \brief Assure that all groups are published
423 void CreateGroupServants();
426 * \brief Return true if all sub-meshes are computed OK - to update an icon
431 // ====================================
432 // SMESH_Mesh interface (continuation)
433 // ====================================
436 * \brief Return groups cantained in _mapGroups by their IDs
438 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
441 * Get XYZ coordinates of node as list of double
442 * If there is not node for given ID - returns empty list
444 SMESH::double_array* GetNodeXYZ(SMESH::smIdType id);
447 * For given node returns list of IDs of inverse elements
448 * If there is not node for given ID - returns empty list
450 SMESH::smIdType_array* GetNodeInverseElements(SMESH::smIdType id,
451 SMESH::ElementType elemType);
454 * \brief Return position of a node on shape
456 SMESH::NodePosition* GetNodePosition(SMESH::smIdType NodeID);
459 * \brief Return position of an element on shape
461 SMESH::ElementPosition GetElementPosition(SMESH::smIdType ElemID);
464 * If given element is node returns IDs of shape from position
465 * If there is not node for given ID - returns -1
467 CORBA::Long GetShapeID(SMESH::smIdType id);
470 * For given element returns ID of result shape after
471 * ::FindShape() from SMESH_MeshEditor
472 * If there is not element for given ID - returns -1
474 CORBA::Long GetShapeIDForElem(SMESH::smIdType id);
477 * Returns number of nodes for given element
478 * If there is not element for given ID - returns -1
480 CORBA::Short GetElemNbNodes(SMESH::smIdType id);
483 * Returns IDs of nodes of given element
485 SMESH::smIdType_array* GetElemNodes(SMESH::smIdType id);
488 * Returns ID of node by given index for given element
489 * If there is not element for given ID - returns -1
490 * If there is not node for given index - returns -2
492 SMESH::smIdType GetElemNode(SMESH::smIdType id, CORBA::Short index);
495 * Returns true if given node is medium node
496 * in given quadratic element
498 CORBA::Boolean IsMediumNode(SMESH::smIdType ide, SMESH::smIdType idn);
501 * Returns true if given node is medium node
502 * in one of quadratic elements
504 CORBA::Boolean IsMediumNodeOfAnyElem(SMESH::smIdType idn,
505 SMESH::ElementType elemType);
508 * Returns number of edges for given element
510 CORBA::Long ElemNbEdges(SMESH::smIdType id);
513 * Returns number of faces for given element
515 CORBA::Long ElemNbFaces(SMESH::smIdType id);
517 * Returns nodes of given face (counted from zero) for given element.
519 SMESH::smIdType_array* GetElemFaceNodes(SMESH::smIdType elemId, CORBA::Short faceIndex);
522 * Returns three components of normal of given mesh face (or an empty array in KO case)
524 SMESH::double_array* GetFaceNormal(CORBA::Long faceId, CORBA::Boolean normalized);
527 * Returns an element based on all given nodes.
529 SMESH::smIdType FindElementByNodes(const SMESH::smIdType_array& nodes);
532 * Return elements including all given nodes.
534 SMESH::smIdType_array* GetElementsByNodes(const SMESH::smIdType_array& nodes,
535 SMESH::ElementType elemType);
538 * Returns true if given element is polygon
540 CORBA::Boolean IsPoly(SMESH::smIdType id);
543 * Returns true if given element is quadratic
545 CORBA::Boolean IsQuadratic(SMESH::smIdType id);
548 * Returns diameter of ball discrete element or zero in case of an invalid \a id
550 CORBA::Double GetBallDiameter(SMESH::smIdType id);
553 * Returns bary center for given element
555 SMESH::double_array* BaryCenter(SMESH::smIdType id);
558 * Returns information about imported MED file
560 virtual SMESH::MedFileInfo* GetMEDFileInfo();
563 * Persistence of file info
565 std::string FileInfoToString();
566 void FileInfoFromString(const std::string& info);
569 * Persistence of geometry tick
571 int& MainShapeTick() { return _mainShapeTick; }
575 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
577 void SetParameters (const char* theParameters);
580 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
582 char* GetParameters();
585 * Returns list of notebook variables used for last Mesh operation
587 SMESH::string_array* GetLastParameters();
590 * \brief Return \c true if a meshing order not yet set for a concurrent sub-mesh
592 CORBA::Boolean IsUnorderedSubMesh(CORBA::Long submeshID);
594 * \brief Return submesh objects list in meshing order
596 virtual SMESH::submesh_array_array* GetMeshOrder();
598 * \brief Set submesh object order
600 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
604 * Collect statistic of mesh elements given by iterator
606 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
607 SMESH::smIdType_array& theInfo);
609 * \brief Return iterator on elements of given type in given object
611 static SMDS_ElemIteratorPtr GetElements(SMESH::SMESH_IDSource_ptr obj,
612 SMESH::ElementType type);
614 // =========================
615 // SMESH_IDSource interface
616 // =========================
618 virtual SMESH::smIdType_array* GetIDs();
620 * Returns number of mesh elements of each \a EntityType
621 * Result array of number of elements per \a EntityType
622 * Inherited from SMESH_IDSource
624 virtual SMESH::smIdType_array* GetMeshInfo();
626 * Returns number of mesh elements of each \a ElementType
628 virtual SMESH::smIdType_array* GetNbElementsByType();
630 * Returns types of elements it contains
632 virtual SMESH::array_of_ElementType* GetTypes();
636 virtual SMESH::SMESH_Mesh_ptr GetMesh();
638 * Returns false if GetMeshInfo() returns incorrect information that may
639 * happen if mesh data is not yet fully loaded from the file of study.
641 bool IsMeshInfoCorrect();
643 * Returns mesh unstructed grid information.
645 virtual SALOMEDS::TMPFile* GetVtkUgStream();
648 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
649 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
652 std::string generateMeshName( );
653 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
655 * Write GEOM fields to MED file
657 void exportMEDFields( DriverMED_W_Field & writer,
658 SMESHDS_Mesh* meshDS,
659 const GEOM::ListOfFields& fields,
660 const char* geomAssocFields);
663 * Check and correct names of mesh groups
665 void checkGroupNames();
668 * Convert submesh ids into submesh interfaces
670 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
671 SMESH::submesh_array_array& theSubMeshOrder,
672 const bool theIsDump);
675 * \brief Finds concurrent sub-meshes
677 TListOfListOfInt findConcurrentSubMeshes();
681 static int _idGenerator;
682 ::SMESH_Mesh* _impl; // :: force no namespace here
684 int _id; // id given by creator (unique within the creator instance)
686 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
687 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
688 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
689 SMESH_MeshEditor_i* _editor;
690 SMESH_MeshEditor_i* _previewEditor;
691 SMESH::MedFileInfo_var _medFileInfo;
692 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
694 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
695 friend class SMESH_PreMeshInfo;
699 // Data used to track changes of GEOM groups
700 struct TGeomGroupData {
701 // keep study entry but not ior because GEOM_Object actually changes if
702 // number of items in a group varies (1) <-> (>1)
703 std::string _groupEntry;
704 std::set<int> _indices; // indices of group items within group's main shape
705 CORBA::Object_var _smeshObject; // SMESH object depending on GEOM group
707 std::list<TGeomGroupData> _geomGroupData;
708 int _mainShapeTick; // to track modifications of the meshed shape
711 * Remember GEOM group data
713 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
714 CORBA::Object_ptr theSmeshObj);
716 * Remove GEOM group data relating to removed smesh object
718 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
720 * Return new group contents if it has been changed and update group data
722 TopoDS_Shape newGroupShape( TGeomGroupData & groupData, int how );