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