idl/SMESH_BasicHypothesis.idl

   1 // Copyright (C) 2007-2011  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_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
 474    * This is an auxiliary 1D hypothesis whose presence forces construction
 475    * of quadratic edges.
 476    * If the 2D mesher sees that all boundary edges are quadratic ones,
 477    * it generates quadratic faces, else it generates linear faces using
 478    * medium nodes as if they were vertex ones.
 479    * The 3D mesher generates quadratic volumes only if all boundary faces
 480    * are quadratic ones, else it fails.
 481    */
 482   interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
 483   {
 484   };
 485
 486
 487   /*!
 488    * StdMeshers_NumberOfLayers: interface of "Nb. Layers" hypothesis.
 489    * This hypothesis is used by "Radial prism" algorithm.
 490    * It specifies number of segments between the internal
 491    * and the external surfaces.
 492    */
 493   interface StdMeshers_NumberOfLayers : SMESH::SMESH_Hypothesis
 494   {
 495     /*!
 496      * Sets <number of segments> parameter value
 497      */
 498     void SetNumberOfLayers(in long numberOfLayers)
 499       raises (SALOME::SALOME_Exception);
 500
 501     /*!
 502      * Returns <number of layers> parameter value
 503      */
 504     long GetNumberOfLayers();
 505
 506   };
 507
 508   /*!
 509    * StdMeshers_LayerDistribution: interface of "Distribution of Layers" hypothesis.
 510    * This hypothesis is used by "Radial prism" algorithm.
 511    * It specifies 1D hypothesis defining distribution of segments between the internal
 512    * and the external surfaces.
 513    */
 514   interface StdMeshers_LayerDistribution : SMESH::SMESH_Hypothesis
 515   {
 516     /*!
 517      * Sets  1D hypothesis specifying distribution of layers
 518      */
 519     void SetLayerDistribution(in SMESH::SMESH_Hypothesis distributionHyp)
 520       raises (SALOME::SALOME_Exception);
 521
 522     /*!
 523      * Returns 1D hypothesis specifying distribution of layers
 524      */
 525     SMESH::SMESH_Hypothesis GetLayerDistribution();
 526
 527   };
 528
 529   /*!
 530    * StdMeshers_NumberOfLayers2D: interface of "Nb. Layers" hypothesis.
 531    * This hypothesis is used by "Radial quadrangle" algorithm.
 532    * It specifies number of segments between the internal
 533    * and the external surfaces.
 534    */
 535   interface StdMeshers_NumberOfLayers2D : StdMeshers_NumberOfLayers
 536   {
 537   };
 538
 539   /*!
 540    * StdMeshers_LayerDistribution2D: interface of "Distribution of Layers" hypothesis.
 541    * This hypothesis is used by "Radial quadrangle" algorithm.
 542    * It specifies 1D hypothesis defining distribution of segments between the internal
 543    * and the external surfaces.
 544    */
 545   interface StdMeshers_LayerDistribution2D : StdMeshers_LayerDistribution
 546   {
 547   };
 548
 549   /*!
 550    * interface of "ProjectionSource1D" hypothesis.
 551    * This hypothesis specifies a meshed edge to take a mesh pattern from
 552    * and optionally association of vertices between the source edge and a
 553    * target one (where a hipothesis is assigned to)
 554    */
 555   interface StdMeshers_ProjectionSource1D : SMESH::SMESH_Hypothesis
 556   {
 557     /*!
 558      * Sets source <edge> to take a mesh pattern from
 559      */
 560     void SetSourceEdge(in GEOM::GEOM_Object edge)
 561       raises (SALOME::SALOME_Exception);
 562
 563     /*!
 564      * Returns the source edge
 565      */
 566     GEOM::GEOM_Object GetSourceEdge();
 567
 568     /*!
 569      * Sets source <mesh> to take a mesh pattern from
 570      */
 571     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 572
 573     /*!
 574      * Return source mesh
 575      */
 576     SMESH::SMESH_Mesh GetSourceMesh();
 577
 578     /*!
 579      * Sets vertex association between the source edge and the target one.
 580      * This parameter is optional
 581      */
 582     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex,
 583                               in GEOM::GEOM_Object targetVertex)
 584       raises (SALOME::SALOME_Exception);
 585
 586     /*!
 587      * Returns the vertex associated with the target vertex.
 588      * Result may be nil if association not set
 589      */
 590     GEOM::GEOM_Object  GetSourceVertex();
 591
 592     /*!
 593      * Returns the vertex associated with the source vertex.
 594      * Result may be nil if association not set
 595      */
 596     GEOM::GEOM_Object  GetTargetVertex();
 597   };
 598
 599   /*!
 600    * interface of "ProjectionSource2D" hypothesis.
 601    * This hypothesis specifies a meshed face to take a mesh pattern from
 602    * and optionally association of vertices between the source face and a
 603    * target one (where a hipothesis is assigned to)
 604    */
 605   interface StdMeshers_ProjectionSource2D : SMESH::SMESH_Hypothesis
 606   {
 607     /*!
 608      * Sets a source <face> to take a mesh pattern from
 609      */
 610     void SetSourceFace(in GEOM::GEOM_Object face)
 611       raises (SALOME::SALOME_Exception);
 612
 613     /*!
 614      * Returns the source face
 615      */
 616     GEOM::GEOM_Object GetSourceFace();
 617
 618     /*!
 619      * Sets source <mesh> to take a mesh pattern from
 620      */
 621     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 622
 623     /*!
 624      * Return source mesh
 625      */
 626     SMESH::SMESH_Mesh GetSourceMesh();
 627
 628     /*!
 629      * Sets vertex association between the source face and the target one.
 630      * This parameter is optional.
 631      * Two vertices must belong to one edge of a face
 632      */
 633     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 634                               in GEOM::GEOM_Object sourceVertex2,
 635                               in GEOM::GEOM_Object targetVertex1,
 636                               in GEOM::GEOM_Object targetVertex2)
 637       raises (SALOME::SALOME_Exception);
 638
 639     /*!
 640      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 641      * Result may be nil if association not set.
 642      * Valid indices are 1 and 2
 643      */
 644     GEOM::GEOM_Object  GetSourceVertex(in long i)
 645       raises (SALOME::SALOME_Exception);
 646
 647     /*!
 648      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 649      * Result may be nil if association not set.
 650      * Valid indices are 1 and 2
 651      */
 652     GEOM::GEOM_Object  GetTargetVertex(in long i)
 653       raises (SALOME::SALOME_Exception);
 654   };
 655
 656   /*!
 657    * interface of "ProjectionSource3D" hypothesis.
 658    * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
 659    * and optionally association of vertices between the source shape and a
 660    * target one (where a hipothesis is assigned to)
 661    */
 662   interface StdMeshers_ProjectionSource3D : SMESH::SMESH_Hypothesis
 663   {
 664     /*!
 665      * Sets a source <shape> to take a mesh pattern from
 666      */
 667     void SetSource3DShape(in GEOM::GEOM_Object shape)
 668       raises (SALOME::SALOME_Exception);
 669
 670     /*!
 671      * Returns the source shape
 672      */
 673     GEOM::GEOM_Object GetSource3DShape();
 674
 675     /*!
 676      * Sets source <mesh> to take a mesh pattern from
 677      */
 678     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 679
 680     /*!
 681      * Return source mesh
 682      */
 683     SMESH::SMESH_Mesh GetSourceMesh();
 684
 685     /*!
 686      * Sets vertex association between the source shape and the target one.
 687      * This parameter is optional.
 688      * Two vertices must belong to one edge of a shape
 689      */
 690     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 691                               in GEOM::GEOM_Object sourceVertex2,
 692                               in GEOM::GEOM_Object targetVertex1,
 693                               in GEOM::GEOM_Object targetVertex2)
 694       raises (SALOME::SALOME_Exception);
 695
 696     /*!
 697      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 698      * Result may be nil if association not set.
 699      * Valid indices are 1 and 2
 700      */
 701     GEOM::GEOM_Object  GetSourceVertex(in long i)
 702       raises (SALOME::SALOME_Exception);
 703
 704     /*!
 705      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 706      * Result may be nil if association not set.
 707      * Valid indices are 1 and 2
 708      */
 709     GEOM::GEOM_Object  GetTargetVertex(in long i)
 710       raises (SALOME::SALOME_Exception);
 711   };
 712
 713   /*!
 714    * interface of "SegmentLengthAroundVertex" hypothesis.
 715    * This hypothesis specifies length of segments adjacent to the vertex the
 716    * hypothesis is assigned to
 717    */
 718   interface StdMeshers_SegmentLengthAroundVertex : SMESH::SMESH_Hypothesis
 719   {
 720     /*!
 721      * Sets <length> parameter value
 722      */
 723     void SetLength(in double length)
 724       raises (SALOME::SALOME_Exception);
 725
 726     /*!
 727      * Returns <length> parameter value
 728      */
 729     double GetLength();
 730   };
 731
 732   /*!
 733    * StdMeshers_QuadrangleParams: interface of "Quadrangle Params" hypothesis
 734    */
 735   enum QuadType
 736   {
 737     QUAD_STANDARD,
 738     QUAD_TRIANGLE_PREF,
 739     QUAD_QUADRANGLE_PREF,
 740     QUAD_QUADRANGLE_PREF_REVERSED,
 741     QUAD_REDUCED,
 742     QUAD_NB_TYPES /* this is not a type of quadrangulation */
 743   };
 744
 745   interface StdMeshers_QuadrangleParams : SMESH::SMESH_Hypothesis
 746   {
 747     /*!
 748      * Set base vertex for triangles
 749      */
 750     void SetTriaVertex( in long vertID );
 751
 752     /*!
 753      * Returns base vertex for triangles
 754      */
 755     long GetTriaVertex();
 756
 757     /*!
 758      * Set entry of the main object
 759      */
 760     void SetObjectEntry( in string entry );
 761
 762     /*!
 763      * Get the entry of the main object
 764      */
 765     string GetObjectEntry();
 766
 767     /*!
 768      * Set the type of quadrangulation
 769      */
 770     void SetQuadType( in QuadType type );
 771
 772     /*!
 773      * Get the type of quadrangulation
 774      */
 775     QuadType GetQuadType();
 776   };
 777
 778   /*!
 779    * interface of "Source edges" hypothesis.
 780    * This hypothesis specifies groups of edges of other mesh to be imported
 781    * in this mesh
 782    */
 783   interface StdMeshers_ImportSource1D : SMESH::SMESH_Hypothesis
 784   {
 785     /*!
 786      * Set edges to import from other mesh
 787      */
 788     void SetSourceEdges(in SMESH::ListOfGroups groups);
 789     SMESH::string_array GetSourceEdges();
 790
 791     /*!
 792      * Set to import the whole other mesh or not, and if yes, to
 793      * copy groups of not. By default the mesh is not copied.
 794      */
 795     void SetCopySourceMesh(in boolean toCopyMesh, in boolean toCopyGroups);
 796     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 797   };
 798
 799   /*!
 800    * interface of "Source faces" hypothesis.
 801    * This hypothesis specifies groups of faces of other mesh to be imported
 802    * in this mesh
 803    */
 804   interface StdMeshers_ImportSource2D : SMESH::SMESH_Hypothesis
 805   {
 806     /*!
 807      * Set faces to import from other mesh
 808      */
 809     void SetSourceFaces(in SMESH::ListOfGroups groups);
 810     SMESH::string_array GetSourceFaces();
 811
 812     /*!
 813      * Set to import the whole other mesh or not, and if yes, to
 814      * copy groups of not. By default the mesh is not copied.
 815      */
 816     void SetCopySourceMesh(in boolean toCopyMesh,in boolean toCopyGroups);
 817     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 818   };
 819
 820   /*!
 821    * interface of "Viscous Layers" hypothesis.
 822    * This hypothesis specifies parameters of layers of prisms to build
 823    * near mesh boundary. This hypothesis can be used by several 3D algorithms:
 824    * NETGEN 3D, GHS3D, Hexahedron(i,j,k)
 825    */
 826   interface StdMeshers_ViscousLayers : SMESH::SMESH_Hypothesis
 827   {
 828     /*!
 829      * Set faces to exclude from treatment
 830      */
 831     void SetIgnoreFaces(in SMESH::long_array faceIDs) raises (SALOME::SALOME_Exception);
 832     SMESH::long_array GetIgnoreFaces();
 833
 834     /*!
 835      * Set total thickness of layers of prisms
 836      */
 837     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 838     double GetTotalThickness();
 839
 840     /*!
 841      * Set number of layers of prisms
 842      */
 843     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 844     short GetNumberLayers();
 845
 846     /*!
 847      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 848      */
 849     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 850     double GetStretchFactor();
 851   };
 852
 853   /*!
 854    * StdMeshers_SegmentAroundVertex_0D: interface of "SegmentAroundVertex" algorithm
 855    */
 856   interface StdMeshers_SegmentAroundVertex_0D : SMESH::SMESH_0D_Algo
 857   {
 858   };
 859
 860   /*!
 861    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
 862    */
 863   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
 864   {
 865   };
 866
 867   /*!
 868    * StdMeshers_CompositeSegment_1D: interface of "Composite side discretisation" algorithm
 869    */
 870   interface StdMeshers_CompositeSegment_1D : SMESH::SMESH_1D_Algo
 871   {
 872   };
 873
 874   /*!
 875    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
 876    */
 877   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
 878   {
 879   };
 880
 881   /*!
 882    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
 883    */
 884   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
 885   {
 886   };
 887
 888   /*!
 889    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
 890    */
 891   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
 892   {
 893   };
 894
 895   /*!
 896    * StdMeshers_Prism_3D: interface of "3D extrusion" algorithm
 897    */
 898   interface StdMeshers_Prism_3D : SMESH::SMESH_3D_Algo
 899   {
 900   };
 901
 902   /*!
 903    * StdMeshers_RadialPrism_3D: interface of "Radial Prism" algorithm
 904    */
 905   interface StdMeshers_RadialPrism_3D : SMESH::SMESH_3D_Algo
 906   {
 907   };
 908
 909   /*!
 910    * StdMeshers_Projection_3D: interface of "Projection 3D" algorithm
 911    */
 912   interface StdMeshers_Projection_3D : SMESH::SMESH_3D_Algo
 913   {
 914   };
 915
 916   /*!
 917    * StdMeshers_Projection_2D: interface of "Projection 2D" algorithm
 918    */
 919   interface StdMeshers_Projection_2D : SMESH::SMESH_2D_Algo
 920   {
 921   };
 922
 923   /*!
 924    * StdMeshers_Projection_1D: interface of "Projection 1D" algorithm
 925    */
 926   interface StdMeshers_Projection_1D : SMESH::SMESH_1D_Algo
 927   {
 928   };
 929
 930   /*!
 931    * StdMeshers_UseExisting_2D: interface of "UseExisting 2D" algorithm
 932    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
 933    */
 934   interface StdMeshers_UseExisting_2D : SMESH::SMESH_2D_Algo
 935   {
 936   };
 937
 938   /*!
 939    * StdMeshers_UseExisting_1D: interface of "UseExisting 1D" algorithm
 940    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
 941    */
 942   interface StdMeshers_UseExisting_1D : SMESH::SMESH_1D_Algo
 943   {
 944   };
 945
 946   /*!
 947    * StdMeshers_RadialQuadrangle_1D2D: interface of "Radial quadrangle" algorithm
 948    */
 949   interface StdMeshers_RadialQuadrangle_1D2D : SMESH::SMESH_2D_Algo
 950   {
 951   };
 952
 953   /*!
 954    * StdMeshers_Import_1D2D: interface of "Use existing 2D elements" algorithm
 955    */
 956   interface StdMeshers_Import_1D2D : SMESH::SMESH_2D_Algo
 957   {
 958   };
 959   /*!
 960    * StdMeshers_Import_1D: interface of "Use existing 1D elements" algorithm
 961    */
 962   interface StdMeshers_Import_1D : SMESH::SMESH_1D_Algo
 963   {
 964   };
 965
 966 };
 967
 968 #endif