idl/NETGENPlugin_Algorithm.idl

   1 // Copyright (C) 2007-2013  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.
  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_Hypothesis: interface of "NETGEN parameters" hypothesis
  71    */
  72   interface NETGENPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  73   {
  74     void SetMaxSize(in double value);
  75     double GetMaxSize();
  76
  77     void SetMinSize(in double value);
  78     double GetMinSize();
  79
  80     void SetSecondOrder(in boolean value);
  81     boolean GetSecondOrder();
  82
  83     void SetOptimize(in boolean value);
  84     boolean GetOptimize();
  85
  86     void SetFineness(in long value);
  87     long GetFineness();
  88
  89     void SetGrowthRate(in double value);
  90     double GetGrowthRate();
  91
  92     void SetNbSegPerEdge(in double value);
  93     double GetNbSegPerEdge();
  94
  95     void SetNbSegPerRadius(in double value);
  96     double GetNbSegPerRadius();
  97
  98     void SetQuadAllowed(in boolean value);
  99     boolean GetQuadAllowed();
 100
 101     void SetLocalSizeOnShape(in GEOM::GEOM_Object GeomObj, in double localSize);
 102     void SetLocalSizeOnEntry(in string entry, in double localSize);
 103     double GetLocalSizeOnEntry(in string entry);
 104     string_array GetLocalSizeEntries();
 105     void UnsetLocalSizeOnEntry(in string entry);
 106   };
 107
 108   /*!
 109    * NETGENPlugin_Hypothesis_2D: interface of "NETGEN 2D parameters" hypothesis
 110    */
 111   interface NETGENPlugin_Hypothesis_2D : NETGENPlugin_Hypothesis
 112   {
 113   };
 114
 115   /*!
 116    * interface of "NETGEN 2D parameters" hypothesis used by NETGENPlugin_NETGEN_2D_ONLY algoritm
 117    */
 118   interface NETGENPlugin_Hypothesis_2D_ONLY : NETGENPlugin_Hypothesis_2D
 119   {
 120   };
 121
 122   /*!
 123    * interface of "NETGEN 3D parameters" hypothesis used by NETGENPlugin_NETGEN_3D algorithm
 124    */
 125   interface NETGENPlugin_Hypothesis_3D : NETGENPlugin_Hypothesis
 126   {
 127   };
 128
 129   /*!
 130    * NETGENPlugin_Hypothesis: interface of "NETGEN 2D simple parameters" hypothesis
 131    */
 132   interface NETGENPlugin_SimpleHypothesis_2D : SMESH::SMESH_Hypothesis
 133   {
 134     /*!
 135      * Sets <number of segments> value
 136      */
 137     void SetNumberOfSegments(in short nb) raises (SALOME::SALOME_Exception);
 138     /*!
 139      * Returns <number of segments> value.
 140      * Can be zero in case if LocalLength() has been set
 141      */
 142     short GetNumberOfSegments();
 143
 144     /*!
 145      * Sets <segment length> value
 146      */
 147     void SetLocalLength(in double segmentLength);
 148     /*!
 149      * Returns <segment length> value.
 150      * Can be zero in case if NumberOfSegments() has been set
 151      */
 152     double GetLocalLength();
 153
 154     /*!
 155      * Sets <maximum element area> to be dependent on 1D discretization
 156      */
 157     void LengthFromEdges();
 158     /*!
 159      * Sets <maximum element area> value.
 160      * Zero or negative value means same as LengthFromEdges().
 161      */
 162     void SetMaxElementArea(in double area);
 163     /*!
 164      * Returns <maximum element area> value.
 165      * Can be zero in case of LengthFromEdges()
 166      */
 167     double GetMaxElementArea();
 168
 169     /*!
 170      * Enables/disables generation of quadrangular faces
 171      */
 172     void SetAllowQuadrangles(in boolean toAllow);
 173     /*!
 174      * Returns true if generation of quadrangular faces is enabled
 175      */
 176     boolean GetAllowQuadrangles();
 177   };
 178
 179   /*!
 180    * NETGENPlugin_SimpleHypothesis_3D: interface of "NETGEN 3D simple parameters" hypothesis
 181    */
 182   interface NETGENPlugin_SimpleHypothesis_3D : NETGENPlugin_SimpleHypothesis_2D
 183   {
 184     /*!
 185      * Sets <maximum element volume> to be dependent on 2D discretization
 186      */
 187     void LengthFromFaces();
 188     /*!
 189      * Sets <maximum element volume> value.
 190      * Zero or negative value means same as LengthFromFaces().
 191      */
 192     void SetMaxElementVolume(in double volume);
 193
 194     /*!
 195      * Returns <maximum element volume> value
 196      * Can be zero in case of LengthFromFaces()
 197      */
 198     double GetMaxElementVolume();
 199   };
 200
 201 };
 202
 203 #endif