idl/SMESH_Gen.idl

   1 // Copyright (C) 2007-2021  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 //  File   : SMESH_Gen.idl
  23 //  Author : Paul RASCLE, EDF
  24
  25 #ifndef _SMESH_GEN_IDL_
  26 #define _SMESH_GEN_IDL_
  27
  28 #include "SALOME_Exception.idl"
  29 #include "SALOME_Component.idl"
  30 #include "SALOMEDS.idl"
  31
  32 #include "GEOM_Gen.idl"
  33
  34 #include "SMESH_Mesh.idl"
  35 #include "SMESH_Hypothesis.idl"
  36 #include "SMESH_smIdType.idl"
  37
  38 module SMESH
  39 {
  40   typedef sequence<SALOMEDS::SObject> sobject_list;
  41   typedef sequence<GEOM::GEOM_Object> object_array;
  42   typedef sequence<SMESH_Mesh>        mesh_array;
  43
  44   interface FilterManager;
  45   interface SMESH_Pattern;
  46   interface Measurements;
  47   interface MG_ADAPT;
  48   interface MG_ADAPT_OBJECT;
  49
  50   /*!
  51    * Tags definition
  52    */
  53   // Top level
  54   const long Tag_HypothesisRoot = 1; // hypotheses root
  55   const long Tag_AlgorithmsRoot = 2; // algorithms root
  56   const long Tag_FirstMeshRoot  = 3; // first mesh root
  57   // Mesh/Submesh
  58   const long Tag_RefOnShape             = 1; // references to shape
  59   const long Tag_RefOnAppliedHypothesis = 2; // applied hypotheses root
  60   const long Tag_RefOnAppliedAlgorithms = 3; // applied algorithms root
  61   // Mesh only: sub-meshes roots by type
  62   const long Tag_FirstSubMesh           =  4;
  63   const long Tag_SubMeshOnVertex        =  4;
  64   const long Tag_SubMeshOnEdge          =  5;
  65   const long Tag_SubMeshOnWire          =  6;
  66   const long Tag_SubMeshOnFace          =  7;
  67   const long Tag_SubMeshOnShell         =  8;
  68   const long Tag_SubMeshOnSolid         =  9;
  69   const long Tag_SubMeshOnCompound      = 10;
  70   const long Tag_LastSubMesh            = 10;
  71   // Mesh only: group roots by type
  72   const long Tag_FirstGroup             = 11;
  73   const long Tag_NodeGroups             = 11;
  74   const long Tag_EdgeGroups             = 12;
  75   const long Tag_FaceGroups             = 13;
  76   const long Tag_VolumeGroups           = 14;
  77   const long Tag_0DElementsGroups       = 15;
  78   const long Tag_BallElementsGroups     = 16;
  79   const long Tag_LastGroup              = 16;
  80
  81   /*!
  82    * Hypothesis definition error
  83    */
  84   struct AlgoStateError
  85   {
  86     Hypothesis_Status  state;
  87     string             algoName;
  88     long               algoDim;
  89     boolean            isGlobalAlgo;
  90   };
  91   typedef sequence<AlgoStateError> algo_error_array;
  92
  93   /*!
  94    * Mesh computation error
  95    */
  96   enum ComputeErrorName
  97   {
  98     COMPERR_OK            ,
  99     COMPERR_BAD_INPUT_MESH,  // wrong mesh on lower submesh
 100     COMPERR_STD_EXCEPTION ,  // some std exception raised
 101     COMPERR_OCC_EXCEPTION ,  // OCC exception raised
 102     COMPERR_SLM_EXCEPTION ,  // SALOME exception raised
 103     COMPERR_EXCEPTION     ,  // other exception raised
 104     COMPERR_MEMORY_PB     ,  // memory allocation problem
 105     COMPERR_ALGO_FAILED   ,  // computation failed
 106     COMPERR_BAD_SHAPE     ,  // bad geometry
 107     COMPERR_WARNING       ,  // algo reports error but sub-mesh is computed anyway
 108     COMPERR_CANCELED      ,  // compute canceled
 109     COMPERR_NO_MESH_ON_SHAPE,// no mesh elements assigned to sub-mesh
 110     COMPERR_BAD_PARMETERS    // incorrect hypotheses parameters
 111   };
 112   struct ComputeError
 113   {
 114     short   code;       // ComputeErrorName or, if negative, algo specific code
 115     string  comment;    // textual problem description
 116     string  algoName;
 117     long    subShapeID; // id of sub-shape of a shape to mesh
 118     boolean hasBadMesh; // there are elements preventing computation available for visualization
 119   };
 120   typedef sequence<ComputeError> compute_error_array;
 121
 122   /*!
 123    * Way to initialize hypothesis
 124    */
 125   struct HypInitParams
 126   {
 127     short   way; // 0 - by mesh, 1 - by geometry size + preferred parameters, 2 - by averageLength
 128     double  averageLength;
 129     boolean quadDominated;
 130   };
 131
 132   interface SMESH_Gen : Engines::EngineComponent, SALOMEDS::Driver
 133   {
 134     //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
 135     void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
 136
 137     FilterManager CreateFilterManager();
 138
 139     SMESH_Pattern GetPattern();
 140
 141     Measurements  CreateMeasurements();
 142
 143     /*!
 144       Set the current mode
 145      */
 146     void SetEmbeddedMode( in boolean theMode );
 147
 148     /*!
 149       Get the current mode
 150      */
 151     boolean IsEmbeddedMode();
 152
 153     /*!
 154       Update the study
 155      */
 156     void UpdateStudy();
 157
 158     /*!
 159       Set enable publishing in the study
 160      */
 161     void SetEnablePublish( in boolean theIsEnablePublish );
 162
 163     /*!
 164       Get enable publishing in the study
 165      */
 166     boolean IsEnablePublish();
 167
 168     /*!
 169      * Create a hypothesis that can be shared by different parts of the mesh.
 170      * An hypothesis is either:
 171      * - a method used to generate or modify a part of the mesh (algorithm).
 172      * - a parameter or a law used by an algorithm.
 173      * Algorithms are 1D, 2D or 3D.
 174      */
 175     SMESH_Hypothesis CreateHypothesis( in string theHypName,
 176                                        in string theLibName )
 177       raises ( SALOME::SALOME_Exception );
 178
 179     /*!
 180      * Create a hypothesis and initialize it by average length
 181      */
 182     SMESH_Hypothesis CreateHypothesisByAverageLength( in string  theHypName,
 183                                                       in string  theLibName,
 184                                                       in double  theAverageLength,
 185                                                       in boolean theQuadDominated)
 186       raises ( SALOME::SALOME_Exception );
 187
 188     /*!
 189      * Return a hypothesis holding parameter values corresponding either to the mesh
 190      * existing on the given geometry or to size of the geometry.
 191      * The returned hypothesis may be the one existing in a study and used
 192      * to compute the mesh, or a temporary one created just to pass parameter
 193      * values.
 194      */
 195     SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
 196                                                    in string            theLibName,
 197                                                    in SMESH_Mesh        theMesh,
 198                                                    in GEOM::GEOM_Object theGeom,
 199                                                    in HypInitParams     theWay)
 200       raises ( SALOME::SALOME_Exception );
 201
 202     /*!
 203      * Returns \c True if a hypothesis is assigned to a sole sub-mesh in a current Study
 204      *  \param [in] theHyp - the hypothesis of interest
 205      *  \param [out] theMesh - the sole mesh using \a theHyp
 206      *  \param [out] theShape - the sole geometry \a theHyp is assigned to
 207      *  \return boolean - \c True if \a theMesh and \a theShape are sole using \a theHyp
 208      */
 209     boolean GetSoleSubMeshUsingHyp( in SMESH_Hypothesis   theHyp,
 210                                     out SMESH_Mesh        theMesh,
 211                                     out GEOM::GEOM_Object theShape);
 212
 213     /*!
 214      * Sets number of segments per diagonal of boundary box of geometry by which
 215      * default segment length of appropriate 1D hypotheses is defined
 216      */
 217     void SetBoundaryBoxSegmentation( in long theNbSegments ) raises ( SALOME::SALOME_Exception );
 218     /*!
 219      * \brief Sets default number of segments per edge
 220      */
 221     void SetDefaultNbSegments( in long theNbSegments) raises ( SALOME::SALOME_Exception );
 222
 223     /*!
 224      * Set the object name
 225      */
 226     void SetName( in string theObjectIOR,
 227                   in string theObjectName )
 228       raises ( SALOME::SALOME_Exception );
 229
 230     /*!
 231      * Create a Mesh object, given a geometry shape.
 232      * Mesh is created empty (no points, no elements).
 233      * Shape is explored via GEOM_Client to create local copies.
 234      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
 235      * with TopoDS_Shapes
 236      */
 237     SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
 238       raises ( SALOME::SALOME_Exception );
 239
 240     /*!
 241      * Create an empty mesh object
 242      */
 243     SMESH_Mesh CreateEmptyMesh()
 244       raises ( SALOME::SALOME_Exception );
 245
 246     /*!
 247      * Create Mesh object importing data from given UNV file
 248      * (UNV supported version is I-DEAS 10)
 249      */
 250     SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
 251       raises ( SALOME::SALOME_Exception );
 252
 253     /*!
 254      * Create Mesh object(s) importing data from given MED file
 255      */
 256     mesh_array CreateMeshesFromMED( in string theFileName,
 257                                     out SMESH::DriverMED_ReadStatus theStatus )
 258       raises ( SALOME::SALOME_Exception );
 259
 260     /*!
 261      * Create Mesh object importing data from given STL file
 262      */
 263     SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
 264       raises ( SALOME::SALOME_Exception );
 265
 266     /*!
 267      * Create Mesh object(s) importing data from given CGNS file
 268      */
 269     mesh_array CreateMeshesFromCGNS( in string theFileName,
 270                                      out SMESH::DriverMED_ReadStatus theStatus )
 271       raises ( SALOME::SALOME_Exception );
 272
 273     /*!
 274      * Create Mesh object importing data from given GMF file
 275      *  \param theFileName - a name of file to import
 276      *  \param theMakeRequiredGroups - if true, groups of required entities will be created
 277      */
 278     SMESH_Mesh CreateMeshesFromGMF( in string               theFileName,
 279                                     in boolean              theMakeRequiredGroups,
 280                                     out SMESH::ComputeError theError)
 281       raises ( SALOME::SALOME_Exception );
 282
 283     /*!
 284      * Create a mesh by copying a part of another mesh
 285      *  \param meshPart - a part of mesh to copy
 286      *  \param meshName - a name of the new mesh
 287      *  \param toCopyGroups - to create in the new mesh groups
 288      *                        the copied elements belongs to
 289      *  \param toKeepIDs - to preserve IDs of the copied elements or not
 290      */
 291     SMESH_Mesh CopyMesh(in SMESH_IDSource meshPart,
 292                         in string         meshName,
 293                         in boolean        toCopyGroups,
 294                         in boolean        toKeepIDs)
 295       raises ( SALOME::SALOME_Exception );
 296
 297     /*!
 298      * Create a mesh by copying definitions of another mesh to a given geometry
 299      *  \param sourceMesh - a mesh to copy
 300      *  \param newGeometry - a new geometry
 301      *  \param meshName - a name of the new mesh
 302      *  \param toCopyGroups - to create groups in the new mesh
 303      *  \param toReuseHypotheses - if True, existing hypothesis will be used by the new mesh,
 304      *         otherwise new hypotheses with the same parameters will be created for the new mesh.
 305      *  \param toCopyElements - to copy mesh elements of same sub-shapes of the two geometries
 306      *  \param newMesh - return a new mesh
 307      *  \param newGroups - return new groups
 308      *  \param newSubmeshes - return new sub-meshes
 309      *  \param newHypotheses - return new algorithms and hypotheses
 310      *  \param invalidEntries - return study entries of objects whose
 311      *         counterparts are not found in the newGeometry, followed by entries
 312      *         of mesh sub-objects that are invalid because they depend on a not found
 313      *         preceding sub-shape
 314      */
 315     boolean CopyMeshWithGeom( in SMESH_Mesh        sourceMesh,
 316                               in GEOM::GEOM_Object newGeometry,
 317                               in string            meshName,
 318                               in boolean           toCopyGroups,
 319                               in boolean           toReuseHypotheses,
 320                               in boolean           toCopyElements,
 321                               out SMESH_Mesh       newMesh,
 322                               out ListOfGroups     newGroups,
 323                               out submesh_array    newSubmeshes,
 324                               out ListOfHypothesis newHypotheses,
 325                               out string_array     invalidEntries)
 326       raises ( SALOME::SALOME_Exception );
 327
 328     /*!
 329      * Concatenate the given meshes or groups into one mesh,
 330      * optionally to theMeshToAppendTo.
 331      * Union groups with the same name and type if
 332      * theUniteIdenticalGroups flag is true.
 333      * Merge coincident nodes and elements if
 334      * theMergeNodesAndElements flag is true.
 335      */
 336     SMESH_Mesh Concatenate(in ListOfIDSources theMeshesArray,
 337                            in boolean         theUniteIdenticalGroups,
 338                            in boolean         theMergeNodesAndElements,
 339                            in double          theMergeTolerance,
 340                            in SMESH_Mesh      theMeshToAppendTo)
 341       raises ( SALOME::SALOME_Exception );
 342
 343     /*!
 344      * Concatenate the given meshes into one mesh,
 345      * optionally to theMeshToAppendTo.
 346      * Union groups with the same name and type if
 347      * theUniteIdenticalGroups flag is true.
 348      * Merge coincident nodes and elements if
 349      * theMergeNodesAndElements flag is true.
 350      * Create the groups of all elements from initial meshes.
 351      */
 352     SMESH_Mesh ConcatenateWithGroups(in ListOfIDSources theMeshesArray,
 353                                      in boolean         theUniteIdenticalGroups,
 354                                      in boolean         theMergeNodesAndElements,
 355                                      in double          theMergeTolerance,
 356                                      in SMESH_Mesh      theMeshToAppendTo)
 357       raises ( SALOME::SALOME_Exception );
 358
 359     /*!
 360      * Mesh a subShape.
 361      * First, verify list of hypothesis associated with the Sub-shape,
 362      * return NOK if hypothesis are not sufficient
 363      */
 364     boolean Compute( in SMESH_Mesh        theMesh,
 365                      in GEOM::GEOM_Object theSubObject )
 366       raises ( SALOME::SALOME_Exception );
 367
 368     /*!
 369      * Cancel a computation.
 370      */
 371     void CancelCompute( in SMESH_Mesh        theMesh,
 372                         in GEOM::GEOM_Object theSubObject );
 373
 374     /*!
 375      * Return true if hypotheses are defined well
 376      */
 377     boolean IsReadyToCompute( in SMESH_Mesh        theMesh,
 378                               in GEOM::GEOM_Object theSubObject )
 379       raises ( SALOME::SALOME_Exception );
 380
 381     /*!
 382      * Evaluates size of prospective mesh on a shape
 383      */
 384     smIdType_array  Evaluate(in SMESH_Mesh        theMesh,
 385                              in GEOM::GEOM_Object theSubObject)
 386       raises ( SALOME::SALOME_Exception );
 387
 388     /*!
 389      * Calculate Mesh as preview till indicated dimension
 390      * First, verify list of hypothesis associated with the Sub-shape.
 391      * Return mesh preview structure
 392      */
 393     MeshPreviewStruct Precompute( in SMESH_Mesh        theMesh,
 394                                   in GEOM::GEOM_Object theSubObject,
 395                                   in Dimension         theDimension,
 396                                   inout long_array    theShapesId )
 397       raises ( SALOME::SALOME_Exception );
 398
 399     /*!
 400      * Return errors of hypotheses definition
 401      * algo_error_array is empty if everything is OK
 402      */
 403     algo_error_array GetAlgoState( in SMESH_Mesh        theMesh,
 404                                    in GEOM::GEOM_Object theSubObject )
 405       raises ( SALOME::SALOME_Exception );
 406
 407     /*!
 408      * Return errors of mesh computation
 409      * compute_error_array is empty if everything is OK
 410      */
 411     compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh,
 412                                           in GEOM::GEOM_Object theSubObject )
 413       raises ( SALOME::SALOME_Exception );
 414
 415     /*!
 416      * Return mesh elements preventing computation of a sub-shape
 417      */
 418     MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
 419                                            in short      theSubShapeID )
 420       raises ( SALOME::SALOME_Exception );
 421
 422     /*!
 423      * Create groups of elements preventing computation of a sub-shape
 424      */
 425     SMESH::ListOfGroups MakeGroupsOfBadInputElements( in SMESH_Mesh theMesh,
 426                                                       in short      theSubShapeID,
 427                                                       in string     theGroupName)
 428       raises ( SALOME::SALOME_Exception );
 429
 430     /*!
 431      * Return indices of faces, edges and vertices of given sub-shapes
 432      * within theMainObject
 433      */
 434     long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
 435                                in object_array      theListOfSubObjects )
 436        raises ( SALOME::SALOME_Exception );
 437
 438     /*!
 439      * Return geometrical object the given element is built on.
 440      * The returned geometrical object, if not nil, is either found in the
 441      * study or is published by this method with the given name
 442      */
 443     GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh theMesh,
 444                                                 in smIdType   theElementID,
 445                                                 in string     theGeomName)
 446       raises ( SALOME::SALOME_Exception );
 447
 448     /*!
 449      * Return geometrical object the given element is built on.
 450      * The returned geometrical object not published in study by this method.
 451      */
 452     GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh theMesh,
 453                                                  in smIdType   theElementID)
 454       raises ( SALOME::SALOME_Exception );
 455
 456     /*!
 457      * \brief Return id of object, registered in current study context
 458      *
 459      * Can be used to check if the object was created in the same container, as this engine.
 460      */
 461     long GetObjectId(in Object theObject);
 462
 463     /*!
 464      * \brief Get version of MED format being used.
 465      */
 466     string GetMEDFileVersion();
 467
 468     /*!
 469      * \brief Get MED version of the file by its name.
 470      */
 471     string GetMEDVersion(in string theFileName);
 472
 473     /*!
 474      * \brief Check compatibility of file with MED format being used, for read only.
 475      */
 476     boolean CheckCompatibility(in string theFileName);
 477
 478     /*!
 479      * \brief Check compatibility of file with MED format being used, for append on write.
 480      */
 481     boolean CheckWriteCompatibility(in string theFileName);
 482
 483     /*!
 484      * \brief Get names of meshes defined in file with the specified name.
 485      */
 486     string_array GetMeshNames(in string theFileName);
 487
 488     /*!
 489      * \brief Moves objects to the specified position
 490      *  \param what objects being moved
 491      *  \param where parent object where objects are moved to
 492      *  \param row position in the parent object's children list at which objects are moved
 493      *
 494      * This function is used in the drag-n-drop functionality.
 495      */
 496     void Move( in sobject_list what,
 497                in SALOMEDS::SObject where,
 498                in long row );
 499     /*!
 500      * Returns true if algorithm can be used to mesh a given geometry
 501      *  \param theAlgoType - the algorithm type
 502      *  \param theLibName - a name of the Plug-in library implementing the algorithm
 503      *  \param theShapeObject - the geometry to mesh
 504      *  \param toCheckAll - if \c True, returns \c True if all shapes are meshable,
 505      *         else, returns \c True if at least one shape is meshable
 506      */
 507     boolean IsApplicable( in string             theAlgoType,
 508                           in string             theLibName,
 509                           in GEOM::GEOM_Object  theShapeObject,
 510                           in boolean            toCheckAll );
 511
 512
 513     /*!
 514      * Return indices of elements, which are located inside the sphere
 515      *  \param theSource - mesh, sub-mesh or group
 516      *  \param theElemType - mesh element type
 517      *  \param theX - x coordinate of the center of the sphere
 518      *  \param theY - y coordinate of the center of the sphere
 519      *  \param theZ - y coordinate of the center of the sphere
 520      *  \param theR - radius of the sphere
 521      */
 522     long_array GetInsideSphere( in SMESH_IDSource theSource,
 523                                 in ElementType    theElemType,
 524                                 in double theX,
 525                                 in double theY,
 526                                 in double theZ,
 527                                 in double theR );
 528
 529     /*!
 530      * Return indices of elements, which are located inside the box
 531      *  \param theSource - mesh, sub-mesh or group
 532      *  \param theElemType - mesh element type
 533      *  \param theX1 - x coordinate of the first opposite point
 534      *  \param theY1 - y coordinate of the first opposite point
 535      *  \param theZ1 - y coordinate of the first opposite point
 536      *  \param theX2 - x coordinate of the second opposite point
 537      *  \param theY2 - y coordinate of the second opposite point
 538      *  \param theZ2 - y coordinate of the second opposite point
 539      */
 540     long_array GetInsideBox( in SMESH_IDSource theSource,
 541                              in ElementType    theElemType,
 542                              in double theX1,
 543                              in double theY1,
 544                              in double theZ1,
 545                              in double theX2,
 546                              in double theY2,
 547                              in double theZ2);
 548     /*!
 549      * Return indices of elements, which are located inside the box
 550      *  \param theSource - mesh, sub-mesh or group
 551      *  \param theElemType - mesh element type
 552      *  \param theX - x coordinate of the cented of the bottom face
 553      *  \param theY - y coordinate of the cented of the bottom face
 554      *  \param theZ - y coordinate of the cented of the bottom face
 555      *  \param theDX - x coordinate of the cented of the base vector
 556      *  \param theDY - y coordinate of the cented of the base vector
 557      *  \param theDZ - z coordinate of the cented of the base vector
 558      *  \param theH - height of the cylinder
 559      *  \param theR - radius of the cylinder
 560      */
 561     long_array GetInsideCylinder( in SMESH_IDSource theSource,
 562                                   in ElementType    theElemType,
 563                                   in double theX,
 564                                   in double theY,
 565                                   in double theZ,
 566                                   in double theDX,
 567                                   in double theDY,
 568                                   in double theDZ,
 569                                   in double theH,
 570                                   in double theR );
 571     /*!
 572      * Return indices of elements, which are located inside the geometry
 573      *  \param theSource - mesh, sub-mesh or group
 574      *  \param theElemType - mesh element type
 575      *  \param theGeom - geometrical object
 576      *  \param theTolerance - tolerance for selection.
 577      */
 578     long_array GetInside( in SMESH_IDSource theSource,
 579                           in ElementType    theElemType,
 580                           in GEOM::GEOM_Object theGeom,
 581                           in double theTolerance );
 582
 583     MG_ADAPT CreateMG_ADAPT();
 584     MG_ADAPT_OBJECT Adaptation(in string adaptType);
 585     MG_ADAPT CreateAdaptationHypothesis();
 586   };
 587
 588 };
 589
 590 #endif