src/NETGENPlugin/NETGENPlugin_Hypothesis_i.hxx

   1 // Copyright (C) 2007-2023  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_i.hxx
  25 // Author    : Michael Sazonov (OCN)
  26 // Date      : 03/04/2006
  27 // Project   : SALOME
  28 //=============================================================================
  29 //
  30 #ifndef _NETGENPlugin_Hypothesis_i_HXX_
  31 #define _NETGENPlugin_Hypothesis_i_HXX_
  32
  33 #include "NETGENPlugin_Defs.hxx"
  34
  35 #include <SALOMEconfig.h>
  36 #include CORBA_SERVER_HEADER(NETGENPlugin_Algorithm)
  37
  38 #include "SMESH_Hypothesis_i.hxx"
  39 #include "NETGENPlugin_Hypothesis.hxx"
  40
  41 class SMESH_Gen;
  42 //class GEOM_Object;
  43
  44 // NETGENPlugin parameters hypothesis
  45
  46 class NETGENPLUGIN_EXPORT NETGENPlugin_Hypothesis_i:
  47   public virtual POA_NETGENPlugin::NETGENPlugin_Hypothesis,
  48   public virtual SMESH_Hypothesis_i
  49 {
  50  public:
  51   // Constructor
  52   NETGENPlugin_Hypothesis_i (PortableServer::POA_ptr thePOA,
  53                              ::SMESH_Gen*            theGenImpl);
  54   // Destructor
  55   virtual ~NETGENPlugin_Hypothesis_i();
  56
  57   void SetMaxSize(CORBA::Double theSize);
  58   CORBA::Double GetMaxSize();
  59
  60   void SetMinSize(CORBA::Double theSize);
  61   CORBA::Double GetMinSize();
  62
  63   void SetSecondOrder(CORBA::Boolean theVal);
  64   CORBA::Boolean GetSecondOrder();
  65
  66   void SetOptimize(CORBA::Boolean theVal);
  67   CORBA::Boolean GetOptimize();
  68
  69   void SetFineness(CORBA::Long theFineness);
  70   CORBA::Long GetFineness();
  71
  72   void SetGrowthRate(CORBA::Double theRate);
  73   CORBA::Double GetGrowthRate();
  74
  75   void SetNbSegPerEdge(CORBA::Double theVal);
  76   CORBA::Double GetNbSegPerEdge();
  77
  78   void SetNbSegPerRadius(CORBA::Double theVal);
  79   CORBA::Double GetNbSegPerRadius();
  80
  81   void SetChordalErrorEnabled(CORBA::Boolean value);
  82   CORBA::Boolean GetChordalErrorEnabled();
  83   void SetChordalError(CORBA::Double value);
  84   CORBA::Double GetChordalError();
  85
  86   void SetLocalSizeOnShape(GEOM::GEOM_Object_ptr GeomObj, CORBA::Double localSize);
  87   void SetLocalSizeOnEntry(const char* entry, CORBA::Double localSize);
  88   CORBA::Double GetLocalSizeOnEntry(const char* entry);
  89   NETGENPlugin::string_array* GetLocalSizeEntries();
  90   void UnsetLocalSizeOnEntry(const char* entry);
  91
  92   void SetMeshSizeFile(const char* fileName);
  93   char* GetMeshSizeFile();
  94
  95   void SetQuadAllowed(CORBA::Boolean theVal);
  96   CORBA::Boolean GetQuadAllowed();
  97
  98   void SetUseSurfaceCurvature(CORBA::Boolean theVal);
  99   CORBA::Boolean GetUseSurfaceCurvature();
 100
 101   void SetFuseEdges(CORBA::Boolean theVal);
 102   CORBA::Boolean GetFuseEdges();
 103
 104   void    SetNbSurfOptSteps(CORBA::Short nb );
 105   CORBA::Short GetNbSurfOptSteps();
 106
 107   void    SetNbVolOptSteps(CORBA::Short nb );
 108   CORBA::Short GetNbVolOptSteps();
 109
 110   void    SetElemSizeWeight(CORBA::Double size );
 111   CORBA::Double GetElemSizeWeight();
 112
 113   void    SetWorstElemMeasure(CORBA::Short val );
 114   CORBA::Short GetWorstElemMeasure();
 115
 116   void    SetNbThreads(CORBA::Short val );
 117   CORBA::Short GetNbThreads();
 118
 119   void    SetUseDelauney(CORBA::Boolean toUse);
 120   CORBA::Boolean GetUseDelauney();
 121
 122   void    SetCheckOverlapping(CORBA::Boolean toCheck );
 123   CORBA::Boolean GetCheckOverlapping();
 124
 125   void    SetCheckChartBoundary(CORBA::Boolean toCheck );
 126   CORBA::Boolean GetCheckChartBoundary();
 127
 128   // Get implementation
 129   ::NETGENPlugin_Hypothesis* GetImpl();
 130
 131   // Verify whether hypothesis supports given entity type
 132   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
 133
 134
 135   // Methods for copying mesh definition to other geometry
 136
 137   // Return geometry this hypothesis depends on. Return false if there is no geometry parameter
 138   virtual bool getObjectsDependOn( std::vector< std::string > & entryArray,
 139                                    std::vector< int >         & subIDArray ) const;
 140
 141   // Set new geometry instead of that returned by getObjectsDependOn()
 142   virtual bool setObjectsDependOn( std::vector< std::string > & entryArray,
 143                                    std::vector< int >         & subIDArray );
 144
 145  protected:
 146
 147   // to remember whether a parameter is already set (issue 0021364)
 148   enum SettingMethod
 149   {
 150     METH_SetMaxSize             = 1,
 151     METH_SetMinSize             = 2,
 152     METH_SetSecondOrder         = 4,
 153     METH_SetOptimize            = 8,
 154     METH_SetFineness            = 16,
 155     METH_SetGrowthRate          = 32,
 156     METH_SetNbSegPerEdge        = 64,
 157     METH_SetNbSegPerRadius      = 128,
 158     METH_SetLocalSizeOnEntry    = 256,
 159     METH_SetQuadAllowed         = METH_SetLocalSizeOnEntry * 2,
 160     METH_SetSurfaceCurvature    = METH_SetQuadAllowed * 2,
 161     METH_SetFuseEdges           = METH_SetSurfaceCurvature * 2,
 162     METH_SetChordalErrorEnabled = METH_SetFuseEdges * 2,
 163     METH_SetChordalError        = METH_SetChordalErrorEnabled * 2,
 164     METH_LAST                   = METH_SetChordalError
 165   };
 166   int mySetMethodFlags;
 167
 168   // Return true if a parameter is not yet set, else return true if a parameter changes.
 169   // PythonDumping depends on the result of this function.
 170   // Checking only change of a parameter is not enough because then the default values are
 171   // not dumped and if the defaults will change then the behaviour of scripts
 172   // created without dump of the default parameters will also change what is not good.
 173   template<typename T>
 174     bool isToSetParameter(T curValue, T newValue, /*SettingMethod*/int meth)
 175   {
 176     if ( mySetMethodFlags & meth ) // already set, check if a value is changing
 177       return ( curValue != newValue );
 178     else
 179       return ( mySetMethodFlags |= meth ); // == return true
 180   }
 181
 182  public:
 183   // method intended to remove explicit treatment of Netgen hypotheses from
 184   // SMESH_NoteBook to assure backward compatibility after implemeneting
 185   // issue 0021308: Remove hard-coded dependency of the external mesh plugins
 186   virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const;
 187
 188   // method used to convert variable parameters stored in an old study
 189   // into myMethod2VarParams. It should return a method name for an index of
 190   // variable parameters. Index is countered from zero
 191   virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const;
 192 };
 193
 194 #endif