idl/SMESH_Mesh.idl

   1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
  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
  23 //  File   : SMESH_Mesh.idl
  24 //  Author : Paul RASCLE, EDF
  25 //
  26 #ifndef _SMESH_MESH_IDL_
  27 #define _SMESH_MESH_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SALOME_GenericObj.idl"
  31 #include "GEOM_Gen.idl"
  32
  33 module SMESH
  34 {
  35   interface SMESH_Hypothesis;
  36   typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
  37   interface SMESH_GroupBase;
  38   typedef sequence<SMESH_GroupBase> ListOfGroups;
  39   interface SMESH_IDSource;
  40   typedef sequence<SMESH_IDSource> ListOfIDSources;
  41
  42   typedef sequence<double    > double_array ;
  43   typedef sequence<long      > long_array ;
  44   typedef sequence<string    > string_array ;
  45   typedef sequence<long_array> array_of_long_array ;
  46
  47   enum log_command
  48     {
  49       ADD_NODE,
  50       ADD_EDGE,
  51       ADD_TRIANGLE,
  52       ADD_QUADRANGLE,
  53       ADD_POLYGON,
  54       ADD_TETRAHEDRON,
  55       ADD_PYRAMID,
  56       ADD_PRISM,
  57       ADD_HEXAHEDRON,
  58       ADD_POLYHEDRON,
  59       REMOVE_NODE,
  60       REMOVE_ELEMENT,
  61       MOVE_NODE,
  62       CHANGE_ELEMENT_NODES,
  63       CHANGE_POLYHEDRON_NODES,
  64       RENUMBER,
  65       CLEAR_MESH,
  66       ADD_QUADEDGE,
  67       ADD_QUADTRIANGLE,
  68       ADD_QUADQUADRANGLE,
  69       ADD_QUADPOLYGON,
  70       ADD_QUADTETRAHEDRON,
  71       ADD_QUADPYRAMID,
  72       ADD_QUADPENTAHEDRON,
  73       ADD_QUADHEXAHEDRON,
  74       ADD_ELEM0D,
  75       ADD_BIQUAD_TRIANGLE,
  76       ADD_BIQUAD_QUADRANGLE,
  77       ADD_TRIQUAD_HEXA,
  78       ADD_HEXAGONAL_PRISM,
  79       ADD_BALL
  80     };
  81
  82   struct log_block
  83   {
  84     long commandType;
  85     long number;
  86     double_array coords;
  87     long_array indexes;
  88   };
  89   typedef sequence<log_block> log_array;
  90
  91   struct PointStruct { double x;
  92                        double y;
  93                        double z; };
  94
  95   typedef sequence<PointStruct> nodes_array;
  96
  97   struct DirStruct   { PointStruct PS; };          // analog to OCCT gp_Vec
  98
  99   struct AxisStruct  { double x;
 100                        double y;
 101                        double z;
 102                        double vx;
 103                        double vy;
 104                        double vz; };
 105   /*!
 106    * Node location on a shape
 107    */
 108   struct NodePosition {
 109     long             shapeID;
 110     GEOM::shape_type shapeType;
 111     double_array     params; // [U] on EDGE, [U,V] on FACE, [] on the rest shapes
 112   };
 113
 114   /*!
 115    * Element location on a shape
 116    */
 117   struct ElementPosition {
 118     long             shapeID;
 119     GEOM::shape_type shapeType;
 120   };
 121
 122   /*!
 123    * Enumeration for element type, like in SMDS
 124    */
 125   enum ElementType
 126   {
 127     ALL,
 128     NODE,
 129     EDGE,
 130     FACE,
 131     VOLUME,
 132     ELEM0D,
 133     BALL,
 134     NB_ELEMENT_TYPES
 135   };
 136   typedef sequence<ElementType> array_of_ElementType;
 137
 138   /*!
 139    * Enumeration for element geometry type, like SMDSAbs_GeometryType in SMDSAbs_ElementType.hxx
 140    */
 141   enum GeometryType
 142   {
 143     Geom_POINT,
 144     Geom_EDGE,
 145     Geom_TRIANGLE,
 146     Geom_QUADRANGLE, // when a new GeometryType is added, please
 147     Geom_POLYGON,    // update a corresponding list in SMESH_2smeshpy.cxx, ln 665
 148     Geom_TETRA,
 149     Geom_PYRAMID,
 150     Geom_HEXA,
 151     Geom_PENTA,
 152     Geom_HEXAGONAL_PRISM,
 153     Geom_POLYHEDRA,
 154     Geom_BALL,
 155     Geom_LAST
 156   };
 157
 158   /*!
 159    * ElementOrder points out entities of what order are requested
 160    */
 161   enum ElementOrder {
 162     ORDER_ANY,          /*! entities of any order */
 163     ORDER_LINEAR,       /*! entities of 1st order */
 164     ORDER_QUADRATIC     /*! entities of 2nd order */
 165   };
 166
 167   /*!
 168    * Enumeration of entity type used in mesh info array,
 169    * it should be synchronised with enum SMDSAbs_EntityType
 170    */
 171   enum EntityType
 172   {
 173     Entity_Node,
 174     Entity_0D,
 175     Entity_Edge,
 176     Entity_Quad_Edge,
 177     Entity_Triangle,
 178     Entity_Quad_Triangle,
 179     Entity_BiQuad_Triangle,
 180     Entity_Quadrangle,
 181     Entity_Quad_Quadrangle,
 182     Entity_BiQuad_Quadrangle,
 183     Entity_Polygon,
 184     Entity_Quad_Polygon,
 185     Entity_Tetra,
 186     Entity_Quad_Tetra,
 187     Entity_Pyramid,
 188     Entity_Quad_Pyramid,
 189     Entity_Hexa,
 190     Entity_Quad_Hexa,
 191     Entity_TriQuad_Hexa,
 192     Entity_Penta,
 193     Entity_Quad_Penta,
 194     Entity_BiQuad_Penta,
 195     Entity_Hexagonal_Prism,
 196     Entity_Polyhedra,
 197     Entity_Quad_Polyhedra,
 198     Entity_Ball,
 199     Entity_Last
 200   };
 201
 202   /*!
 203    * Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
 204    */
 205   enum Hypothesis_Status // in the order of severity
 206   {
 207     HYP_OK,
 208     HYP_MISSING,      // algo misses a hypothesis
 209     HYP_CONCURRENT,   // several applicable hypotheses
 210     HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
 211     HYP_HIDDEN_ALGO,  // an algo is hidden by an upper dim algo generating all-dim elements
 212     HYP_HIDING_ALGO,  // an algo hides lower dim algos by generating all-dim elements
 213     HYP_UNKNOWN_FATAL,//  --- all statuses below should be considered as fatal
 214                       //      for Add/RemoveHypothesis operations
 215     HYP_INCOMPATIBLE, // hypothesis does not fit algo
 216     HYP_NOTCONFORM,   // not conform mesh is produced appling a hypothesis
 217     HYP_ALREADY_EXIST,// such hypothesis already exist
 218     HYP_BAD_DIM,      // bad dimension
 219     HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
 220     HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
 221     HYP_NEED_SHAPE,   // algorithm can work on shape only
 222     HYP_INCOMPAT_HYPS // several additional hypotheses are incompatible one with other
 223   };
 224
 225   /*!
 226    * Enumeration for mesh read status (used by SMESH_Gen::CreateMeshesFrom*() methods)
 227    */
 228   enum DriverMED_ReadStatus // in the order of severity
 229   {
 230     DRS_OK,
 231     DRS_EMPTY,          // a file contains no mesh with the given name
 232     DRS_WARN_RENUMBER,  // a MED file has overlapped ranges of element numbers,
 233                         // so the numbers from the file are ignored
 234     DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
 235     DRS_WARN_DESCENDING, // some elements were skipped due to descending connectivity
 236     DRS_FAIL            // general failure (exception etc.)
 237   };
 238
 239   /*!
 240    * Enumeration for ExportToMED*()
 241    * MED_V2_1 and MED_V2_2 are here for compatibility and mean respectively obsolete and MED_LATEST.
 242    * MED_MINOR_0 to MED_MINOR_9 are use to specify the minor version used by MEDfichier
 243    * to write MED files (major version cannot be changed).
 244    * This allows backward compatibility from a newer version of SALOME to an older one:
 245    * for instance, a MESH produced in SALOME 8.4 (med 3.3) can be written in med 3.2 format
 246    * to be read in SALOME 8.3.
 247    */
 248   enum MED_VERSION
 249   {
 250     MED_V2_1,
 251     MED_V2_2,
 252     MED_LATEST,
 253     MED_MINOR_0,
 254     MED_MINOR_1,
 255     MED_MINOR_2,
 256     MED_MINOR_3,
 257     MED_MINOR_4,
 258     MED_MINOR_5,
 259     MED_MINOR_6,
 260     MED_MINOR_7,
 261     MED_MINOR_8,
 262     MED_MINOR_9
 263   };
 264
 265   /*!
 266    * \brief A structure containing information about MED file
 267    */
 268   struct MedFileInfo
 269   {
 270     string fileName; //!< name of file
 271     long   fileSize; //!< size of file
 272     long   major, minor, release; //!< MED file version
 273   };
 274
 275   /*!
 276    * Enumeration for CreateDimGroup()
 277    */
 278   enum NB_COMMON_NODES_ENUM
 279   {
 280     ALL_NODES, MAIN, AT_LEAST_ONE, MAJORITY
 281   };
 282
 283   /*!
 284    * Auxiliary flags for advanced extrusion.
 285    * BOUNDARY: create or not boundary for result of extrusion
 286    * SEW:      try to use existing nodes or create new nodes in any case
 287    */
 288   const long EXTRUSION_FLAG_BOUNDARY = 1;
 289   const long EXTRUSION_FLAG_SEW = 2;
 290
 291   /*!
 292    * Structure used in mesh edit preview data (MeshPreviewStruct)
 293    */
 294   struct ElementSubType { ElementType SMDS_ElementType;
 295                           boolean     isPoly;
 296                           long        nbNodesInElement; };
 297
 298   typedef sequence<ElementSubType> types_array;
 299
 300   /*!
 301    * Structure containing mesh edit preview data
 302    */
 303   struct MeshPreviewStruct { nodes_array nodesXYZ;
 304                              long_array  elementConnectivities;
 305                              types_array elementTypes; };
 306
 307   interface SMESH_Mesh;
 308
 309   interface SMESH_IDSource : SALOME::GenericObj
 310   {
 311     /*!
 312      * Returns a sequence of all element IDs
 313      */
 314     long_array GetIDs();
 315
 316     /*!
 317      * Returns number of mesh elements of each \a EntityType
 318      * @return array of number of elements per \a EntityType
 319      */
 320     long_array GetMeshInfo();
 321
 322     /*!
 323      * Returns number of mesh elements of each \a ElementType
 324      * @return array of number of elements per \a ElementType
 325      */
 326     long_array GetNbElementsByType();
 327
 328     /*!
 329      * Returns types of elements it contains.
 330      * It's empty if the SMESH_IDSource contains no IDs
 331      */
 332     array_of_ElementType GetTypes();
 333
 334     /*!
 335      * Returns the mesh
 336      */
 337     SMESH_Mesh GetMesh();
 338
 339     /*!
 340      * Returns false if GetMeshInfo() returns incorrect information that may
 341      * happen if mesh data is not yet fully loaded from the file of study.
 342      */
 343     boolean IsMeshInfoCorrect();
 344
 345     /*!
 346      * Returns mesh unstructed grid information.
 347      */
 348     SALOMEDS::TMPFile GetVtkUgStream();
 349   };
 350
 351   interface SMESH_Group;
 352   interface SMESH_GroupOnGeom;
 353   interface Filter;
 354   interface SMESH_GroupOnFilter;
 355   interface SMESH_subMesh;
 356   interface SMESH_MeshEditor;
 357
 358   typedef sequence<SMESH_subMesh>     submesh_array;
 359   typedef sequence<submesh_array>     submesh_array_array;
 360
 361   interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
 362   {
 363     /*!
 364      * Return true if there is a geometry to be meshed
 365      */
 366     boolean HasShapeToMesh()
 367       raises (SALOME::SALOME_Exception);
 368
 369     /*!
 370      * Get geom shape to mesh. A result should not be nil. Use HasShapeToMesh()
 371      * to know if a returned shape
 372      */
 373     GEOM::GEOM_Object GetShapeToMesh()
 374       raises (SALOME::SALOME_Exception);
 375
 376     /*!
 377      * Return false if the mesh is not yet fully loaded from the study file
 378      */
 379     boolean IsLoaded()
 380       raises (SALOME::SALOME_Exception);
 381
 382     /*!
 383      * Load full mesh data from the study file
 384      */
 385     void Load()
 386       raises (SALOME::SALOME_Exception);
 387
 388     /*!
 389      * Remove all nodes and elements
 390      */
 391     void Clear()
 392       raises (SALOME::SALOME_Exception);
 393
 394     /*!
 395      *  Get the list of sub-meshes existing in the mesh
 396      */
 397     submesh_array GetSubMeshes()
 398       raises (SALOME::SALOME_Exception);
 399
 400     /*!
 401      * Remove all nodes and elements of submesh
 402      */
 403     void ClearSubMesh(in long ShapeID)
 404       raises (SALOME::SALOME_Exception);
 405
 406     /*!
 407      * Get the subMesh object associated to a Sub-shape. The subMesh object
 408      * gives access to nodes and elements IDs.
 409      * SubMesh will be used instead of Sub-shape in a next idl version to
 410      * address a specific subMesh...
 411      */
 412     SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
 413       raises (SALOME::SALOME_Exception);
 414
 415     /*!
 416      * Remove a submesh
 417      */
 418     void RemoveSubMesh(in SMESH_subMesh aSubMesh)
 419       raises (SALOME::SALOME_Exception);
 420
 421
 422     /*!
 423      * Create a group
 424      */
 425     SMESH_Group CreateGroup( in ElementType elem_type,
 426                              in string      name )
 427       raises (SALOME::SALOME_Exception);
 428
 429     /*!
 430      * Create a group from geometry
 431      */
 432     SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType       elemType,
 433                                            in string            name,
 434                                            in GEOM::GEOM_Object geomObject )
 435       raises (SALOME::SALOME_Exception);
 436
 437     /*!
 438      * Create a group from filter
 439      */
 440     SMESH_GroupOnFilter CreateGroupFromFilter( in ElementType   elemType,
 441                                                in string        name,
 442                                                in SMESH::Filter filter )
 443       raises (SALOME::SALOME_Exception);
 444
 445     /*!
 446      * Remove a group
 447      */
 448     void RemoveGroup(in SMESH_GroupBase aGroup)
 449       raises (SALOME::SALOME_Exception);
 450
 451     /*!
 452      *  Remove group with its contents
 453      */
 454     void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
 455       raises (SALOME::SALOME_Exception);
 456
 457     /*!
 458      *  Get the list of groups existing in the mesh
 459      */
 460     ListOfGroups GetGroups()
 461       raises (SALOME::SALOME_Exception);
 462
 463     /*!
 464      *  Get number of groups existing in the mesh
 465      */
 466     long NbGroups()
 467       raises (SALOME::SALOME_Exception);
 468
 469     /*!
 470      * Union of two groups
 471      *    New group is created. All mesh elements that are
 472      *    present in initial groups are added to the new one
 473      */
 474     SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
 475                              in SMESH_GroupBase aGroup2,
 476                              in string          name )
 477       raises (SALOME::SALOME_Exception);
 478
 479     /*!
 480      * Union of list of groups
 481      * New group is created. All mesh elements that are
 482      * present in initial groups are added to the new one
 483      */
 484     SMESH_Group UnionListOfGroups (in ListOfGroups aListOfGroups,
 485                                    in string       name )
 486       raises (SALOME::SALOME_Exception);
 487
 488     /*!
 489      *  Intersection of two groups
 490      *  New group is created. All mesh elements that are
 491      *  present in both initial groups are added to the new one.
 492      */
 493     SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
 494                                  in SMESH_GroupBase aGroup2,
 495                                  in string          name )
 496       raises (SALOME::SALOME_Exception);
 497
 498     /*!
 499      *  Intersection of list of groups
 500      *  New group is created. All mesh elements that are
 501      *  present in all initial groups simultaneously are added to the new one.
 502      */
 503     SMESH_Group IntersectListOfGroups (in ListOfGroups aListOfGroups,
 504                                        in string       name)
 505       raises (SALOME::SALOME_Exception);
 506
 507     /*!
 508      *  Cut of two groups
 509      *  New group is created. All mesh elements that are present in
 510      *  main group but do not present in tool group are added to the new one
 511      */
 512     SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
 513                            in SMESH_GroupBase aToolGroup,
 514                            in string          name )
 515       raises (SALOME::SALOME_Exception);
 516
 517     /*!
 518      *  Cut of lists of groups
 519      *  New group is created. All mesh elements that are present in
 520      *  main groups but do not present in tool groups are added to the new one
 521      */
 522     SMESH_Group CutListOfGroups (in ListOfGroups aMainGroups,
 523                                  in ListOfGroups aToolGroups,
 524                                  in string       name)
 525       raises (SALOME::SALOME_Exception);
 526
 527     /*!
 528      *  Create a group of entities basing on nodes of other groups.
 529      *  \param [in] aListOfGroups - list of either groups, sub-meshes or filters.
 530      *  \param [in] anElemType - a type of elements to include to the new group.
 531      *  \param [in] name - a name of the new group.
 532      *  \param [in] nbCommonNodes - criterion of inclusion of an element to the new group.
 533      *  \param [in] underlyingOnly - if \c True, an element is included to the
 534      *         new group provided that it is based on nodes of an element of
 535      *         \a aListOfGroups
 536      *  \return SMESH_Group - the created group
 537      */
 538     SMESH_Group CreateDimGroup( in ListOfIDSources      aListOfGroups,
 539                                 in ElementType          anElemType,
 540                                 in string               name,
 541                                 in NB_COMMON_NODES_ENUM nbCommonNodes,
 542                                 in boolean              underlyingOnly )
 543       raises (SALOME::SALOME_Exception);
 544
 545     /*!
 546      * Convert group on geometry or on filter into standalone group
 547      */
 548     SMESH_Group ConvertToStandalone( in SMESH_GroupBase theGroupOn )
 549       raises (SALOME::SALOME_Exception);
 550
 551     /*!
 552      * Add hypothesis to the mesh, under a particular sub-shape
 553      * (or the main shape itself)
 554      * This method is only used to prepare the build of the mesh and store
 555      * the algorithms and associated parameters.
 556      * Actual job of meshing the shape is done by SMESH_Gen::Compute()
 557      * @params
 558      * - aSubObject : sub-shape obtained by a shape explode in GEOM
 559      *   (or main shape)
 560      * - anHyp : an hypothesis object
 561      * @return
 562      * - An enum item explaining what's up
 563      * - anErrorText: an optional textual description of a problem (if any)
 564      */
 565     Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
 566                                     in SMESH_Hypothesis  anHyp,
 567                                     out string           anErrorText)
 568       raises (SALOME::SALOME_Exception);
 569
 570     /*!
 571      * Remove an hypothesis previously added with AddHypothesis.
 572      */
 573     Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
 574                                        in SMESH_Hypothesis anHyp)
 575       raises (SALOME::SALOME_Exception);
 576
 577     /*!
 578      * Get the list of hypothesis added on a sub-shape
 579      */
 580     ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
 581       raises (SALOME::SALOME_Exception);
 582
 583     /*!
 584      * Get the log of nodes and elements added or removed since previous
 585      * clear of the log.
 586      * @params
 587      * - clearAfterGet : log is emptied after Get (safe if concurrents access)
 588      */
 589     log_array GetLog(in boolean clearAfterGet)
 590       raises (SALOME::SALOME_Exception);
 591
 592     /*!
 593      * Clear the log of nodes and elements added or removed since previous
 594      * clear. Must be used immediately after GetLog if clearAfterGet is false.
 595      */
 596     void ClearLog()
 597       raises (SALOME::SALOME_Exception);
 598
 599     /*!
 600      * Toggle auto color mode on the object.
 601      * @params
 602      * - theAutoColor : flag which toggles auto color mode.
 603      */
 604     void SetAutoColor(in boolean theAutoColor)
 605       raises (SALOME::SALOME_Exception);
 606
 607     /*!
 608      * Get flag of object's auto color mode.
 609      */
 610     boolean GetAutoColor()
 611       raises (SALOME::SALOME_Exception);
 612
 613     /*!
 614      * Get the internal Id
 615      */
 616     long GetId();
 617
 618     /*!
 619      * Get the study Id
 620      */
 621     long GetStudyId();
 622
 623     /*!
 624      * Obtain instance of SMESH_MeshEditor
 625      */
 626     SMESH_MeshEditor GetMeshEditor()
 627       raises (SALOME::SALOME_Exception);
 628
 629     /*!
 630      * Return SMESH_MeshEditor that would not modify the mesh but
 631      * fill MeshPreviewStruct
 632      */
 633     SMESH_MeshEditor GetMeshEditPreviewer()
 634       raises (SALOME::SALOME_Exception);
 635
 636     /*!
 637      * Return true if the mesh has been edited since a total re-compute
 638      * and those modifications may prevent successful partial re-compute
 639      */
 640     boolean HasModificationsToDiscard()
 641       raises (SALOME::SALOME_Exception);
 642
 643     /*! Check group names for duplications.
 644      *  Consider maximum group name length stored in MED file.
 645      */
 646     boolean HasDuplicatedGroupNamesMED();
 647
 648     /*!
 649      * Export Mesh to a MED Format file
 650      * @params
 651      * - file : name of the MED file
 652      * - auto_groups : boolean parameter for creating/not creating
 653      *                 the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
 654      *                 the typical use is auto_groups=false.
 655      * - version : defines the version of format of MED file, that will be created
 656      * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
 657      * - autoDimension : if @c true, a space dimension of a MED mesh can be either
 658      *         - 1D if all mesh nodes lie on OX coordinate axis, or
 659      *         - 2D if all mesh nodes lie on XOY coordinate plane, or
 660      *         - 3D in the rest cases.
 661      *         If @a autoDimension is @c false, the space dimension is always 3.
 662      */
 663     void ExportToMEDX( in string      file,
 664                        in boolean     auto_groups,
 665                        in MED_VERSION version,
 666                        in boolean     overwrite,
 667                        in boolean     autoDimension) raises (SALOME::SALOME_Exception);
 668
 669     /*!
 670      * Export a [part of] Mesh into a MED file
 671      * @params
 672      * - meshPart : a part of mesh to store
 673      * - file : name of the MED file
 674      * - version : define the version of format of MED file, that will be created
 675      * - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
 676      * - autoDimension : if @c True, a space dimension for export is defined by mesh
 677      *                 configuration; for example a planar mesh lying on XOY plane
 678      *                 will be exported as a mesh in 2D space.
 679      *                 If @a autoDimension == @c False, the space dimension is 3.
 680      * - fields : list of GEOM fields defined on the shape to mesh.
 681      * - geomAssocFields : each character of this string means a need to export a
 682      *         corresponding field; correspondence between fields and characters is following:
 683      *         - 'v' stands for _vertices_ field;
 684      *         - 'e' stands for _edges_ field;
 685      *         - 'f' stands for _faces_ field;
 686      *         - 's' stands for _solids_ field.
 687      */
 688     void ExportPartToMED( in SMESH_IDSource     meshPart,
 689                           in string             file,
 690                           in boolean            auto_groups,
 691                           in MED_VERSION        version,
 692                           in boolean            overwrite,
 693                           in boolean            autoDimension,
 694                           in GEOM::ListOfFields fields,
 695                           in string             geomAssocFields ) raises (SALOME::SALOME_Exception);
 696
 697     /*!
 698      * Export Mesh to a MED Format file
 699      * Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
 700      * The method is kept in order to support old functionality
 701      */
 702     void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
 703       raises (SALOME::SALOME_Exception);
 704
 705     /*!
 706      * Export Mesh to MED_LATEST MED format
 707      * Works, just the same as ExportToMEDX with MED_VERSION parameter equal to MED_LATEST
 708      * and overwrite parameter equal to true
 709      * The method is kept in order to support old functionality
 710      */
 711     void ExportMED( in string file, in boolean auto_groups )
 712       raises (SALOME::SALOME_Exception);
 713
 714     /*!
 715      * Export Mesh to SAUV formatted file
 716      * Write a temporary med file and use med2sauv
 717      */
 718     void ExportSAUV( in string file, in boolean auto_groups )
 719       raises (SALOME::SALOME_Exception);
 720
 721     /*!
 722      * Return string representation of a MED file version comprising nbDigits
 723      */
 724     string GetVersionString(in MED_VERSION version, in short nbDigits);
 725
 726     /*!
 727      * Export Mesh to different Formats
 728      * (UNV supported version is I-DEAS 10)
 729      */
 730     void ExportDAT( in string file ) raises (SALOME::SALOME_Exception);
 731     void ExportUNV( in string file ) raises (SALOME::SALOME_Exception);
 732     void ExportSTL( in string  file,
 733                     in boolean isascii ) raises (SALOME::SALOME_Exception);
 734     void ExportCGNS( in SMESH_IDSource meshPart,
 735                      in string         file,
 736                      in boolean        overwrite,
 737                      in boolean        groupElemsByType) raises (SALOME::SALOME_Exception);
 738     void ExportGMF( in SMESH_IDSource  meshPart,
 739                     in string          file,
 740                     in boolean         withRequiredGroups) raises (SALOME::SALOME_Exception);
 741     void ExportPartToDAT( in SMESH_IDSource meshPart,
 742                           in string         file ) raises (SALOME::SALOME_Exception);
 743     void ExportPartToUNV( in SMESH_IDSource meshPart,
 744                           in string         file ) raises (SALOME::SALOME_Exception);
 745     void ExportPartToSTL( in SMESH_IDSource meshPart,
 746                           in string         file,
 747                           in boolean        isascii ) raises (SALOME::SALOME_Exception);
 748     /*!
 749      * Return computation progress [0.,1]
 750      */
 751     double GetComputeProgress();
 752
 753     /*!
 754      * Get information about mesh contents
 755      */
 756     long NbNodes()
 757       raises (SALOME::SALOME_Exception);
 758
 759     long NbElements()
 760       raises (SALOME::SALOME_Exception);
 761
 762     long Nb0DElements()
 763       raises (SALOME::SALOME_Exception);
 764
 765     long NbBalls()
 766       raises (SALOME::SALOME_Exception);
 767
 768     long NbEdges()
 769       raises (SALOME::SALOME_Exception);
 770
 771     long NbEdgesOfOrder(in ElementOrder order)
 772       raises (SALOME::SALOME_Exception);
 773
 774     long NbFaces()
 775       raises (SALOME::SALOME_Exception);
 776
 777     long NbFacesOfOrder(in ElementOrder order)
 778       raises (SALOME::SALOME_Exception);
 779
 780     long NbTriangles()
 781       raises (SALOME::SALOME_Exception);
 782
 783     long NbTrianglesOfOrder(in ElementOrder order)
 784       raises (SALOME::SALOME_Exception);
 785
 786     long NbBiQuadTriangles()
 787       raises (SALOME::SALOME_Exception);
 788
 789     long NbQuadrangles()
 790       raises (SALOME::SALOME_Exception);
 791
 792     long NbQuadranglesOfOrder(in ElementOrder order)
 793       raises (SALOME::SALOME_Exception);
 794
 795     long NbBiQuadQuadrangles()
 796       raises (SALOME::SALOME_Exception);
 797
 798     long NbPolygons()
 799       raises (SALOME::SALOME_Exception);
 800
 801     long NbPolygonsOfOrder(in ElementOrder order)
 802       raises (SALOME::SALOME_Exception);
 803
 804     long NbVolumes()
 805       raises (SALOME::SALOME_Exception);
 806
 807     long NbVolumesOfOrder(in ElementOrder order)
 808       raises (SALOME::SALOME_Exception);
 809
 810     long NbTetras()
 811       raises (SALOME::SALOME_Exception);
 812
 813     long NbTetrasOfOrder(in ElementOrder order)
 814       raises (SALOME::SALOME_Exception);
 815
 816     long NbHexas()
 817       raises (SALOME::SALOME_Exception);
 818
 819     long NbHexasOfOrder(in ElementOrder order)
 820       raises (SALOME::SALOME_Exception);
 821
 822     long NbTriQuadraticHexas()
 823       raises (SALOME::SALOME_Exception);
 824
 825     long NbPyramids()
 826       raises (SALOME::SALOME_Exception);
 827
 828     long NbPyramidsOfOrder(in ElementOrder order)
 829       raises (SALOME::SALOME_Exception);
 830
 831     long NbPrisms()
 832       raises (SALOME::SALOME_Exception);
 833
 834     long NbPrismsOfOrder(in ElementOrder order)
 835       raises (SALOME::SALOME_Exception);
 836
 837     long NbHexagonalPrisms()
 838       raises (SALOME::SALOME_Exception);
 839
 840     long NbPolyhedrons()
 841       raises (SALOME::SALOME_Exception);
 842
 843     long NbSubMesh()
 844       raises (SALOME::SALOME_Exception);
 845
 846     long_array GetElementsId()
 847       raises (SALOME::SALOME_Exception);
 848
 849     long_array GetElementsByType( in ElementType theType )
 850       raises (SALOME::SALOME_Exception);
 851
 852     long_array GetNodesId()
 853       raises (SALOME::SALOME_Exception);
 854
 855     /*!
 856      * Returns type of mesh element
 857      */
 858     ElementType GetElementType( in long id, in boolean iselem )
 859       raises (SALOME::SALOME_Exception);
 860
 861     EntityType GetElementGeomType( in long id )
 862       raises (SALOME::SALOME_Exception);
 863
 864     GeometryType GetElementShape( in long id )
 865       raises (SALOME::SALOME_Exception);
 866
 867     long_array GetSubMeshElementsId(in long ShapeID)
 868       raises (SALOME::SALOME_Exception);
 869
 870     long_array GetSubMeshNodesId(in long ShapeID, in boolean all )
 871       raises (SALOME::SALOME_Exception);
 872
 873     ElementType GetSubMeshElementType(in long ShapeID)
 874       raises (SALOME::SALOME_Exception);
 875
 876
 877     /*!
 878      * Methods to set meshing order of submeshes
 879      */
 880
 881     /*!
 882      * \brief Return \c true if a meshing order not yet set for a concurrent sub-mesh
 883      */
 884     boolean IsUnorderedSubMesh(in long submeshID);
 885
 886     /*!
 887      * \brief Return submesh objects list in meshing order
 888      */
 889     submesh_array_array GetMeshOrder();
 890
 891     /*!
 892      * \brief Set submesh object order
 893      */
 894     boolean SetMeshOrder(in submesh_array_array theSubMeshArray);
 895
 896
 897     /*!
 898      * Get mesh description
 899      */
 900     string Dump();
 901
 902     /*!
 903      * Get mesh pointer
 904      */
 905     long long GetMeshPtr();
 906
 907     /*!
 908      * Get XYZ coordinates of node as list of double
 909      * If there is not node for given ID - returns empty list
 910      */
 911     double_array GetNodeXYZ(in long id);
 912
 913     /*!
 914      * For given node returns list of IDs of inverse elements
 915      * If there is not node for given ID - returns empty list
 916      */
 917     long_array GetNodeInverseElements(in long id);
 918
 919     /*!
 920      * \brief Return position of a node on shape
 921      */
 922     NodePosition GetNodePosition(in long NodeID);
 923
 924     /*!
 925      * \brief Return position of an element on shape
 926      */
 927     ElementPosition GetElementPosition(in long ElemID);
 928
 929     /*!
 930      * If given element is node returns IDs of shape from position
 931      * If there is not node for given ID - returns -1
 932      */
 933     long GetShapeID(in long id);
 934
 935     /*!
 936      * For given element returns ID of result shape after
 937      * ::FindShape() from SMESH_MeshEditor
 938      * If there is not element for given ID - returns -1
 939      */
 940     long GetShapeIDForElem(in long id);
 941
 942     /*!
 943      * Returns number of nodes for given element
 944      * If there is not element for given ID - returns -1
 945      */
 946     long GetElemNbNodes(in long id);
 947
 948     /*!
 949      * Returns IDs of nodes of given element
 950      */
 951     long_array GetElemNodes(in long id);
 952
 953     /*!
 954      * Returns ID of node by given index for given element
 955      * If there is not element for given ID - returns -1
 956      * If there is not node for given index - returns -2
 957      */
 958     long GetElemNode(in long id, in long index);
 959
 960     /*!
 961      * Returns true if given node is medium node
 962      * in given quadratic element
 963      */
 964     boolean IsMediumNode(in long ide, in long idn);
 965
 966     /*!
 967      * Returns true if given node is medium node
 968      * in one of quadratic elements
 969      */
 970     boolean IsMediumNodeOfAnyElem(in long idn, in ElementType elem_type);
 971
 972     /*!
 973      * Returns number of edges for given element
 974      */
 975     long ElemNbEdges(in long id);
 976
 977     /*!
 978      * Returns number of faces for given element
 979      */
 980     long ElemNbFaces(in long id);
 981
 982     /*!
 983      * Returns nodes of given face (counted from zero) for given volumic element.
 984      */
 985     long_array GetElemFaceNodes(in long elemId, in short faceIndex);
 986
 987     /*!
 988      * Returns three components of normal of given mesh face (or an empty array in KO case)
 989      */
 990     double_array GetFaceNormal(in long faceId, in boolean normalized);
 991
 992     /*!
 993      * Returns an element based on all given nodes.
 994      */
 995     long FindElementByNodes(in long_array nodes);
 996
 997     /*!
 998      * Return elements including all given nodes.
 999      */
1000     long_array GetElementsByNodes(in long_array nodes, in ElementType elem_type);
1001
1002     /*!
1003      * Returns true if given element is polygon
1004      */
1005     boolean IsPoly(in long id);
1006
1007     /*!
1008      * Returns true if given element is quadratic
1009      */
1010     boolean IsQuadratic(in long id);
1011
1012     /*!
1013      * Returns diameter of a ball discrete element or zero in case of an invalid \a id
1014      */
1015     double GetBallDiameter(in long id);
1016
1017     /*!
1018      * Returns XYZ coordinates of bary center for given element
1019      * as list of double
1020      * If there is not element for given ID - returns empty list
1021      */
1022     double_array BaryCenter(in long id);
1023
1024     /*! Gets information about imported MED file */
1025     MedFileInfo GetMEDFileInfo();
1026
1027     /*!
1028      *  Sets list of notebook variables used for Mesh operations separated by ":" symbol
1029      *  \param theParameters is a string containing the notebook variables
1030      */
1031     void SetParameters (in string theParameters);
1032
1033     /*!
1034      *  Returns list of notebook variables used for Mesh operations separated by ":" symbol
1035      */
1036     string GetParameters();
1037
1038     /*!
1039      *  Returns list of notebook variables used for last Mesh operation
1040      */
1041     string_array GetLastParameters();
1042   };
1043
1044   interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
1045   {
1046     /*!
1047      *
1048      */
1049     long GetNumberOfElements()
1050       raises (SALOME::SALOME_Exception);
1051
1052     /*!
1053      *
1054      */
1055     long GetNumberOfNodes( in boolean all )
1056       raises (SALOME::SALOME_Exception);
1057
1058     /*!
1059      *
1060      */
1061     long_array GetElementsId()
1062       raises (SALOME::SALOME_Exception);
1063
1064     /*!
1065      *
1066      */
1067     long_array GetElementsByType( in ElementType theType )
1068       raises (SALOME::SALOME_Exception);
1069
1070     /*!
1071      * Returns type of mesh element (same as SMESH_Mesh::GetElementType() )
1072      */
1073     ElementType GetElementType( in long id, in boolean iselem )
1074       raises (SALOME::SALOME_Exception);
1075
1076     /*!
1077      *
1078      */
1079     long_array GetNodesId()
1080       raises (SALOME::SALOME_Exception);
1081
1082     /*!
1083      * Get geom shape the submesh is dedicated to
1084      */
1085     GEOM::GEOM_Object GetSubShape()
1086       raises (SALOME::SALOME_Exception);
1087
1088     /*!
1089      * Get SMESH_Mesh which stores nodes coordinates & elements definition
1090      */
1091     SMESH_Mesh GetFather()
1092       raises (SALOME::SALOME_Exception);
1093
1094     /*!
1095      * Get the internal Id
1096      */
1097     long GetId();
1098   };
1099
1100 };
1101
1102 #endif