idl/SMESH_BasicHypothesis.idl

   1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  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    * Common inteface of 1D hypotheses that can be reversed
 132    */
 133   interface Reversible1D
 134   {
 135     /*!
 136      * Set list of edges to reverse
 137      */
 138     void SetReversedEdges( in SMESH::long_array list );
 139
 140     /*!
 141      * Returns list of edges to reverse
 142      */
 143     SMESH::long_array GetReversedEdges();
 144
 145     /*!
 146      * Set entry of the main object
 147      */
 148     void SetObjectEntry( in string entry );
 149
 150     /*!
 151      * Get the entry of the main object
 152      */
 153     string GetObjectEntry();
 154   };
 155
 156   /*!
 157    * StdMeshers_NumberOfSegments: interface of "Nb. Segments" hypothesis
 158    */
 159   interface StdMeshers_NumberOfSegments : SMESH::SMESH_Hypothesis, Reversible1D
 160   {
 161     /*!
 162      * Builds and returns point distribution according to passed density function
 163      */
 164     SMESH::double_array BuildDistributionExpr( in string func, in long nbSeg, in long conv )
 165       raises (SALOME::SALOME_Exception);
 166     SMESH::double_array BuildDistributionTab( in SMESH::double_array func, in long nbSeg, in long conv )
 167       raises (SALOME::SALOME_Exception);
 168
 169     /*!
 170      * Sets <number of segments> parameter value
 171      */
 172     void SetNumberOfSegments(in long segmentsNumber)
 173       raises (SALOME::SALOME_Exception);
 174
 175     /*!
 176      * Returns <number of segments> parameter value
 177      */
 178     long GetNumberOfSegments();
 179
 180     /*!
 181      * Sets <distribution type> parameter value
 182      */
 183     void SetDistrType(in long typ)
 184       raises (SALOME::SALOME_Exception);
 185
 186     /*!
 187      * Returns <distribution type> parameter value
 188      */
 189     long GetDistrType();
 190
 191     /*!
 192      * Sets <scale factor> parameter value
 193      */
 194     void SetScaleFactor(in double scaleFactor)
 195       raises (SALOME::SALOME_Exception);
 196
 197     /*!
 198      * Returns <scale factor> parameter value
 199      */
 200     double GetScaleFactor()
 201       raises (SALOME::SALOME_Exception);
 202
 203     /*!
 204      * Sets <table function> parameter value for distribution DT_TabFunc
 205      */
 206     void SetTableFunction(in SMESH::double_array table)
 207       raises (SALOME::SALOME_Exception);
 208
 209     /*!
 210      * Returns <table function> parameter value for distribution DT_TabFunc
 211      */
 212     SMESH::double_array GetTableFunction()
 213       raises (SALOME::SALOME_Exception);
 214
 215     /*!
 216      * Sets <expression function> parameter value for distribution DT_ExprFunc
 217      */
 218     void SetExpressionFunction(in string expr)
 219       raises (SALOME::SALOME_Exception);
 220
 221     /*!
 222      * Returns <expression function> parameter value for distribution DT_ExprFunc
 223      */
 224     string GetExpressionFunction()
 225       raises (SALOME::SALOME_Exception);
 226
 227     /*!
 228      * Sets <conversion mode> parameter value for functional distributions
 229      */
 230     void SetConversionMode(in long conv )
 231       raises (SALOME::SALOME_Exception);
 232
 233     /*!
 234      * Returns <conversion mode> parameter value for functional distributions
 235      */
 236     long ConversionMode()
 237       raises (SALOME::SALOME_Exception);
 238   };
 239
 240   /*!
 241    * StdMeshers_Arithmetic1D: interface of "Arithmetic 1D" hypothesis
 242    */
 243   interface StdMeshers_Arithmetic1D : SMESH::SMESH_Hypothesis, Reversible1D
 244   {
 245     /*!
 246      * Sets <start segment length> or <end segment length> parameter value
 247      * * OBSOLETE *. Avoid such a way of interface design
 248      * * It is recommended to dedicate a method to each parameter.
 249      */
 250     void SetLength(in double length, in boolean isStartLength)
 251       raises (SALOME::SALOME_Exception);
 252
 253     /*!
 254      * Sets <start segment length> parameter value
 255      */
 256     void SetStartLength(in double length)
 257       raises (SALOME::SALOME_Exception);
 258
 259     /*!
 260      * Sets <end segment length> parameter value
 261      */
 262     void SetEndLength(in double length)
 263       raises (SALOME::SALOME_Exception);
 264
 265     /*!
 266      * Returns <start segment length> or <end segment length> parameter value
 267      */
 268     double GetLength(in boolean isStartLength);
 269
 270   };
 271
 272   /*!
 273    * StdMeshers_Arithmetic1D: interface of "Geometric 1D" hypothesis
 274    */
 275   interface StdMeshers_Geometric1D : SMESH::SMESH_Hypothesis, Reversible1D
 276   {
 277     /*!
 278      * Sets length of the first segment
 279      */
 280     void SetStartLength(in double length)
 281       raises (SALOME::SALOME_Exception);
 282
 283     /*!
 284      * Sets value of Common Ratio
 285      */
 286     void SetCommonRatio(in double factor)
 287       raises (SALOME::SALOME_Exception);
 288
 289     /*!
 290      * Returns length of the first segment
 291      */
 292     double GetStartLength();
 293
 294     /*!
 295      * Returns value of Common Ratio
 296      */
 297     double GetCommonRatio();
 298
 299   };
 300
 301   /*!
 302    * StdMeshers_MaxElementArea: interface of "Max. Triangle Area" hypothesis
 303    */
 304   interface StdMeshers_MaxElementArea : SMESH::SMESH_Hypothesis
 305   {
 306     /*!
 307      * Sets <maximum element area> parameter value
 308      */
 309     void SetMaxElementArea(in double area)
 310       raises (SALOME::SALOME_Exception);
 311
 312     /*!
 313      * Returns <maximum element area> parameter value
 314      */
 315     double GetMaxElementArea();
 316   };
 317
 318   /*!
 319    * StdMeshers_LengthFromEdges: interface of "Length From Edges (2D Hyp. for Triangulator)" hypothesis
 320    */
 321   interface StdMeshers_LengthFromEdges : SMESH::SMESH_Hypothesis
 322   {
 323     /*!
 324      * Sets <mode> parameter value
 325      */
 326     void SetMode(in long mode)
 327       raises (SALOME::SALOME_Exception);
 328
 329     /*!
 330      * Returns <mode> parameter value
 331      */
 332     long GetMode();
 333   };
 334
 335   /*!
 336    * StdMeshers_StartEndLength: interface of "Start and End Length" hypothesis
 337    */
 338   interface StdMeshers_StartEndLength : SMESH::SMESH_Hypothesis, Reversible1D
 339   {
 340     /*!
 341      * Sets <start segment length> or <end segment length> parameter value
 342      * * OBSOLETE *. Avoid such a way of interface design.
 343      * * It is recommended to dedicate a method to each parameter.
 344      */
 345     void SetLength(in double length, in boolean isStartLength)
 346       raises (SALOME::SALOME_Exception);
 347
 348     /*!
 349      * Sets <start segment length> parameter value
 350      */
 351     void SetStartLength(in double length)
 352       raises (SALOME::SALOME_Exception);
 353
 354     /*!
 355      * Sets <end segment length> parameter value
 356      */
 357     void SetEndLength(in double length)
 358       raises (SALOME::SALOME_Exception);
 359
 360     /*!
 361      * Returns <start segment length> or <end segment length> parameter value
 362      */
 363     double GetLength(in boolean isStartLength);
 364
 365   };
 366
 367
 368   /*!
 369    * StdMeshers_Deflection1D: interface of "Deflection 1D" hypothesis
 370    */
 371   interface StdMeshers_Deflection1D : SMESH::SMESH_Hypothesis
 372   {
 373     /*!
 374      * Sets <deflection> parameter value
 375      */
 376     void SetDeflection(in double deflection)
 377       raises (SALOME::SALOME_Exception);
 378
 379     /*!
 380      * Returns <deflection> parameter value
 381      */
 382     double GetDeflection();
 383   };
 384
 385   /*!
 386    * StdMeshers_FixedPoints1D: interface of "Fixed points 1D" hypothesis
 387    */
 388   interface StdMeshers_FixedPoints1D : SMESH::SMESH_Hypothesis, Reversible1D
 389   {
 390     /*!
 391      * Sets some points on edge using parameter on curve from 0 to 1
 392      * (additionally it is neecessary to check orientation of edges and
 393      * create list of reversed edges if it is needed) and sets numbers
 394      * of segments between given points (default values are equals 1)
 395      */
 396     void SetPoints(in SMESH::double_array listParams)
 397       raises (SALOME::SALOME_Exception);
 398     void SetNbSegments(in SMESH::long_array listNbSeg)
 399       raises (SALOME::SALOME_Exception);
 400
 401     /*!
 402      * Returns list of point's parameters
 403      */
 404     SMESH::double_array GetPoints();
 405
 406     /*!
 407      * Returns list of numbers of segments
 408      */
 409     SMESH::long_array GetNbSegments();
 410
 411   };
 412
 413   /*!
 414    * StdMeshers_Adaptive1D: interface of "Adaptive" hypothesis
 415    */
 416   interface StdMeshers_Adaptive1D : SMESH::SMESH_Hypothesis
 417   {
 418     /*!
 419      * Sets minimal allowed segment length
 420      */
 421     void SetMinSize(in double minSegLen) raises (SALOME::SALOME_Exception);
 422     double GetMinSize();
 423
 424     /*!
 425      * Sets maximal allowed segment length
 426      */
 427     void SetMaxSize(in double maxSegLen) raises (SALOME::SALOME_Exception);
 428     double GetMaxSize();
 429
 430     /*!
 431      * Sets <deflection> parameter value,
 432      * i.e. a maximal allowed distance between a segment and an edge.
 433      */
 434     void SetDeflection(in double deflection) raises (SALOME::SALOME_Exception);
 435     double GetDeflection();
 436
 437     /*!
 438      * Sets <grading> parameter value,
 439      * i.e. how much size of adjacent elements can differ
 440      */
 441     void SetGrading(in double grading) raises (SALOME::SALOME_Exception);
 442     double GetGrading();
 443   };
 444
 445   /*!
 446    * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
 447    */
 448   interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
 449   {
 450     /*!
 451      * Sets <maximum element volume> parameter value
 452      */
 453     void SetMaxElementVolume(in double volume)
 454       raises (SALOME::SALOME_Exception);
 455
 456     /*!
 457      * Returns <maximum element volume> parameter value
 458      */
 459     double GetMaxElementVolume();
 460   };
 461
 462   /*!
 463    * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
 464    * Presence of this hypothesis permits to algorithm generation of not conform mesh.
 465    */
 466   interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
 467   {
 468   };
 469
 470   /*!
 471    * StdMeshers_Propagation: interface of "Propagation of 1D Hyp. on
 472    * Opposite Edges" hypothesis.
 473    * Presence of this hypothesis on any edge propagates any other 1D
 474    * hypothesis from this edge on all edges, opposite to it.
 475    * It concerns only edges of quadrangle faces.
 476    */
 477   interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
 478   {
 479   };
 480
 481   /*!
 482    * StdMeshers_Propagation: interface of "Propagation of Node
 483    * Distribution on Opposite Edges" hypothesis.
 484    * Presence of this hypothesis on any edge propagates distribution of nodes
 485    * from this edge on all edges, opposite to it.
 486    * It concerns only edges of quadrangle faces.
 487    */
 488   interface StdMeshers_PropagOfDistribution : SMESH::SMESH_Hypothesis
 489   {
 490   };
 491
 492   /*!
 493    * StdMeshers_QuadranglePreference: interface of "QuadranglePreference" hypothesis.
 494    * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
 495    * Presence of this hypothesis forces construction of quadrangles if the number
 496    * of nodes on opposite edges is not the same in the case where the global number
 497    * of nodes on edges is even
 498    */
 499   interface StdMeshers_QuadranglePreference : SMESH::SMESH_Hypothesis
 500   {
 501   };
 502
 503   /*!
 504    * StdMeshers_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
 505    * This is an auxiliary 1D hypothesis whose presence forces construction
 506    * of quadratic edges.
 507    * If the 2D mesher sees that all boundary edges are quadratic ones,
 508    * it generates quadratic faces, else it generates linear faces using
 509    * medium nodes as if they were vertex ones.
 510    * The 3D mesher generates quadratic volumes only if all boundary faces
 511    * are quadratic ones, else it fails.
 512    */
 513   interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
 514   {
 515   };
 516
 517
 518   /*!
 519    * StdMeshers_NumberOfLayers: interface of "Nb. Layers" hypothesis.
 520    * This hypothesis is used by "Radial prism" algorithm.
 521    * It specifies number of segments between the internal
 522    * and the external surfaces.
 523    */
 524   interface StdMeshers_NumberOfLayers : SMESH::SMESH_Hypothesis
 525   {
 526     /*!
 527      * Sets <number of segments> parameter value
 528      */
 529     void SetNumberOfLayers(in long numberOfLayers)
 530       raises (SALOME::SALOME_Exception);
 531
 532     /*!
 533      * Returns <number of layers> parameter value
 534      */
 535     long GetNumberOfLayers();
 536
 537   };
 538
 539   /*!
 540    * StdMeshers_LayerDistribution: interface of "Distribution of Layers" hypothesis.
 541    * This hypothesis is used by "Radial prism" algorithm.
 542    * It specifies 1D hypothesis defining distribution of segments between the internal
 543    * and the external surfaces.
 544    */
 545   interface StdMeshers_LayerDistribution : SMESH::SMESH_Hypothesis
 546   {
 547     /*!
 548      * Sets  1D hypothesis specifying distribution of layers
 549      */
 550     void SetLayerDistribution(in SMESH::SMESH_Hypothesis distributionHyp)
 551       raises (SALOME::SALOME_Exception);
 552
 553     /*!
 554      * Returns 1D hypothesis specifying distribution of layers
 555      */
 556     SMESH::SMESH_Hypothesis GetLayerDistribution();
 557
 558   };
 559
 560   /*!
 561    * StdMeshers_NumberOfLayers2D: interface of "Nb. Layers" hypothesis.
 562    * This hypothesis is used by "Radial quadrangle" algorithm.
 563    * It specifies number of segments between the internal
 564    * and the external surfaces.
 565    */
 566   interface StdMeshers_NumberOfLayers2D : StdMeshers_NumberOfLayers
 567   {
 568   };
 569
 570   /*!
 571    * StdMeshers_LayerDistribution2D: interface of "Distribution of Layers" hypothesis.
 572    * This hypothesis is used by "Radial quadrangle" algorithm.
 573    * It specifies 1D hypothesis defining distribution of segments between the internal
 574    * and the external surfaces.
 575    */
 576   interface StdMeshers_LayerDistribution2D : StdMeshers_LayerDistribution
 577   {
 578   };
 579
 580   /*!
 581    * interface of "ProjectionSource1D" hypothesis.
 582    * This hypothesis specifies a meshed edge to take a mesh pattern from
 583    * and optionally association of vertices between the source edge and a
 584    * target one (where a hipothesis is assigned to)
 585    */
 586   interface StdMeshers_ProjectionSource1D : SMESH::SMESH_Hypothesis
 587   {
 588     /*!
 589      * Sets source <edge> to take a mesh pattern from
 590      */
 591     void SetSourceEdge(in GEOM::GEOM_Object edge)
 592       raises (SALOME::SALOME_Exception);
 593
 594     /*!
 595      * Returns the source edge
 596      */
 597     GEOM::GEOM_Object GetSourceEdge();
 598
 599     /*!
 600      * Sets source <mesh> to take a mesh pattern from
 601      */
 602     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 603
 604     /*!
 605      * Return source mesh
 606      */
 607     SMESH::SMESH_Mesh GetSourceMesh();
 608
 609     /*!
 610      * Sets vertex association between the source edge and the target one.
 611      * This parameter is optional
 612      */
 613     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex,
 614                               in GEOM::GEOM_Object targetVertex)
 615       raises (SALOME::SALOME_Exception);
 616
 617     /*!
 618      * Returns the vertex associated with the target vertex.
 619      * Result may be nil if association not set
 620      */
 621     GEOM::GEOM_Object  GetSourceVertex();
 622
 623     /*!
 624      * Returns the vertex associated with the source vertex.
 625      * Result may be nil if association not set
 626      */
 627     GEOM::GEOM_Object  GetTargetVertex();
 628   };
 629
 630   /*!
 631    * interface of "ProjectionSource2D" hypothesis.
 632    * This hypothesis specifies a meshed face to take a mesh pattern from
 633    * and optionally association of vertices between the source face and a
 634    * target one (where a hipothesis is assigned to)
 635    */
 636   interface StdMeshers_ProjectionSource2D : SMESH::SMESH_Hypothesis
 637   {
 638     /*!
 639      * Sets a source <face> to take a mesh pattern from
 640      */
 641     void SetSourceFace(in GEOM::GEOM_Object face)
 642       raises (SALOME::SALOME_Exception);
 643
 644     /*!
 645      * Returns the source face
 646      */
 647     GEOM::GEOM_Object GetSourceFace();
 648
 649     /*!
 650      * Sets source <mesh> to take a mesh pattern from
 651      */
 652     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 653
 654     /*!
 655      * Return source mesh
 656      */
 657     SMESH::SMESH_Mesh GetSourceMesh();
 658
 659     /*!
 660      * Sets vertex association between the source face and the target one.
 661      * This parameter is optional.
 662      * Two vertices must belong to one edge of a face
 663      */
 664     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 665                               in GEOM::GEOM_Object sourceVertex2,
 666                               in GEOM::GEOM_Object targetVertex1,
 667                               in GEOM::GEOM_Object targetVertex2)
 668       raises (SALOME::SALOME_Exception);
 669
 670     /*!
 671      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 672      * Result may be nil if association not set.
 673      * Valid indices are 1 and 2
 674      */
 675     GEOM::GEOM_Object  GetSourceVertex(in long i)
 676       raises (SALOME::SALOME_Exception);
 677
 678     /*!
 679      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 680      * Result may be nil if association not set.
 681      * Valid indices are 1 and 2
 682      */
 683     GEOM::GEOM_Object  GetTargetVertex(in long i)
 684       raises (SALOME::SALOME_Exception);
 685   };
 686
 687   /*!
 688    * interface of "ProjectionSource3D" hypothesis.
 689    * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
 690    * and optionally association of vertices between the source shape and a
 691    * target one (where a hipothesis is assigned to)
 692    */
 693   interface StdMeshers_ProjectionSource3D : SMESH::SMESH_Hypothesis
 694   {
 695     /*!
 696      * Sets a source <shape> to take a mesh pattern from
 697      */
 698     void SetSource3DShape(in GEOM::GEOM_Object shape)
 699       raises (SALOME::SALOME_Exception);
 700
 701     /*!
 702      * Returns the source shape
 703      */
 704     GEOM::GEOM_Object GetSource3DShape();
 705
 706     /*!
 707      * Sets source <mesh> to take a mesh pattern from
 708      */
 709     void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
 710
 711     /*!
 712      * Return source mesh
 713      */
 714     SMESH::SMESH_Mesh GetSourceMesh();
 715
 716     /*!
 717      * Sets vertex association between the source shape and the target one.
 718      * This parameter is optional.
 719      * Two vertices must belong to one edge of a shape
 720      */
 721     void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
 722                               in GEOM::GEOM_Object sourceVertex2,
 723                               in GEOM::GEOM_Object targetVertex1,
 724                               in GEOM::GEOM_Object targetVertex2)
 725       raises (SALOME::SALOME_Exception);
 726
 727     /*!
 728      * Returns the <i>-th source vertex associated with the <i>-th target vertex.
 729      * Result may be nil if association not set.
 730      * Valid indices are 1 and 2
 731      */
 732     GEOM::GEOM_Object  GetSourceVertex(in long i)
 733       raises (SALOME::SALOME_Exception);
 734
 735     /*!
 736      * Returns the <i>-th target vertex associated with the <i>-th source vertex.
 737      * Result may be nil if association not set.
 738      * Valid indices are 1 and 2
 739      */
 740     GEOM::GEOM_Object  GetTargetVertex(in long i)
 741       raises (SALOME::SALOME_Exception);
 742   };
 743
 744   /*!
 745    * interface of "SegmentLengthAroundVertex" hypothesis.
 746    * This hypothesis specifies length of segments adjacent to the vertex the
 747    * hypothesis is assigned to
 748    */
 749   interface StdMeshers_SegmentLengthAroundVertex : SMESH::SMESH_Hypothesis
 750   {
 751     /*!
 752      * Sets <length> parameter value
 753      */
 754     void SetLength(in double length)
 755       raises (SALOME::SALOME_Exception);
 756
 757     /*!
 758      * Returns <length> parameter value
 759      */
 760     double GetLength();
 761   };
 762
 763   /*!
 764    * StdMeshers_QuadrangleParams: interface of "Quadrangle Params" hypothesis
 765    */
 766   enum QuadType
 767   {
 768     QUAD_STANDARD,
 769     QUAD_TRIANGLE_PREF,
 770     QUAD_QUADRANGLE_PREF,
 771     QUAD_QUADRANGLE_PREF_REVERSED,
 772     QUAD_REDUCED,
 773     QUAD_NB_TYPES /* this is not a type of quadrangulation */
 774   };
 775
 776   interface StdMeshers_QuadrangleParams : SMESH::SMESH_Hypothesis
 777   {
 778     /*!
 779      * Set base vertex for triangles
 780      */
 781     void SetTriaVertex( in long vertID );
 782
 783     /*!
 784      * Returns base vertex for triangles
 785      */
 786     long GetTriaVertex();
 787
 788     /*!
 789      * Set entry of the main object
 790      */
 791     void SetObjectEntry( in string entry );
 792
 793     /*!
 794      * Get the entry of the main object
 795      */
 796     string GetObjectEntry();
 797
 798     /*!
 799      * Set the type of quadrangulation
 800      */
 801     void SetQuadType( in QuadType type );
 802
 803     /*!
 804      * Get the type of quadrangulation
 805      */
 806     QuadType GetQuadType();
 807
 808     /*!
 809      * Set positions of enforced nodes
 810      */
 811     void SetEnforcedNodes(in GEOM::ListOfGO vertices, in SMESH::nodes_array points)
 812       raises (SALOME::SALOME_Exception);
 813
 814     /*!
 815      * Returns positions of enforced nodes
 816      */
 817     void GetEnforcedNodes(out GEOM::ListOfGO vertices, out SMESH::nodes_array points);
 818
 819     /*!
 820      * Returns entries of shapes defining enforced nodes
 821      */
 822     SMESH::string_array GetEnfVertices();
 823   };
 824
 825   /*!
 826    * interface of "Source edges" hypothesis.
 827    * This hypothesis specifies groups of edges of other mesh to be imported
 828    * in this mesh
 829    */
 830   interface StdMeshers_ImportSource1D : SMESH::SMESH_Hypothesis
 831   {
 832     /*!
 833      * Set edges to import from other mesh
 834      */
 835     void SetSourceEdges(in SMESH::ListOfGroups groups);
 836     SMESH::string_array GetSourceEdges();
 837
 838     /*!
 839      * Set to import the whole other mesh or not, and if yes, to
 840      * copy groups of not. By default the mesh is not copied.
 841      */
 842     void SetCopySourceMesh(in boolean toCopyMesh, in boolean toCopyGroups);
 843     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 844   };
 845
 846   /*!
 847    * interface of "Source faces" hypothesis.
 848    * This hypothesis specifies groups of faces of other mesh to be imported
 849    * in this mesh
 850    */
 851   interface StdMeshers_ImportSource2D : SMESH::SMESH_Hypothesis
 852   {
 853     /*!
 854      * Set faces to import from other mesh
 855      */
 856     void SetSourceFaces(in SMESH::ListOfGroups groups);
 857     SMESH::string_array GetSourceFaces();
 858
 859     /*!
 860      * Set to import the whole other mesh or not, and if yes, to
 861      * copy groups of not. By default the mesh is not copied.
 862      */
 863     void SetCopySourceMesh(in boolean toCopyMesh,in boolean toCopyGroups);
 864     void GetCopySourceMesh(out boolean toCopyMesh,out boolean toCopyGroups);
 865   };
 866
 867   /*!
 868    * interface of "Viscous Layers" hypothesis.
 869    * This hypothesis specifies parameters of layers of prisms to build
 870    * near mesh boundary. This hypothesis can be used by several 3D algorithms:
 871    * NETGEN 3D, GHS3D, Hexahedron(i,j,k)
 872    */
 873   interface StdMeshers_ViscousLayers : SMESH::SMESH_Hypothesis
 874   {
 875     /*!
 876      * Set faces to exclude from treatment
 877      */
 878     void SetIgnoreFaces(in SMESH::long_array faceIDs) raises (SALOME::SALOME_Exception);
 879     SMESH::long_array GetIgnoreFaces();
 880
 881     /*!
 882      * Set faces either to exclude from treatment or to make the Viscous Layers on.
 883      */
 884     void SetFaces(in SMESH::long_array faceIDs,
 885                   in boolean           toIgnore) raises (SALOME::SALOME_Exception);
 886     SMESH::long_array GetFaces();
 887     boolean           GetIsToIgnoreFaces();
 888
 889     /*!
 890      * Set total thickness of layers of prisms
 891      */
 892     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 893     double GetTotalThickness();
 894
 895     /*!
 896      * Set number of layers of prisms
 897      */
 898     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 899     short GetNumberLayers();
 900
 901     /*!
 902      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 903      */
 904     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 905     double GetStretchFactor();
 906   };
 907
 908   /*!
 909    * interface of "Viscous Layers 2D" hypothesis.
 910    * This hypothesis specifies parameters of layers of quadrilaterals to build
 911    * near mesh boundary. This hypothesis can be used by several 2D algorithms:
 912    * Mefisto, Quadrangle (mapping), NETGEN, BLSURF
 913    */
 914   interface StdMeshers_ViscousLayers2D : SMESH::SMESH_Hypothesis
 915   {
 916     /*!
 917      * Set edges to exclude from treatment
 918      */
 919     void SetIgnoreEdges(in SMESH::long_array edgeIDs) raises (SALOME::SALOME_Exception);
 920     SMESH::long_array GetIgnoreEdges();
 921
 922     /*!
 923      * Set edges either to exclude from treatment or to make the Viscous Layers on.
 924      */
 925     void SetEdges(in SMESH::long_array edgeIDs,
 926                   in boolean           toIgnore) raises (SALOME::SALOME_Exception);
 927     SMESH::long_array GetEdges();
 928     boolean           GetIsToIgnoreEdges();
 929
 930     /*!
 931      * Set total thickness of layers of prisms
 932      */
 933     void SetTotalThickness(in double thickness) raises (SALOME::SALOME_Exception);
 934     double GetTotalThickness();
 935
 936     /*!
 937      * Set number of layers of prisms
 938      */
 939     void SetNumberLayers(in short nb) raises (SALOME::SALOME_Exception);
 940     short GetNumberLayers();
 941
 942     /*!
 943      * Set factor (>1.0) of growth of layer thickness towards inside of mesh
 944      */
 945     void SetStretchFactor(in double factor) raises (SALOME::SALOME_Exception);
 946     double GetStretchFactor();
 947   };
 948
 949   /*!
 950    * interface of "Body fitting Parameters" hypothesis.
 951    * This hypothesis specifies
 952    * - Size threshold
 953    * - Definition of the Cartesian grid
 954    * - Direction of grid axes
 955    */
 956   interface StdMeshers_CartesianParameters3D : SMESH::SMESH_Hypothesis
 957   {
 958     /*!
 959      * Set size threshold. A polyhedral cell got by cutting an initial
 960      * hexahedron by geometry boundary is considered small and is removed if
 961      * it's size is \a threshold times less than the size of the initial hexahedron.
 962      * threshold must be > 1.0
 963      */
 964     void SetSizeThreshold(in double threshold) raises (SALOME::SALOME_Exception);
 965     double GetSizeThreshold();
 966
 967     /*!
 968      * \brief Return true if the grid is defined by spacing functions and
 969      *        not by node coordinates in given direction (X==0,...)
 970      */
 971     boolean IsGridBySpacing(in short axis);
 972
 973     /*!
 974      * Set coordinates of nodes along an axis (countered from zero)
 975      */
 976     void SetGrid(in SMESH::double_array  coords,
 977                  in short                axis) raises (SALOME::SALOME_Exception);
 978     SMESH::double_array GetGrid(in short axis) raises (SALOME::SALOME_Exception);
 979
 980     /*!
 981      * \brief Set grid spacing along an axis
 982      *  \param spaceFunctions - functions defining spacing values at given point on axis
 983      *  \param internalPoints - points dividing a grid into parts along an axis
 984      *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
 985      *
 986      * Parameter t of spaceFunction f(t) is a position [0,1] withing bounding box of
 987      * the shape to mesh or withing an interval defined by internal points
 988      */
 989     void SetGridSpacing(in SMESH::string_array spaceFunctions,
 990                         in SMESH::double_array internalPoints,
 991                         in short               axis) raises (SALOME::SALOME_Exception);
 992
 993     void GetGridSpacing(out SMESH::string_array spaceFunctions,
 994                         out SMESH::double_array internalPoints,
 995                         in short                axis) raises (SALOME::SALOME_Exception);
 996     /*!
 997      * Set custom direction of axes
 998      */
 999     void SetAxesDirs(in SMESH::DirStruct x,
1000                      in SMESH::DirStruct y,
1001                      in SMESH::DirStruct z ) raises (SALOME::SALOME_Exception);
1002     void GetAxesDirs(out SMESH::DirStruct x,
1003                      out SMESH::DirStruct y,
1004                      out SMESH::DirStruct z );
1005     /*!
1006      * Set/unset a fixed point, at which a node will be created provided that grid
1007      * is defined by spacing in all directions
1008      */
1009     void SetFixedPoint(in SMESH::PointStruct p, in boolean toUnset);
1010     boolean GetFixedPoint(out SMESH::PointStruct p);
1011
1012     /*!
1013      * Enables implementation of geometrical edges into the mesh. If this feature
1014      * is disabled, sharp edges of the shape are lost ("smoothed") in the mesh if
1015      * they don't coincide with the grid lines
1016      */
1017     void SetToAddEdges(in boolean toAdd);
1018     boolean GetToAddEdges();
1019
1020     /*!
1021      * Returns axes at which a number of generated hexahedra is maximal
1022      */
1023     void ComputeOptimalAxesDirs(in GEOM::GEOM_Object shape,
1024                                 in boolean           isOrthogonal,
1025                                 out SMESH::DirStruct x,
1026                                 out SMESH::DirStruct y,
1027                                 out SMESH::DirStruct z )
1028       raises (SALOME::SALOME_Exception);
1029
1030     /*!
1031      * \brief Computes node coordinates by spacing functions
1032      *  \param x0 - lower coordinate
1033      *  \param x1 - upper coordinate
1034      *  \param spaceFuns - space functions
1035      *  \param points - internal points
1036      *  \param axisName - e.g. "X"
1037      *  \return the computed coordinates
1038      */
1039     SMESH::double_array ComputeCoordinates(in double              x0,
1040                                            in double              x1,
1041                                            in SMESH::string_array spaceFuns,
1042                                            in SMESH::double_array points,
1043                                            in string              axisName )
1044       raises (SALOME::SALOME_Exception);
1045   };
1046
1047   /*!
1048    * StdMeshers_SegmentAroundVertex_0D: interface of "SegmentAroundVertex" algorithm
1049    */
1050   interface StdMeshers_SegmentAroundVertex_0D : SMESH::SMESH_0D_Algo
1051   {
1052   };
1053
1054   /*!
1055    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
1056    */
1057   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
1058   {
1059   };
1060
1061   /*!
1062    * StdMeshers_CompositeSegment_1D: interface of "Composite side discretisation" algorithm
1063    */
1064   interface StdMeshers_CompositeSegment_1D : SMESH::SMESH_1D_Algo
1065   {
1066   };
1067
1068   /*!
1069    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
1070    */
1071   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
1072   {
1073   };
1074
1075   /*!
1076    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
1077    */
1078   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
1079   {
1080   };
1081
1082   /*!
1083    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
1084    */
1085   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
1086   {
1087   };
1088
1089   /*!
1090    * StdMeshers_Prism_3D: interface of "3D extrusion" algorithm
1091    */
1092   interface StdMeshers_Prism_3D : SMESH::SMESH_3D_Algo
1093   {
1094   };
1095
1096   /*!
1097    * StdMeshers_RadialPrism_3D: interface of "Radial Prism" algorithm
1098    */
1099   interface StdMeshers_RadialPrism_3D : SMESH::SMESH_3D_Algo
1100   {
1101   };
1102
1103   /*!
1104    * StdMeshers_Projection_3D: interface of "Projection 3D" algorithm
1105    */
1106   interface StdMeshers_Projection_3D : SMESH::SMESH_3D_Algo
1107   {
1108   };
1109
1110   /*!
1111    * StdMeshers_Projection_2D: interface of "Projection 2D" algorithm
1112    */
1113   interface StdMeshers_Projection_2D : SMESH::SMESH_2D_Algo
1114   {
1115   };
1116
1117   /*!
1118    * StdMeshers_Projection_1D2D: interface of "Projection 1D-2D" algorithm
1119    */
1120   interface StdMeshers_Projection_1D2D : SMESH::SMESH_2D_Algo
1121   {
1122   };
1123
1124   /*!
1125    * StdMeshers_Projection_1D: interface of "Projection 1D" algorithm
1126    */
1127   interface StdMeshers_Projection_1D : SMESH::SMESH_1D_Algo
1128   {
1129   };
1130
1131   /*!
1132    * StdMeshers_UseExisting_2D: interface of "UseExisting 2D" algorithm
1133    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1134    */
1135   interface StdMeshers_UseExisting_2D : SMESH::SMESH_2D_Algo
1136   {
1137   };
1138
1139   /*!
1140    * StdMeshers_UseExisting_1D: interface of "UseExisting 1D" algorithm
1141    * doing nothing to allow mesh generation by mesh edition functions in TUI mode
1142    */
1143   interface StdMeshers_UseExisting_1D : SMESH::SMESH_1D_Algo
1144   {
1145   };
1146
1147   /*!
1148    * StdMeshers_RadialQuadrangle_1D2D: interface of "Radial quadrangle" algorithm
1149    */
1150   interface StdMeshers_RadialQuadrangle_1D2D : SMESH::SMESH_2D_Algo
1151   {
1152   };
1153
1154   /*!
1155    * StdMeshers_Import_1D2D: interface of "Use existing 2D elements" algorithm
1156    */
1157   interface StdMeshers_Import_1D2D : SMESH::SMESH_2D_Algo
1158   {
1159   };
1160   /*!
1161    * StdMeshers_Import_1D: interface of "Use existing 1D elements" algorithm
1162    */
1163   interface StdMeshers_Import_1D : SMESH::SMESH_1D_Algo
1164   {
1165   };
1166   /*!
1167    * StdMeshers_Cartesian_3D: interface of "Body fitting" algorithm
1168    */
1169   interface StdMeshers_Cartesian_3D : SMESH::SMESH_3D_Algo
1170   {
1171   };
1172
1173 };
1174
1175 #endif