src/StdMeshers/StdMeshers_AutomaticLength.hxx

   1 //  Copyright (C) 2007-2008  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.
  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 //  SMESH SMESH : implementaion of SMESH idl descriptions
  23 //  File   : StdMeshers_AutomaticLength.hxx
  24 //  Author : Edward AGAPOV, OCC
  25 //  Module : SMESH
  26
  27 #ifndef _SMESH_AutomaticLength_HXX_
  28 #define _SMESH_AutomaticLength_HXX_
  29
  30 #include "SMESH_StdMeshers.hxx"
  31
  32 #include "SMESH_Hypothesis.hxx"
  33 #include "Utils_SALOME_Exception.hxx"
  34
  35 #include <map>
  36
  37 class SMESH_Mesh;
  38 class TopoDS_Shape;
  39 class TopoDS_TShape;
  40
  41 /*!
  42  * \brief 1D Hypothesis to compute segment length free of thinking
  43  *
  44  * It computes segment length basing on max shape size to shortest edge length ratio:
  45  * S = S0 * f(L/Lmin) where f(x) = 1 + (2/Pi * 7 * atan(x/5) )
  46  */
  47
  48 class STDMESHERS_EXPORT StdMeshers_AutomaticLength:public SMESH_Hypothesis
  49 {
  50 public:
  51   StdMeshers_AutomaticLength(int hypId, int studyId, SMESH_Gen * gen);
  52   virtual ~ StdMeshers_AutomaticLength();
  53
  54   /*!
  55    * \brief Computes segment for a given edge
  56    */
  57   double GetLength(const SMESH_Mesh* aMesh, const TopoDS_Shape& anEdge)
  58     throw(SALOME_Exception);
  59
  60   /*!
  61    * \brief Computes segment length for an edge of given length
  62    */
  63   double GetLength(const SMESH_Mesh* aMesh, const double edgeLength)
  64     throw(SALOME_Exception);
  65
  66   /*!
  67    * \brief Set Fineness
  68     * \param theFineness - The Fineness value [0.0-1.0],
  69     *                        0 - coarse mesh
  70     *                        1 - fine mesh
  71    *
  72    * Raise if theFineness is out of range
  73    * The "Initial Number of Elements on the Shortest Edge" (S0)
  74    * is divided by (0.5 + 4.5 x theFineness)
  75    */
  76   void SetFineness(double theFineness)
  77     throw(SALOME_Exception);
  78
  79   /*!
  80    * \brief Return mesh Fineness
  81     * \retval double - Fineness value [0.0-1.0]
  82    */
  83   double GetFineness() const { return _fineness; }
  84
  85   virtual std::ostream & SaveTo(std::ostream & save);
  86   virtual std::istream & LoadFrom(std::istream & load);
  87   friend std::ostream & operator <<(std::ostream & save, StdMeshers_AutomaticLength & hyp);
  88   friend std::istream & operator >>(std::istream & load, StdMeshers_AutomaticLength & hyp);
  89
  90   /*!
  91    * \brief Initialize Fineness by the mesh built on the geometry
  92     * \param theMesh - the built mesh
  93     * \param theShape - the geometry of interest
  94     * \retval bool - true if parameter values have been successfully defined
  95    */
  96   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  97
  98   /*!
  99    * \brief Initialize my parameter values by default parameters.
 100    *  \retval bool - true if parameter values have been successfully defined
 101    */
 102   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 103
 104 protected:
 105   std::map<const TopoDS_TShape*, double> _TShapeToLength;
 106   const SMESH_Mesh* _mesh;
 107   double _fineness, _S0, _minLen;
 108 };
 109
 110 #endif