src/StdMeshers/StdMeshers_AutomaticLength.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  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 //
  23 //
  24 //  File   : StdMeshers_AutomaticLength.hxx
  25 //  Author : Edward AGAPOV, OCC
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_AutomaticLength_HXX_
  30 #define _SMESH_AutomaticLength_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_AutomaticLength:public SMESH_Hypothesis
  49 {
  50 public:
  51   StdMeshers_AutomaticLength(int hypId, int studyId, SMESH_Gen * gen);
  52   virtual ~ StdMeshers_AutomaticLength();
  53
  54   double GetLength(const SMESH_Mesh* aMesh, const TopoDS_Shape& anEdge)
  55     throw(SALOME_Exception);
  56
  57   /*!
  58    * \brief Set Fineness
  59     * \param theFineness - The Fineness value [0.0-1.0],
  60     *                        0 - coarse mesh
  61     *                        1 - fine mesh
  62    *
  63    * Raise if theFineness is out of range
  64    * The "Initial Number of Elements on the Shortest Edge" (S0)
  65    * is divided by (0.5 + 4.5 x theFineness)
  66    */
  67   void SetFineness(double theFineness)
  68     throw(SALOME_Exception);
  69
  70   /*!
  71    * \brief Return mesh Fineness
  72     * \retval double - Fineness value [0.0-1.0]
  73    */
  74   double GetFineness() const { return _fineness; }
  75
  76   virtual std::ostream & SaveTo(std::ostream & save);
  77   virtual std::istream & LoadFrom(std::istream & load);
  78   friend std::ostream & operator <<(std::ostream & save, StdMeshers_AutomaticLength & hyp);
  79   friend std::istream & operator >>(std::istream & load, StdMeshers_AutomaticLength & hyp);
  80
  81   /*!
  82    * \brief Initialize Fineness by the mesh built on the geometry
  83     * \param theMesh - the built mesh
  84     * \param theShape - the geometry of interest
  85     * \retval bool - true if parameter values have been successfully defined
  86    */
  87   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  88
  89 protected:
  90   std::map<const TopoDS_TShape*, double> _TShapeToLength;
  91   const SMESH_Mesh* _mesh;
  92   double _fineness;
  93 };
  94
  95 #endif