idl/HYBRIDPlugin_Algorithm.idl

   1 // Copyright (C) 2004-2013  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 //  File   : HYBRID_Algorithm.idl
  21 //  Author : Julia DOROVSKIKH
  22 //
  23 #ifndef _HYBRID_Algorithm_IDL_
  24 #define _HYBRID_Algorithm_IDL_
  25
  26 #include "SALOME_Exception.idl"
  27 #include "SMESH_Hypothesis.idl"
  28 #include "SMESH_Mesh.idl"
  29
  30 /*!
  31  * HYBRIDPlugin: interfaces to HYBRID related hypotheses and algorithms
  32  */
  33 module HYBRIDPlugin
  34 {
  35   typedef sequence<double,3> TCoords;
  36   struct HYBRIDEnforcedVertex {
  37     string name;
  38     string geomEntry;
  39     boolean isCompound;
  40     TCoords coords;
  41     string groupName;
  42     double size;
  43   };
  44
  45   typedef sequence<HYBRIDEnforcedVertex> HYBRIDEnforcedVertexList;
  46
  47   struct HYBRIDEnforcedMesh {
  48     string name;
  49     string entry;
  50     SMESH::ElementType elementType;
  51     string groupName;
  52   };
  53
  54   typedef sequence<HYBRIDEnforcedMesh> HYBRIDEnforcedMeshList;
  55
  56   /*!
  57    * HYBRIDPlugin_HYBRID: interface of "Tetrahedron (HYBRID)" algorithm
  58    */
  59   interface HYBRIDPlugin_HYBRID : SMESH::SMESH_3D_Algo
  60   {
  61     SMESH::SMESH_Mesh importGMFMesh(in string aGMFFileName);
  62   };
  63
  64   /*!
  65    * Parameters of "Tetrahedron (HYBRID)" algorithm
  66    */
  67   interface HYBRIDPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  68   {
  69     /*!
  70      * To mesh "holes" in a solid or not. Default is to mesh.
  71      */
  72     void SetToMeshHoles(in boolean toMesh);
  73     boolean GetToMeshHoles();
  74     /*!
  75      * To make groups of volumes of different domains when mesh is generated from skin.
  76      * Default is to make groups.
  77      * This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
  78      */
  79     void SetToMakeGroupsOfDomains(in boolean toMakeGroups);
  80     boolean GetToMakeGroupsOfDomains();
  81     /*!
  82      * Maximal size of memory to be used by the algorithm (in Megabytes).
  83      * Negative value means not to use this option
  84      */
  85     void SetMaximumMemory(in double MB) raises (SALOME::SALOME_Exception);
  86     double GetMaximumMemory();
  87     /*!
  88      * Initial size of memory to be used by the algorithm (in Megabytes) in
  89      * automatic memory adjustment mode. Default is zero.
  90      * Negative value means not to use this option
  91      */
  92     void SetInitialMemory(in double MB) raises (SALOME::SALOME_Exception);
  93     double GetInitialMemory();
  94     /*!
  95      * Optimization level: 0-none, 1-light, 2-medium, 3-strong. Default is medium
  96      */
  97     void SetOptimizationLevel(in short level) raises (SALOME::SALOME_Exception);
  98     short GetOptimizationLevel();
  99
 100
 101     /*!
 102      * To mesh Boundary Layers growing inward or outward.
 103      * Default is inward.
 104      */
 105     void SetBoundaryLayersInward(in boolean toBoundaryLayersInward);
 106     boolean GetBoundaryLayersInward();
 107     /*!
 108      * To mesh with element type Tetra Dominant or hexa Dominant in the boundary layers.
 109      * Default is Tetra Dominant.
 110      */
 111     void SetElemGenTetraDominant(in boolean toElemGenTetraDominant);
 112     boolean GetElemGenTetraDominant();
 113     /*!
 114      * To mesh adding extra normals at opening ridges and corners.
 115      * Default is no.
 116      */
 117     void SetAddMultinormals(in boolean toAddMultinormals);
 118     boolean GetAddMultinormals();
 119     /*!
 120      * To mesh smoothing normals at closed ridges and corners.
 121      * Default is no.
 122      */
 123     void SetSmoothNormals(in boolean toSmoothNormals);
 124     boolean GetSmoothNormals();
 125     /*!
 126      * To set height of the first layer.
 127      */
 128     void SetHeightFirstLayer(in double HFL) raises (SALOME::SALOME_Exception);
 129     double GetHeightFirstLayer();
 130     /*!
 131      * To set boundary layers coefficient of geometric progression.
 132      * Default is 1.0
 133      */
 134     void SetBoundaryLayersProgression(in double BLP) raises (SALOME::SALOME_Exception);
 135     double GetBoundaryLayersProgression();
 136     /*!
 137      * To set multinormals angle threshold at opening ridges.
 138      * Default is 30.0
 139      */
 140     void SetMultinormalsAngle(in double MNA) raises (SALOME::SALOME_Exception);
 141     double GetMultinormalsAngle();
 142     /*!
 143      * To set number of boundary layers.
 144      * Default is 1
 145      */
 146     void SetNbOfBoundaryLayers(in short NBL) raises (SALOME::SALOME_Exception);
 147     short GetNbOfBoundaryLayers();
 148
 149
 150
 151     /*!
 152      * Path to working directory
 153      */
 154     void SetWorkingDirectory(in string path) raises (SALOME::SALOME_Exception);
 155     string GetWorkingDirectory();
 156     /*!
 157      * To keep working files or remove them. Log file remains in case of errors anyway.
 158      */
 159     void SetKeepFiles(in boolean toKeep);
 160     boolean GetKeepFiles();
 161     /*!
 162      * Verbose level [0-10]
 163      *  0 - no standard output,
 164      *  2 - prints the data, quality statistics of the skin and final meshes and
 165      *     indicates when the final mesh is being saved. In addition the software
 166      *     gives indication regarding the CPU time.
 167      * 10 - same as 2 plus the main steps in the computation, quality statistics
 168      *     histogram of the skin mesh, quality statistics histogram together with
 169      *     the characteristics of the final mesh.
 170      */
 171     void SetVerboseLevel(in short level);
 172     short GetVerboseLevel();
 173     /*!
 174      * To create new nodes
 175      */
 176     void SetToCreateNewNodes(in boolean toCreate);
 177     boolean GetToCreateNewNodes();
 178     /*!
 179      * To use boundary recovery version which tries to create mesh on a very poor
 180      * quality surface mesh
 181      */
 182     void SetToUseBoundaryRecoveryVersion(in boolean toUse);
 183     boolean GetToUseBoundaryRecoveryVersion();
 184     /*!
 185      * Applies finite-element correction by replacing overconstrained elements where
 186      * it is possible. The process is cutting first the overconstrained edges and
 187      * second the overconstrained facets. This insure that no edges have two boundary
 188      * vertices and that no facets have three boundary vertices.
 189      */
 190     void SetFEMCorrection(in boolean toUseFem);
 191     boolean GetFEMCorrection();
 192     /*!
 193      * To removes initial central point.
 194      */
 195     void SetToRemoveCentralPoint(in boolean toRemove);
 196     boolean GetToRemoveCentralPoint();
 197     /*!
 198      * To set hiden/undocumented/advanced options
 199      */
 200     void SetTextOption(in string option);
 201     string GetTextOption();
 202     /*!
 203      * To define the volumic gradation
 204      */
 205     void SetGradation(in double gradation);
 206     double GetGradation();
 207     /*!
 208      * Print log in standard output
 209      */
 210     void SetStandardOutputLog(in boolean logInStandardOutput);
 211     boolean GetStandardOutputLog();
 212     /*!
 213     * Remove log file on success
 214     */
 215     void SetRemoveLogOnSuccess(in boolean removeLogOnSuccess);
 216     boolean GetRemoveLogOnSuccess();
 217     /*!
 218      * To set an enforced vertex
 219      */
 220     boolean SetEnforcedVertex(in double x, in double y, in double z, in double size) raises (SALOME::SALOME_Exception);
 221     boolean SetEnforcedVertexNamed(in double x, in double y, in double z, in double size, in string vertexName) raises (SALOME::SALOME_Exception);
 222     boolean SetEnforcedVertexWithGroup(in double x, in double y, in double z, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 223     boolean SetEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in double size, in string vertexName, in string groupName) raises (SALOME::SALOME_Exception);
 224     boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex, in double size) raises (SALOME::SALOME_Exception);
 225     boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 226     double GetEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 227     double GetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 228     boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 229     boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 230     HYBRIDEnforcedVertexList GetEnforcedVertices();
 231     void ClearEnforcedVertices();
 232    /*!
 233     * Set/get/unset an enforced vertex (private method for GUI)
 234     */
 235     boolean p_SetEnforcedVertex(in double size, in double x, in double y, in double z,
 236                                 in string theVertexName, in string theVertexEntry, in string groupName,
 237                                 in boolean isCompound) raises (SALOME::SALOME_Exception);
 238
 239     boolean SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType) raises (SALOME::SALOME_Exception);
 240     boolean SetEnforcedMeshWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string groupName) raises (SALOME::SALOME_Exception);
 241
 242     /* OBSOLETE FUNCTIONS */
 243     boolean SetEnforcedMeshSize(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size) raises (SALOME::SALOME_Exception);
 244     boolean SetEnforcedMeshSizeWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 245     /* OBSOLETE FUNCTIONS */
 246
 247     HYBRIDEnforcedMeshList GetEnforcedMeshes();
 248     void ClearEnforcedMeshes();
 249
 250    /*!
 251     * Set/get/unset an enforced vertex (private method for GUI)
 252     */
 253     boolean p_SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string name, in string groupName) raises (SALOME::SALOME_Exception);
 254   };
 255 };
 256
 257 #endif