Salome HOME
#18963 Minimize compiler warnings
[modules/smesh.git] / src / StdMeshers / StdMeshers_AutomaticLength.hxx
1 // Copyright (C) 2007-2020  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 //  SMESH SMESH : implementation 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, 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
60   /*!
61    * \brief Computes segment length for an edge of given length
62    */
63   double GetLength(const SMESH_Mesh* aMesh, const double edgeLength);
64
65   /*!
66    * \brief Set Fineness
67     * \param theFineness - The Fineness value [0.0-1.0],
68     *                        0 - coarse mesh
69     *                        1 - fine mesh
70    * 
71    * Raise if theFineness is out of range
72    * The "Initial Number of Elements on the Shortest Edge" (S0)
73    * is divided by (0.5 + 4.5 x theFineness)
74    */
75   void SetFineness(double theFineness);
76
77   /*!
78    * \brief Return mesh Fineness
79     * \retval double - Fineness value [0.0-1.0]
80    */
81   double GetFineness() const { return _fineness; }
82
83   virtual std::ostream & SaveTo(std::ostream & save);
84   virtual std::istream & LoadFrom(std::istream & load);
85   friend std::ostream & operator <<(std::ostream & save, StdMeshers_AutomaticLength & hyp);
86   friend std::istream & operator >>(std::istream & load, StdMeshers_AutomaticLength & hyp);
87
88   /*!
89    * \brief Initialize Fineness by the mesh built on the geometry
90     * \param theMesh - the built mesh
91     * \param theShape - the geometry of interest
92     * \retval bool - true if parameter values have been successfully defined
93    */
94   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
95
96   /*!
97    * \brief Initialize my parameter values by default parameters.
98    *  \retval bool - true if parameter values have been successfully defined
99    */
100   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
101
102 protected:
103   std::map<const TopoDS_TShape*, double> _TShapeToLength;
104   const SMESH_Mesh* _mesh;
105   double _fineness, _S0, _minLen;
106 };
107
108 #endif