1 // Copyright (C) 2007-2024 CEA, EDF, 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 );
222 void ExportStructuredCGNS(SMESH::SMESH_IDSource_ptr meshPart,
224 CORBA::Boolean overwrite);
226 void ExportCGNS(SMESH::SMESH_IDSource_ptr meshPart,
228 CORBA::Boolean overwrite,
229 CORBA::Boolean groupElemsByType);
230 void ExportGMF(SMESH::SMESH_IDSource_ptr meshPart,
232 CORBA::Boolean withRequiredGroups);
235 template<class SPECLS>
236 void ExportPartToMEDCommon(SPECLS& speCls,
237 SMESH::SMESH_IDSource_ptr meshPart,
238 CORBA::Boolean auto_groups,
239 CORBA::Boolean autoDim,
240 const GEOM::ListOfFields& fields,
241 const char* geomAssocFields,
242 CORBA::Double ZTolerance,
243 CORBA::Boolean saveNumbers );
245 void ExportPartToMED(SMESH::SMESH_IDSource_ptr meshPart,
247 CORBA::Boolean auto_groups,
249 CORBA::Boolean overwrite,
250 CORBA::Boolean autoDim,
251 const GEOM::ListOfFields& fields,
252 const char* geomAssocFields,
253 CORBA::Double ZTolerance,
254 CORBA::Boolean saveNumbers );
256 void ExportPartToMESHIO(SMESH::SMESH_IDSource_ptr meshPart,
258 const char* selectedFilter);
260 CORBA::LongLong ExportPartToMEDCoupling(SMESH::SMESH_IDSource_ptr meshPart,
261 CORBA::Boolean auto_groups,
262 CORBA::Boolean autoDim,
263 const GEOM::ListOfFields& fields,
264 const char* geomAssocFields,
265 CORBA::Double ZTolerance,
266 CORBA::Boolean saveNumbers);
268 void ExportPartToDAT(SMESH::SMESH_IDSource_ptr meshPart,
270 CORBA::Boolean renumber);
271 void ExportPartToUNV(SMESH::SMESH_IDSource_ptr meshPart,
273 CORBA::Boolean renumber);
274 void ExportPartToSTL(SMESH::SMESH_IDSource_ptr meshPart,
276 CORBA::Boolean isascii);
278 CORBA::Double GetComputeProgress();
280 SMESH::smIdType NbNodes();
282 SMESH::smIdType NbElements();
284 SMESH::smIdType Nb0DElements();
286 SMESH::smIdType NbBalls();
288 SMESH::smIdType NbEdges();
290 SMESH::smIdType NbEdgesOfOrder(SMESH::ElementOrder order);
292 SMESH::smIdType NbFaces();
294 SMESH::smIdType NbFacesOfOrder(SMESH::ElementOrder order);
296 SMESH::smIdType NbTriangles();
298 SMESH::smIdType NbTrianglesOfOrder(SMESH::ElementOrder order);
300 SMESH::smIdType NbBiQuadTriangles();
302 SMESH::smIdType NbQuadrangles();
304 SMESH::smIdType NbQuadranglesOfOrder(SMESH::ElementOrder order);
306 SMESH::smIdType NbBiQuadQuadrangles();
308 SMESH::smIdType NbPolygons();
310 SMESH::smIdType NbPolygonsOfOrder(SMESH::ElementOrder order = SMESH::ORDER_ANY);
312 SMESH::smIdType NbVolumes();
314 SMESH::smIdType NbVolumesOfOrder(SMESH::ElementOrder order);
316 SMESH::smIdType NbTetras();
318 SMESH::smIdType NbTetrasOfOrder(SMESH::ElementOrder order);
320 SMESH::smIdType NbHexas();
322 SMESH::smIdType NbHexasOfOrder(SMESH::ElementOrder order);
324 SMESH::smIdType NbTriQuadraticHexas();
326 SMESH::smIdType NbPyramids();
328 SMESH::smIdType NbPyramidsOfOrder(SMESH::ElementOrder order);
330 SMESH::smIdType NbPrisms();
332 SMESH::smIdType NbPrismsOfOrder(SMESH::ElementOrder order);
334 SMESH::smIdType NbHexagonalPrisms();
336 SMESH::smIdType NbPolyhedrons();
338 SMESH::smIdType NbSubMesh();
340 SMESH::smIdType_array* GetElementsId();
342 SMESH::smIdType_array* GetElementsByType( SMESH::ElementType theElemType );
344 SMESH::smIdType_array* GetNodesId();
346 SMESH::ElementType GetElementType( SMESH::smIdType id, bool iselem );
348 SMESH::EntityType GetElementGeomType( SMESH::smIdType id );
350 SMESH::GeometryType GetElementShape( SMESH::smIdType id );
353 * Returns ID of elements for given submesh
355 SMESH::smIdType_array* GetSubMeshElementsId(CORBA::Long ShapeID);
358 * Returns ID of nodes for given submesh
359 * If param all==true - returns all nodes, else -
360 * returns only nodes on shapes.
362 SMESH::smIdType_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all);
365 * Returns type of elements for given submesh
367 SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID);
371 // Create groups of elements preventing computation of a sub-shape
372 SMESH::ListOfGroups* MakeGroupsOfBadInputElements( int theSubShapeID,
373 const char* theGroupName);
375 // ===================================================
376 // Internal methods not available through CORBA
377 // They are called by corresponding interface methods
378 // ===================================================
380 SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShape,
381 SMESH::SMESH_Hypothesis_ptr anHyp,
382 std::string* anErrorText=0);
384 SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShape,
385 SMESH::SMESH_Hypothesis_ptr anHyp);
387 static SMESH::Hypothesis_Status
388 ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
390 static void PrepareForWriting (const char* file, bool overwrite = true);
392 //int importMEDFile( const char* theFileName, const char* theMeshName );
394 SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
396 bool removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
397 GEOM::GEOM_Object_ptr theSubShapeObject );
399 SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType theElemType,
401 const int theID = -1,
402 const TopoDS_Shape& theShape = TopoDS_Shape(),
403 const SMESH_PredicatePtr& thePred = SMESH_PredicatePtr());
405 void removeGroup( const int theId );
407 SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
408 // return an existing subMesh object for the shapeID. shapeID == submeshID.
410 const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
411 // return existing group objects
413 void onHypothesisModified(int theHypID, bool updateIcons);
414 // callback from _impl to forget not loaded mesh data (issue 0021208)
417 * \brief Update data if geometry changes
421 void CheckGeomModif( bool isBreakLink = false );
423 * \brief Update hypotheses assigned to geom groups if the latter change
425 * NPAL16168: "geometrical group edition from a submesh don't modify mesh computation"
427 void CheckGeomGroupModif();
429 CORBA::LongLong GetMeshPtr();
432 * \brief Assure that all groups are published
434 void CreateGroupServants();
438 // ====================================
439 // SMESH_Mesh interface (continuation)
440 // ====================================
442 * \brief Return true if all sub-meshes are computed OK - to update an icon
444 CORBA::Boolean IsComputedOK();
447 * \brief Return groups cantained in _mapGroups by their IDs
449 SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
452 * Get XYZ coordinates of node as list of double
453 * If there is not node for given ID - returns empty list
455 SMESH::double_array* GetNodeXYZ(SMESH::smIdType id);
458 * For given node returns list of IDs of inverse elements
459 * If there is not node for given ID - returns empty list
461 SMESH::smIdType_array* GetNodeInverseElements(SMESH::smIdType id,
462 SMESH::ElementType elemType);
465 * \brief Return position of a node on shape
467 SMESH::NodePosition* GetNodePosition(SMESH::smIdType NodeID);
470 * \brief Return position of an element on shape
472 SMESH::ElementPosition GetElementPosition(SMESH::smIdType ElemID);
475 * If given element is node returns IDs of shape from position
476 * If there is not node for given ID - returns -1
478 CORBA::Long GetShapeID(SMESH::smIdType id);
481 * For given element returns ID of result shape after
482 * ::FindShape() from SMESH_MeshEditor
483 * If there is not element for given ID - returns -1
485 CORBA::Long GetShapeIDForElem(SMESH::smIdType id);
488 * Returns number of nodes for given element
489 * If there is not element for given ID - returns -1
491 CORBA::Short GetElemNbNodes(SMESH::smIdType id);
494 * Returns IDs of nodes of given element
496 SMESH::smIdType_array* GetElemNodes(SMESH::smIdType id);
499 * Returns ID of node by given index for given element
500 * If there is not element for given ID - returns -1
501 * If there is not node for given index - returns -2
503 SMESH::smIdType GetElemNode(SMESH::smIdType id, CORBA::Short index);
506 * Returns true if given node is medium node
507 * in given quadratic element
509 CORBA::Boolean IsMediumNode(SMESH::smIdType ide, SMESH::smIdType idn);
512 * Returns true if given node is medium node
513 * in one of quadratic elements
515 CORBA::Boolean IsMediumNodeOfAnyElem(SMESH::smIdType idn,
516 SMESH::ElementType elemType);
519 * Returns number of edges for given element
521 CORBA::Long ElemNbEdges(SMESH::smIdType id);
524 * Returns number of faces for given element
526 CORBA::Long ElemNbFaces(SMESH::smIdType id);
528 * Returns nodes of given face (counted from zero) for given element.
530 SMESH::smIdType_array* GetElemFaceNodes(SMESH::smIdType elemId, CORBA::Short faceIndex);
533 * Returns three components of normal of given mesh face (or an empty array in KO case)
535 SMESH::double_array* GetFaceNormal(CORBA::Long faceId, CORBA::Boolean normalized);
538 * Returns an element based on all given nodes.
540 SMESH::smIdType FindElementByNodes(const SMESH::smIdType_array& nodes);
543 * Return elements including all given nodes.
545 SMESH::smIdType_array* GetElementsByNodes(const SMESH::smIdType_array& nodes,
546 SMESH::ElementType elemType);
549 * Returns true if given element is polygon
551 CORBA::Boolean IsPoly(SMESH::smIdType id);
554 * Returns true if given element is quadratic
556 CORBA::Boolean IsQuadratic(SMESH::smIdType id);
559 * Returns diameter of ball discrete element or zero in case of an invalid \a id
561 CORBA::Double GetBallDiameter(SMESH::smIdType id);
564 * Returns bary center for given element
566 SMESH::double_array* BaryCenter(SMESH::smIdType id);
569 * Returns information about imported MED file
571 virtual SMESH::MedFileInfo* GetMEDFileInfo();
574 * Persistence of file info
576 std::string FileInfoToString();
577 void FileInfoFromString(const std::string& info);
580 * Persistence of geometry tick
582 int& MainShapeTick() { return _mainShapeTick; }
586 * Sets list of notebook variables used for Mesh operations separated by ":" symbol
588 void SetParameters (const char* theParameters);
591 * Returns list of notebook variables used for Mesh operations separated by ":" symbol
593 char* GetParameters();
596 * Returns list of notebook variables used for last Mesh operation
598 SMESH::string_array* GetLastParameters();
601 * \brief Return \c true if a meshing order not yet set for a concurrent sub-mesh
603 CORBA::Boolean IsUnorderedSubMesh(CORBA::Long submeshID);
605 * \brief Return submesh objects list in meshing order
607 virtual SMESH::submesh_array_array* GetMeshOrder();
609 * \brief Set submesh object order
611 virtual ::CORBA::Boolean SetMeshOrder(const SMESH::submesh_array_array& theSubMeshArray);
615 * Collect statistic of mesh elements given by iterator
617 static void CollectMeshInfo(const SMDS_ElemIteratorPtr theItr,
618 SMESH::smIdType_array& theInfo);
620 * \brief Return iterator on elements of given type in given object
622 static SMDS_ElemIteratorPtr GetElements(SMESH::SMESH_IDSource_ptr obj,
623 SMESH::ElementType type);
625 // =========================
626 // SMESH_IDSource interface
627 // =========================
629 virtual SMESH::smIdType_array* GetIDs();
631 * Returns number of mesh elements of each \a EntityType
632 * Result array of number of elements per \a EntityType
633 * Inherited from SMESH_IDSource
635 virtual SMESH::smIdType_array* GetMeshInfo();
637 * Returns number of mesh elements of each \a ElementType
639 virtual SMESH::smIdType_array* GetNbElementsByType();
641 * Returns types of elements it contains
643 virtual SMESH::array_of_ElementType* GetTypes();
647 virtual SMESH::SMESH_Mesh_ptr GetMesh();
649 * Returns false if GetMeshInfo() returns incorrect information that may
650 * happen if mesh data is not yet fully loaded from the file of study.
652 bool IsMeshInfoCorrect();
654 * Returns mesh unstructed grid information.
656 virtual SALOMEDS::TMPFile* GetVtkUgStream();
659 std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
660 std::map<int, ::SMESH_subMesh*> _mapSubMesh; //NRI
663 std::string generateMeshName( );
664 std::string prepareMeshNameAndGroups( const char* file, CORBA::Boolean overwrite );
666 * Write GEOM fields to MED file
668 void exportMEDFields( DriverMED_W_Field & writer,
669 SMESHDS_Mesh* meshDS,
670 const GEOM::ListOfFields& fields,
671 const char* geomAssocFields);
674 * Check and correct names of mesh groups
676 void checkGroupNames();
679 * Convert submesh ids into submesh interfaces
681 void convertMeshOrder(const TListOfListOfInt& theIdsOrder,
682 SMESH::submesh_array_array& theSubMeshOrder,
683 const bool theIsDump);
686 * \brief Finds concurrent sub-meshes
688 TListOfListOfInt findConcurrentSubMeshes();
691 ::SMESH_Mesh* _impl; // :: force no namespace here
694 static int _idGenerator;
696 int _id; // id given by creator (unique within the creator instance)
698 std::map<int, SMESH::SMESH_subMesh_ptr> _mapSubMeshIor;
699 std::map<int, SMESH::SMESH_GroupBase_ptr> _mapGroups;
700 std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
701 SMESH_MeshEditor_i* _editor;
702 SMESH_MeshEditor_i* _previewEditor;
703 SMESH::MedFileInfo_var _medFileInfo;
704 SMESH_PreMeshInfo* _preMeshInfo; // mesh info before full loading from study file
706 SMESH_PreMeshInfo* & changePreMeshInfo() { return _preMeshInfo; }
707 friend class SMESH_PreMeshInfo;
711 // Data used to track changes of GEOM groups
712 struct TGeomGroupData {
713 // keep study entry but not ior because GEOM_Object actually changes if
714 // number of items in a group varies (1) <-> (>1)
715 std::string _groupEntry;
716 std::set<int> _indices; // indices of group items within group's main shape
717 CORBA::Object_var _smeshObject; // SMESH object depending on GEOM group
719 std::list<TGeomGroupData> _geomGroupData;
720 int _mainShapeTick; // to track modifications of the meshed shape
723 * Remember GEOM group data
725 void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
726 CORBA::Object_ptr theSmeshObj);
728 * Remove GEOM group data relating to removed smesh object
730 void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
732 * Return new group contents if it has been changed and update group data
734 TopoDS_Shape newGroupShape( TGeomGroupData & groupData, int how );