src/HYBRIDPlugin/HYBRIDPlugin_Hypothesis_i.hxx

   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_Hypothesis_i.hxx
  22 // Author : Christian VAN WAMBEKE (CEA)
  23 // ---
  24 //
  25 #ifndef _HYBRIDPlugin_Hypothesis_i_HXX_
  26 #define _HYBRIDPlugin_Hypothesis_i_HXX_
  27
  28 #include "HYBRIDPlugin_Defs.hxx"
  29
  30 #include <SALOMEconfig.h>
  31 #include CORBA_SERVER_HEADER(HYBRIDPlugin_Algorithm)
  32
  33 #include "SMESH_Hypothesis_i.hxx"
  34 #include "SMESH_Mesh_i.hxx"
  35 #include "HYBRIDPlugin_Hypothesis.hxx"
  36
  37 class SMESH_Gen;
  38
  39 // HYBRIDPlugin parameters hypothesis
  40
  41 class HYBRIDPLUGIN_EXPORT HYBRIDPlugin_Hypothesis_i:
  42   public virtual POA_HYBRIDPlugin::HYBRIDPlugin_Hypothesis,
  43   public virtual SMESH_Hypothesis_i
  44 {
  45  public:
  46   // Constructor
  47   HYBRIDPlugin_Hypothesis_i (PortableServer::POA_ptr thePOA,
  48                              int                     theStudyId,
  49                              ::SMESH_Gen*            theGenImpl);
  50   // Destructor
  51   virtual ~HYBRIDPlugin_Hypothesis_i();
  52
  53   /*!
  54    * To mesh "holes" in a solid or not. Default is to mesh.
  55    */
  56   void SetToMeshHoles(CORBA::Boolean toMesh);
  57   CORBA::Boolean GetToMeshHoles();
  58    /*!
  59    * IDs of faces to grow the layers on
  60    */
  61   void SetFacesWithLayers(const SMESH::long_array& faceIDs);
  62   SMESH::long_array* GetFacesWithLayers();
  63   /*!
  64    * IDs of faces to imprint the layers on
  65    */
  66   void SetFacesWithImprinting(const SMESH::long_array& faceIDs);
  67   SMESH::long_array* GetFacesWithImprinting();
  68   /*!
  69    * To mesh "layers on all wrap". Default is to mesh.
  70    */
  71   void SetLayersOnAllWrap(CORBA::Boolean toMesh);
  72   CORBA::Boolean GetLayersOnAllWrap();
  73   /*!
  74    * To make groups of volumes of different domains when mesh is generated from skin.
  75    * Default is to make groups.
  76    * This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
  77    */
  78   void SetToMakeGroupsOfDomains(CORBA::Boolean toMakeGroups);
  79   CORBA::Boolean GetToMakeGroupsOfDomains();
  80   /*!
  81    * Maximal size of memory to be used by the algorithm (in Megabytes)
  82    */
  83   void SetMaximumMemory(CORBA::Double MB) throw ( SALOME::SALOME_Exception );
  84   CORBA::Double GetMaximumMemory();
  85   /*!
  86    * Initial size of memory to be used by the algorithm (in Megabytes) in
  87    * automatic memory adjustment mode. Default is zero
  88    */
  89   void SetInitialMemory(CORBA::Double MB) throw ( SALOME::SALOME_Exception );
  90   CORBA::Double GetInitialMemory();
  91   /*!
  92    * Optimization level: 0-none, 1-light, 2-medium, 3-strong. Default is medium
  93    */
  94   void SetOptimizationLevel(CORBA::Short level) throw ( SALOME::SALOME_Exception );
  95   CORBA::Short GetOptimizationLevel();
  96   /*!
  97    * Collision Mode: 0-decrease, 1-stop. Default is decrease
  98    */
  99   void SetCollisionMode(CORBA::Short mode) throw ( SALOME::SALOME_Exception );
 100   CORBA::Short GetCollisionMode();
 101   /*!
 102    * Path to working directory
 103    */
 104   void SetWorkingDirectory(const char* path) throw ( SALOME::SALOME_Exception );
 105   char* GetWorkingDirectory();
 106   /*!
 107    * To keep working files or remove them. Log file remains in case of errors anyway.
 108    */
 109   void SetKeepFiles(CORBA::Boolean toKeep);
 110   CORBA::Boolean GetKeepFiles();
 111   /*!
 112    * Verbose level [0-10]
 113    *  0 - no standard output,
 114    *  2 - prints the data, quality statistics of the skin and final meshes and
 115    *     indicates when the final mesh is being saved. In addition the software
 116    *     gives indication regarding the CPU time.
 117    * 10 - same as 2 plus the main steps in the computation, quality statistics
 118    *     histogram of the skin mesh, quality statistics histogram together with
 119    *     the characteristics of the final mesh.
 120    */
 121   void SetVerboseLevel(CORBA::Short level) throw ( SALOME::SALOME_Exception );
 122   CORBA::Short GetVerboseLevel();
 123   /*!
 124    * To create new nodes
 125    */
 126   void SetToCreateNewNodes(CORBA::Boolean toCreate);
 127   CORBA::Boolean GetToCreateNewNodes();
 128   /*!
 129    * To use boundary recovery version which tries to create mesh on a very poor
 130    * quality surface mesh
 131    */
 132   void SetToUseBoundaryRecoveryVersion(CORBA::Boolean toUse);
 133   CORBA::Boolean GetToUseBoundaryRecoveryVersion();
 134   /*!
 135    * Applies ﬁnite-element correction by replacing overconstrained elements where
 136    * it is possible. The process is cutting ﬁrst the overconstrained edges and
 137    * second the overconstrained facets. This insure that no edges have two boundary
 138    * vertices and that no facets have three boundary vertices.
 139    */
 140   void SetFEMCorrection(CORBA::Boolean toUseFem);
 141   CORBA::Boolean GetFEMCorrection();
 142   /*!
 143    * To removes initial central point.
 144    */
 145   void SetToRemoveCentralPoint(CORBA::Boolean toRemove);
 146   CORBA::Boolean GetToRemoveCentralPoint();
 147   /*!
 148    * To set hiden/undocumented/advanced options
 149    */
 150   void SetAdvancedOption(const char* theOptAndVals );
 151   char* GetAdvancedOption();
 152   void SetTextOption(const char* option);
 153   char* GetTextOption();
 154   /*!
 155   * To define the volumic gradation
 156   */
 157   void SetGradation(CORBA::Double gradation);
 158   CORBA::Double GetGradation();
 159   /*!
 160   * Print log in standard output
 161   */
 162   void SetStandardOutputLog(CORBA::Boolean logInStandardOutput);
 163   CORBA::Boolean GetStandardOutputLog();
 164   /*!
 165   * Remove log file on success
 166   */
 167   void SetRemoveLogOnSuccess(CORBA::Boolean removeLogOnSuccess);
 168   CORBA::Boolean GetRemoveLogOnSuccess();
 169
 170   void SetBoundaryLayersGrowth(CORBA::Short mode) throw ( SALOME::SALOME_Exception );
 171   CORBA::Short GetBoundaryLayersGrowth();
 172
 173   void SetElementGeneration(CORBA::Short mode) throw ( SALOME::SALOME_Exception );
 174   CORBA::Short GetElementGeneration();
 175
 176   void SetAddMultinormals(CORBA::Boolean toAddMultinormals);
 177   CORBA::Boolean GetAddMultinormals();
 178
 179   void SetSmoothNormals(CORBA::Boolean toSmoothNormals);
 180   CORBA::Boolean GetSmoothNormals();
 181
 182   void SetHeightFirstLayer(CORBA::Double toHeightFirstLayer);
 183   CORBA::Double GetHeightFirstLayer();
 184
 185   void SetBoundaryLayersProgression(CORBA::Double toBoundaryLayersProgression);
 186   CORBA::Double GetBoundaryLayersProgression();
 187
 188   void SetCoreSize(CORBA::Double toCoreSize);
 189   CORBA::Double GetCoreSize();
 190
 191   void SetMultinormalsAngle(CORBA::Double toMultinormalsAngle);
 192   CORBA::Double GetMultinormalsAngle();
 193
 194   void SetNbOfBoundaryLayers(CORBA::Short toNbOfBoundaryLayers);
 195   CORBA::Short GetNbOfBoundaryLayers();
 196
 197   /*!
 198    * To set an enforced vertex
 199    */
 200   bool p_SetEnforcedVertex(CORBA::Double size, CORBA::Double x = 0, CORBA::Double y = 0, CORBA::Double z = 0,
 201                            const char* theVertexName = "", const char* theVertexEntry = "", const char* theGroupName = "",
 202                            CORBA::Boolean isCompound = false)
 203     throw (SALOME::SALOME_Exception);
 204   bool SetEnforcedVertex(CORBA::Double x, CORBA::Double y, CORBA::Double z, CORBA::Double size) throw (SALOME::SALOME_Exception);
 205   bool SetEnforcedVertexNamed(CORBA::Double x, CORBA::Double y, CORBA::Double z, CORBA::Double size, const char* theVertexName) throw (SALOME::SALOME_Exception);
 206   bool SetEnforcedVertexWithGroup(CORBA::Double x, CORBA::Double y, CORBA::Double z, CORBA::Double size, const char* theGroupName) throw (SALOME::SALOME_Exception);
 207   bool SetEnforcedVertexNamedWithGroup(CORBA::Double x, CORBA::Double y, CORBA::Double z, CORBA::Double size, const char* theVertexName, const char* theGroupName) throw (SALOME::SALOME_Exception);
 208   bool SetEnforcedVertexGeom(GEOM::GEOM_Object_ptr theVertex, CORBA::Double size) throw (SALOME::SALOME_Exception);
 209   bool SetEnforcedVertexGeomWithGroup(GEOM::GEOM_Object_ptr theVertex, CORBA::Double size, const char* theGroupName) throw (SALOME::SALOME_Exception);
 210   CORBA::Double GetEnforcedVertex(CORBA::Double x, CORBA::Double y, CORBA::Double z) throw (SALOME::SALOME_Exception);
 211   CORBA::Double GetEnforcedVertexGeom(GEOM::GEOM_Object_ptr theVertex) throw (SALOME::SALOME_Exception);
 212   bool RemoveEnforcedVertex(CORBA::Double x, CORBA::Double y, CORBA::Double z) throw (SALOME::SALOME_Exception);
 213   bool RemoveEnforcedVertexGeom(GEOM::GEOM_Object_ptr theVertex) throw (SALOME::SALOME_Exception);
 214   HYBRIDPlugin::HYBRIDEnforcedVertexList* GetEnforcedVertices();
 215   void ClearEnforcedVertices();
 216   /*!
 217    * To set an enforced mesh
 218    */
 219   bool p_SetEnforcedMesh(SMESH::SMESH_IDSource_ptr theSource, SMESH::ElementType elementType, const char* theName="", const char* theGroupName="") throw (SALOME::SALOME_Exception);
 220   bool SetEnforcedMesh(SMESH::SMESH_IDSource_ptr theSource, SMESH::ElementType elementType) throw (SALOME::SALOME_Exception);
 221   bool SetEnforcedMeshWithGroup(SMESH::SMESH_IDSource_ptr theSource, SMESH::ElementType elementType, const char* theGroupName) throw (SALOME::SALOME_Exception);
 222
 223   /* OBSOLETE FUNCTIONS */
 224   bool SetEnforcedMeshSize(SMESH::SMESH_IDSource_ptr theSource, SMESH::ElementType elementType, double size) throw (SALOME::SALOME_Exception);
 225   bool SetEnforcedMeshSizeWithGroup(SMESH::SMESH_IDSource_ptr theSource, SMESH::ElementType elementType, double size, const char* theGroupName) throw (SALOME::SALOME_Exception);
 226   /* OBSOLETE FUNCTIONS */
 227
 228   HYBRIDPlugin::HYBRIDEnforcedMeshList* GetEnforcedMeshes();
 229   void ClearEnforcedMeshes();
 230
 231   // Get implementation
 232   ::HYBRIDPlugin_Hypothesis* GetImpl();
 233
 234   // Verify whether hypothesis supports given entity type
 235   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
 236
 237 };
 238
 239 #endif