Salome HOME
Update of CheckDone
[modules/smesh.git] / src / StdMeshers / StdMeshers_Adaptive1D.hxx
1 // Copyright (C) 2007-2022  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 //  File   : StdMeshers_Adaptive1D.hxx
23 //  Module : SMESH
24 //
25 #ifndef _StdMeshers_Adaptive1D_HXX_
26 #define _StdMeshers_Adaptive1D_HXX_
27
28 #include "SMESH_StdMeshers.hxx"
29
30 #include "StdMeshers_Regular_1D.hxx"
31
32 #include "Utils_SALOME_Exception.hxx"
33
34 /*!
35  * \brief Adaptive 1D hypothesis
36  */
37 class STDMESHERS_EXPORT StdMeshers_Adaptive1D : public SMESH_Hypothesis
38 {
39  public:
40   StdMeshers_Adaptive1D(int hypId, SMESH_Gen * gen);
41   ~StdMeshers_Adaptive1D();
42
43   /*!
44    * Sets minimal allowed segment length
45    */
46   void SetMinSize( double minSegLen );
47   double GetMinSize() const { return myMinSize; }
48
49   /*!
50    * Sets maximal allowed segment length
51    */
52   void SetMaxSize( double maxSegLen );
53   double GetMaxSize() const { return myMaxSize; }
54
55   /*!
56    * Sets <deflection> parameter value, 
57    * i.e. a maximal allowed distance between a segment and an edge.
58    */
59   void SetDeflection(double value);
60   double GetDeflection() const { return myDeflection; }
61   
62   virtual std::ostream & SaveTo(std::ostream & save);
63   virtual std::istream & LoadFrom(std::istream & load);
64
65   /*!
66    * \brief Initialize deflection value by the mesh built on the geometry
67     * \param theMesh - the built mesh
68     * \param theShape - the geometry of interest
69     * \retval bool - true if parameter values have been successfully defined
70    */
71   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
72
73   /*!
74    * \brief Initialize my parameter values by default parameters.
75    *  \retval bool - true if parameter values have been successfully defined
76    */
77   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
78
79   /*!
80    * \brief Returns an algorithm that works using this hypothesis
81    */
82   SMESH_Algo* GetAlgo() const;
83
84 protected:
85
86   double myMinSize, myMaxSize, myDeflection;
87   SMESH_Algo* myAlgo; // StdMeshers_AdaptiveAlgo_1D implemented in cxx file
88 };
89
90 #endif