idl/SMESH_BasicHypothesis.idl

   1 // Copyright (C) 2007-2013  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    * StdMeshers_FixedPoints1D: interface of "Fixed points 1D" hypothesis
 390    */
 391   interface StdMeshers_FixedPoints1D : SMESH::SMESH_Hypothesis
 392   {
 393     /*!
 394      * Sets some points on edge using parameter on curve from 0 to 1
 395      * (additionally it is neecessary to check orientation of edges and
 396      * create list of reversed edges if it is needed) and sets numbers
 397      * of segments between given points (default values are equals 1)
 398      */
 399     void SetPoints(in SMESH::double_array listParams)
 400       raises (SALOME::SALOME_Exception);
 401     void SetNbSegments(in SMESH::long_array listNbSeg)
 402       raises (SALOME::SALOME_Exception);
 403
 404     /*!
 405      * Returns list of point's parameters
 406      */
 407     SMESH::double_array GetPoints();
 408
 409     /*!
 410      * Returns list of numbers of segments
 411      */
 412     SMESH::long_array GetNbSegments();
 413
 414     /*!
 415      * Set list of edges to reverse
 416      */
 417     void SetReversedEdges( in SMESH::long_array list );
 418
 419     /*!
 420      * Returns list of edges to reverse
 421      */
 422     SMESH::long_array GetReversedEdges();
 423
 424     /*!
 425      * Set entry of the main object
 426      */
 427     void SetObjectEntry( in string entry );
 428
 429     /*!
 430      * Get the entry of the main object
 431      */
 432     string GetObjectEntry();
 433   };
 434
 435   /*!
 436    * StdMeshers_Adaptive1D: interface of "Adaptive" hypothesis
 437    */
 438   interface StdMeshers_Adaptive1D : SMESH::SMESH_Hypothesis
 439   {
 440     /*!
 441      * Sets minimal allowed segment length
 442      */
 443     void SetMinSize(in double minSegLen) raises (SALOME::SALOME_Exception);
 444     double GetMinSize();
 445
 446     /*!
 447      * Sets maximal allowed segment length
 448      */
 449     void SetMaxSize(in double maxSegLen) raises (SALOME::SALOME_Exception);
 450     double GetMaxSize();
 451
 452     /*!
 453      * Sets <deflection> parameter value,
 454      * i.e. a maximal allowed distance between a segment and an edge.
 455      */
 456     void SetDeflection(in double deflection) raises (SALOME::SALOME_Exception);
 457     double GetDeflection();
 458   };
 459
 460   /*!
 461    * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
 462    */
 463   interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
 464   {
 465     /*!
 466      * Sets <maximum element volume> parameter value
 467      */
 468     void SetMaxElementVolume(in double volume)
 469       raises (SALOME::SALOME_Exception);
 470
 471     /*!
 472      * Returns <maximum element volume> parameter value
 473      */
 474     double GetMaxElementVolume();
 475   };
 476
 477   /*!
 478    * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
 479    * Presence of this hypothesis permits to algorithm generation of not conform mesh.
 480    */
 481   interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
 482   {
 483   };
 484
 485   /*!
 486    * StdMeshers_Propagation: interface of "Propagation" hypothesis.
 487    * Presence of this hypothesis on any edge propagates any other 1D
 488    * hypothesis from this edge on all edges, opposite to it.
 489    * It concerns only edges of quadrangle faces.
 490    */
 491   interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
 492   {
 493   };
 494
 495   /*!
 496    * StdMeshers_QuadranglePreference: interface of "QuadranglePreference" hypothesis.
 497    * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
 498    * Presence of this hypothesis forces construction of quadrangles if the number
 499    * of nodes on opposite edges is not the same in the case where the global number
 500    * of nodes on edges is even
 501    */
 502   interface StdMeshers_QuadranglePreference : SMESH::SMESH_Hypothesis
 503   {
 504   };
 505
 506   /*!
 507    * StdMeshers_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
 508    * This is an auxiliary 1D hypothesis whose presence forces construction
 509    * of quadratic edges.
 510    * If the 2D mesher sees that all boundary edges are quadratic ones,
 511    * it generates quadratic faces, else it generates linear faces using
 512    * medium nodes as if they were vertex ones.
 513    * The 3D mesher generates quadratic volumes only if all boundary faces
 514    * are quadratic ones, else it fails.
 515    */
 516   interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
 517   {
 518   };
 519
 520
 521   /*!
 522    * StdMeshers_NumberOfLayers: interface of "Nb. Layers" hypothesis.
 523    * This hypothesis is used by "Radial prism" algorithm.
 524    * It specifies number of segments between the internal
 525    * and the external surfaces.
 526    */
 527   interface StdMeshers_NumberOfLayers : SMESH::SMESH_Hypothesis
 528   {
 529     /*!
 530      * Sets <number of segments> parameter value
 531      */
 532     void SetNumberOfLayers(in long numberOfLayers)
 533       raises (SALOME::SALOME_Exception);
 534
 535     /*!
 536      * Returns <number of layers> parameter value
 537      */
 538     long GetNumberOfLayers();
 539
 540   };
 541
 542   /*!
 543    * StdMeshers_LayerDistribution: interface of "Distribution of Layers" hypothesis.
 544    * This hypothesis is used by "Radial prism" algorithm.
 545    * It specifies 1D hypothesis defining distribution of segments between the internal
 546    * and the external surfaces.
 547    */
 548   interface StdMeshers_LayerDistribution : SMESH::SMESH_Hypothesis
 549   {
 550     /*!
 551      * Sets  1D hypothesis specifying distribution of layers
 552      */
 553     void SetLayerDistribution(in SMESH::SMESH_Hypothesis distributionHyp)
 554       raises (SALOME::SALOME_Exception);
 555
 556     /*!
 557      * Returns 1D hypothesis specifying distribution of layers
 558      */
 559     SMESH::SMESH_Hypothesis GetLayerDistribution();
 560
 561   };
 562
 563   /*!
 564    * StdMeshers_NumberOfLayers2D: interface of "Nb. Layers" hypothesis.
 565    * This hypothesis is used by "Radial quadrangle" algorithm.
 566    * It specifies number of segments between the internal
 567    * and the external surfaces.
 568    */
 569   interface StdMeshers_NumberOfLayers2D : StdMeshers_NumberOfLayers
 570   {
 571   };
 572
 573   /*!
 574    * StdMeshers_LayerDistribution2D: interface of "Distribution of Layers" hypothesis.
 575    * This hypothesis is used by "Radial quadrangle" algorithm.
 576    * It specifies 1D hypothesis defining distribution of segments between the internal
 577    * and the external surfaces.
 578    */
 579   interface StdMeshers_LayerDistribution2D : StdMeshers_LayerDistribution
 580   {
 581   };
 582
 583   /*!
 584    * interface of "ProjectionSource1D" hypothesis.
 585    * This hypothesis specifies a meshed edge to take a mesh pattern from
 586    * and optionally association of vertices between the source edge and a
 587    * target one (where a hipothesis is assigned to)
 588    */
 589   interface StdMeshers_ProjectionSource1D : SMESH::SMESH_Hypothesis
 590   {
 591     /*!
 592      * Sets source <edge> to take a mesh pattern from
 593      */
 594     void SetSourceEdge(in GEOM::GEOM_Object edge)
 595       raises (SALOME::SALOME_Exception);
 596
 597     /*!
 598      * Returns the source edge
 599      */
 600     GEOM::GEOM_Object GetSourceEdge();
 601
 602     /*!
 603      * Sets source <mesh> to take a mesh pattern from
 604      */
 605     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 606
 607     /*!
 608      * Return source mesh
 609      */
 610     SMESH::SMESH_Mesh GetSourceMesh();
 611
 612     /*!
 613      * Sets vertex association between the source edge and the target one.
 614      * This parameter is optional
 615      */
 616     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex,
 617                               in GEOM::GEOM_Object targetVertex)
 618       raises (SALOME::SALOME_Exception);
 619
 620     /*!
 621      * Returns the vertex associated with the target vertex.
 622      * Result may be nil if association not set
 623      */
 624     GEOM::GEOM_Object  GetSourceVertex();
 625
 626     /*!
 627      * Returns the vertex associated with the source vertex.
 628      * Result may be nil if association not set
 629      */
 630     GEOM::GEOM_Object  GetTargetVertex();
 631   };
 632
 633   /*!
 634    * interface of "ProjectionSource2D" hypothesis.
 635    * This hypothesis specifies a meshed face to take a mesh pattern from
 636    * and optionally association of vertices between the source face and a
 637    * target one (where a hipothesis is assigned to)
 638    */
 639   interface StdMeshers_ProjectionSource2D : SMESH::SMESH_Hypothesis
 640   {
 641     /*!
 642      * Sets a source <face> to take a mesh pattern from
 643      */
 644     void SetSourceFace(in GEOM::GEOM_Object face)
 645       raises (SALOME::SALOME_Exception);
 646
 647     /*!
 648      * Returns the source face
 649      */
 650     GEOM::GEOM_Object GetSourceFace();
 651
 652     /*!
 653      * Sets source <mesh> to take a mesh pattern from
 654      */
 655     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 656
 657     /*!
 658      * Return source mesh
 659      */
 660     SMESH::SMESH_Mesh GetSourceMesh();
 661
 662     /*!
 663      * Sets vertex association between the source face and the target one.
 664      * This parameter is optional.
 665      * Two vertices must belong to one edge of a face
 666      */
 667     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 668                               in GEOM::GEOM_Object sourceVertex2,
 669                               in GEOM::GEOM_Object targetVertex1,
 670                               in GEOM::GEOM_Object targetVertex2)
 671       raises (SALOME::SALOME_Exception);
 672
 673     /*!
 674      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 675      * Result may be nil if association not set.
 676      * Valid indices are 1 and 2
 677      */
 678     GEOM::GEOM_Object  GetSourceVertex(in long i)
 679       raises (SALOME::SALOME_Exception);
 680
 681     /*!
 682      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 683      * Result may be nil if association not set.
 684      * Valid indices are 1 and 2
 685      */
 686     GEOM::GEOM_Object  GetTargetVertex(in long i)
 687       raises (SALOME::SALOME_Exception);
 688   };
 689
 690   /*!
 691    * interface of "ProjectionSource3D" hypothesis.
 692    * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
 693    * and optionally association of vertices between the source shape and a
 694    * target one (where a hipothesis is assigned to)
 695    */
 696   interface StdMeshers_ProjectionSource3D : SMESH::SMESH_Hypothesis
 697   {
 698     /*!
 699      * Sets a source <shape> to take a mesh pattern from
 700      */
 701     void SetSource3DShape(in GEOM::GEOM_Object shape)
 702       raises (SALOME::SALOME_Exception);
 703
 704     /*!
 705      * Returns the source shape
 706      */
 707     GEOM::GEOM_Object GetSource3DShape();
 708
 709     /*!
 710      * Sets source <mesh> to take a mesh pattern from
 711      */
 712     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 713
 714     /*!
 715      * Return source mesh
 716      */
 717     SMESH::SMESH_Mesh GetSourceMesh();
 718
 719     /*!
 720      * Sets vertex association between the source shape and the target one.
 721      * This parameter is optional.
 722      * Two vertices must belong to one edge of a shape
 723      */
 724     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 725                               in GEOM::GEOM_Object sourceVertex2,
 726                               in GEOM::GEOM_Object targetVertex1,
 727                               in GEOM::GEOM_Object targetVertex2)
 728       raises (SALOME::SALOME_Exception);
 729
 730     /*!
 731      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 732      * Result may be nil if association not set.
 733      * Valid indices are 1 and 2
 734      */
 735     GEOM::GEOM_Object  GetSourceVertex(in long i)
 736       raises (SALOME::SALOME_Exception);
 737
 738     /*!
 739      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 740      * Result may be nil if association not set.
 741      * Valid indices are 1 and 2
 742      */
 743     GEOM::GEOM_Object  GetTargetVertex(in long i)
 744       raises (SALOME::SALOME_Exception);
 745   };
 746
 747   /*!
 748    * interface of "SegmentLengthAroundVertex" hypothesis.
 749    * This hypothesis specifies length of segments adjacent to the vertex the
 750    * hypothesis is assigned to
 751    */
 752   interface StdMeshers_SegmentLengthAroundVertex : SMESH::SMESH_Hypothesis
 753   {
 754     /*!
 755      * Sets <length> parameter value
 756      */
 757     void SetLength(in double length)
 758       raises (SALOME::SALOME_Exception);
 759
 760     /*!
 761      * Returns <length> parameter value
 762      */
 763     double GetLength();
 764   };
 765
 766   /*!
 767    * StdMeshers_QuadrangleParams: interface of "Quadrangle Params" hypothesis
 768    */
 769   enum QuadType
 770   {
 771     QUAD_STANDARD,
 772     QUAD_TRIANGLE_PREF,
 773     QUAD_QUADRANGLE_PREF,
 774     QUAD_QUADRANGLE_PREF_REVERSED,
 775     QUAD_REDUCED,
 776     QUAD_NB_TYPES /* this is not a type of quadrangulation */
 777   };
 778
 779   interface StdMeshers_QuadrangleParams : SMESH::SMESH_Hypothesis
 780   {
 781     /*!
 782      * Set base vertex for triangles
 783      */
 784     void SetTriaVertex( in long vertID );
 785
 786     /*!
 787      * Returns base vertex for triangles
 788      */
 789     long GetTriaVertex();
 790
 791     /*!
 792      * Set entry of the main object
 793      */
 794     void SetObjectEntry( in string entry );
 795
 796     /*!
 797      * Get the entry of the main object
 798      */
 799     string GetObjectEntry();
 800
 801     /*!
 802      * Set the type of quadrangulation
 803      */
 804     void SetQuadType( in QuadType type );
 805
 806     /*!
 807      * Get the type of quadrangulation
 808      */
 809     QuadType GetQuadType();
 810   };
 811
 812   /*!
 813    * interface of "Source edges" hypothesis.
 814    * This hypothesis specifies groups of edges of other mesh to be imported
 815    * in this mesh
 816    */
 817   interface StdMeshers_ImportSource1D : SMESH::SMESH_Hypothesis
 818   {
 819     /*!
 820      * Set edges to import from other mesh
 821      */
 822     void SetSourceEdges(in SMESH::ListOfGroups groups);
 823     SMESH::string_array GetSourceEdges();
 824
 825     /*!
 826      * Set to import the whole other mesh or not, and if yes, to
 827      * copy groups of not. By default the mesh is not copied.
 828      */
 829     void SetCopySourceMesh(in boolean toCopyMesh, in boolean toCopyGroups);
 830     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 831   };
 832
 833   /*!
 834    * interface of "Source faces" hypothesis.
 835    * This hypothesis specifies groups of faces of other mesh to be imported
 836    * in this mesh
 837    */
 838   interface StdMeshers_ImportSource2D : SMESH::SMESH_Hypothesis
 839   {
 840     /*!
 841      * Set faces to import from other mesh
 842      */
 843     void SetSourceFaces(in SMESH::ListOfGroups groups);
 844     SMESH::string_array GetSourceFaces();
 845
 846     /*!
 847      * Set to import the whole other mesh or not, and if yes, to
 848      * copy groups of not. By default the mesh is not copied.
 849      */
 850     void SetCopySourceMesh(in boolean toCopyMesh,in boolean toCopyGroups);
 851     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 852   };
 853
 854   /*!
 855    * interface of "Viscous Layers" hypothesis.
 856    * This hypothesis specifies parameters of layers of prisms to build
 857    * near mesh boundary. This hypothesis can be used by several 3D algorithms:
 858    * NETGEN 3D, GHS3D, Hexahedron(i,j,k)
 859    */
 860   interface StdMeshers_ViscousLayers : SMESH::SMESH_Hypothesis
 861   {
 862     /*!
 863      * Set faces to exclude from treatment
 864      */
 865     void SetIgnoreFaces(in SMESH::long_array faceIDs) raises (SALOME::SALOME_Exception);
 866     SMESH::long_array GetIgnoreFaces();
 867
 868     /*!
 869      * Set total thickness of layers of prisms
 870      */
 871     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 872     double GetTotalThickness();
 873
 874     /*!
 875      * Set number of layers of prisms
 876      */
 877     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 878     short GetNumberLayers();
 879
 880     /*!
 881      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 882      */
 883     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 884     double GetStretchFactor();
 885   };
 886
 887   /*!
 888    * interface of "Viscous Layers 2D" hypothesis.
 889    * This hypothesis specifies parameters of layers of quadrilaterals to build
 890    * near mesh boundary. This hypothesis can be used by several 2D algorithms:
 891    * Mefisto, Quadrangle (mapping), NETGEN, BLSURF
 892    */
 893   interface StdMeshers_ViscousLayers2D : SMESH::SMESH_Hypothesis
 894   {
 895     /*!
 896      * Set edges to exclude from treatment
 897      */
 898     void SetIgnoreEdges(in SMESH::long_array edgeIDs) raises (SALOME::SALOME_Exception);
 899     SMESH::long_array GetIgnoreEdges();
 900
 901     /*!
 902      * Set edges either to exclude from treatment or to make the Viscous Layers on.
 903      */
 904     void SetEdges(in SMESH::long_array edgeIDs,
 905                   in boolean           toIgnore) raises (SALOME::SALOME_Exception);
 906     SMESH::long_array GetEdges();
 907     boolean           GetIsToIgnoreEdges();
 908
 909     /*!
 910      * Set total thickness of layers of prisms
 911      */
 912     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 913     double GetTotalThickness();
 914
 915     /*!
 916      * Set number of layers of prisms
 917      */
 918     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 919     short GetNumberLayers();
 920
 921     /*!
 922      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 923      */
 924     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 925     double GetStretchFactor();
 926   };
 927
 928   /*!
 929    * interface of "Body fitting Parameters" hypothesis.
 930    * This hypothesis specifies
 931    * - Definition of the Cartesian grid
 932    * - Size threshold
 933    */
 934   interface StdMeshers_CartesianParameters3D : SMESH::SMESH_Hypothesis
 935   {
 936     /*!
 937      * Set size threshold. A polyhedral cell got by cutting an initial
 938      * hexahedron by geometry boundary is considered small and is removed if
 939      * it's size is \athreshold times less than the size of the initial hexahedron.
 940      * threshold must be > 1.0
 941      */
 942     void SetSizeThreshold(in double threshold) raises (SALOME::SALOME_Exception);
 943     double GetSizeThreshold();
 944
 945     /*!
 946      * \brief Return true if the grid is defined by spacing functions and
 947      *        not by node coordinates in given direction (X==0,...)
 948      */
 949     boolean IsGridBySpacing(in short axis);
 950
 951     /*!
 952      * Set coordinates of nodes along an axis (countered from zero)
 953      */
 954     void SetGrid(in SMESH::double_array coords,
 955                  in short               axis) raises (SALOME::SALOME_Exception);
 956     SMESH::double_array GetGrid(in short axis) raises (SALOME::SALOME_Exception);
 957
 958     /*!
 959      * \brief Set grid spacing along an axis
 960      *  \param spaceFunctions - functions defining spacing values at given point on axis
 961      *  \param internalPoints - points dividing a grid into parts along an axis
 962      *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
 963      *
 964      * Parameter t of spaceFunction f(t) is a position [0,1] withing bounding box of
 965      * the shape to mesh or withing an interval defined by internal points
 966      */
 967     void SetGridSpacing(in SMESH::string_array spaceFunctions,
 968                         in SMESH::double_array internalPoints,
 969                         in short               axis) raises (SALOME::SALOME_Exception);
 970
 971     void GetGridSpacing(out SMESH::string_array spaceFunctions,
 972                         out SMESH::double_array internalPoints,
 973                         in short                axis) raises (SALOME::SALOME_Exception);
 974
 975     /*!
 976      * \brief Computes node coordinates by spacing functions
 977      *  \param x0 - lower coordinate
 978      *  \param x1 - upper coordinate
 979      *  \param spaceFuns - space functions
 980      *  \param points - internal points
 981      *  \param coords - the computed coordinates
 982      */
 983     SMESH::double_array ComputeCoordinates(in double              x0,
 984                                            in double              x1,
 985                                            in SMESH::string_array spaceFuns,
 986                                            in SMESH::double_array points,
 987                                            in string              axisName ) raises (SALOME::SALOME_Exception);
 988   };
 989
 990   /*!
 991    * StdMeshers_SegmentAroundVertex_0D: interface of "SegmentAroundVertex" algorithm
 992    */
 993   interface StdMeshers_SegmentAroundVertex_0D : SMESH::SMESH_0D_Algo
 994   {
 995   };
 996
 997   /*!
 998    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
 999    */
1000   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
1001   {
1002   };
1003
1004   /*!
1005    * StdMeshers_CompositeSegment_1D: interface of "Composite side discretisation" algorithm
1006    */
1007   interface StdMeshers_CompositeSegment_1D : SMESH::SMESH_1D_Algo
1008   {
1009   };
1010
1011   /*!
1012    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
1013    */
1014   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
1015   {
1016   };
1017
1018   /*!
1019    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
1020    */
1021   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
1022   {
1023   };
1024
1025   /*!
1026    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
1027    */
1028   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
1029   {
1030   };
1031
1032   /*!
1033    * StdMeshers_Prism_3D: interface of "3D extrusion" algorithm
1034    */
1035   interface StdMeshers_Prism_3D : SMESH::SMESH_3D_Algo
1036   {
1037   };
1038
1039   /*!
1040    * StdMeshers_RadialPrism_3D: interface of "Radial Prism" algorithm
1041    */
1042   interface StdMeshers_RadialPrism_3D : SMESH::SMESH_3D_Algo
1043   {
1044   };
1045
1046   /*!
1047    * StdMeshers_Projection_3D: interface of "Projection 3D" algorithm
1048    */
1049   interface StdMeshers_Projection_3D : SMESH::SMESH_3D_Algo
1050   {
1051   };
1052
1053   /*!
1054    * StdMeshers_Projection_2D: interface of "Projection 2D" algorithm
1055    */
1056   interface StdMeshers_Projection_2D : SMESH::SMESH_2D_Algo
1057   {
1058   };
1059
1060   /*!
1061    * StdMeshers_Projection_1D2D: interface of "Projection 1D-2D" algorithm
1062    */
1063   interface StdMeshers_Projection_1D2D : SMESH::SMESH_2D_Algo
1064   {
1065   };
1066
1067   /*!
1068    * StdMeshers_Projection_1D: interface of "Projection 1D" algorithm
1069    */
1070   interface StdMeshers_Projection_1D : SMESH::SMESH_1D_Algo
1071   {
1072   };
1073
1074   /*!
1075    * StdMeshers_UseExisting_2D: interface of "UseExisting 2D" algorithm
1076    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1077    */
1078   interface StdMeshers_UseExisting_2D : SMESH::SMESH_2D_Algo
1079   {
1080   };
1081
1082   /*!
1083    * StdMeshers_UseExisting_1D: interface of "UseExisting 1D" algorithm
1084    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1085    */
1086   interface StdMeshers_UseExisting_1D : SMESH::SMESH_1D_Algo
1087   {
1088   };
1089
1090   /*!
1091    * StdMeshers_RadialQuadrangle_1D2D: interface of "Radial quadrangle" algorithm
1092    */
1093   interface StdMeshers_RadialQuadrangle_1D2D : SMESH::SMESH_2D_Algo
1094   {
1095   };
1096
1097   /*!
1098    * StdMeshers_Import_1D2D: interface of "Use existing 2D elements" algorithm
1099    */
1100   interface StdMeshers_Import_1D2D : SMESH::SMESH_2D_Algo
1101   {
1102   };
1103   /*!
1104    * StdMeshers_Import_1D: interface of "Use existing 1D elements" algorithm
1105    */
1106   interface StdMeshers_Import_1D : SMESH::SMESH_1D_Algo
1107   {
1108   };
1109   /*!
1110    * StdMeshers_Cartesian_3D: interface of "Body fitting" algorithm
1111    */
1112   interface StdMeshers_Cartesian_3D : SMESH::SMESH_3D_Algo
1113   {
1114   };
1115
1116 };
1117
1118 #endif