src/SMESH_I/SMESH_Mesh_i.hxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
  23 //  File   : SMESH_Mesh_i.hxx
  24 //  Author : Paul RASCLE, EDF
  25 //  Module : SMESH
  26 //
  27 #ifndef _SMESH_MESH_I_HXX_
  28 #define _SMESH_MESH_I_HXX_
  29
  30 #include "SMESH.hxx"
  31
  32 #include <SALOMEconfig.h>
  33 #include CORBA_SERVER_HEADER(SMESH_Mesh)
  34 #include CORBA_SERVER_HEADER(SMESH_Group)
  35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  36 #include CORBA_CLIENT_HEADER(GEOM_Gen)
  37 #include CORBA_CLIENT_HEADER(MED)
  38
  39 #include "SMESH_Hypothesis.hxx"
  40 #include "SMESH_Mesh.hxx"
  41 //#include "SMESH_subMesh_i.hxx"
  42 #include "SMESH_subMesh.hxx"
  43
  44 #include "SALOME_GenericObj_i.hh"
  45
  46 class SMESH_Gen_i;
  47 class SMESH_GroupBase_i;
  48 class SMESH_subMesh_i;
  49
  50 #include <map>
  51
  52 class SMESH_I_EXPORT SMESH_Mesh_i:
  53   public virtual POA_SMESH::SMESH_Mesh,
  54   public virtual SALOME::GenericObj_i
  55 {
  56   SMESH_Mesh_i();
  57   SMESH_Mesh_i(const SMESH_Mesh_i&);
  58 public:
  59   SMESH_Mesh_i( PortableServer::POA_ptr thePOA,
  60                 SMESH_Gen_i*            myGen_i,
  61                 CORBA::Long             studyId );
  62
  63   virtual ~SMESH_Mesh_i();
  64
  65   // --- CORBA
  66   void SetShape( GEOM::GEOM_Object_ptr theShapeObject )
  67     throw (SALOME::SALOME_Exception);
  68
  69   CORBA::Boolean HasShapeToMesh()
  70     throw (SALOME::SALOME_Exception);
  71
  72   GEOM::GEOM_Object_ptr GetShapeToMesh()
  73     throw (SALOME::SALOME_Exception);
  74
  75   void Clear()
  76     throw (SALOME::SALOME_Exception);
  77
  78   void ClearSubMesh(CORBA::Long ShapeID)
  79     throw (SALOME::SALOME_Exception);
  80
  81   SMESH::Hypothesis_Status AddHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
  82                                          SMESH::SMESH_Hypothesis_ptr anHyp)
  83     throw (SALOME::SALOME_Exception);
  84
  85   SMESH::Hypothesis_Status RemoveHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
  86                                             SMESH::SMESH_Hypothesis_ptr anHyp)
  87     throw (SALOME::SALOME_Exception);
  88
  89   SMESH::ListOfHypothesis* GetHypothesisList(GEOM::GEOM_Object_ptr aSubShapeObject)
  90     throw (SALOME::SALOME_Exception);
  91
  92   SMESH::SMESH_subMesh_ptr GetSubMesh(GEOM::GEOM_Object_ptr aSubShapeObject, const char* theName)
  93     throw (SALOME::SALOME_Exception);
  94
  95   void RemoveSubMesh( SMESH::SMESH_subMesh_ptr theSubMesh )
  96     throw (SALOME::SALOME_Exception);
  97
  98   SMESH::SMESH_Group_ptr CreateGroup( SMESH::ElementType theElemType, const char* theName )
  99     throw (SALOME::SALOME_Exception);
 100
 101   SMESH::SMESH_GroupOnGeom_ptr CreateGroupFromGEOM(SMESH::ElementType    theElemType,
 102                                                    const char*           theName,
 103                                                    GEOM::GEOM_Object_ptr theGeomObj )
 104     throw (SALOME::SALOME_Exception);
 105
 106   void RemoveGroup( SMESH::SMESH_GroupBase_ptr theGroup )
 107     throw (SALOME::SALOME_Exception);
 108
 109   void RemoveGroupWithContents( SMESH::SMESH_GroupBase_ptr theGroup )
 110     throw (SALOME::SALOME_Exception);
 111
 112   SMESH::ListOfGroups* GetGroups()
 113     throw (SALOME::SALOME_Exception);
 114
 115   CORBA::Long NbGroups()
 116     throw (SALOME::SALOME_Exception);
 117
 118   SMESH::SMESH_Group_ptr UnionGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 119                                       SMESH::SMESH_GroupBase_ptr theGroup2,
 120                                       const char* theName )
 121     throw (SALOME::SALOME_Exception);
 122
 123   SMESH::SMESH_Group_ptr UnionListOfGroups( const SMESH::ListOfGroups& theGroups,
 124                                             const char* theName)
 125     throw (SALOME::SALOME_Exception);
 126
 127   SMESH::SMESH_Group_ptr IntersectGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 128                                           SMESH::SMESH_GroupBase_ptr theGroup2,
 129                                           const char* theName )
 130     throw (SALOME::SALOME_Exception);
 131
 132   SMESH::SMESH_Group_ptr IntersectListOfGroups( const SMESH::ListOfGroups&  theGroups,
 133                                                 const char* theName )
 134     throw (SALOME::SALOME_Exception);
 135
 136   SMESH::SMESH_Group_ptr CutGroups( SMESH::SMESH_GroupBase_ptr theGroup1,
 137                                     SMESH::SMESH_GroupBase_ptr theGroup2,
 138                                     const char* theName )
 139     throw (SALOME::SALOME_Exception);
 140
 141   SMESH::SMESH_Group_ptr CutListOfGroups( const SMESH::ListOfGroups& theMainGroups,
 142                                           const SMESH::ListOfGroups& theToolGroups,
 143                                           const char* theName )
 144   throw (SALOME::SALOME_Exception);
 145
 146   SMESH::SMESH_Group_ptr CreateDimGroup( const SMESH::ListOfGroups& theGroups,
 147                                          SMESH::ElementType theElemType,
 148                                          const char* theName )
 149   throw (SALOME::SALOME_Exception);
 150
 151
 152   SMESH::SMESH_Group_ptr ConvertToStandalone( SMESH::SMESH_GroupOnGeom_ptr theGeomGroup );
 153
 154 //    SMESH::string_array* GetLog(CORBA::Boolean clearAfterGet)
 155 //      throw (SALOME::SALOME_Exception);
 156
 157   SMESH::log_array* GetLog(CORBA::Boolean clearAfterGet)
 158     throw (SALOME::SALOME_Exception);
 159
 160   SMESH::SMESH_MeshEditor_ptr GetMeshEditor();
 161
 162   SMESH::SMESH_MeshEditor_ptr GetMeshEditPreviewer();
 163
 164   void ClearLog()
 165     throw (SALOME::SALOME_Exception);
 166
 167   CORBA::Long GetId()
 168     throw (SALOME::SALOME_Exception);
 169
 170   CORBA::Long GetStudyId()
 171     throw (SALOME::SALOME_Exception);
 172
 173   // --- C++ interface
 174   void SetImpl(::SMESH_Mesh* impl);
 175   ::SMESH_Mesh& GetImpl();         // :: force no namespace here
 176
 177   SMESH_Gen_i* GetGen() { return _gen_i; }
 178
 179   int ImportUNVFile( const char* theFileName )
 180     throw (SALOME::SALOME_Exception);
 181
 182   int ImportSTLFile( const char* theFileName )
 183     throw (SALOME::SALOME_Exception);
 184
 185   /*!
 186    * consult DriverMED_R_SMESHDS_Mesh::ReadStatus for returned value
 187    */
 188   SMESH::DriverMED_ReadStatus ImportMEDFile( const char* theFileName, const char* theMeshName )
 189     throw (SALOME::SALOME_Exception);
 190
 191   /*!
 192    *  Auto color
 193    */
 194   void SetAutoColor(CORBA::Boolean theAutoColor)
 195     throw (SALOME::SALOME_Exception);
 196
 197   CORBA::Boolean GetAutoColor()
 198     throw (SALOME::SALOME_Exception);
 199
 200   /*! Check group names for duplications.
 201    *  Consider maximum group name length stored in MED file.
 202    */
 203   CORBA::Boolean HasDuplicatedGroupNamesMED();
 204   /*!
 205    * Return string representation of a MED file version comprising nbDigits
 206    */
 207   char* GetVersionString(SMESH::MED_VERSION version, CORBA::Short nbDigits);
 208
 209   void ExportToMED( const char* file, CORBA::Boolean auto_groups, SMESH::MED_VERSION theVersion )
 210     throw (SALOME::SALOME_Exception);
 211   void ExportMED( const char* file, CORBA::Boolean auto_groups )
 212     throw (SALOME::SALOME_Exception);
 213
 214   void ExportDAT( const char* file )
 215     throw (SALOME::SALOME_Exception);
 216   void ExportUNV( const char* file )
 217     throw (SALOME::SALOME_Exception);
 218   void ExportSTL( const char* file, bool isascii )
 219     throw (SALOME::SALOME_Exception);
 220
 221   SALOME_MED::MESH_ptr GetMEDMesh()
 222     throw (SALOME::SALOME_Exception);
 223
 224   CORBA::Long NbNodes()
 225     throw (SALOME::SALOME_Exception);
 226
 227   CORBA::Long NbElements()
 228     throw (SALOME::SALOME_Exception);
 229
 230   CORBA::Long NbEdges()
 231     throw (SALOME::SALOME_Exception);
 232
 233   CORBA::Long NbEdgesOfOrder(SMESH::ElementOrder order)
 234     throw (SALOME::SALOME_Exception);
 235
 236   CORBA::Long NbFaces()
 237     throw (SALOME::SALOME_Exception);
 238
 239   CORBA::Long NbFacesOfOrder(SMESH::ElementOrder order)
 240     throw (SALOME::SALOME_Exception);
 241
 242   CORBA::Long NbTriangles()
 243     throw (SALOME::SALOME_Exception);
 244
 245   CORBA::Long NbTrianglesOfOrder(SMESH::ElementOrder order)
 246     throw (SALOME::SALOME_Exception);
 247
 248   CORBA::Long NbQuadrangles()
 249     throw (SALOME::SALOME_Exception);
 250
 251   CORBA::Long NbQuadranglesOfOrder(SMESH::ElementOrder order)
 252     throw (SALOME::SALOME_Exception);
 253
 254   CORBA::Long NbPolygons()
 255     throw (SALOME::SALOME_Exception);
 256
 257   CORBA::Long NbVolumes()
 258     throw (SALOME::SALOME_Exception);
 259
 260   CORBA::Long NbVolumesOfOrder(SMESH::ElementOrder order)
 261     throw (SALOME::SALOME_Exception);
 262
 263   CORBA::Long NbTetras()
 264     throw (SALOME::SALOME_Exception);
 265
 266   CORBA::Long NbTetrasOfOrder(SMESH::ElementOrder order)
 267     throw (SALOME::SALOME_Exception);
 268
 269   CORBA::Long NbHexas()
 270     throw (SALOME::SALOME_Exception);
 271
 272   CORBA::Long NbHexasOfOrder(SMESH::ElementOrder order)
 273     throw (SALOME::SALOME_Exception);
 274
 275   CORBA::Long NbPyramids()
 276     throw (SALOME::SALOME_Exception);
 277
 278   CORBA::Long NbPyramidsOfOrder(SMESH::ElementOrder order)
 279     throw (SALOME::SALOME_Exception);
 280
 281   CORBA::Long NbPrisms()
 282     throw (SALOME::SALOME_Exception);
 283
 284   CORBA::Long NbPrismsOfOrder(SMESH::ElementOrder order)
 285     throw (SALOME::SALOME_Exception);
 286
 287   CORBA::Long NbPolyhedrons()
 288     throw (SALOME::SALOME_Exception);
 289
 290   CORBA::Long NbSubMesh()
 291     throw (SALOME::SALOME_Exception);
 292
 293   SMESH::long_array* GetElementsId()
 294     throw (SALOME::SALOME_Exception);
 295
 296   SMESH::long_array* GetElementsByType( SMESH::ElementType theElemType )
 297     throw (SALOME::SALOME_Exception);
 298
 299   SMESH::long_array* GetNodesId()
 300     throw (SALOME::SALOME_Exception);
 301
 302   SMESH::ElementType GetElementType( CORBA::Long id, bool iselem )
 303     throw (SALOME::SALOME_Exception);
 304
 305   /*!
 306    * Returns ID of elements for given submesh
 307    */
 308   SMESH::long_array* GetSubMeshElementsId(CORBA::Long ShapeID)
 309     throw (SALOME::SALOME_Exception);
 310
 311   /*!
 312    * Returns ID of nodes for given submesh
 313    * If param all==true - returns all nodes, else -
 314    * returns only nodes on shapes.
 315    */
 316   SMESH::long_array* GetSubMeshNodesId(CORBA::Long ShapeID, CORBA::Boolean all)
 317     throw (SALOME::SALOME_Exception);
 318
 319   /*!
 320    * Returns type of elements for given submesh
 321    */
 322   SMESH::ElementType GetSubMeshElementType(CORBA::Long ShapeID)
 323     throw (SALOME::SALOME_Exception);
 324
 325   char* Dump();
 326
 327   // Internal methods not available through CORBA
 328   // They are called by corresponding interface methods
 329   SMESH_Hypothesis::Hypothesis_Status addHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
 330                                                     SMESH::SMESH_Hypothesis_ptr anHyp);
 331
 332   SMESH_Hypothesis::Hypothesis_Status removeHypothesis(GEOM::GEOM_Object_ptr aSubShapeObject,
 333                                                        SMESH::SMESH_Hypothesis_ptr anHyp);
 334
 335   static SMESH::Hypothesis_Status
 336   ConvertHypothesisStatus (SMESH_Hypothesis::Hypothesis_Status theStatus);
 337
 338   static void PrepareForWriting (const char* file);
 339
 340   //int importMEDFile( const char* theFileName, const char* theMeshName );
 341
 342   SMESH::SMESH_subMesh_ptr createSubMesh( GEOM::GEOM_Object_ptr theSubShapeObject );
 343
 344   void removeSubMesh(SMESH::SMESH_subMesh_ptr theSubMesh,
 345                      GEOM::GEOM_Object_ptr theSubShapeObject );
 346
 347   SMESH::SMESH_GroupBase_ptr createGroup(SMESH::ElementType  theElemType,
 348                                          const char*         theName,
 349                                          const TopoDS_Shape& theShape = TopoDS_Shape());
 350
 351   void removeGroup( const int theId );
 352
 353   SMESH::SMESH_subMesh_ptr getSubMesh(int shapeID);
 354   // return an existing subMesh object for the shapeID. shapeID == submeshID.
 355
 356   const std::map<int, SMESH::SMESH_GroupBase_ptr>& getGroups() { return _mapGroups; }
 357   // return an existing group object.
 358
 359   /*!
 360    * \brief Update hypotheses assigned to geom groups if the latter change
 361    *
 362    * NPAL16168: "geometrical group edition from a submesh don't modifiy mesh computation"
 363    */
 364   void CheckGeomGroupModif();
 365
 366   virtual SMESH::long_array* GetIDs();
 367
 368   CORBA::LongLong GetMeshPtr();
 369
 370   /*!
 371    * \brief Assure that all groups are published
 372    */
 373   void CreateGroupServants();
 374
 375   /*!
 376    * \brief Return groups cantained in _mapGroups by their IDs
 377    */
 378   SMESH::ListOfGroups* GetGroups(const std::list<int>& groupIDs) const;
 379
 380   /*!
 381    * Get XYZ coordinates of node as list of double
 382    * If there is not node for given ID - returns empty list
 383    */
 384   SMESH::double_array* GetNodeXYZ(CORBA::Long id);
 385
 386   /*!
 387    * For given node returns list of IDs of inverse elements
 388    * If there is not node for given ID - returns empty list
 389    */
 390   SMESH::long_array* GetNodeInverseElements(CORBA::Long id);
 391
 392   /*!
 393    * \brief Return position of a node on shape
 394    */
 395   SMESH::NodePosition* GetNodePosition(CORBA::Long NodeID);
 396
 397   /*!
 398    * If given element is node returns IDs of shape from position
 399    * If there is not node for given ID - returns -1
 400    */
 401   CORBA::Long GetShapeID(CORBA::Long id);
 402
 403   /*!
 404    * For given element returns ID of result shape after
 405    * ::FindShape() from SMESH_MeshEditor
 406    * If there is not element for given ID - returns -1
 407    */
 408   CORBA::Long GetShapeIDForElem(CORBA::Long id);
 409
 410   /*!
 411    * Returns number of nodes for given element
 412    * If there is not element for given ID - returns -1
 413    */
 414   CORBA::Long GetElemNbNodes(CORBA::Long id);
 415
 416   /*!
 417    * Returns IDs of nodes of given element
 418    */
 419   SMESH::long_array* GetElemNodes(CORBA::Long id);
 420
 421   /*!
 422    * Returns ID of node by given index for given element
 423    * If there is not element for given ID - returns -1
 424    * If there is not node for given index - returns -2
 425    */
 426   CORBA::Long GetElemNode(CORBA::Long id, CORBA::Long index);
 427
 428   /*!
 429    * Returns true if given node is medium node
 430    * in given quadratic element
 431    */
 432   CORBA::Boolean IsMediumNode(CORBA::Long ide, CORBA::Long idn);
 433
 434   /*!
 435    * Returns true if given node is medium node
 436    * in one of quadratic elements
 437    */
 438   CORBA::Boolean IsMediumNodeOfAnyElem(CORBA::Long idn,
 439                                        SMESH::ElementType theElemType);
 440
 441   /*!
 442    * Returns number of edges for given element
 443    */
 444   CORBA::Long ElemNbEdges(CORBA::Long id);
 445
 446   /*!
 447    * Returns number of faces for given element
 448    */
 449   CORBA::Long ElemNbFaces(CORBA::Long id);
 450
 451   /*!
 452    * Returns true if given element is polygon
 453    */
 454   CORBA::Boolean IsPoly(CORBA::Long id);
 455
 456   /*!
 457    * Returns true if given element is quadratic
 458    */
 459   CORBA::Boolean IsQuadratic(CORBA::Long id);
 460
 461   /*!
 462    * Returns bary center for given element
 463    */
 464   SMESH::double_array* BaryCenter(CORBA::Long id);
 465
 466   /*!
 467    * Returns information about imported MED file
 468    */
 469   virtual SALOME_MED::MedFileInfo* GetMEDFileInfo();
 470
 471   /*!
 472    * Sets list of notebook variables used for Mesh operations separated by ":" symbol
 473    */
 474   void SetParameters (const char* theParameters);
 475
 476   /*!
 477    * Returns list of notebook variables used for Mesh operations separated by ":" symbol
 478    */
 479   char* GetParameters();
 480
 481   /*!
 482    * Returns list of notebook variables used for last Mesh operation
 483    */
 484   SMESH::string_array* GetLastParameters();
 485
 486   std::map<int, SMESH_subMesh_i*> _mapSubMesh_i; //NRI
 487   std::map<int, ::SMESH_subMesh*> _mapSubMesh;   //NRI
 488
 489 private:
 490   /*!
 491    * Check and correct names of mesh groups
 492    */
 493   void checkGroupNames();
 494
 495 private:
 496
 497   static int myIdGenerator;
 498   ::SMESH_Mesh* _impl;  // :: force no namespace here
 499   SMESH_Gen_i* _gen_i;
 500   int _id;          // id given by creator (unique within the creator instance)
 501   int _studyId;
 502   std::map<int, SMESH::SMESH_subMesh_ptr>    _mapSubMeshIor;
 503   std::map<int, SMESH::SMESH_GroupBase_ptr>  _mapGroups;
 504   std::map<int, SMESH::SMESH_Hypothesis_ptr> _mapHypo;
 505   SALOME_MED::MedFileInfo_var myFileInfo;
 506
 507 private:
 508
 509   // Data used to track changes of GEOM groups
 510   struct TGeomGroupData {
 511     // keep study entry and not ior because GEOM_Object actually changes if
 512     // number of items in a group varies (1) <-> (>1)
 513     std::string       _groupEntry;
 514     std::set<int>     _indices; // indices of group items within group's main shape
 515     CORBA::Object_ptr _smeshObject; // SMESH object depending on GEOM group
 516   };
 517   std::list<TGeomGroupData> _geomGroupData;
 518
 519   /*!
 520    * Remember GEOM group data
 521    */
 522   void addGeomGroupData(GEOM::GEOM_Object_ptr theGeomObj,
 523                         CORBA::Object_ptr     theSmeshObj);
 524   /*!
 525    * Remove GEOM group data relating to removed smesh object
 526    */
 527   void removeGeomGroupData(CORBA::Object_ptr theSmeshObj);
 528   /*!
 529    * \brief Return new group contents if it has been changed and update group data
 530    */
 531   TopoDS_Shape newGroupShape( TGeomGroupData & groupData);
 532
 533 };
 534
 535 #endif
 536