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