idl/NETGENPlugin_Algorithm.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   : NETGENPlugin_Algorithm.idl
  24 //  Author : Julia DOROVSKIKH
  25 //
  26 #ifndef _SMESH_NETGENALGORITHM_IDL_
  27 #define _SMESH_NETGENALGORITHM_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SMESH_Hypothesis.idl"
  31 #include "GEOM_Gen.idl"
  32
  33 /*!
  34  * NETGENPlugin: interfaces to NETGEN related hypotheses and algorithms
  35  */
  36 module NETGENPlugin
  37 {
  38   typedef sequence<string> string_array;
  39   /*!
  40    * NETGENPlugin_NETGEN_3D: interface of "Tetrahedron (Netgen)" algorithm
  41    */
  42   interface NETGENPlugin_NETGEN_3D : SMESH::SMESH_3D_Algo
  43   {
  44   };
  45
  46   /*!
  47    * NETGENPlugin_NETGEN_2D: interface of "Netgen 1D-2D" algorithm
  48    */
  49   interface NETGENPlugin_NETGEN_2D : SMESH::SMESH_2D_Algo
  50   {
  51   };
  52
  53   /*!
  54    * NETGENPlugin_NETGEN_2D3D: interface of "Netgen 1D-2D-3D" algorithm
  55    */
  56   interface NETGENPlugin_NETGEN_2D3D : SMESH::SMESH_3D_Algo
  57   {
  58   };
  59
  60   /*!
  61    * NETGENPlugin_NETGEN_2D_ONLY: interface of "Netgen 2D" algorithm,
  62    * generating 2D elements on a geometrical face taking
  63    * into account pre-existing nodes on face boundaries
  64    */
  65   interface NETGENPlugin_NETGEN_2D_ONLY : SMESH::SMESH_2D_Algo
  66   {
  67   };
  68
  69   /*!
  70    * NETGENPlugin_Remesher_2D: interface of "NETGEN Remesher" algorithm,
  71    * generating 2D elements basing on an existing 2D mesh
  72    */
  73   interface NETGENPlugin_Remesher_2D : SMESH::SMESH_2D_Algo
  74   {
  75   };
  76
  77   /*!
  78    * NETGENPlugin_Hypothesis: interface of "NETGEN parameters" hypothesis
  79    */
  80   interface NETGENPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  81   {
  82     void SetMaxSize(in double value);
  83     double GetMaxSize();
  84
  85     void SetMinSize(in double value);
  86     double GetMinSize();
  87
  88     void SetSecondOrder(in boolean value);
  89     boolean GetSecondOrder();
  90
  91     void SetOptimize(in boolean value);
  92     boolean GetOptimize();
  93
  94     void SetFineness(in long value);
  95     long GetFineness();
  96
  97     void SetGrowthRate(in double value);
  98     double GetGrowthRate();
  99
 100     void SetNbSegPerEdge(in double value);
 101     double GetNbSegPerEdge();
 102
 103     void SetChordalErrorEnabled(in boolean value);
 104     boolean GetChordalErrorEnabled();
 105     void SetChordalError(in double value);
 106     double GetChordalError();
 107
 108     void SetNbSegPerRadius(in double value);
 109     double GetNbSegPerRadius();
 110
 111     void SetQuadAllowed(in boolean value);
 112     boolean GetQuadAllowed();
 113
 114     void SetUseSurfaceCurvature(in boolean value);
 115     boolean GetUseSurfaceCurvature();
 116
 117     void SetFuseEdges(in boolean value);
 118     boolean GetFuseEdges();
 119
 120     void SetLocalSizeOnShape(in GEOM::GEOM_Object GeomObj, in double localSize)
 121       raises (SALOME::SALOME_Exception);
 122     void SetLocalSizeOnEntry(in string entry, in double localSize);
 123     double GetLocalSizeOnEntry(in string entry);
 124     string_array GetLocalSizeEntries();
 125     void UnsetLocalSizeOnEntry(in string entry);
 126
 127     void SetMeshSizeFile(in string fileName);
 128     string GetMeshSizeFile();
 129   };
 130
 131   /*!
 132    * NETGENPlugin_Hypothesis_2D: interface of "NETGEN 2D parameters" hypothesis
 133    */
 134   interface NETGENPlugin_Hypothesis_2D : NETGENPlugin_Hypothesis
 135   {
 136   };
 137
 138   /*!
 139    * interface of "NETGEN 2D parameters" hypothesis used by NETGENPlugin_NETGEN_2D_ONLY algoritm
 140    */
 141   interface NETGENPlugin_Hypothesis_2D_ONLY : NETGENPlugin_Hypothesis_2D
 142   {
 143   };
 144
 145   /*!
 146    * interface of "NETGEN 3D parameters" hypothesis used by NETGENPlugin_NETGEN_3D algorithm
 147    */
 148   interface NETGENPlugin_Hypothesis_3D : NETGENPlugin_Hypothesis
 149   {
 150   };
 151
 152   /*!
 153    * interface of "NETGEN Remesher parameters" hypothesis used by NETGENPlugin_Remesher_2D algoritm
 154    */
 155   interface NETGENPlugin_RemesherHypothesis_2D : NETGENPlugin_Hypothesis_2D
 156   {
 157     /*!
 158      * \brief Set/get ridge angle
 159      */
 160     void SetRidgeAngle(in double angle );
 161     double GetRidgeAngle();
 162   };
 163
 164   /*!
 165    * NETGENPlugin_Hypothesis: interface of "NETGEN 2D simple parameters" hypothesis
 166    */
 167   interface NETGENPlugin_SimpleHypothesis_2D : SMESH::SMESH_Hypothesis
 168   {
 169     /*!
 170      * Sets <number of segments> value
 171      */
 172     void SetNumberOfSegments(in short nb) raises (SALOME::SALOME_Exception);
 173     /*!
 174      * Returns <number of segments> value.
 175      * Can be zero in case if LocalLength() has been set
 176      */
 177     short GetNumberOfSegments();
 178
 179     /*!
 180      * Sets <segment length> value
 181      */
 182     void SetLocalLength(in double segmentLength);
 183     /*!
 184      * Returns <segment length> value.
 185      * Can be zero in case if NumberOfSegments() has been set
 186      */
 187     double GetLocalLength();
 188
 189     /*!
 190      * Sets <maximum element area> to be dependent on 1D discretization
 191      */
 192     void LengthFromEdges();
 193     /*!
 194      * Sets <maximum element area> value.
 195      * Zero or negative value means same as LengthFromEdges().
 196      */
 197     void SetMaxElementArea(in double area);
 198     /*!
 199      * Returns <maximum element area> value.
 200      * Can be zero in case of LengthFromEdges()
 201      */
 202     double GetMaxElementArea();
 203
 204     /*!
 205      * Enables/disables generation of quadrangular faces
 206      */
 207     void SetAllowQuadrangles(in boolean toAllow);
 208     /*!
 209      * Returns true if generation of quadrangular faces is enabled
 210      */
 211     boolean GetAllowQuadrangles();
 212   };
 213
 214   /*!
 215    * NETGENPlugin_SimpleHypothesis_3D: interface of "NETGEN 3D simple parameters" hypothesis
 216    */
 217   interface NETGENPlugin_SimpleHypothesis_3D : NETGENPlugin_SimpleHypothesis_2D
 218   {
 219     /*!
 220      * Sets <maximum element volume> to be dependent on 2D discretization
 221      */
 222     void LengthFromFaces();
 223     /*!
 224      * Sets <maximum element volume> value.
 225      * Zero or negative value means same as LengthFromFaces().
 226      */
 227     void SetMaxElementVolume(in double volume);
 228
 229     /*!
 230      * Returns <maximum element volume> value
 231      * Can be zero in case of LengthFromFaces()
 232      */
 233     double GetMaxElementVolume();
 234   };
 235
 236 };
 237
 238 #endif