src/NETGENPlugin/NETGENPlugin_Hypothesis.hxx

   1 // Copyright (C) 2007-2014  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, or (at your option) any later version.
  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
  23 //  NETGENPlugin : C++ implementation
  24 // File      : NETGENPlugin_Hypothesis.hxx
  25 // Author    : Michael Sazonov (OCN)
  26 // Date      : 27/03/2006
  27 // Project   : SALOME
  28 //
  29 #ifndef _NETGENPlugin_Hypothesis_HXX_
  30 #define _NETGENPlugin_Hypothesis_HXX_
  31
  32 #include "NETGENPlugin_Defs.hxx"
  33
  34 #include "SMESH_Hypothesis.hxx"
  35 #include "Utils_SALOME_Exception.hxx"
  36
  37 #include <map>
  38
  39 //  Parameters for work of NETGEN
  40 //
  41
  42 using namespace std;
  43
  44 class NETGENPLUGIN_EXPORT NETGENPlugin_Hypothesis: public SMESH_Hypothesis
  45 {
  46 public:
  47
  48   NETGENPlugin_Hypothesis(int hypId, int studyId, SMESH_Gen * gen);
  49
  50   void SetMaxSize(double theSize);
  51   double GetMaxSize() const { return _maxSize; }
  52
  53   void SetMinSize(double theSize);
  54   double GetMinSize() const { return _minSize; }
  55
  56   void SetSecondOrder(bool theVal);
  57   bool GetSecondOrder() const { return _secondOrder; }
  58
  59   void SetOptimize(bool theVal);
  60   bool GetOptimize() const { return _optimize; }
  61
  62   enum Fineness
  63   {
  64     VeryCoarse,
  65     Coarse,
  66     Moderate,
  67     Fine,
  68     VeryFine,
  69     UserDefined
  70   };
  71
  72   void SetFineness(Fineness theFineness);
  73   Fineness GetFineness() const { return _fineness; }
  74
  75   // the following parameters are controlled by Fineness
  76
  77   void SetGrowthRate(double theRate);
  78   double GetGrowthRate() const { return _growthRate; }
  79
  80   void SetNbSegPerEdge(double theVal);
  81   double GetNbSegPerEdge() const { return _nbSegPerEdge; }
  82
  83   void SetNbSegPerRadius(double theVal);
  84   double GetNbSegPerRadius() const { return _nbSegPerRadius; }
  85
  86   typedef std::map<std::string, double> TLocalSize;
  87   static TLocalSize GetDefaultLocalSize() { return TLocalSize(); }
  88   void SetLocalSizeOnEntry(const std::string& entry, double localSize);
  89   double GetLocalSizeOnEntry(const std::string& entry);
  90   const TLocalSize& GetLocalSizesAndEntries() const { return _localSize; }
  91   void UnsetLocalSizeOnEntry(const std::string& entry);
  92
  93   void SetQuadAllowed(bool theVal);
  94   bool GetQuadAllowed() const { return _quadAllowed; }
  95
  96   void SetSurfaceCurvature(bool theVal);
  97   bool GetSurfaceCurvature() const { return _surfaceCurvature; }
  98
  99   void SetFuseEdges(bool theVal);
 100   bool GetFuseEdges() const { return _fuseEdges; }
 101
 102   // the default values (taken from NETGEN 4.5 sources)
 103
 104   static double GetDefaultMaxSize();
 105   static Fineness GetDefaultFineness();
 106   static double GetDefaultGrowthRate();
 107   static double GetDefaultNbSegPerEdge();
 108   static double GetDefaultNbSegPerRadius();
 109   static bool GetDefaultSecondOrder();
 110   static bool GetDefaultOptimize();
 111   static bool GetDefaultQuadAllowed();
 112   static bool GetDefaultSurfaceCurvature();
 113   static bool GetDefaultFuseEdges();
 114
 115   // Persistence
 116   virtual ostream & SaveTo(ostream & save);
 117   virtual istream & LoadFrom(istream & load);
 118   friend NETGENPLUGIN_EXPORT ostream & operator <<(ostream & save, NETGENPlugin_Hypothesis & hyp);
 119   friend NETGENPLUGIN_EXPORT istream & operator >>(istream & load, NETGENPlugin_Hypothesis & hyp);
 120
 121   /*!
 122    * \brief Does nothing
 123    * \param theMesh - the built mesh
 124    * \param theShape - the geometry of interest
 125    * \retval bool - always false
 126    */
 127   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 128
 129   /*!
 130    * \brief Initialize my parameter values by default parameters.
 131    *  \retval bool - true if parameter values have been successfully defined
 132    */
 133   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 134
 135 private:
 136   double        _maxSize, _minSize;
 137   double        _growthRate;
 138   double        _nbSegPerEdge;
 139   double        _nbSegPerRadius;
 140   Fineness      _fineness;
 141   bool          _secondOrder;
 142   bool          _optimize;
 143   TLocalSize    _localSize;
 144   bool          _quadAllowed;
 145   bool          _surfaceCurvature;
 146   bool          _fuseEdges;
 147 };
 148
 149 #endif