idl/HYBRIDPlugin_Algorithm.idl

   1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
   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 // ---
  21 // File   : HYBRIDPlugin_Algorithm.idl
  22 // Author : Christian VAN WAMBEKE (CEA)
  23 // ---
  24 //
  25 #ifndef _HYBRID_Algorithm_IDL_
  26 #define _HYBRID_Algorithm_IDL_
  27
  28 #include "SALOME_Exception.idl"
  29 #include "SMESH_Hypothesis.idl"
  30 #include "SMESH_Mesh.idl"
  31
  32 /*!
  33  * HYBRIDPlugin: interfaces to HYBRID related hypotheses and algorithms
  34  */
  35 module HYBRIDPlugin
  36 {
  37   typedef sequence<double,3> TCoords;
  38   struct HYBRIDEnforcedVertex {
  39     string name;
  40     string geomEntry;
  41     boolean isCompound;
  42     TCoords coords;
  43     string groupName;
  44     double size;
  45   };
  46
  47   typedef sequence<HYBRIDEnforcedVertex> HYBRIDEnforcedVertexList;
  48
  49   struct HYBRIDEnforcedMesh {
  50     string name;
  51     string entry;
  52     SMESH::ElementType elementType;
  53     string groupName;
  54   };
  55
  56   typedef sequence<HYBRIDEnforcedMesh> HYBRIDEnforcedMeshList;
  57
  58   /*!
  59    * HYBRIDPlugin_HYBRID: interface of "Tetra-hexahedron (HYBRID)" algorithm
  60    */
  61   interface HYBRIDPlugin_HYBRID : SMESH::SMESH_3D_Algo
  62   {
  63     SMESH::SMESH_Mesh importGMFMesh(in string aGMFFileName);
  64   };
  65
  66   /*!
  67    * Parameters of "Tetra-hexahedron (HYBRID)" algorithm
  68    */
  69   interface HYBRIDPlugin_Hypothesis : SMESH::SMESH_Hypothesis
  70   {
  71     /*!
  72      * To mesh "holes" in a solid or not. Default is to mesh.
  73      */
  74     void SetToMeshHoles(in boolean toMesh);
  75     boolean GetToMeshHoles();
  76     /*!
  77      * To mesh layers on all wrap Default is yes.
  78      */
  79     void SetLayersOnAllWrap(in boolean toMesh);
  80     boolean GetLayersOnAllWrap();
  81     /*!
  82      * To make groups of volumes of different domains when mesh is generated from skin.
  83      * Default is to make groups.
  84      * This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
  85      */
  86     void SetToMakeGroupsOfDomains(in boolean toMakeGroups);
  87     boolean GetToMakeGroupsOfDomains();
  88     /*!
  89      * Maximal size of memory to be used by the algorithm (in Megabytes).
  90      * Negative value means not to use this option
  91      */
  92     void SetMaximumMemory(in double MB) raises (SALOME::SALOME_Exception);
  93     double GetMaximumMemory();
  94     /*!
  95      * Initial size of memory to be used by the algorithm (in Megabytes) in
  96      * automatic memory adjustment mode. Default is zero.
  97      * Negative value means not to use this option
  98      */
  99     void SetInitialMemory(in double MB) raises (SALOME::SALOME_Exception);
 100     double GetInitialMemory();
 101     /*!
 102      * Optimization level: 0-none, 1-light, 2-medium, 3-strong. Default is medium
 103      */
 104     void SetOptimizationLevel(in short level) raises (SALOME::SALOME_Exception);
 105     short GetOptimizationLevel();
 106
 107
 108     /*!
 109      * Collision mode: 0-decrease, 1-stop. Default is decrease
 110      */
 111     void SetCollisionMode(in short level) raises (SALOME::SALOME_Exception);
 112     short GetCollisionMode();
 113     /*!
 114      * BoundaryLayersGrowth: 0-Layer_Growth_Inward, 1-Layer_Growth_Outward. Default is Layer_Growth_Inward
 115      */
 116     void SetBoundaryLayersGrowth(in short level) raises (SALOME::SALOME_Exception);
 117     short GetBoundaryLayersGrowth();
 118     /*!
 119      * ElementGeneration: 0-Generation_Tetra_Dominant, 1-Generation_Hexa_Dominant. Default is Generation_Tetra_Dominant
 120      */
 121     void SetElementGeneration(in short level) raises (SALOME::SALOME_Exception);
 122     short GetElementGeneration();
 123
 124     /*!
 125      * To mesh adding extra normals at opening ridges and corners.
 126      * Default is no.
 127      */
 128     void SetAddMultinormals(in boolean toAddMultinormals);
 129     boolean GetAddMultinormals();
 130     /*!
 131      * To mesh smoothing normals at closed ridges and corners.
 132      * Default is no.
 133      */
 134     void SetSmoothNormals(in boolean toSmoothNormals);
 135     boolean GetSmoothNormals();
 136     /*!
 137      * To set height of the first layer.
 138      */
 139     void SetHeightFirstLayer(in double HFL) raises (SALOME::SALOME_Exception);
 140     double GetHeightFirstLayer();
 141     /*!
 142      * To set boundary layers coefficient of geometric progression.
 143      * Default is 1.0
 144      */
 145     void SetBoundaryLayersProgression(in double BLP) raises (SALOME::SALOME_Exception);
 146     double GetBoundaryLayersProgression();
 147     /*!
 148      * To set multinormals angle threshold at opening ridges.
 149      * Default is 30.0
 150      */
 151     void SetMultinormalsAngle(in double MNA) raises (SALOME::SALOME_Exception);
 152     double GetMultinormalsAngle();
 153     /*!
 154      * To set number of boundary layers.
 155      * Default is 1
 156      */
 157     void SetNbOfBoundaryLayers(in short NBL) raises (SALOME::SALOME_Exception);
 158     short GetNbOfBoundaryLayers();
 159
 160
 161
 162     /*!
 163      * Path to working directory
 164      */
 165     void SetWorkingDirectory(in string path) raises (SALOME::SALOME_Exception);
 166     string GetWorkingDirectory();
 167     /*!
 168      * To keep working files or remove them. Log file remains in case of errors anyway.
 169      */
 170     void SetKeepFiles(in boolean toKeep);
 171     boolean GetKeepFiles();
 172     /*!
 173      * Verbose level [0-10]
 174      *  0 - no standard output,
 175      *  2 - prints the data, quality statistics of the skin and final meshes and
 176      *     indicates when the final mesh is being saved. In addition the software
 177      *     gives indication regarding the CPU time.
 178      * 10 - same as 2 plus the main steps in the computation, quality statistics
 179      *     histogram of the skin mesh, quality statistics histogram together with
 180      *     the characteristics of the final mesh.
 181      */
 182     void SetVerboseLevel(in short level);
 183     short GetVerboseLevel();
 184     /*!
 185      * To create new nodes
 186      */
 187     void SetToCreateNewNodes(in boolean toCreate);
 188     boolean GetToCreateNewNodes();
 189     /*!
 190      * To use boundary recovery version which tries to create mesh on a very poor
 191      * quality surface mesh
 192      */
 193     void SetToUseBoundaryRecoveryVersion(in boolean toUse);
 194     boolean GetToUseBoundaryRecoveryVersion();
 195     /*!
 196      * Applies finite-element correction by replacing overconstrained elements where
 197      * it is possible. The process is cutting first the overconstrained edges and
 198      * second the overconstrained facets. This insure that no edges have two boundary
 199      * vertices and that no facets have three boundary vertices.
 200      */
 201     void SetFEMCorrection(in boolean toUseFem);
 202     boolean GetFEMCorrection();
 203     /*!
 204      * To removes initial central point.
 205      */
 206     void SetToRemoveCentralPoint(in boolean toRemove);
 207     boolean GetToRemoveCentralPoint();
 208     /*!
 209      * To set hiden/undocumented/advanced options
 210      */
 211     void SetAdvancedOption( in string optAndVals );
 212     string GetAdvancedOption();
 213     void SetTextOption(in string option); // obsolete
 214     string GetTextOption();
 215     /*!
 216      * To define the volumic gradation
 217      */
 218     void SetGradation(in double gradation);
 219     double GetGradation();
 220     /*!
 221      * Print log in standard output
 222      */
 223     void SetStandardOutputLog(in boolean logInStandardOutput);
 224     boolean GetStandardOutputLog();
 225     /*!
 226     * Remove log file on success
 227     */
 228     void SetRemoveLogOnSuccess(in boolean removeLogOnSuccess);
 229     boolean GetRemoveLogOnSuccess();
 230     /*!
 231      * To set an enforced vertex
 232      */
 233     boolean SetEnforcedVertex(in double x, in double y, in double z, in double size) raises (SALOME::SALOME_Exception);
 234     boolean SetEnforcedVertexNamed(in double x, in double y, in double z, in double size, in string vertexName) raises (SALOME::SALOME_Exception);
 235     boolean SetEnforcedVertexWithGroup(in double x, in double y, in double z, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 236     boolean SetEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in double size, in string vertexName, in string groupName) raises (SALOME::SALOME_Exception);
 237     boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex, in double size) raises (SALOME::SALOME_Exception);
 238     boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 239     double GetEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 240     double GetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 241     boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 242     boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 243     HYBRIDEnforcedVertexList GetEnforcedVertices();
 244     void ClearEnforcedVertices();
 245    /*!
 246     * Set/get/unset an enforced vertex (private method for GUI)
 247     */
 248     boolean p_SetEnforcedVertex(in double size, in double x, in double y, in double z,
 249                                 in string theVertexName, in string theVertexEntry, in string groupName,
 250                                 in boolean isCompound) raises (SALOME::SALOME_Exception);
 251
 252     boolean SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType) raises (SALOME::SALOME_Exception);
 253     boolean SetEnforcedMeshWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string groupName) raises (SALOME::SALOME_Exception);
 254
 255     /* OBSOLETE FUNCTIONS */
 256     boolean SetEnforcedMeshSize(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size) raises (SALOME::SALOME_Exception);
 257     boolean SetEnforcedMeshSizeWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size, in string groupName) raises (SALOME::SALOME_Exception);
 258     /* OBSOLETE FUNCTIONS */
 259
 260     HYBRIDEnforcedMeshList GetEnforcedMeshes();
 261     void ClearEnforcedMeshes();
 262
 263    /*!
 264     * Set/get/unset an enforced vertex (private method for GUI)
 265     */
 266     boolean p_SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string name, in string groupName) raises (SALOME::SALOME_Exception);
 267   };
 268 };
 269
 270 #endif