src/BLSURFPlugin/BLSURFPlugin_Hypothesis_i.hxx

   1 // Copyright (C) 2007-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 // ---
  21 // File    : BLSURFPlugin_Hypothesis.hxx
  22 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
  23 //           Size maps developement: Nicolas GEIMER (OCC) & Gilles DAVID (EURIWARE)
  24 // ---
  25 //
  26 #ifndef _BLSURFPlugin_Hypothesis_i_HXX_
  27 #define _BLSURFPlugin_Hypothesis_i_HXX_
  28
  29 #include <SALOMEconfig.h>
  30 #include CORBA_SERVER_HEADER(BLSURFPlugin_Algorithm)
  31
  32 #include "SMESH_Hypothesis_i.hxx"
  33 #include "BLSURFPlugin_Hypothesis.hxx"
  34
  35 class SMESH_Gen;
  36 class GEOM_Object;
  37
  38 // BLSURFPlugin parameters hypothesis
  39
  40 class BLSURFPlugin_Hypothesis_i: public virtual POA_BLSURFPlugin::BLSURFPlugin_Hypothesis,
  41     public virtual SMESH_Hypothesis_i {
  42 public:
  43   // Constructor
  44   BLSURFPlugin_Hypothesis_i(PortableServer::POA_ptr thePOA, int theStudyId, ::SMESH_Gen* theGenImpl);
  45   // Destructor
  46   virtual ~BLSURFPlugin_Hypothesis_i();
  47
  48   void SetPhysicalMesh(CORBA::Long theValue);
  49   CORBA::Long GetPhysicalMesh();
  50
  51   void SetGeometricMesh(CORBA::Long theValue);
  52   CORBA::Long GetGeometricMesh();
  53
  54   void SetPhySize(CORBA::Double theValue);
  55   void SetPhySizeRel(CORBA::Double theValue);
  56   CORBA::Double GetPhySize();
  57   CORBA::Boolean IsPhySizeRel();
  58
  59   void SetMinSize(CORBA::Double theMinSize);
  60   void SetMinSizeRel(CORBA::Double theMinSize);
  61   CORBA::Double GetMinSize();
  62   CORBA::Boolean IsMinSizeRel();
  63
  64   void SetMaxSize(CORBA::Double theMaxSize);
  65   void SetMaxSizeRel(CORBA::Double theMaxSize);
  66   CORBA::Double GetMaxSize();
  67   CORBA::Boolean IsMaxSizeRel();
  68
  69   void SetGradation(CORBA::Double theValue);
  70   CORBA::Double GetGradation();
  71
  72   void SetQuadAllowed(CORBA::Boolean theValue);
  73   CORBA::Boolean GetQuadAllowed();
  74
  75   void SetAngleMesh(CORBA::Double theValue);
  76   CORBA::Double GetAngleMesh();
  77
  78   void SetChordalError(CORBA::Double distance);
  79   CORBA::Double GetChordalError();
  80
  81   void SetAnisotropic(CORBA::Boolean anisotropic);
  82   CORBA::Boolean GetAnisotropic();
  83
  84   void SetAnisotropicRatio(CORBA::Double ratio);
  85   CORBA::Double GetAnisotropicRatio();
  86
  87   void SetRemoveTinyEdges(CORBA::Boolean remove);
  88   CORBA::Boolean GetRemoveTinyEdges();
  89
  90   void SetTinyEdgeLength(CORBA::Double length);
  91   CORBA::Double GetTinyEdgeLength();
  92
  93   void SetBadElementRemoval(CORBA::Boolean remove);
  94   CORBA::Boolean GetBadElementRemoval();
  95
  96   void SetBadElementAspectRatio(CORBA::Double ratio);
  97   CORBA::Double GetBadElementAspectRatio();
  98
  99   void SetOptimizeMesh(CORBA::Boolean optimize);
 100   CORBA::Boolean GetOptimizeMesh();
 101
 102   void SetQuadraticMesh(CORBA::Boolean quadratic);
 103   CORBA::Boolean GetQuadraticMesh();
 104
 105   void SetTopology(CORBA::Long theValue);
 106   CORBA::Long GetTopology();
 107
 108   void SetVerbosity(CORBA::Short theVal) throw (SALOME::SALOME_Exception);
 109   CORBA::Short GetVerbosity();
 110
 111   void SetPreCADMergeEdges(CORBA::Boolean theValue);
 112   CORBA::Boolean GetPreCADMergeEdges();
 113
 114   void SetPreCADProcess3DTopology(CORBA::Boolean theValue);
 115   CORBA::Boolean GetPreCADProcess3DTopology();
 116
 117   void SetPreCADDiscardInput(CORBA::Boolean theValue);
 118   CORBA::Boolean GetPreCADDiscardInput();
 119
 120   void SetOptionValue(const char* optionName, const char* optionValue) throw (SALOME::SALOME_Exception);
 121   void SetPreCADOptionValue(const char* optionName, const char* optionValue) throw (SALOME::SALOME_Exception);
 122   char* GetOptionValue(const char* optionName) throw (SALOME::SALOME_Exception);
 123   char* GetPreCADOptionValue(const char* optionName) throw (SALOME::SALOME_Exception);
 124
 125   void UnsetOption(const char* optionName);
 126   void UnsetPreCADOption(const char* optionName);
 127
 128   BLSURFPlugin::string_array* GetOptionValues();
 129   BLSURFPlugin::string_array* GetPreCADOptionValues();
 130
 131   void SetOptionValues(const BLSURFPlugin::string_array& options) throw (SALOME::SALOME_Exception);
 132   void SetPreCADOptionValues(const BLSURFPlugin::string_array& options) throw (SALOME::SALOME_Exception);
 133
 134   void SetSizeMapEntry(const char* entry, const char* sizeMap) throw (SALOME::SALOME_Exception);
 135
 136   void SetConstantSizeMapEntry(const char* entry, GEOM::shape_type shapeType, CORBA::Double sizeMap) throw (SALOME::SALOME_Exception);
 137
 138   char* GetSizeMapEntry(const char* entry) throw (SALOME::SALOME_Exception);
 139
 140   void UnsetEntry(const char* entry);
 141
 142   BLSURFPlugin::string_array* GetSizeMapEntries();
 143
 144   void SetSizeMapEntries(const BLSURFPlugin::string_array& sizeMaps) throw (SALOME::SALOME_Exception);
 145
 146   void SetSizeMap(GEOM::GEOM_Object_ptr GeomObj, const char* sizeMap);
 147
 148   void SetConstantSizeMap(GEOM::GEOM_Object_ptr GeomObj, CORBA::Double sizeMap);
 149
 150   void UnsetSizeMap(GEOM::GEOM_Object_ptr GeomObj);
 151
 152   void ClearSizeMaps();
 153
 154   void SetAttractor(GEOM::GEOM_Object_ptr GeomObj, const char* attractor);
 155
 156   void UnsetAttractor(GEOM::GEOM_Object_ptr GeomObj);
 157
 158   void SetAttractorEntry(const char* entry, const char* attractor) throw (SALOME::SALOME_Exception);
 159
 160   char* GetAttractorEntry(const char* entry) throw (SALOME::SALOME_Exception);
 161
 162   BLSURFPlugin::string_array* GetAttractorEntries();
 163
 164
 165   /*!
 166     * Set/get/unset an attractor on a face
 167     */
 168
 169   void SetAttractorGeom(GEOM::GEOM_Object_ptr GeomObj, GEOM::GEOM_Object_ptr Attractor, CORBA::Double StartSize, CORBA::Double EndSize, CORBA::Double ActionRadius, CORBA::Double ConstantRadius );
 170
 171   void UnsetAttractorGeom(GEOM::GEOM_Object_ptr GeomObj);
 172
 173   void SetClassAttractorEntry(const char* entry, const char* att_entry, CORBA::Double StartSize, CORBA::Double EndSize, CORBA::Double ActionRadius, CORBA::Double ConstantRadius)  throw (SALOME::SALOME_Exception);
 174
 175   BLSURFPlugin::TAttParamsMap* GetAttractorParams();
 176
 177
 178   /*
 179    void SetCustomSizeMap(GEOM::GEOM_Object_ptr GeomObj, const char* sizeMap);
 180
 181    void UnsetCustomSizeMap(GEOM::GEOM_Object_ptr GeomObj);
 182
 183    void SetCustomSizeMapEntry(const char* entry,const char* sizeMap )  throw (SALOME::SALOME_Exception);
 184
 185    char* GetCustomSizeMapEntry(const char* entry)  throw (SALOME::SALOME_Exception);
 186
 187    BLSURFPlugin::string_array* GetCustomSizeMapEntries();
 188    */
 189
 190   ///////////////////////
 191   // ENFORCED VERTEXES //
 192   ///////////////////////
 193
 194   BLSURFPlugin::TFaceEntryEnfVertexListMap* GetAllEnforcedVerticesByFace();
 195   BLSURFPlugin::TEnfVertexList* GetAllEnforcedVertices();
 196
 197   BLSURFPlugin::TFaceEntryCoordsListMap* GetAllCoordsByFace();
 198   BLSURFPlugin::TCoordsEnfVertexMap* GetAllEnforcedVerticesByCoords();
 199
 200   BLSURFPlugin::TFaceEntryEnfVertexEntryListMap* GetAllEnfVertexEntriesByFace();
 201   BLSURFPlugin::TEnfVertexEntryEnfVertexMap* GetAllEnforcedVerticesByEnfVertexEntry();
 202
 203   void ClearAllEnforcedVertices();
 204
 205   /*!
 206    * Set/get/unset an enforced vertex on geom object
 207    */
 208   bool SetEnforcedVertex(GEOM::GEOM_Object_ptr theFace, CORBA::Double x, CORBA::Double y, CORBA::Double z)
 209       throw (SALOME::SALOME_Exception);
 210   bool SetEnforcedVertexNamed(GEOM::GEOM_Object_ptr theFace, CORBA::Double x, CORBA::Double y, CORBA::Double z, const char* theVertexName)
 211       throw (SALOME::SALOME_Exception);
 212   bool SetEnforcedVertexGeom(GEOM::GEOM_Object_ptr theFace, GEOM::GEOM_Object_ptr theVertex)
 213       throw (SALOME::SALOME_Exception);
 214   bool SetEnforcedVertexWithGroup(GEOM::GEOM_Object_ptr theFace, CORBA::Double x, CORBA::Double y, CORBA::Double z, const char* theGroupName)
 215       throw (SALOME::SALOME_Exception);
 216   bool SetEnforcedVertexNamedWithGroup(GEOM::GEOM_Object_ptr theFace, CORBA::Double x, CORBA::Double y, CORBA::Double z, const char* theVertexName, const char* theGroupName)
 217       throw (SALOME::SALOME_Exception);
 218   bool SetEnforcedVertexGeomWithGroup(GEOM::GEOM_Object_ptr theFace, GEOM::GEOM_Object_ptr theVertex, const char* theGroupName)
 219       throw (SALOME::SALOME_Exception);
 220
 221   BLSURFPlugin::TEnfVertexList* GetEnforcedVertices(GEOM::GEOM_Object_ptr theFace) throw (SALOME::SALOME_Exception);
 222
 223   bool UnsetEnforcedVertex(GEOM::GEOM_Object_ptr theFace, CORBA::Double x, CORBA::Double y, CORBA::Double z)
 224       throw (SALOME::SALOME_Exception);
 225   bool UnsetEnforcedVertexGeom(GEOM::GEOM_Object_ptr theFace, GEOM::GEOM_Object_ptr theVertex)
 226       throw (SALOME::SALOME_Exception);
 227   bool UnsetEnforcedVertices(GEOM::GEOM_Object_ptr theFace) throw (SALOME::SALOME_Exception);
 228
 229   /*!
 230    * Set/get/unset an enforced vertex on geom object given by entry
 231    */
 232   bool SetEnforcedVertexEntry(const char* theFaceEntry, CORBA::Double x = 0, CORBA::Double y = 0, CORBA::Double z = 0,
 233       const char* theVertexName = "", const char* theVertexEntry = "", const char* theGroupName = "")
 234       throw (SALOME::SALOME_Exception);
 235
 236   BLSURFPlugin::TEnfVertexList* GetEnforcedVerticesEntry(const char* theFaceEntry) throw (SALOME::SALOME_Exception);
 237
 238   bool UnsetEnforcedVertexEntry(const char* theFaceEntry, CORBA::Double x, CORBA::Double y, CORBA::Double z,
 239       const char* theVertexEntry = "") throw (SALOME::SALOME_Exception);
 240   bool UnsetEnforcedVerticesEntry(const char* theFaceEntry) throw (SALOME::SALOME_Exception);
 241
 242   /*!
 243    * To add internal vertices as enforced vertices
 244    */
 245   void SetInternalEnforcedVertexAllFaces(CORBA::Boolean toEnforceInternalVertices);
 246   CORBA::Boolean GetInternalEnforcedVertexAllFaces();
 247   void SetInternalEnforcedVertexAllFacesGroup(const char*  groupName = "");
 248   char* GetInternalEnforcedVertexAllFacesGroup();
 249
 250 // Enable internal enforced vertices on specific face if requested by user
 251 //  void SetInternalEnforcedVertex(GEOM::GEOM_Object_ptr theFace, CORBA::Boolean toEnforceInternalVertices) throw (SALOME::SALOME_Exception);
 252 //  void SetInternalEnforcedVertexWithGroup(GEOM::GEOM_Object_ptr theFace, CORBA::Boolean toEnforceInternalVertices, const char* theGroupName = "") throw (SALOME::SALOME_Exception);
 253 //  void SetInternalEnforcedVertexEntry(const char* theFaceEntry, CORBA::Boolean toEnforceInternalVertices, const char* theGroupName = "") throw (SALOME::SALOME_Exception);
 254 //  CORBA::Boolean GetInternalEnforcedVertex(GEOM::GEOM_Object_ptr theFace) throw (SALOME::SALOME_Exception);
 255 //  CORBA::Boolean GetInternalEnforcedVertexEntry(const char* theFaceEntry) throw (SALOME::SALOME_Exception);
 256
 257   ///////////////////////
 258   // PERIODICITY       //
 259   ///////////////////////
 260
 261   void ClearPreCadPeriodicityVectors();
 262
 263   BLSURFPlugin::TPeriodicityList* GetPreCadFacesPeriodicityVector();
 264   BLSURFPlugin::TPeriodicityList* GetPreCadEdgesPeriodicityVector();
 265
 266   BLSURFPlugin::TPeriodicityList* PreCadVectorToSequence(const ::BLSURFPlugin_Hypothesis::TPreCadPeriodicityVector& preCadPeriodicityVector);
 267
 268   void AddPreCadFacesPeriodicity(GEOM::GEOM_Object_ptr theFace1, GEOM::GEOM_Object_ptr theFace2)
 269       throw (SALOME::SALOME_Exception);
 270
 271   void AddPreCadFacesPeriodicityWithVertices(GEOM::GEOM_Object_ptr theFace1, GEOM::GEOM_Object_ptr theFace2,
 272       const GEOM::ListOfGO& theSourceVertices, const GEOM::ListOfGO& theTargetVertices)
 273       throw (SALOME::SALOME_Exception);
 274
 275   void AddPreCadFacesPeriodicityEntry(const char* theFace1Entry, const char* theFace2Entry,
 276       const BLSURFPlugin::TEntryList& theSourceVerticesEntries, const BLSURFPlugin::TEntryList& theTargetVerticesEntries)
 277       throw (SALOME::SALOME_Exception);
 278
 279   void AddPreCadEdgesPeriodicity(GEOM::GEOM_Object_ptr theEdge1, GEOM::GEOM_Object_ptr theEdge2)
 280       throw (SALOME::SALOME_Exception);
 281
 282   void AddPreCadEdgesPeriodicityWithVertices(GEOM::GEOM_Object_ptr theEdge1, GEOM::GEOM_Object_ptr theEdge2,
 283       const GEOM::ListOfGO& theSourceVertices, const GEOM::ListOfGO& theTargetVertices)
 284       throw (SALOME::SALOME_Exception);
 285
 286   void AddPreCadEdgesPeriodicityEntry(const char* theEdge1Entry, const char* theEdge2Entry,
 287       const BLSURFPlugin::TEntryList& theSourceVerticesEntries, const BLSURFPlugin::TEntryList& theTargetVerticesEntries)
 288       throw (SALOME::SALOME_Exception);
 289
 290   void AddFacePeriodicity(GEOM::GEOM_Object_ptr theFace1, GEOM::GEOM_Object_ptr theFace2)
 291       throw (SALOME::SALOME_Exception);
 292
 293   void AddFacePeriodicityEntry(const char* theFace1Entry, const char* theFace2Entry)
 294     throw (SALOME::SALOME_Exception);
 295
 296   void AddEdgePeriodicity(GEOM::GEOM_Object_ptr theFace1, GEOM::GEOM_Object_ptr theEdge1,
 297                           GEOM::GEOM_Object_ptr theFace2, GEOM::GEOM_Object_ptr theEdge2, CORBA::Long edge_orientation = 0)
 298       throw (SALOME::SALOME_Exception);
 299
 300   void AddEdgePeriodicityWithoutFaces(GEOM::GEOM_Object_ptr theEdge1, GEOM::GEOM_Object_ptr theEdge2, CORBA::Long edge_orientation = 0)
 301       throw (SALOME::SALOME_Exception);
 302
 303   void AddEdgePeriodicityEntry(const char* theFace1Entry, const char* theEdge1Entry, const char* theFace2Entry, const char* theEdge2Entry, const long edge_orientation = 0)
 304     throw (SALOME::SALOME_Exception);
 305
 306   void AddVertexPeriodicity(GEOM::GEOM_Object_ptr theEdge1, GEOM::GEOM_Object_ptr theVertex1,
 307       GEOM::GEOM_Object_ptr theEdge2, GEOM::GEOM_Object_ptr theVertex2)
 308       throw (SALOME::SALOME_Exception);
 309
 310   void AddVertexPeriodicityEntry(const char* theEdge1Entry, const char* theVertex1Entry, const char* theEdge2Entry, const char* theVertex2Entry)
 311     throw (SALOME::SALOME_Exception);
 312
 313   ///////////////////////
 314
 315   /*!
 316     * Sets the file for export resulting mesh in GMF format
 317     */
 318 //   void SetGMFFile(const char* theFileName, CORBA::Boolean isBinary);
 319   void SetGMFFile(const char* theFileName);
 320   char* GetGMFFile();
 321 //   CORBA::Boolean GetGMFFileMode();
 322
 323   // Get implementation
 324   ::BLSURFPlugin_Hypothesis* GetImpl();
 325
 326   // Verify whether hypothesis supports given entity type
 327   CORBA::Boolean IsDimSupported(SMESH::Dimension type);
 328
 329
 330   //
 331   // Obsolete methods - To be removed in V7
 332   //
 333   void SetPhyMin(CORBA::Double theMinSize);
 334   CORBA::Double GetPhyMin();
 335   void SetPhyMax(CORBA::Double theMaxSize);
 336   CORBA::Double GetPhyMax();
 337   void SetGeoMin(CORBA::Double theMinSize);
 338   CORBA::Double GetGeoMin();
 339   void SetGeoMax(CORBA::Double theMaxSize);
 340   CORBA::Double GetGeoMax();
 341   void SetAngleMeshS(CORBA::Double angle);
 342   CORBA::Double GetAngleMeshS();
 343   void SetAngleMeshC(CORBA::Double angle);
 344   CORBA::Double GetAngleMeshC();
 345   void SetDecimesh(CORBA::Boolean toIgnoreEdges);
 346   CORBA::Boolean GetDecimesh();
 347   void SetPreCADRemoveNanoEdges(CORBA::Boolean toRemoveNanoEdges);
 348   CORBA::Boolean GetPreCADRemoveNanoEdges();
 349   void SetPreCADEpsNano(CORBA::Double epsNano);
 350   CORBA::Double GetPreCADEpsNano();
 351
 352 private:
 353   ///////////////////////
 354   // PERIODICITY       //
 355   ///////////////////////
 356   std::string ShapeTypeToString(GEOM::shape_type theShapeType);
 357   void CheckShapeType(GEOM::GEOM_Object_ptr shape, GEOM::shape_type theShapeType);
 358   void CheckShapeTypes(GEOM::GEOM_Object_ptr shape, std::vector<GEOM::shape_type> theShapeTypes);
 359   std::string PublishIfNeeded(GEOM::GEOM_Object_ptr shape, GEOM::shape_type theShapeType, std::string prefix);
 360   std::string FormatVerticesEntries(vector<string> &theSourceVerticesEntries, vector<string> &theTargetVerticesEntries);
 361
 362 };
 363
 364 #endif