Salome HOME
#18963 Minimize compiler warnings
[plugins/netgenplugin.git] / src / NETGENPlugin / NETGENPlugin_SimpleHypothesis_2D.hxx
1 // Copyright (C) 2007-2020  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 //  NETGENPlugin : C++ implementation
21 // File      : NETGENPlugin_SimpleHypothesis_2D.hxx
22 // Author    : Edward AGAPOV
23 // Project   : SALOME
24 //=============================================================================
25 //
26 #ifndef _NETGENPlugin_SimpleHypothesis_2D_HXX_
27 #define _NETGENPlugin_SimpleHypothesis_2D_HXX_
28
29 #include "NETGENPlugin_Defs.hxx"
30
31 #include "SMESH_Hypothesis.hxx"
32 #include "Utils_SALOME_Exception.hxx"
33
34 //  Simplified parameters of NETGEN
35 //
36
37 class NETGENPLUGIN_EXPORT NETGENPlugin_SimpleHypothesis_2D: public SMESH_Hypothesis
38 {
39 public:
40
41   NETGENPlugin_SimpleHypothesis_2D(int hypId, SMESH_Gen * gen);
42
43   /*!
44    * Sets <number of segments> value
45    */
46   void SetNumberOfSegments(int nb);
47   /*!
48    * Returns <number of segments> value.
49    * Can be zero in case if LocalLength() has been set
50    */
51   int GetNumberOfSegments() const { return _nbSegments; }
52
53   /*!
54    * Sets <segment length> value
55    */
56   void SetLocalLength(double segmentLength);
57   /*!
58    * Returns <segment length> value.
59    * Can be zero in case if NumberOfSegments() has been set
60    */
61   double GetLocalLength() const { return _segmentLength; }
62
63   /*!
64    * Sets <maximum element area> to be dependent on 1D discretization
65    */
66   void LengthFromEdges();
67
68   /*!
69    * Sets <maximum element area> value.
70    * Zero or negative value means same as LengthFromEdges().
71    */
72   void SetMaxElementArea(double area);
73   /*!
74    * Returns <maximum element area> value.
75    * Can be zero in case of LengthFromEdges()
76    */
77   double GetMaxElementArea() const { return _area; }
78
79   /*!
80    * Enables/disables generation of quadrangular faces
81    */
82   void SetAllowQuadrangles(bool toAllow);
83   /*!
84    * Returns true if generation of quadrangular faces is enabled
85    */
86   bool GetAllowQuadrangles() const;
87
88   // Persistence
89   virtual std::ostream & SaveTo(std::ostream & save);
90   virtual std::istream & LoadFrom(std::istream & load);
91
92   /*!
93    * \brief Set parameters by mesh
94    * \param theMesh - the built mesh
95    * \param theShape - the geometry of interest
96    * \retval bool - true if theShape is meshed
97    */
98   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
99
100   /*!
101    * \brief Initialize my parameter values by default parameters.
102    *  \retval bool - true if parameter values have been successfully defined
103    */
104   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
105
106 private:
107   int    _nbSegments;
108   double _segmentLength, _area;
109   bool   _allowQuad;
110 };
111
112 #endif