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 class NETGENPLUGIN_EXPORT NETGENPlugin_SimpleHypothesis_2D: public SMESH_Hypothesis
40 {
41 public:
42
43   NETGENPlugin_SimpleHypothesis_2D(int hypId, int studyId, SMESH_Gen * gen);
44
45   /*!
46    * Sets <number of segments> value
47    */
48   void SetNumberOfSegments(int nb) throw (SALOME_Exception);
49   /*!
50    * Returns <number of segments> value.
51    * Can be zero in case if LocalLength() has been set
52    */
53   int GetNumberOfSegments() const { return _nbSegments; }
54
55   /*!
56    * Sets <segment length> value
57    */
58   void SetLocalLength(double segmentLength) throw (SALOME_Exception);
59   /*!
60    * Returns <segment length> value.
61    * Can be zero in case if NumberOfSegments() has been set
62    */
63   double GetLocalLength() const { return _segmentLength; }
64
65   /*!
66    * Sets <maximum element area> to be dependent on 1D discretization
67    */
68   void LengthFromEdges();
69
70   /*!
71    * Sets <maximum element area> value.
72    * Zero or negative value means same as LengthFromEdges().
73    */
74   void SetMaxElementArea(double area);
75   /*!
76    * Returns <maximum element area> value.
77    * Can be zero in case of LengthFromEdges()
78    */
79   double GetMaxElementArea() const { return _area; }
80
81   // Persistence
82   virtual std::ostream & SaveTo(std::ostream & save);
83   virtual std::istream & LoadFrom(std::istream & load);
84
85   /*!
86    * \brief Set parameters by mesh
87    * \param theMesh - the built mesh
88    * \param theShape - the geometry of interest
89    * \retval bool - true if theShape is meshed
90    */
91   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
92
93 private:
94   int    _nbSegments;
95   double _segmentLength, _area;
96 };
97
98 #endif