Salome HOME
Update copyright information
[plugins/netgenplugin.git] / src / NETGENPlugin / NETGENPlugin_SimpleHypothesis_2D.hxx
1 //  Copyright (C) 2007-2008  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 //  NETGENPlugin : C++ implementation
23 // File      : NETGENPlugin_SimpleHypothesis_2D.hxx
24 // Author    : Edward AGAPOV
25 // Project   : SALOME
26 //=============================================================================
27 //
28 #ifndef _NETGENPlugin_SimpleHypothesis_2D_HXX_
29 #define _NETGENPlugin_SimpleHypothesis_2D_HXX_
30
31 #include "NETGENPlugin_Defs.hxx"
32
33 #include "SMESH_Hypothesis.hxx"
34 #include "Utils_SALOME_Exception.hxx"
35
36 //  Simplified parameters of NETGEN
37 //
38
39 using namespace std;
40
41 class NETGENPLUGIN_EXPORT NETGENPlugin_SimpleHypothesis_2D: public SMESH_Hypothesis
42 {
43 public:
44
45   NETGENPlugin_SimpleHypothesis_2D(int hypId, int studyId, SMESH_Gen * gen);
46
47   /*!
48    * Sets <number of segments> value
49    */
50   void SetNumberOfSegments(int nb) throw (SALOME_Exception);
51   /*!
52    * Returns <number of segments> value.
53    * Can be zero in case if LocalLength() has been set
54    */
55   int GetNumberOfSegments() const { return _nbSegments; }
56
57   /*!
58    * Sets <segment length> value
59    */
60   void SetLocalLength(double segmentLength) throw (SALOME_Exception);
61   /*!
62    * Returns <segment length> value.
63    * Can be zero in case if NumberOfSegments() has been set
64    */
65   double GetLocalLength() const { return _segmentLength; }
66
67   /*!
68    * Sets <maximum element area> to be dependent on 1D discretization
69    */
70   void LengthFromEdges();
71
72   /*!
73    * Sets <maximum element area> value.
74    * Zero or negative value means same as LengthFromEdges().
75    */
76   void SetMaxElementArea(double area);
77   /*!
78    * Returns <maximum element area> value.
79    * Can be zero in case of LengthFromEdges()
80    */
81   double GetMaxElementArea() const { return _area; }
82
83   // Persistence
84   virtual ostream & SaveTo(ostream & save);
85   virtual istream & LoadFrom(istream & load);
86
87   /*!
88    * \brief Set parameters by mesh
89    * \param theMesh - the built mesh
90    * \param theShape - the geometry of interest
91    * \retval bool - true if theShape is meshed
92    */
93   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
94
95 private:
96   int    _nbSegments;
97   double _segmentLength, _area;
98 };
99
100 #endif