idl/NETGENPlugin_Algorithm.idl

   1 //  Copyright (C) 2007-2008  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 //  File   : NETGENPlugin_Algorithm.idl
  23 //  Author : Julia DOROVSKIKH
  24 //  $Header$
  25 //
  26 #ifndef _SMESH_NETGENALGORITHM_IDL_
  27 #define _SMESH_NETGENALGORITHM_IDL_
  28
  29 #include "SALOME_Exception.idl"
  30 #include "SMESH_Hypothesis.idl"
  31
  32 /*!
  33  * NETGENPlugin: interfaces to NETGEN related hypotheses and algorithms
  34  */
  35 module NETGENPlugin
  36 {
  37   /*!
  38    * NETGENPlugin_NETGEN_3D: interface of "Tetrahedron (Netgen)" algorithm
  39    */
  40   interface NETGENPlugin_NETGEN_3D : SMESH::SMESH_3D_Algo
  41   {
  42   };
  43
  44   /*!
  45    * NETGENPlugin_NETGEN_2D: interface of "Netgen 1D-2D" algorithm
  46    */
  47   interface NETGENPlugin_NETGEN_2D : SMESH::SMESH_2D_Algo
  48   {
  49   };
  50
  51   /*!
  52    * NETGENPlugin_NETGEN_2D3D: interface of "Netgen 1D-2D-3D" algorithm
  53    */
  54   interface NETGENPlugin_NETGEN_2D3D : SMESH::SMESH_3D_Algo
  55   {
  56   };
  57
  58   /*!
  59    * NETGENPlugin_NETGEN_2D_ONLY: interface of "Netgen 2D" algorithm,
  60    * generating 2D elements on a geometrical face taking
  61    * into account pre-existing nodes on face boundaries
  62    */
  63   interface NETGENPlugin_NETGEN_2D_ONLY : SMESH::SMESH_2D_Algo
  64   {
  65   };
  66
  67   /*!
  68    * NETGENPlugin_Hypothesis: interface of "NETGEN parameters" hypothesis
  69    */
  70   interface NETGENPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  71   {
  72     void SetMaxSize(in double value);
  73     double GetMaxSize();
  74
  75     void SetSecondOrder(in boolean value);
  76     boolean GetSecondOrder();
  77
  78     void SetOptimize(in boolean value);
  79     boolean GetOptimize();
  80
  81     void SetFineness(in long value);
  82     long GetFineness();
  83
  84     void SetGrowthRate(in double value);
  85     double GetGrowthRate();
  86
  87     void SetNbSegPerEdge(in double value);
  88     double GetNbSegPerEdge();
  89
  90     void SetNbSegPerRadius(in double value);
  91     double GetNbSegPerRadius();
  92   };
  93
  94   /*!
  95    * NETGENPlugin_Hypothesis_2D: interface of "NETGEN 2D parameters" hypothesis
  96    */
  97   interface NETGENPlugin_Hypothesis_2D : NETGENPlugin_Hypothesis
  98   {
  99     void SetQuadAllowed(in boolean value);
 100     boolean GetQuadAllowed();
 101   };
 102
 103   /*!
 104    * NETGENPlugin_Hypothesis: interface of "NETGEN 2D simple parameters" hypothesis
 105    */
 106   interface NETGENPlugin_SimpleHypothesis_2D : SMESH::SMESH_Hypothesis
 107   {
 108     /*!
 109      * Sets <number of segments> value
 110      */
 111     void SetNumberOfSegments(in short nb) raises (SALOME::SALOME_Exception);
 112     /*!
 113      * Returns <number of segments> value.
 114      * Can be zero in case if LocalLength() has been set
 115      */
 116     short GetNumberOfSegments();
 117
 118     /*!
 119      * Sets <segment length> value
 120      */
 121     void SetLocalLength(in double segmentLength);
 122     /*!
 123      * Returns <segment length> value.
 124      * Can be zero in case if NumberOfSegments() has been set
 125      */
 126     double GetLocalLength();
 127
 128     /*!
 129      * Sets <maximum element area> to be dependent on 1D discretization
 130      */
 131     void LengthFromEdges();
 132     /*!
 133      * Sets <maximum element area> value.
 134      * Zero or negative value means same as LengthFromEdges().
 135      */
 136     void SetMaxElementArea(in double area);
 137     /*!
 138      * Returns <maximum element area> value.
 139      * Can be zero in case of LengthFromEdges()
 140      */
 141     double GetMaxElementArea();
 142   };
 143
 144   /*!
 145    * NETGENPlugin_SimpleHypothesis_3D: interface of "NETGEN 3D simple parameters" hypothesis
 146    */
 147   interface NETGENPlugin_SimpleHypothesis_3D : NETGENPlugin_SimpleHypothesis_2D
 148   {
 149     /*!
 150      * Sets <maximum element volume> to be dependent on 2D discretization
 151      */
 152     void LengthFromFaces();
 153     /*!
 154      * Sets <maximum element volume> value.
 155      * Zero or negative value means same as LengthFromFaces().
 156      */
 157     void SetMaxElementVolume(in double volume);
 158
 159     /*!
 160      * Returns <maximum element volume> value
 161      * Can be zero in case of LengthFromFaces()
 162      */
 163     double GetMaxElementVolume();
 164   };
 165
 166 };
 167
 168 #endif