idl/SMESH_Gen.idl

   1 // Copyright (C) 2007-2012  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 //  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
  37 module SMESH
  38 {
  39   typedef sequence<GEOM::GEOM_Object> object_array;
  40   typedef sequence<SMESH_Mesh>        mesh_array;
  41
  42   interface FilterManager;
  43   interface SMESH_Pattern;
  44   interface Measurements;
  45
  46   /*!
  47    * Tags definition
  48    */
  49   // Top level
  50   const long Tag_HypothesisRoot = 1; // hypotheses root
  51   const long Tag_AlgorithmsRoot = 2; // algorithms root
  52   const long Tag_FirstMeshRoot  = 3; // first mesh root
  53   // Mesh/Submesh
  54   const long Tag_RefOnShape             = 1; // references to shape
  55   const long Tag_RefOnAppliedHypothesis = 2; // applied hypotheses root
  56   const long Tag_RefOnAppliedAlgorithms = 3; // applied algorithms root
  57   // Mesh only: sub-meshes roots by type
  58   const long Tag_FirstSubMesh           =  4;
  59   const long Tag_SubMeshOnVertex        =  4;
  60   const long Tag_SubMeshOnEdge          =  5;
  61   const long Tag_SubMeshOnWire          =  6;
  62   const long Tag_SubMeshOnFace          =  7;
  63   const long Tag_SubMeshOnShell         =  8;
  64   const long Tag_SubMeshOnSolid         =  9;
  65   const long Tag_SubMeshOnCompound      = 10;
  66   const long Tag_LastSubMesh            = 10;
  67   // Mesh only: group roots by type
  68   const long Tag_FirstGroup             = 11;
  69   const long Tag_NodeGroups             = 11;
  70   const long Tag_EdgeGroups             = 12;
  71   const long Tag_FaceGroups             = 13;
  72   const long Tag_VolumeGroups           = 14;
  73   const long Tag_0DElementsGroups       = 15;
  74   const long Tag_BallElementsGroups     = 16;
  75   const long Tag_LastGroup              = 16;
  76
  77   /*!
  78    * Hypothesis definintion error
  79    */
  80   struct AlgoStateError
  81   {
  82     Hypothesis_Status  state;
  83     string             algoName;
  84     long               algoDim;
  85     boolean            isGlobalAlgo;
  86   };
  87   typedef sequence<AlgoStateError> algo_error_array;
  88
  89   /*!
  90    * Mesh computation error
  91    */
  92   enum ComputeErrorName
  93   {
  94     COMPERR_OK            ,
  95     COMPERR_BAD_INPUT_MESH,  // wrong mesh on lower submesh
  96     COMPERR_STD_EXCEPTION ,  // some std exception raised
  97     COMPERR_OCC_EXCEPTION ,  // OCC exception raised
  98     COMPERR_SLM_EXCEPTION ,  // SALOME exception raised
  99     COMPERR_EXCEPTION     ,  // other exception raised
 100     COMPERR_MEMORY_PB     ,  // memory allocation problem
 101     COMPERR_ALGO_FAILED   ,  // computation failed
 102     COMPERR_BAD_SHAPE     ,  // bad geometry
 103     COMPERR_WARNING          // algo reports error but sub-mesh is computed anyway
 104   };
 105   struct ComputeError
 106   {
 107     short   code;       // ComputeErrorName or, if negative, algo specific code
 108     string  comment;    // textual problem description
 109     string  algoName;
 110     short   subShapeID; // id of sub-shape of a shape to mesh
 111     boolean hasBadMesh; // there are elements preventing computation available for visualization
 112   };
 113   typedef sequence<ComputeError> compute_error_array;
 114
 115
 116   interface SMESH_Gen : Engines::EngineComponent, SALOMEDS::Driver
 117   {
 118     //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
 119     void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
 120
 121     FilterManager CreateFilterManager();
 122
 123     SMESH_Pattern GetPattern();
 124
 125     Measurements  CreateMeasurements();
 126
 127     /*!
 128       Set the current mode
 129      */
 130     void SetEmbeddedMode( in boolean theMode );
 131
 132     /*!
 133       Get the current mode
 134      */
 135     boolean IsEmbeddedMode();
 136
 137     /*!
 138       Set the current study
 139      */
 140     void SetCurrentStudy( in SALOMEDS::Study theStudy );
 141
 142     /*!
 143       Get the current study
 144      */
 145     SALOMEDS::Study GetCurrentStudy();
 146
 147     /*!
 148      * Create a hypothesis that can be shared by differents parts of the mesh.
 149      * An hypothesis is either:
 150      * - a method used to generate or modify a part of the mesh (algorithm).
 151      * - a parameter or a law used by an algorithm.
 152      * Algorithms are 1D, 2D or 3D.
 153      */
 154     SMESH_Hypothesis CreateHypothesis( in string theHypName,
 155                                        in string theLibName )
 156       raises ( SALOME::SALOME_Exception );
 157
 158     /*!
 159      * Return a hypothesis holding parameter values corresponding either to the mesh
 160      * existing on the given geometry or to size of the geometry.
 161      * The returned hypothesis may be the one existing in a study and used
 162      * to compute the mesh, or a temporary one created just to pass parameter
 163      * values.
 164      */
 165     SMESH_Hypothesis GetHypothesisParameterValues( in string            theHypName,
 166                                                    in string            theLibName,
 167                                                    in SMESH_Mesh        theMesh,
 168                                                    in GEOM::GEOM_Object theGeom,
 169                                                    in boolean           byMesh)
 170       raises ( SALOME::SALOME_Exception );
 171
 172     /*!
 173      * Sets number of segments per diagonal of boundary box of geometry by which
 174      * default segment length of appropriate 1D hypotheses is defined
 175      */
 176     void SetBoundaryBoxSegmentation( in long theNbSegments ) raises ( SALOME::SALOME_Exception );
 177     /*!
 178      * \brief Sets default number of segments per edge
 179      */
 180     void SetDefaultNbSegments( in long theNbSegments) raises ( SALOME::SALOME_Exception );
 181
 182     /*!
 183      * Set the object name
 184      */
 185     void SetName( in string theObjectIOR,
 186                   in string theObjectName )
 187       raises ( SALOME::SALOME_Exception );
 188
 189     /*!
 190      * Create a Mesh object, given a geometry shape.
 191      * Mesh is created empty (no points, no elements).
 192      * Shape is explored via GEOM_Client to create local copies.
 193      * of TopoDS_Shapes and bind CORBA references of shape & subshapes
 194      * with TopoDS_Shapes
 195      */
 196     SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
 197       raises ( SALOME::SALOME_Exception );
 198
 199     /*!
 200      * Create an empty mesh object
 201      */
 202     SMESH_Mesh CreateEmptyMesh()
 203       raises ( SALOME::SALOME_Exception );
 204
 205     /*!
 206      * Create Mesh object importing data from given UNV file
 207      * (UNV supported version is I-DEAS 10)
 208      */
 209     SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
 210       raises ( SALOME::SALOME_Exception );
 211
 212     /*!
 213      * Create Mesh object(s) importing data from given MED file
 214      */
 215      mesh_array CreateMeshesFromMED( in string theFileName,
 216                                      out SMESH::DriverMED_ReadStatus theStatus )
 217        raises ( SALOME::SALOME_Exception );
 218
 219     /*!
 220      * Create Mesh object(s) importing data from given MED file
 221      */
 222      mesh_array CreateMeshesFromSAUV( in string theFileName,
 223                                       out SMESH::DriverMED_ReadStatus theStatus )
 224        raises ( SALOME::SALOME_Exception );
 225
 226     /*!
 227      * Create Mesh object importing data from given STL file
 228      */
 229     SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
 230       raises ( SALOME::SALOME_Exception );
 231
 232     /*!
 233      * Create Mesh object(s) importing data from given CGNS file
 234      */
 235     mesh_array CreateMeshesFromCGNS( in string theFileName,
 236                                      out SMESH::DriverMED_ReadStatus theStatus )
 237       raises ( SALOME::SALOME_Exception );
 238
 239     /*!
 240      * Create a mesh by copying a part of another mesh
 241      *  \param meshPart - a part of mesh to copy
 242      *  \param meshName - a name of the new mesh
 243      *  \param toCopyGroups - to create in the new mesh groups
 244      *                        the copied elements belongs to
 245      *  \param toKeepIDs - to preserve IDs of the copied elements or not
 246      */
 247     SMESH_Mesh CopyMesh(in SMESH_IDSource meshPart,
 248                         in string         meshName,
 249                         in boolean        toCopyGroups,
 250                         in boolean        toKeepIDs)
 251       raises ( SALOME::SALOME_Exception );
 252
 253     /*!
 254      * Concatenate the given meshes into one mesh.
 255      * Union groups with the same name and type if
 256      * theUniteIdenticalGroups flag is true.
 257      * Merge coincident nodes and elements if
 258      * theMergeNodesAndElements flag is true.
 259      */
 260     SMESH_Mesh Concatenate(in mesh_array theMeshesArray,
 261                            in boolean    theUniteIdenticalGroups,
 262                            in boolean    theMergeNodesAndElements,
 263                            in double     theMergeTolerance)
 264       raises ( SALOME::SALOME_Exception );
 265
 266     /*!
 267      * Concatenate the given meshes into one mesh.
 268      * Union groups with the same name and type if
 269      * theUniteIdenticalGroups flag is true.
 270      * Merge coincident nodes and elements if
 271      * theMergeNodesAndElements flag is true.
 272      * Create the groups of all elements from initial meshes.
 273      */
 274     SMESH_Mesh ConcatenateWithGroups(in mesh_array theMeshesArray,
 275                                      in boolean    theUniteIdenticalGroups,
 276                                      in boolean    theMergeNodesAndElements,
 277                                      in double     theMergeTolerance)
 278       raises ( SALOME::SALOME_Exception );
 279
 280     /*!
 281      * Mesh a subShape.
 282      * First, verify list of hypothesis associated with the Sub-shape,
 283      * return NOK if hypothesis are not sufficient
 284      */
 285     boolean Compute( in SMESH_Mesh        theMesh,
 286                      in GEOM::GEOM_Object theSubObject )
 287       raises ( SALOME::SALOME_Exception );
 288
 289     /*!
 290      * Cancel a computation.
 291      */
 292     void CancelCompute( in SMESH_Mesh        theMesh,
 293                         in GEOM::GEOM_Object theSubObject );
 294
 295     /*!
 296      * Return true if hypotheses are defined well
 297      */
 298     boolean IsReadyToCompute( in SMESH_Mesh        theMesh,
 299                               in GEOM::GEOM_Object theSubObject )
 300       raises ( SALOME::SALOME_Exception );
 301
 302     /*!
 303      * Evaluates size of prospective mesh on a shape
 304      */
 305     long_array  Evaluate(in SMESH_Mesh        theMesh,
 306                          in GEOM::GEOM_Object theSubObject)
 307       raises ( SALOME::SALOME_Exception );
 308
 309     /*!
 310      * Calculate Mesh as preview till indicated dimension
 311      * First, verify list of hypothesis associated with the Sub-shape.
 312      * Return mesh preview structure
 313      */
 314     MeshPreviewStruct Precompute( in SMESH_Mesh        theMesh,
 315                                   in GEOM::GEOM_Object theSubObject,
 316                                   in Dimension         theDimension,
 317                                   inout long_array    theShapesId )
 318       raises ( SALOME::SALOME_Exception );
 319
 320     /*!
 321      * Return errors of hypotheses definintion
 322      * algo_error_array is empty if everything is OK
 323      */
 324     algo_error_array GetAlgoState( in SMESH_Mesh        theMesh,
 325                                    in GEOM::GEOM_Object theSubObject )
 326       raises ( SALOME::SALOME_Exception );
 327
 328     /*!
 329      * Return errors of mesh computation
 330      * compute_error_array is empty if everything is OK
 331      */
 332     compute_error_array GetComputeErrors( in SMESH_Mesh        theMesh,
 333                                           in GEOM::GEOM_Object theSubObject )
 334       raises ( SALOME::SALOME_Exception );
 335
 336     /*!
 337      * Return mesh elements preventing computation of a sub-shape
 338      */
 339     MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
 340                                            in short      theSubShapeID )
 341       raises ( SALOME::SALOME_Exception );
 342
 343     /*!
 344      * Return indeces of faces, edges and vertices of given sub-shapes
 345      * within theMainObject
 346      */
 347     long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
 348                                in object_array      theListOfSubObjects )
 349        raises ( SALOME::SALOME_Exception );
 350
 351     /*!
 352      * Return geometrical object the given element is built on.
 353      * The returned geometrical object, if not nil, is either found in the
 354      * study or is published by this method with the given name
 355      */
 356     GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh  theMesh,
 357                                                 in long        theElementID,
 358                                                 in string      theGeomName)
 359       raises ( SALOME::SALOME_Exception );
 360
 361     /*!
 362      * Return geometrical object the given element is built on.
 363      * The returned geometrical object not published in study by this method.
 364      */
 365     GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh  theMesh,
 366                                                  in long        theElementID)
 367       raises ( SALOME::SALOME_Exception );
 368
 369     /*!
 370      * \brief Return id of object, registered in current study context
 371      *
 372      * Can be used to check if the object was created in the same container, as this engine.
 373      */
 374     long GetObjectId(in Object theObject);
 375
 376     /*!
 377      * \brief Get MED version of the file by its name.
 378      */
 379     boolean GetMEDVersion(in string theFileName, out MED_VERSION theVersion);
 380
 381     /*!
 382      * \brief Get names of meshes defined in file with the specified name.
 383      */
 384     string_array GetMeshNames(in string theFileName);
 385   };
 386
 387 };
 388
 389 #endif