idl/SMESH_BasicHypothesis.idl

   1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 //
  20 //
  21 //
  22 //  File   : SMESH_BasicHypothesis.idl
  23 //  Author : Paul RASCLE, EDF
  24
  25 #ifndef _SMESH_BASICHYPOTHESIS_IDL_
  26 #define _SMESH_BASICHYPOTHESIS_IDL_
  27
  28 #include "SALOME_Exception.idl"
  29 #include "SMESH_Hypothesis.idl"
  30 #include "SMESH_Mesh.idl"
  31
  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      * Returns <length> parameter value
  51      */
  52     double GetLength();
  53   };
  54
  55   /*!
  56    * StdMeshers_AutomaticLength: interface of "Automatic length" hypothesis
  57    */
  58   interface StdMeshers_AutomaticLength : SMESH::SMESH_Hypothesis
  59   {
  60     /*!
  61      * Sets Fineness parameter value
  62      */
  63     void SetFineness(in double theFineness)
  64       raises (SALOME::SALOME_Exception);
  65
  66     /*!
  67      * Returns <Fineness> parameter value
  68      */
  69     double GetFineness();
  70   };
  71
  72   /*!
  73    * StdMeshers_NumberOfSegments: interface of "Nb. Segments" hypothesis
  74    */
  75   interface StdMeshers_NumberOfSegments : SMESH::SMESH_Hypothesis
  76   {
  77     /*!
  78      * Builds and returns point distribution according to passed density function
  79      */
  80     SMESH::double_array BuildDistributionExpr( in string func, in long nbSeg, in long conv )
  81       raises (SALOME::SALOME_Exception);
  82     SMESH::double_array BuildDistributionTab( in SMESH::double_array func, in long nbSeg, in long conv )
  83       raises (SALOME::SALOME_Exception);
  84
  85     /*!
  86      * Sets <number of segments> parameter value
  87      */
  88     void SetNumberOfSegments(in long segmentsNumber)
  89       raises (SALOME::SALOME_Exception);
  90
  91     /*!
  92      * Returns <number of segments> parameter value
  93      */
  94     long GetNumberOfSegments();
  95
  96     /*!
  97      * Sets <distribution type> parameter value
  98      */
  99     void SetDistrType(in long typ)
 100       raises (SALOME::SALOME_Exception);
 101
 102     /*!
 103      * Returns <distribution type> parameter value
 104      */
 105     long GetDistrType();
 106
 107     /*!
 108      * Sets <scale factor> parameter value
 109      */
 110     void SetScaleFactor(in double scaleFactor)
 111       raises (SALOME::SALOME_Exception);
 112
 113     /*!
 114      * Returns <scale factor> parameter value
 115      */
 116     double GetScaleFactor()
 117       raises (SALOME::SALOME_Exception);
 118
 119     /*!
 120      * Sets <table function> parameter value for distribution DT_TabFunc
 121      */
 122     void SetTableFunction(in SMESH::double_array table)
 123       raises (SALOME::SALOME_Exception);
 124
 125     /*!
 126      * Returns <table function> parameter value for distribution DT_TabFunc
 127      */
 128     SMESH::double_array GetTableFunction()
 129       raises (SALOME::SALOME_Exception);
 130
 131     /*!
 132      * Sets <expression function> parameter value for distribution DT_ExprFunc
 133      */
 134     void SetExpressionFunction(in string expr)
 135       raises (SALOME::SALOME_Exception);
 136
 137     /*!
 138      * Returns <expression function> parameter value for distribution DT_ExprFunc
 139      */
 140     string GetExpressionFunction()
 141       raises (SALOME::SALOME_Exception);
 142
 143     /*!
 144      * Sets <conversion mode> parameter value for functional distributions
 145      */
 146     void SetConversionMode(in long conv )
 147       raises (SALOME::SALOME_Exception);
 148
 149     /*!
 150      * Returns <conversion mode> parameter value for functional distributions
 151      */
 152     long ConversionMode()
 153       raises (SALOME::SALOME_Exception);
 154   };
 155
 156   /*!
 157    * StdMeshers_Arithmetic1D: interface of "Arithmetic 1D" hypothesis
 158    */
 159   interface StdMeshers_Arithmetic1D : SMESH::SMESH_Hypothesis
 160   {
 161     /*!
 162      * Sets <start segment length> or <end segment length> parameter value
 163      */
 164     void SetLength(in double length, in boolean isStartLength)
 165       raises (SALOME::SALOME_Exception);
 166
 167     /*!
 168      * Returns <start segment length> or <end segment length> parameter value
 169      */
 170     double GetLength(in boolean isStartLength);
 171   };
 172
 173   /*!
 174    * StdMeshers_MaxElementArea: interface of "Max. Triangle Area" hypothesis
 175    */
 176   interface StdMeshers_MaxElementArea : SMESH::SMESH_Hypothesis
 177   {
 178     /*!
 179      * Sets <maximum element area> parameter value
 180      */
 181     void SetMaxElementArea(in double area)
 182       raises (SALOME::SALOME_Exception);
 183
 184     /*!
 185      * Returns <maximum element area> parameter value
 186      */
 187     double GetMaxElementArea();
 188   };
 189
 190   /*!
 191    * StdMeshers_LengthFromEdges: interface of "Length From Edges (2D Hyp. for Triangulator)" hypothesis
 192    */
 193   interface StdMeshers_LengthFromEdges : SMESH::SMESH_Hypothesis
 194   {
 195     /*!
 196      * Sets <mode> parameter value
 197      */
 198     void SetMode(in long mode)
 199       raises (SALOME::SALOME_Exception);
 200
 201     /*!
 202      * Returns <mode> parameter value
 203      */
 204     long GetMode();
 205   };
 206
 207   /*!
 208    * StdMeshers_StartEndLength: interface of "Start and End Length" hypothesis
 209    */
 210   interface StdMeshers_StartEndLength : SMESH::SMESH_Hypothesis
 211   {
 212     /*!
 213      * Sets <start segment length> or <end segment length> parameter value
 214      */
 215     void SetLength(in double length, in boolean isStartLength)
 216       raises (SALOME::SALOME_Exception);
 217
 218     /*!
 219      * Returns <start segment length> or <end segment length> parameter value
 220      */
 221     double GetLength(in boolean isStartLength);
 222   };
 223
 224
 225   /*!
 226    * StdMeshers_Deflection1D: interface of "Deflection 1D" hypothesis
 227    */
 228   interface StdMeshers_Deflection1D : SMESH::SMESH_Hypothesis
 229   {
 230     /*!
 231      * Sets <deflection> parameter value
 232      */
 233     void SetDeflection(in double deflection)
 234       raises (SALOME::SALOME_Exception);
 235
 236     /*!
 237      * Returns <deflection> parameter value
 238      */
 239     double GetDeflection();
 240   };
 241
 242
 243   /*!
 244    * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
 245    */
 246   interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
 247   {
 248     /*!
 249      * Sets <maximum element volume> parameter value
 250      */
 251     void SetMaxElementVolume(in double volume)
 252       raises (SALOME::SALOME_Exception);
 253
 254     /*!
 255      * Returns <maximum element volume> parameter value
 256      */
 257     double GetMaxElementVolume();
 258   };
 259
 260   /*!
 261    * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
 262    * Presence of this hypothesis permits to algorithm generation of not conform mesh.
 263    */
 264   interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
 265   {
 266   };
 267
 268   /*!
 269    * StdMeshers_Propagation: interface of "Propagation" hypothesis.
 270    * Presence of this hypothesis on any edge propagates any other 1D
 271    * hypothesis from this edge on all edges, opposite to it.
 272    * It concerns only edges of quadrangle faces.
 273    */
 274   interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
 275   {
 276   };
 277
 278   /*!
 279    * StdMeshers_QuadranglePreference: interface of "QuadranglePreference" hypothesis.
 280    * This hypothesis is used by StdMeshers_Quadrangle_2D algorithm.
 281    * Presence of this hypothesis forces construction of quadrangles if the number
 282    * of nodes on opposite edges is not the same in the case where the global number
 283    * of nodes on edges is even
 284    */
 285   interface StdMeshers_QuadranglePreference : SMESH::SMESH_Hypothesis
 286   {
 287   };
 288
 289   /*!
 290    * StdMeshers_QuadraticMesh: interface of "QuadraticMesh" hypothesis.
 291    * This is an auxiliary 1D hypothesis whose presence forces construction
 292    * of quadratic edges.
 293    * If the 2D mesher sees that all boundary edges are quadratic ones,
 294    * it generates quadratic faces, else it generates linear faces using
 295    * medium nodes as if they were vertex ones.
 296    * The 3D mesher generates quadratic volumes only if all boundary faces
 297    * are quadratic ones, else it fails.
 298    */
 299   interface StdMeshers_QuadraticMesh : SMESH::SMESH_Hypothesis
 300   {
 301   };
 302
 303
 304   /*!
 305    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
 306    */
 307   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
 308   {
 309   };
 310
 311   /*!
 312    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
 313    */
 314   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
 315   {
 316   };
 317
 318   /*!
 319    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
 320    */
 321   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
 322   {
 323   };
 324
 325   /*!
 326    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
 327    */
 328   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
 329   {
 330   };
 331
 332 };
 333
 334 #endif