1 // Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SMESH_BasicHypothesis.idl
24 // Author : Paul RASCLE, EDF
26 #ifndef _SMESH_BASICHYPOTHESIS_IDL_
27 #define _SMESH_BASICHYPOTHESIS_IDL_
29 #include "SALOME_Exception.idl"
30 #include "SMESH_Hypothesis.idl"
31 #include "SMESH_Mesh.idl"
34 * StdMeshers: interfaces to standard hypotheses and algorithms
39 * StdMeshers_LocalLength: interface of "Average length" hypothesis
41 interface StdMeshers_LocalLength : SMESH::SMESH_Hypothesis
44 * Sets <length> parameter value
46 void SetLength(in double length)
47 raises (SALOME::SALOME_Exception);
50 * Sets <precision> parameter value
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.
61 void SetPrecision(in double precision)
62 raises (SALOME::SALOME_Exception);
65 * Returns <length> parameter value
70 * Returns <precision> parameter value
72 double GetPrecision();
76 * StdMeshers_MaxLength: interface of "Max length" hypothesis
78 interface StdMeshers_MaxLength : SMESH::SMESH_Hypothesis
81 * Sets <length> parameter value
83 void SetLength(in double length)
84 raises (SALOME::SALOME_Exception);
86 * Returns <length> parameter value
90 * Returns true if preestemated length is defined
92 boolean HavePreestimatedLength();
94 * Returns preestemated length
96 double GetPreestimatedLength();
98 * Sets preestemated length
100 void SetPreestimatedLength(in double length);
102 * Sets boolean parameter enabling/desabling usage of length computed
103 * basing on size of bounding box of shape to mesh
105 void SetUsePreestimatedLength(in boolean toUse);
107 * Returns value of boolean parameter enabling/desabling usage of length computed
108 * basing on size of bounding box of shape to mesh
110 boolean GetUsePreestimatedLength();
114 * StdMeshers_AutomaticLength: interface of "Automatic length" hypothesis
116 interface StdMeshers_AutomaticLength : SMESH::SMESH_Hypothesis
119 * Sets Fineness parameter value
121 void SetFineness(in double theFineness)
122 raises (SALOME::SALOME_Exception);
125 * Returns <Fineness> parameter value
127 double GetFineness();
131 * StdMeshers_NumberOfSegments: interface of "Nb. Segments" hypothesis
133 interface StdMeshers_NumberOfSegments : SMESH::SMESH_Hypothesis
136 * Builds and returns point distribution according to passed density function
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);
144 * Sets <number of segments> parameter value
146 void SetNumberOfSegments(in long segmentsNumber)
147 raises (SALOME::SALOME_Exception);
150 * Returns <number of segments> parameter value
152 long GetNumberOfSegments();
155 * Sets <distribution type> parameter value
157 void SetDistrType(in long typ)
158 raises (SALOME::SALOME_Exception);
161 * Returns <distribution type> parameter value
166 * Sets <scale factor> parameter value
168 void SetScaleFactor(in double scaleFactor)
169 raises (SALOME::SALOME_Exception);
172 * Returns <scale factor> parameter value
174 double GetScaleFactor()
175 raises (SALOME::SALOME_Exception);
178 * Sets <table function> parameter value for distribution DT_TabFunc
180 void SetTableFunction(in SMESH::double_array table)
181 raises (SALOME::SALOME_Exception);
184 * Returns <table function> parameter value for distribution DT_TabFunc
186 SMESH::double_array GetTableFunction()
187 raises (SALOME::SALOME_Exception);
190 * Sets <expression function> parameter value for distribution DT_ExprFunc
192 void SetExpressionFunction(in string expr)
193 raises (SALOME::SALOME_Exception);
196 * Returns <expression function> parameter value for distribution DT_ExprFunc
198 string GetExpressionFunction()
199 raises (SALOME::SALOME_Exception);
202 * Sets <conversion mode> parameter value for functional distributions
204 void SetConversionMode(in long conv )
205 raises (SALOME::SALOME_Exception);
208 * Returns <conversion mode> parameter value for functional distributions
210 long ConversionMode()
211 raises (SALOME::SALOME_Exception);
214 * Set list of edges to reverse
216 void SetReversedEdges( in SMESH::long_array list );
219 * Returns list of edges to reverse
221 SMESH::long_array GetReversedEdges();
224 * Set entry of the main object
226 void SetObjectEntry( in string entry );
229 * Get the entry of the main object
231 string GetObjectEntry();
235 * StdMeshers_Arithmetic1D: interface of "Arithmetic 1D" hypothesis
237 interface StdMeshers_Arithmetic1D : SMESH::SMESH_Hypothesis
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.
244 void SetLength(in double length, in boolean isStartLength)
245 raises (SALOME::SALOME_Exception);
248 * Sets <start segment length> parameter value
250 void SetStartLength(in double length)
251 raises (SALOME::SALOME_Exception);
254 * Sets <end segment length> parameter value
256 void SetEndLength(in double length)
257 raises (SALOME::SALOME_Exception);
260 * Returns <start segment length> or <end segment length> parameter value
262 double GetLength(in boolean isStartLength);
265 * Set list of edges to reverse
267 void SetReversedEdges( in SMESH::long_array list );
270 * Returns list of edges to reverse
272 SMESH::long_array GetReversedEdges();
275 * Set entry of the main object
277 void SetObjectEntry( in string entry );
280 * Get the entry of the main object
282 string GetObjectEntry();
286 * StdMeshers_MaxElementArea: interface of "Max. Triangle Area" hypothesis
288 interface StdMeshers_MaxElementArea : SMESH::SMESH_Hypothesis
291 * Sets <maximum element area> parameter value
293 void SetMaxElementArea(in double area)
294 raises (SALOME::SALOME_Exception);
297 * Returns <maximum element area> parameter value
299 double GetMaxElementArea();
303 * StdMeshers_LengthFromEdges: interface of "Length From Edges (2D Hyp. for Triangulator)" hypothesis
305 interface StdMeshers_LengthFromEdges : SMESH::SMESH_Hypothesis
308 * Sets <mode> parameter value
310 void SetMode(in long mode)
311 raises (SALOME::SALOME_Exception);
314 * Returns <mode> parameter value
320 * StdMeshers_StartEndLength: interface of "Start and End Length" hypothesis
322 interface StdMeshers_StartEndLength : SMESH::SMESH_Hypothesis
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.
329 void SetLength(in double length, in boolean isStartLength)
330 raises (SALOME::SALOME_Exception);
333 * Sets <start segment length> parameter value
335 void SetStartLength(in double length)
336 raises (SALOME::SALOME_Exception);
339 * Sets <end segment length> parameter value
341 void SetEndLength(in double length)
342 raises (SALOME::SALOME_Exception);
345 * Returns <start segment length> or <end segment length> parameter value
347 double GetLength(in boolean isStartLength);
350 * Set list of edges to reverse
352 void SetReversedEdges( in SMESH::long_array list );
355 * Returns list of edges to reverse
357 SMESH::long_array GetReversedEdges();
360 * Set entry of the main object
362 void SetObjectEntry( in string entry );
365 * Get the entry of the main object
367 string GetObjectEntry();
372 * StdMeshers_Deflection1D: interface of "Deflection 1D" hypothesis
374 interface StdMeshers_Deflection1D : SMESH::SMESH_Hypothesis
377 * Sets <deflection> parameter value
379 void SetDeflection(in double deflection)
380 raises (SALOME::SALOME_Exception);
383 * Returns <deflection> parameter value
385 double GetDeflection();
390 * StdMeshers_FixedPoints1D: interface of "Fixed points 1D" hypothesis
392 interface StdMeshers_FixedPoints1D : SMESH::SMESH_Hypothesis
395 * Sets some points on edge using parameter on curve from 0 to 1
396 * (additionally it is neecessary to check orientation of edges and
397 * create list of reversed edges if it is needed) and sets numbers
398 * of segments between given points (default values are equals 1)
400 void SetPoints(in SMESH::double_array listParams)
401 raises (SALOME::SALOME_Exception);
402 void SetNbSegments(in SMESH::long_array listNbSeg)
403 raises (SALOME::SALOME_Exception);
406 * Returns list of point's parameters
408 SMESH::double_array GetPoints();
411 * Returns list of numbers of segments
413 SMESH::long_array GetNbSegments();
416 * Set list of edges to reverse
418 void SetReversedEdges( in SMESH::long_array list );
421 * Returns list of edges to reverse
423 SMESH::long_array GetReversedEdges();
426 * Set entry of the main object
428 void SetObjectEntry( in string entry );
431 * Get the entry of the main object
433 string GetObjectEntry();
438 * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
440 interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
443 * Sets <maximum element volume> parameter value
445 void SetMaxElementVolume(in double volume)
446 raises (SALOME::SALOME_Exception);
449 * Returns <maximum element volume> parameter value
451 double GetMaxElementVolume();
455 * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
456 * Presence of this hypothesis permits to algorithm generation of not conform mesh.
458 interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
463 * StdMeshers_Propagation: interface of "Propagation" hypothesis.
464 * Presence of this hypothesis on any edge propagates any other 1D
465 * hypothesis from this edge on all edges, opposite to it.
466 * It concerns only edges of quadrangle faces.
468 interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
473 * StdMeshers_QuadranglePreference: interface of "QuadranglePreference" hypothesis.
474 * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
475 * Presence of this hypothesis forces construction of quadrangles if the number
476 * of nodes on opposite edges is not the same in the case where the global number
477 * of nodes on edges is even
479 interface StdMeshers_QuadranglePreference : SMESH::SMESH_Hypothesis
484 * StdMeshers_TrianglePreference: interface of "TrianglePreference" hypothesis.
485 * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
486 * Presence of this hypothesis forces construction of triangles in the refinement
487 * area if the number of nodes on opposite edges is not the same.
489 interface StdMeshers_TrianglePreference : SMESH::SMESH_Hypothesis
494 * StdMeshers_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
495 * This is an auxiliary 1D hypothesis whose presence forces construction
496 * of quadratic edges.
497 * If the 2D mesher sees that all boundary edges are quadratic ones,
498 * it generates quadratic faces, else it generates linear faces using
499 * medium nodes as if they were vertex ones.
500 * The 3D mesher generates quadratic volumes only if all boundary faces
501 * are quadratic ones, else it fails.
503 interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
509 * StdMeshers_NumberOfLayers: interface of "Nb. Layers" hypothesis.
510 * This hypothesis is used by "Radial prism" algorithm.
511 * It specifies number of segments between the internal
512 * and the external surfaces.
514 interface StdMeshers_NumberOfLayers : SMESH::SMESH_Hypothesis
517 * Sets <number of segments> parameter value
519 void SetNumberOfLayers(in long numberOfLayers)
520 raises (SALOME::SALOME_Exception);
523 * Returns <number of layers> parameter value
525 long GetNumberOfLayers();
530 * StdMeshers_LayerDistribution: interface of "Distribution of Layers" hypothesis.
531 * This hypothesis is used by "Radial prism" algorithm.
532 * It specifies 1D hypothesis defining distribution of segments between the internal
533 * and the external surfaces.
535 interface StdMeshers_LayerDistribution : SMESH::SMESH_Hypothesis
538 * Sets 1D hypothesis specifying distribution of layers
540 void SetLayerDistribution(in SMESH::SMESH_Hypothesis distributionHyp)
541 raises (SALOME::SALOME_Exception);
544 * Returns 1D hypothesis specifying distribution of layers
546 SMESH::SMESH_Hypothesis GetLayerDistribution();
551 * StdMeshers_NumberOfLayers2D: interface of "Nb. Layers" hypothesis.
552 * This hypothesis is used by "Radial quadrangle" algorithm.
553 * It specifies number of segments between the internal
554 * and the external surfaces.
556 interface StdMeshers_NumberOfLayers2D : StdMeshers_NumberOfLayers
561 * StdMeshers_LayerDistribution2D: interface of "Distribution of Layers" hypothesis.
562 * This hypothesis is used by "Radial quadrangle" algorithm.
563 * It specifies 1D hypothesis defining distribution of segments between the internal
564 * and the external surfaces.
566 interface StdMeshers_LayerDistribution2D : StdMeshers_LayerDistribution
571 * interface of "ProjectionSource1D" hypothesis.
572 * This hypothesis specifies a meshed edge to take a mesh pattern from
573 * and optionally association of vertices between the source edge and a
574 * target one (where a hipothesis is assigned to)
576 interface StdMeshers_ProjectionSource1D : SMESH::SMESH_Hypothesis
579 * Sets source <edge> to take a mesh pattern from
581 void SetSourceEdge(in GEOM::GEOM_Object edge)
582 raises (SALOME::SALOME_Exception);
585 * Returns the source edge
587 GEOM::GEOM_Object GetSourceEdge();
590 * Sets source <mesh> to take a mesh pattern from
592 void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
597 SMESH::SMESH_Mesh GetSourceMesh();
600 * Sets vertex association between the source edge and the target one.
601 * This parameter is optional
603 void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex,
604 in GEOM::GEOM_Object targetVertex)
605 raises (SALOME::SALOME_Exception);
608 * Returns the vertex associated with the target vertex.
609 * Result may be nil if association not set
611 GEOM::GEOM_Object GetSourceVertex();
614 * Returns the vertex associated with the source vertex.
615 * Result may be nil if association not set
617 GEOM::GEOM_Object GetTargetVertex();
621 * interface of "ProjectionSource2D" hypothesis.
622 * This hypothesis specifies a meshed face to take a mesh pattern from
623 * and optionally association of vertices between the source face and a
624 * target one (where a hipothesis is assigned to)
626 interface StdMeshers_ProjectionSource2D : SMESH::SMESH_Hypothesis
629 * Sets a source <face> to take a mesh pattern from
631 void SetSourceFace(in GEOM::GEOM_Object face)
632 raises (SALOME::SALOME_Exception);
635 * Returns the source face
637 GEOM::GEOM_Object GetSourceFace();
640 * Sets source <mesh> to take a mesh pattern from
642 void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
647 SMESH::SMESH_Mesh GetSourceMesh();
650 * Sets vertex association between the source face and the target one.
651 * This parameter is optional.
652 * Two vertices must belong to one edge of a face
654 void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
655 in GEOM::GEOM_Object sourceVertex2,
656 in GEOM::GEOM_Object targetVertex1,
657 in GEOM::GEOM_Object targetVertex2)
658 raises (SALOME::SALOME_Exception);
661 * Returns the <i>-th source vertex associated with the <i>-th target vertex.
662 * Result may be nil if association not set.
663 * Valid indices are 1 and 2
665 GEOM::GEOM_Object GetSourceVertex(in long i)
666 raises (SALOME::SALOME_Exception);
669 * Returns the <i>-th target vertex associated with the <i>-th source vertex.
670 * Result may be nil if association not set.
671 * Valid indices are 1 and 2
673 GEOM::GEOM_Object GetTargetVertex(in long i)
674 raises (SALOME::SALOME_Exception);
678 * interface of "ProjectionSource3D" hypothesis.
679 * This hypothesis specifies a meshed shell or solid to take a mesh pattern from
680 * and optionally association of vertices between the source shape and a
681 * target one (where a hipothesis is assigned to)
683 interface StdMeshers_ProjectionSource3D : SMESH::SMESH_Hypothesis
686 * Sets a source <shape> to take a mesh pattern from
688 void SetSource3DShape(in GEOM::GEOM_Object shape)
689 raises (SALOME::SALOME_Exception);
692 * Returns the source shape
694 GEOM::GEOM_Object GetSource3DShape();
697 * Sets source <mesh> to take a mesh pattern from
699 void SetSourceMesh(in SMESH::SMESH_Mesh mesh);
704 SMESH::SMESH_Mesh GetSourceMesh();
707 * Sets vertex association between the source shape and the target one.
708 * This parameter is optional.
709 * Two vertices must belong to one edge of a shape
711 void SetVertexAssociation(in GEOM::GEOM_Object sourceVertex1,
712 in GEOM::GEOM_Object sourceVertex2,
713 in GEOM::GEOM_Object targetVertex1,
714 in GEOM::GEOM_Object targetVertex2)
715 raises (SALOME::SALOME_Exception);
718 * Returns the <i>-th source vertex associated with the <i>-th target vertex.
719 * Result may be nil if association not set.
720 * Valid indices are 1 and 2
722 GEOM::GEOM_Object GetSourceVertex(in long i)
723 raises (SALOME::SALOME_Exception);
726 * Returns the <i>-th target vertex associated with the <i>-th source vertex.
727 * Result may be nil if association not set.
728 * Valid indices are 1 and 2
730 GEOM::GEOM_Object GetTargetVertex(in long i)
731 raises (SALOME::SALOME_Exception);
735 * interface of "SegmentLengthAroundVertex" hypothesis.
736 * This hypothesis specifies length of segments adjacent to the vertex the
737 * hypothesis is assigned to
739 interface StdMeshers_SegmentLengthAroundVertex : SMESH::SMESH_Hypothesis
742 * Sets <length> parameter value
744 void SetLength(in double length)
745 raises (SALOME::SALOME_Exception);
748 * Returns <length> parameter value
754 * StdMeshers_QuadrangleParams: interface of "Quadrangle Params" hypothesis
756 interface StdMeshers_QuadrangleParams : SMESH::SMESH_Hypothesis
759 * Set base vertex for triangles
761 void SetTriaVertex( in long vertID );
764 * Returns base vertex for triangles
766 long GetTriaVertex();
769 * Set entry of the main object
771 void SetObjectEntry( in string entry );
774 * Get the entry of the main object
776 string GetObjectEntry();
780 * StdMeshers_SegmentAroundVertex_0D: interface of "SegmentAroundVertex" algorithm
782 interface StdMeshers_SegmentAroundVertex_0D : SMESH::SMESH_0D_Algo
787 * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
789 interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
794 * StdMeshers_CompositeSegment_1D: interface of "Composite side discretisation" algorithm
796 interface StdMeshers_CompositeSegment_1D : SMESH::SMESH_1D_Algo
801 * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
803 interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
808 * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
810 interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
815 * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
817 interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
822 * StdMeshers_Prism_3D: interface of "3D extrusion" algorithm
824 interface StdMeshers_Prism_3D : SMESH::SMESH_3D_Algo
829 * StdMeshers_RadialPrism_3D: interface of "Radial Prism" algorithm
831 interface StdMeshers_RadialPrism_3D : SMESH::SMESH_3D_Algo
836 * StdMeshers_Projection_3D: interface of "Projection 3D" algorithm
838 interface StdMeshers_Projection_3D : SMESH::SMESH_3D_Algo
843 * StdMeshers_Projection_2D: interface of "Projection 2D" algorithm
845 interface StdMeshers_Projection_2D : SMESH::SMESH_2D_Algo
850 * StdMeshers_Projection_1D: interface of "Projection 1D" algorithm
852 interface StdMeshers_Projection_1D : SMESH::SMESH_1D_Algo
857 * StdMeshers_UseExisting_2D: interface of "UseExisting 2D" algorithm
858 * doing nothing to allow mesh generation by mesh edition functions in TUI mode
860 interface StdMeshers_UseExisting_2D : SMESH::SMESH_2D_Algo
865 * StdMeshers_UseExisting_1D: interface of "UseExisting 1D" algorithm
866 * doing nothing to allow mesh generation by mesh edition functions in TUI mode
868 interface StdMeshers_UseExisting_1D : SMESH::SMESH_1D_Algo
873 * StdMeshers_RadialQuadrangle_1D2D: interface of "Radial quadrangle" algorithm
875 interface StdMeshers_RadialQuadrangle_1D2D : SMESH::SMESH_2D_Algo