idl/SMESH_BasicHypothesis.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
  23 //  File   : SMESH_BasicHypothesis.idl
  24 //  Author : Paul RASCLE, EDF
  25 //
  26 #ifndef _SMESH_BASICHYPOTHESIS_IDL_
  27 #define _SMESH_BASICHYPOTHESIS_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SMESH_Hypothesis.idl"
  31 #include "SMESH_Mesh.idl"
  32
  33 /*!
  34  * StdMeshers: interfaces to standard hypotheses and algorithms
  35  */
  36 module StdMeshers
  37 {
  38   /*!
  39    * StdMeshers_LocalLength: interface of "Average length" hypothesis
  40    */
  41   interface StdMeshers_LocalLength : SMESH::SMESH_Hypothesis
  42   {
  43     /*!
  44      * Sets <length> parameter value
  45      */
  46     void SetLength(in double length)
  47       raises (SALOME::SALOME_Exception);
  48
  49     /*!
  50      * Sets <precision> parameter value
  51      *
  52      * Precision parameter is used to allow rounding a number of segments,
  53      * calculated from the edge length and average length of segment,
  54      * to the lower integer, if this value outstands from it in bounds of the precision.
  55      * Otherwise, the number of segments is rounded to the higher integer.
  56      * Use value 0.5 to provide rounding to the nearest integer,
  57      * 1.0 for the lower integer, 0.0 for the higher integer.
  58      * Default value is 1e-07. In old studies, restored from file,
  59      * this value will be set to zero, what corresponds to the old behaviour.
  60      */
  61     void SetPrecision(in double precision)
  62       raises (SALOME::SALOME_Exception);
  63
  64     /*!
  65      * Returns <length> parameter value
  66      */
  67     double GetLength();
  68
  69     /*!
  70      * Returns <precision> parameter value
  71      */
  72     double GetPrecision();
  73   };
  74
  75   /*!
  76    * StdMeshers_MaxLength: interface of "Max length" hypothesis
  77    */
  78   interface StdMeshers_MaxLength : SMESH::SMESH_Hypothesis
  79   {
  80     /*!
  81      * Sets <length> parameter value
  82      */
  83     void SetLength(in double length)
  84       raises (SALOME::SALOME_Exception);
  85     /*!
  86      * Returns <length> parameter value
  87      */
  88     double GetLength();
  89     /*!
  90      * Returns true if preestemated length is defined
  91      */
  92     boolean HavePreestimatedLength();
  93     /*!
  94      * Returns preestemated length
  95      */
  96     double GetPreestimatedLength();
  97     /*!
  98      * Sets preestemated length
  99      */
 100     void SetPreestimatedLength(in double length);
 101     /*!
 102      * Sets boolean parameter enabling/desabling usage of length computed
 103      * basing on size of bounding box of shape to mesh
 104      */
 105     void SetUsePreestimatedLength(in boolean toUse);
 106     /*!
 107      * Returns value of boolean parameter enabling/desabling usage of length computed
 108      * basing on size of bounding box of shape to mesh
 109      */
 110     boolean GetUsePreestimatedLength();
 111   };
 112
 113   /*!
 114    * StdMeshers_AutomaticLength: interface of "Automatic length" hypothesis
 115    */
 116   interface StdMeshers_AutomaticLength : SMESH::SMESH_Hypothesis
 117   {
 118     /*!
 119      * Sets Fineness parameter value
 120      */
 121     void SetFineness(in double theFineness)
 122       raises (SALOME::SALOME_Exception);
 123
 124     /*!
 125      * Returns <Fineness> parameter value
 126      */
 127     double GetFineness();
 128   };
 129
 130   /*!
 131    * StdMeshers_NumberOfSegments: interface of "Nb. Segments" hypothesis
 132    */
 133   interface StdMeshers_NumberOfSegments : SMESH::SMESH_Hypothesis
 134   {
 135     /*!
 136      * Builds and returns point distribution according to passed density function
 137      */
 138     SMESH::double_array BuildDistributionExpr( in string func, in long nbSeg, in long conv )
 139       raises (SALOME::SALOME_Exception);
 140     SMESH::double_array BuildDistributionTab( in SMESH::double_array func, in long nbSeg, in long conv )
 141       raises (SALOME::SALOME_Exception);
 142
 143     /*!
 144      * Sets <number of segments> parameter value
 145      */
 146     void SetNumberOfSegments(in long segmentsNumber)
 147       raises (SALOME::SALOME_Exception);
 148
 149     /*!
 150      * Returns <number of segments> parameter value
 151      */
 152     long GetNumberOfSegments();
 153
 154     /*!
 155      * Sets <distribution type> parameter value
 156      */
 157     void SetDistrType(in long typ)
 158       raises (SALOME::SALOME_Exception);
 159
 160     /*!
 161      * Returns <distribution type> parameter value
 162      */
 163     long GetDistrType();
 164
 165     /*!
 166      * Sets <scale factor> parameter value
 167      */
 168     void SetScaleFactor(in double scaleFactor)
 169       raises (SALOME::SALOME_Exception);
 170
 171     /*!
 172      * Returns <scale factor> parameter value
 173      */
 174     double GetScaleFactor()
 175       raises (SALOME::SALOME_Exception);
 176
 177     /*!
 178      * Sets <table function> parameter value for distribution DT_TabFunc
 179      */
 180     void SetTableFunction(in SMESH::double_array table)
 181       raises (SALOME::SALOME_Exception);
 182
 183     /*!
 184      * Returns <table function> parameter value for distribution DT_TabFunc
 185      */
 186     SMESH::double_array GetTableFunction()
 187       raises (SALOME::SALOME_Exception);
 188
 189     /*!
 190      * Sets <expression function> parameter value for distribution DT_ExprFunc
 191      */
 192     void SetExpressionFunction(in string expr)
 193       raises (SALOME::SALOME_Exception);
 194
 195     /*!
 196      * Returns <expression function> parameter value for distribution DT_ExprFunc
 197      */
 198     string GetExpressionFunction()
 199       raises (SALOME::SALOME_Exception);
 200
 201     /*!
 202      * Sets <conversion mode> parameter value for functional distributions
 203      */
 204     void SetConversionMode(in long conv )
 205       raises (SALOME::SALOME_Exception);
 206
 207     /*!
 208      * Returns <conversion mode> parameter value for functional distributions
 209      */
 210     long ConversionMode()
 211       raises (SALOME::SALOME_Exception);
 212
 213     /*!
 214      * Set list of edges to reverse
 215      */
 216     void SetReversedEdges( in SMESH::long_array list );
 217
 218     /*!
 219      * Returns list of edges to reverse
 220      */
 221     SMESH::long_array GetReversedEdges();
 222
 223     /*!
 224      * Set entry of the main object
 225      */
 226     void SetObjectEntry( in string entry );
 227
 228     /*!
 229      * Get the entry of the main object
 230      */
 231     string GetObjectEntry();
 232   };
 233
 234   /*!
 235    * StdMeshers_Arithmetic1D: interface of "Arithmetic 1D" hypothesis
 236    */
 237   interface StdMeshers_Arithmetic1D : SMESH::SMESH_Hypothesis
 238   {
 239     /*!
 240      * Sets <start segment length> or <end segment length> parameter value
 241      * * OBSOLETE *. Avoid such a way of interface design
 242      * * It is recommended to dedicate a method to each parameter.
 243      */
 244     void SetLength(in double length, in boolean isStartLength)
 245       raises (SALOME::SALOME_Exception);
 246
 247     /*!
 248      * Sets <start segment length> parameter value
 249      */
 250     void SetStartLength(in double length)
 251       raises (SALOME::SALOME_Exception);
 252
 253     /*!
 254      * Sets <end segment length> parameter value
 255      */
 256     void SetEndLength(in double length)
 257       raises (SALOME::SALOME_Exception);
 258
 259     /*!
 260      * Returns <start segment length> or <end segment length> parameter value
 261      */
 262     double GetLength(in boolean isStartLength);
 263
 264     /*!
 265      * Set list of edges to reverse
 266      */
 267     void SetReversedEdges( in SMESH::long_array list );
 268
 269     /*!
 270      * Returns list of edges to reverse
 271      */
 272     SMESH::long_array GetReversedEdges();
 273
 274     /*!
 275      * Set entry of the main object
 276      */
 277     void SetObjectEntry( in string entry );
 278
 279     /*!
 280      * Get the entry of the main object
 281      */
 282     string GetObjectEntry();
 283   };
 284
 285   /*!
 286    * StdMeshers_MaxElementArea: interface of "Max. Triangle Area" hypothesis
 287    */
 288   interface StdMeshers_MaxElementArea : SMESH::SMESH_Hypothesis
 289   {
 290     /*!
 291      * Sets <maximum element area> parameter value
 292      */
 293     void SetMaxElementArea(in double area)
 294       raises (SALOME::SALOME_Exception);
 295
 296     /*!
 297      * Returns <maximum element area> parameter value
 298      */
 299     double GetMaxElementArea();
 300   };
 301
 302   /*!
 303    * StdMeshers_LengthFromEdges: interface of "Length From Edges (2D Hyp. for Triangulator)" hypothesis
 304    */
 305   interface StdMeshers_LengthFromEdges : SMESH::SMESH_Hypothesis
 306   {
 307     /*!
 308      * Sets <mode> parameter value
 309      */
 310     void SetMode(in long mode)
 311       raises (SALOME::SALOME_Exception);
 312
 313     /*!
 314      * Returns <mode> parameter value
 315      */
 316     long GetMode();
 317   };
 318
 319   /*!
 320    * StdMeshers_StartEndLength: interface of "Start and End Length" hypothesis
 321    */
 322   interface StdMeshers_StartEndLength : SMESH::SMESH_Hypothesis
 323   {
 324     /*!
 325      * Sets <start segment length> or <end segment length> parameter value
 326      * * OBSOLETE *. Avoid such a way of interface design.
 327      * * It is recommended to dedicate a method to each parameter.
 328      */
 329     void SetLength(in double length, in boolean isStartLength)
 330       raises (SALOME::SALOME_Exception);
 331
 332     /*!
 333      * Sets <start segment length> parameter value
 334      */
 335     void SetStartLength(in double length)
 336       raises (SALOME::SALOME_Exception);
 337
 338     /*!
 339      * Sets <end segment length> parameter value
 340      */
 341     void SetEndLength(in double length)
 342       raises (SALOME::SALOME_Exception);
 343
 344     /*!
 345      * Returns <start segment length> or <end segment length> parameter value
 346      */
 347     double GetLength(in boolean isStartLength);
 348
 349     /*!
 350      * Set list of edges to reverse
 351      */
 352     void SetReversedEdges( in SMESH::long_array list );
 353
 354     /*!
 355      * Returns list of edges to reverse
 356      */
 357     SMESH::long_array GetReversedEdges();
 358
 359     /*!
 360      * Set entry of the main object
 361      */
 362     void SetObjectEntry( in string entry );
 363
 364     /*!
 365      * Get the entry of the main object
 366      */
 367     string GetObjectEntry();
 368   };
 369
 370
 371   /*!
 372    * StdMeshers_Deflection1D: interface of "Deflection 1D" hypothesis
 373    */
 374   interface StdMeshers_Deflection1D : SMESH::SMESH_Hypothesis
 375   {
 376     /*!
 377      * Sets <deflection> parameter value
 378      */
 379     void SetDeflection(in double deflection)
 380       raises (SALOME::SALOME_Exception);
 381
 382     /*!
 383      * Returns <deflection> parameter value
 384      */
 385     double GetDeflection();
 386   };
 387
 388
 389   /*!
 390    * StdMeshers_FixedPoints1D: interface of "Fixed points 1D" hypothesis
 391    */
 392   interface StdMeshers_FixedPoints1D : SMESH::SMESH_Hypothesis
 393   {
 394     /*!
 395      * Sets some points on edge using parameter on curve from 0 to 1
 396      * (additionally it is neecessary to check orientation of edges and
 397      * create list of reversed edges if it is needed) and sets numbers
 398      * of segments between given points (default values are equals 1)
 399      */
 400     void SetPoints(in SMESH::double_array listParams)
 401       raises (SALOME::SALOME_Exception);
 402     void SetNbSegments(in SMESH::long_array listNbSeg)
 403       raises (SALOME::SALOME_Exception);
 404
 405     /*!
 406      * Returns list of point's parameters
 407      */
 408     SMESH::double_array GetPoints();
 409
 410     /*!
 411      * Returns list of numbers of segments
 412      */
 413     SMESH::long_array GetNbSegments();
 414
 415     /*!
 416      * Set list of edges to reverse
 417      */
 418     void SetReversedEdges( in SMESH::long_array list );
 419
 420     /*!
 421      * Returns list of edges to reverse
 422      */
 423     SMESH::long_array GetReversedEdges();
 424
 425     /*!
 426      * Set entry of the main object
 427      */
 428     void SetObjectEntry( in string entry );
 429
 430     /*!
 431      * Get the entry of the main object
 432      */
 433     string GetObjectEntry();
 434   };
 435
 436
 437   /*!
 438    * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
 439    */
 440   interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
 441   {
 442     /*!
 443      * Sets <maximum element volume> parameter value
 444      */
 445     void SetMaxElementVolume(in double volume)
 446       raises (SALOME::SALOME_Exception);
 447
 448     /*!
 449      * Returns <maximum element volume> parameter value
 450      */
 451     double GetMaxElementVolume();
 452   };
 453
 454   /*!
 455    * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
 456    * Presence of this hypothesis permits to algorithm generation of not conform mesh.
 457    */
 458   interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
 459   {
 460   };
 461
 462   /*!
 463    * StdMeshers_Propagation: interface of "Propagation" hypothesis.
 464    * Presence of this hypothesis on any edge propagates any other 1D
 465    * hypothesis from this edge on all edges, opposite to it.
 466    * It concerns only edges of quadrangle faces.
 467    */
 468   interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
 469   {
 470   };
 471
 472   /*!
 473    * StdMeshers_QuadranglePreference: interface of "QuadranglePreference" hypothesis.
 474    * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
 475    * Presence of this hypothesis forces construction of quadrangles if the number
 476    * of nodes on opposite edges is not the same in the case where the global number
 477    * of nodes on edges is even
 478    */
 479   interface StdMeshers_QuadranglePreference : SMESH::SMESH_Hypothesis
 480   {
 481   };
 482
 483   /*!
 484    * StdMeshers_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
 485    * This is an auxiliary 1D hypothesis whose presence forces construction
 486    * of quadratic edges.
 487    * If the 2D mesher sees that all boundary edges are quadratic ones,
 488    * it generates quadratic faces, else it generates linear faces using
 489    * medium nodes as if they were vertex ones.
 490    * The 3D mesher generates quadratic volumes only if all boundary faces
 491    * are quadratic ones, else it fails.
 492    */
 493   interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
 494   {
 495   };
 496
 497
 498   /*!
 499    * StdMeshers_NumberOfLayers: interface of "Nb. Layers" hypothesis.
 500    * This hypothesis is used by "Radial prism" algorithm.
 501    * It specifies number of segments between the internal
 502    * and the external surfaces.
 503    */
 504   interface StdMeshers_NumberOfLayers : SMESH::SMESH_Hypothesis
 505   {
 506     /*!
 507      * Sets <number of segments> parameter value
 508      */
 509     void SetNumberOfLayers(in long numberOfLayers)
 510       raises (SALOME::SALOME_Exception);
 511
 512     /*!
 513      * Returns <number of layers> parameter value
 514      */
 515     long GetNumberOfLayers();
 516
 517   };
 518
 519   /*!
 520    * StdMeshers_LayerDistribution: interface of "Distribution of Layers" hypothesis.
 521    * This hypothesis is used by "Radial prism" algorithm.
 522    * It specifies 1D hypothesis defining distribution of segments between the internal
 523    * and the external surfaces.
 524    */
 525   interface StdMeshers_LayerDistribution : SMESH::SMESH_Hypothesis
 526   {
 527     /*!
 528      * Sets  1D hypothesis specifying distribution of layers
 529      */
 530     void SetLayerDistribution(in SMESH::SMESH_Hypothesis distributionHyp)
 531       raises (SALOME::SALOME_Exception);
 532
 533     /*!
 534      * Returns 1D hypothesis specifying distribution of layers
 535      */
 536     SMESH::SMESH_Hypothesis GetLayerDistribution();
 537
 538   };
 539
 540   /*!
 541    * StdMeshers_NumberOfLayers2D: interface of "Nb. Layers" hypothesis.
 542    * This hypothesis is used by "Radial quadrangle" algorithm.
 543    * It specifies number of segments between the internal
 544    * and the external surfaces.
 545    */
 546   interface StdMeshers_NumberOfLayers2D : StdMeshers_NumberOfLayers
 547   {
 548   };
 549
 550   /*!
 551    * StdMeshers_LayerDistribution2D: interface of "Distribution of Layers" hypothesis.
 552    * This hypothesis is used by "Radial quadrangle" algorithm.
 553    * It specifies 1D hypothesis defining distribution of segments between the internal
 554    * and the external surfaces.
 555    */
 556   interface StdMeshers_LayerDistribution2D : StdMeshers_LayerDistribution
 557   {
 558   };
 559
 560   /*!
 561    * interface of "ProjectionSource1D" hypothesis.
 562    * This hypothesis specifies a meshed edge to take a mesh pattern from
 563    * and optionally association of vertices between the source edge and a
 564    * target one (where a hipothesis is assigned to)
 565    */
 566   interface StdMeshers_ProjectionSource1D : SMESH::SMESH_Hypothesis
 567   {
 568     /*!
 569      * Sets source <edge> to take a mesh pattern from
 570      */
 571     void SetSourceEdge(in GEOM::GEOM_Object edge)
 572       raises (SALOME::SALOME_Exception);
 573
 574     /*!
 575      * Returns the source edge
 576      */
 577     GEOM::GEOM_Object GetSourceEdge();
 578
 579     /*!
 580      * Sets source <mesh> to take a mesh pattern from
 581      */
 582     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 583
 584     /*!
 585      * Return source mesh
 586      */
 587     SMESH::SMESH_Mesh GetSourceMesh();
 588
 589     /*!
 590      * Sets vertex association between the source edge and the target one.
 591      * This parameter is optional
 592      */
 593     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex,
 594                               in GEOM::GEOM_Object targetVertex)
 595       raises (SALOME::SALOME_Exception);
 596
 597     /*!
 598      * Returns the vertex associated with the target vertex.
 599      * Result may be nil if association not set
 600      */
 601     GEOM::GEOM_Object  GetSourceVertex();
 602
 603     /*!
 604      * Returns the vertex associated with the source vertex.
 605      * Result may be nil if association not set
 606      */
 607     GEOM::GEOM_Object  GetTargetVertex();
 608   };
 609
 610   /*!
 611    * interface of "ProjectionSource2D" hypothesis.
 612    * This hypothesis specifies a meshed face to take a mesh pattern from
 613    * and optionally association of vertices between the source face and a
 614    * target one (where a hipothesis is assigned to)
 615    */
 616   interface StdMeshers_ProjectionSource2D : SMESH::SMESH_Hypothesis
 617   {
 618     /*!
 619      * Sets a source <face> to take a mesh pattern from
 620      */
 621     void SetSourceFace(in GEOM::GEOM_Object face)
 622       raises (SALOME::SALOME_Exception);
 623
 624     /*!
 625      * Returns the source face
 626      */
 627     GEOM::GEOM_Object GetSourceFace();
 628
 629     /*!
 630      * Sets source <mesh> to take a mesh pattern from
 631      */
 632     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 633
 634     /*!
 635      * Return source mesh
 636      */
 637     SMESH::SMESH_Mesh GetSourceMesh();
 638
 639     /*!
 640      * Sets vertex association between the source face and the target one.
 641      * This parameter is optional.
 642      * Two vertices must belong to one edge of a face
 643      */
 644     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 645                               in GEOM::GEOM_Object sourceVertex2,
 646                               in GEOM::GEOM_Object targetVertex1,
 647                               in GEOM::GEOM_Object targetVertex2)
 648       raises (SALOME::SALOME_Exception);
 649
 650     /*!
 651      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 652      * Result may be nil if association not set.
 653      * Valid indices are 1 and 2
 654      */
 655     GEOM::GEOM_Object  GetSourceVertex(in long i)
 656       raises (SALOME::SALOME_Exception);
 657
 658     /*!
 659      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 660      * Result may be nil if association not set.
 661      * Valid indices are 1 and 2
 662      */
 663     GEOM::GEOM_Object  GetTargetVertex(in long i)
 664       raises (SALOME::SALOME_Exception);
 665   };
 666
 667   /*!
 668    * interface of "ProjectionSource3D" hypothesis.
 669    * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
 670    * and optionally association of vertices between the source shape and a
 671    * target one (where a hipothesis is assigned to)
 672    */
 673   interface StdMeshers_ProjectionSource3D : SMESH::SMESH_Hypothesis
 674   {
 675     /*!
 676      * Sets a source <shape> to take a mesh pattern from
 677      */
 678     void SetSource3DShape(in GEOM::GEOM_Object shape)
 679       raises (SALOME::SALOME_Exception);
 680
 681     /*!
 682      * Returns the source shape
 683      */
 684     GEOM::GEOM_Object GetSource3DShape();
 685
 686     /*!
 687      * Sets source <mesh> to take a mesh pattern from
 688      */
 689     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 690
 691     /*!
 692      * Return source mesh
 693      */
 694     SMESH::SMESH_Mesh GetSourceMesh();
 695
 696     /*!
 697      * Sets vertex association between the source shape and the target one.
 698      * This parameter is optional.
 699      * Two vertices must belong to one edge of a shape
 700      */
 701     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 702                               in GEOM::GEOM_Object sourceVertex2,
 703                               in GEOM::GEOM_Object targetVertex1,
 704                               in GEOM::GEOM_Object targetVertex2)
 705       raises (SALOME::SALOME_Exception);
 706
 707     /*!
 708      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 709      * Result may be nil if association not set.
 710      * Valid indices are 1 and 2
 711      */
 712     GEOM::GEOM_Object  GetSourceVertex(in long i)
 713       raises (SALOME::SALOME_Exception);
 714
 715     /*!
 716      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 717      * Result may be nil if association not set.
 718      * Valid indices are 1 and 2
 719      */
 720     GEOM::GEOM_Object  GetTargetVertex(in long i)
 721       raises (SALOME::SALOME_Exception);
 722   };
 723
 724   /*!
 725    * interface of "SegmentLengthAroundVertex" hypothesis.
 726    * This hypothesis specifies length of segments adjacent to the vertex the
 727    * hypothesis is assigned to
 728    */
 729   interface StdMeshers_SegmentLengthAroundVertex : SMESH::SMESH_Hypothesis
 730   {
 731     /*!
 732      * Sets <length> parameter value
 733      */
 734     void SetLength(in double length)
 735       raises (SALOME::SALOME_Exception);
 736
 737     /*!
 738      * Returns <length> parameter value
 739      */
 740     double GetLength();
 741   };
 742
 743   /*!
 744    * StdMeshers_QuadrangleParams: interface of "Quadrangle Params" hypothesis
 745    */
 746   enum QuadType
 747   {
 748     QUAD_STANDARD,
 749     QUAD_TRIANGLE_PREF,
 750     QUAD_QUADRANGLE_PREF,
 751     QUAD_QUADRANGLE_PREF_REVERSED,
 752     QUAD_REDUCED,
 753     QUAD_NB_TYPES /* this is not a type of quadrangulation */
 754   };
 755
 756   interface StdMeshers_QuadrangleParams : SMESH::SMESH_Hypothesis
 757   {
 758     /*!
 759      * Set base vertex for triangles
 760      */
 761     void SetTriaVertex( in long vertID );
 762
 763     /*!
 764      * Returns base vertex for triangles
 765      */
 766     long GetTriaVertex();
 767
 768     /*!
 769      * Set entry of the main object
 770      */
 771     void SetObjectEntry( in string entry );
 772
 773     /*!
 774      * Get the entry of the main object
 775      */
 776     string GetObjectEntry();
 777
 778     /*!
 779      * Set the type of quadrangulation
 780      */
 781     void SetQuadType( in QuadType type );
 782
 783     /*!
 784      * Get the type of quadrangulation
 785      */
 786     QuadType GetQuadType();
 787   };
 788
 789   /*!
 790    * interface of "Source edges" hypothesis.
 791    * This hypothesis specifies groups of edges of other mesh to be imported
 792    * in this mesh
 793    */
 794   interface StdMeshers_ImportSource1D : SMESH::SMESH_Hypothesis
 795   {
 796     /*!
 797      * Set edges to import from other mesh
 798      */
 799     void SetSourceEdges(in SMESH::ListOfGroups groups);
 800     SMESH::string_array GetSourceEdges();
 801
 802     /*!
 803      * Set to import the whole other mesh or not, and if yes, to
 804      * copy groups of not. By default the mesh is not copied.
 805      */
 806     void SetCopySourceMesh(in boolean toCopyMesh, in boolean toCopyGroups);
 807     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 808   };
 809
 810   /*!
 811    * interface of "Source faces" hypothesis.
 812    * This hypothesis specifies groups of faces of other mesh to be imported
 813    * in this mesh
 814    */
 815   interface StdMeshers_ImportSource2D : SMESH::SMESH_Hypothesis
 816   {
 817     /*!
 818      * Set faces to import from other mesh
 819      */
 820     void SetSourceFaces(in SMESH::ListOfGroups groups);
 821     SMESH::string_array GetSourceFaces();
 822
 823     /*!
 824      * Set to import the whole other mesh or not, and if yes, to
 825      * copy groups of not. By default the mesh is not copied.
 826      */
 827     void SetCopySourceMesh(in boolean toCopyMesh,in boolean toCopyGroups);
 828     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 829   };
 830
 831   /*!
 832    * interface of "Viscous Layers" hypothesis.
 833    * This hypothesis specifies parameters of layers of prisms to build
 834    * near mesh boundary. This hypothesis can be used by several 3D algorithms:
 835    * NETGEN 3D, GHS3D, Hexahedron(i,j,k)
 836    */
 837   interface StdMeshers_ViscousLayers : SMESH::SMESH_Hypothesis
 838   {
 839     /*!
 840      * Set faces to exclude from treatment
 841      */
 842     void SetIgnoreFaces(in SMESH::long_array faceIDs) raises (SALOME::SALOME_Exception);
 843     SMESH::long_array GetIgnoreFaces();
 844
 845     /*!
 846      * Set total thickness of layers of prisms
 847      */
 848     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 849     double GetTotalThickness();
 850
 851     /*!
 852      * Set number of layers of prisms
 853      */
 854     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 855     short GetNumberLayers();
 856
 857     /*!
 858      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 859      */
 860     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 861     double GetStretchFactor();
 862   };
 863
 864   /*!
 865    * interface of "Viscous Layers 2D" hypothesis.
 866    * This hypothesis specifies parameters of layers of quadrilaterals to build
 867    * near mesh boundary. This hypothesis can be used by several 2D algorithms:
 868    * Mefisto, Quadrangle (mapping), NETGEN, BLSURF
 869    */
 870   interface StdMeshers_ViscousLayers2D : SMESH::SMESH_Hypothesis
 871   {
 872     /*!
 873      * Set edges to exclude from treatment
 874      */
 875     void SetIgnoreEdges(in SMESH::long_array edgeIDs) raises (SALOME::SALOME_Exception);
 876     SMESH::long_array GetIgnoreEdges();
 877
 878     /*!
 879      * Set total thickness of layers of prisms
 880      */
 881     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 882     double GetTotalThickness();
 883
 884     /*!
 885      * Set number of layers of prisms
 886      */
 887     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 888     short GetNumberLayers();
 889
 890     /*!
 891      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 892      */
 893     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 894     double GetStretchFactor();
 895   };
 896
 897   /*!
 898    * interface of "Body fitting Parameters" hypothesis.
 899    * This hypothesis specifies
 900    * - Definition of the Cartesian grid
 901    * - Size threshold
 902    */
 903   interface StdMeshers_CartesianParameters3D : SMESH::SMESH_Hypothesis
 904   {
 905     /*!
 906      * Set size threshold. A polyhedral cell got by cutting an initial
 907      * hexahedron by geometry boundary is considered small and is removed if
 908      * it's size is \athreshold times less than the size of the initial hexahedron.
 909      * threshold must be > 1.0
 910      */
 911     void SetSizeThreshold(in double threshold) raises (SALOME::SALOME_Exception);
 912     double GetSizeThreshold();
 913
 914     /*!
 915      * \brief Return true if the grid is defined by spacing functions and
 916      *        not by node coordinates in given direction (X==0,...)
 917      */
 918     boolean IsGridBySpacing(in short axis);
 919
 920     /*!
 921      * Set coordinates of nodes along an axis (counterd from zero)
 922      */
 923     void SetGrid(in SMESH::double_array coords,
 924                  in short               axis) raises (SALOME::SALOME_Exception);
 925     SMESH::double_array GetGrid(in short axis) raises (SALOME::SALOME_Exception);
 926
 927     /*!
 928      * \brief Set grid spacing along an axis
 929      *  \param spaceFunctions - functions defining spacing values at given point on axis
 930      *  \param internalPoints - points dividing a grid into parts along an axis
 931      *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
 932      *
 933      * Parameter t of spaceFunction f(t) is a position [0,1] withing bounding box of
 934      * the shape to mesh or withing an interval defined by internal points
 935      */
 936     void SetGridSpacing(in SMESH::string_array spaceFunctions,
 937                         in SMESH::double_array internalPoints,
 938                         in short               axis) raises (SALOME::SALOME_Exception);
 939
 940     void GetGridSpacing(out SMESH::string_array spaceFunctions,
 941                         out SMESH::double_array internalPoints,
 942                         in short                axis) raises (SALOME::SALOME_Exception);
 943
 944     /*!
 945      * \brief Computes node coordinates by spacing functions
 946      *  \param x0 - lower coordinate
 947      *  \param x1 - upper coordinate
 948      *  \param spaceFuns - space functions
 949      *  \param points - internal points
 950      *  \param coords - the computed coordinates
 951      */
 952     SMESH::double_array ComputeCoordinates(in double              x0,
 953                                            in double              x1,
 954                                            in SMESH::string_array spaceFuns,
 955                                            in SMESH::double_array points,
 956                                            in string              axisName ) raises (SALOME::SALOME_Exception);
 957   };
 958
 959   /*!
 960    * StdMeshers_SegmentAroundVertex_0D: interface of "SegmentAroundVertex" algorithm
 961    */
 962   interface StdMeshers_SegmentAroundVertex_0D : SMESH::SMESH_0D_Algo
 963   {
 964   };
 965
 966   /*!
 967    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
 968    */
 969   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
 970   {
 971   };
 972
 973   /*!
 974    * StdMeshers_CompositeSegment_1D: interface of "Composite side discretisation" algorithm
 975    */
 976   interface StdMeshers_CompositeSegment_1D : SMESH::SMESH_1D_Algo
 977   {
 978   };
 979
 980   /*!
 981    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
 982    */
 983   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
 984   {
 985   };
 986
 987   /*!
 988    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
 989    */
 990   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
 991   {
 992   };
 993
 994   /*!
 995    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
 996    */
 997   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
 998   {
 999   };
1000
1001   /*!
1002    * StdMeshers_Prism_3D: interface of "3D extrusion" algorithm
1003    */
1004   interface StdMeshers_Prism_3D : SMESH::SMESH_3D_Algo
1005   {
1006   };
1007
1008   /*!
1009    * StdMeshers_RadialPrism_3D: interface of "Radial Prism" algorithm
1010    */
1011   interface StdMeshers_RadialPrism_3D : SMESH::SMESH_3D_Algo
1012   {
1013   };
1014
1015   /*!
1016    * StdMeshers_Projection_3D: interface of "Projection 3D" algorithm
1017    */
1018   interface StdMeshers_Projection_3D : SMESH::SMESH_3D_Algo
1019   {
1020   };
1021
1022   /*!
1023    * StdMeshers_Projection_2D: interface of "Projection 2D" algorithm
1024    */
1025   interface StdMeshers_Projection_2D : SMESH::SMESH_2D_Algo
1026   {
1027   };
1028
1029   /*!
1030    * StdMeshers_Projection_1D2D: interface of "Projection 1D-2D" algorithm
1031    */
1032   interface StdMeshers_Projection_1D2D : SMESH::SMESH_2D_Algo
1033   {
1034   };
1035
1036   /*!
1037    * StdMeshers_Projection_1D: interface of "Projection 1D" algorithm
1038    */
1039   interface StdMeshers_Projection_1D : SMESH::SMESH_1D_Algo
1040   {
1041   };
1042
1043   /*!
1044    * StdMeshers_UseExisting_2D: interface of "UseExisting 2D" algorithm
1045    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1046    */
1047   interface StdMeshers_UseExisting_2D : SMESH::SMESH_2D_Algo
1048   {
1049   };
1050
1051   /*!
1052    * StdMeshers_UseExisting_1D: interface of "UseExisting 1D" algorithm
1053    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1054    */
1055   interface StdMeshers_UseExisting_1D : SMESH::SMESH_1D_Algo
1056   {
1057   };
1058
1059   /*!
1060    * StdMeshers_RadialQuadrangle_1D2D: interface of "Radial quadrangle" algorithm
1061    */
1062   interface StdMeshers_RadialQuadrangle_1D2D : SMESH::SMESH_2D_Algo
1063   {
1064   };
1065
1066   /*!
1067    * StdMeshers_Import_1D2D: interface of "Use existing 2D elements" algorithm
1068    */
1069   interface StdMeshers_Import_1D2D : SMESH::SMESH_2D_Algo
1070   {
1071   };
1072   /*!
1073    * StdMeshers_Import_1D: interface of "Use existing 1D elements" algorithm
1074    */
1075   interface StdMeshers_Import_1D : SMESH::SMESH_1D_Algo
1076   {
1077   };
1078   /*!
1079    * StdMeshers_Cartesian_3D: interface of "Body fitting" algorithm
1080    */
1081   interface StdMeshers_Cartesian_3D : SMESH::SMESH_3D_Algo
1082   {
1083   };
1084
1085 };
1086
1087 #endif