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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  19 //
  20 //
  21 //
  22 //  File   : SMESH_BasicHypothesis.idl
  23 //  Author : Paul RASCLE, EDF
  24 //  $Header$
  25
  26 #ifndef _SMESH_BASICHYPOTHESIS_IDL_
  27 #define _SMESH_BASICHYPOTHESIS_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SMESH_Hypothesis.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_NumberOfSegments: interface of "Nb. Segments" hypothesis
  57    */
  58   interface StdMeshers_NumberOfSegments : SMESH::SMESH_Hypothesis
  59   {
  60     /*!
  61      * Sets <number of segments> parameter value
  62      */
  63     void SetNumberOfSegments(in long segmentsNumber)
  64       raises (SALOME::SALOME_Exception);
  65
  66     /*!
  67      * Returns <number of segments> parameter value
  68      */
  69     long GetNumberOfSegments();
  70
  71     /*!
  72      * Sets <scale factor> parameter value
  73      */
  74     void SetScaleFactor(in double scaleFactor)
  75       raises (SALOME::SALOME_Exception);
  76
  77     /*!
  78      * Returns <scale factor> parameter value
  79      */
  80     double GetScaleFactor();
  81   };
  82
  83   /*!
  84    * StdMeshers_Arithmetic1D: interface of "Arithmetic 1D" hypothesis
  85    */
  86   interface StdMeshers_Arithmetic1D : SMESH::SMESH_Hypothesis
  87   {
  88     /*!
  89      * Sets <start segment length> or <end segment length> parameter value
  90      */
  91     void SetLength(in double length, in boolean isStartLength)
  92       raises (SALOME::SALOME_Exception);
  93
  94     /*!
  95      * Returns <start segment length> or <end segment length> parameter value
  96      */
  97     double GetLength(in boolean isStartLength);
  98   };
  99
 100   /*!
 101    * StdMeshers_MaxElementArea: interface of "Max. Triangle Area" hypothesis
 102    */
 103   interface StdMeshers_MaxElementArea : SMESH::SMESH_Hypothesis
 104   {
 105     /*!
 106      * Sets <maximum element area> parameter value
 107      */
 108     void SetMaxElementArea(in double area)
 109       raises (SALOME::SALOME_Exception);
 110
 111     /*!
 112      * Returns <maximum element area> parameter value
 113      */
 114     double GetMaxElementArea();
 115   };
 116
 117   /*!
 118    * StdMeshers_LengthFromEdges: interface of "Length From Edges (2D Hyp. for Triangulator)" hypothesis
 119    */
 120   interface StdMeshers_LengthFromEdges : SMESH::SMESH_Hypothesis
 121   {
 122     /*!
 123      * Sets <mode> parameter value
 124      */
 125     void SetMode(in long mode)
 126       raises (SALOME::SALOME_Exception);
 127
 128     /*!
 129      * Returns <mode> parameter value
 130      */
 131     long GetMode();
 132   };
 133
 134   /*!
 135    * StdMeshers_StartEndLength: interface of "Start and End Length" hypothesis
 136    */
 137   interface StdMeshers_StartEndLength : SMESH::SMESH_Hypothesis
 138   {
 139     /*!
 140      * Sets <start segment length> or <end segment length> parameter value
 141      */
 142     void SetLength(in double length, in boolean isStartLength)
 143       raises (SALOME::SALOME_Exception);
 144
 145     /*!
 146      * Returns <start segment length> or <end segment length> parameter value
 147      */
 148     double GetLength(in boolean isStartLength);
 149   };
 150
 151
 152   /*!
 153    * StdMeshers_Deflection1D: interface of "Deflection 1D" hypothesis
 154    */
 155   interface StdMeshers_Deflection1D : SMESH::SMESH_Hypothesis
 156   {
 157     /*!
 158      * Sets <deflection> parameter value
 159      */
 160     void SetDeflection(in double deflection)
 161       raises (SALOME::SALOME_Exception);
 162
 163     /*!
 164      * Returns <deflection> parameter value
 165      */
 166     double GetDeflection();
 167   };
 168
 169
 170   /*!
 171    * StdMeshers_MaxElementVolume: interface of "Max. Hexahedron or Tetrahedron Volume" hypothesis
 172    */
 173   interface StdMeshers_MaxElementVolume : SMESH::SMESH_Hypothesis
 174   {
 175     /*!
 176      * Sets <maximum element volume> parameter value
 177      */
 178     void SetMaxElementVolume(in double volume)
 179       raises (SALOME::SALOME_Exception);
 180
 181     /*!
 182      * Returns <maximum element volume> parameter value
 183      */
 184     double GetMaxElementVolume();
 185   };
 186
 187   /*!
 188    * StdMeshers_NotConformAllowed: interface of "Not Conform Mesh Allowed" hypothesis.
 189    * Presence of this hypothesis permits to algorithm generation of not conform mesh.
 190    */
 191   interface StdMeshers_NotConformAllowed : SMESH::SMESH_Hypothesis
 192   {
 193   };
 194
 195   /*!
 196    * StdMeshers_Propagation: interface of "Propagation" hypothesis.
 197    * Presence of this hypothesis on any edge propagates any other 1D
 198    * hypothesis from this edge on all edges, opposite to it.
 199    * It concerns only edges of quadrangle faces.
 200    */
 201   interface StdMeshers_Propagation : SMESH::SMESH_Hypothesis
 202   {
 203   };
 204
 205   /*!
 206    * StdMeshers_Regular_1D: interface of "Wire discretisation" algorithm
 207    */
 208   interface StdMeshers_Regular_1D : SMESH::SMESH_1D_Algo
 209   {
 210   };
 211
 212   /*!
 213    * StdMeshers_MEFISTO_2D: interface of "Triangle (Mefisto)" algorithm
 214    */
 215   interface StdMeshers_MEFISTO_2D : SMESH::SMESH_2D_Algo
 216   {
 217   };
 218
 219   /*!
 220    * StdMeshers_Quadrangle_2D: interface of "Quadrangle (Mapping)" algorithm
 221    */
 222   interface StdMeshers_Quadrangle_2D : SMESH::SMESH_2D_Algo
 223   {
 224   };
 225
 226   /*!
 227    * StdMeshers_Hexa_3D: interface of "Hexahedron (i,j,k)" algorithm
 228    */
 229   interface StdMeshers_Hexa_3D : SMESH::SMESH_3D_Algo
 230   {
 231   };
 232
 233 };
 234
 235 #endif