Salome HOME
Update of CheckDone
[modules/smesh.git] / src / StdMeshers / StdMeshers_MaxElementVolume.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
23 //  SMESH SMESH : implementation of SMESH idl descriptions
24 //  File   : StdMeshers_MaxElementVolume.hxx
25 //           Moved here from SMESH_MaxElementVolume.hxx
26 //  Author : Paul RASCLE, EDF
27 //  Module : SMESH
28 //
29 #ifndef _SMESH_MAXELEMENTVOLUME_HXX_
30 #define _SMESH_MAXELEMENTVOLUME_HXX_
31
32 #include "SMESH_StdMeshers.hxx"
33
34 #include "SMESH_Hypothesis.hxx"
35 #include "Utils_SALOME_Exception.hxx"
36
37 class STDMESHERS_EXPORT StdMeshers_MaxElementVolume:
38   public SMESH_Hypothesis
39 {
40 public:
41   StdMeshers_MaxElementVolume(int hypId, SMESH_Gen* gen);
42   virtual ~StdMeshers_MaxElementVolume();
43
44   void SetMaxVolume(double maxVolume);
45
46   double GetMaxVolume() const;
47
48   virtual std::ostream & SaveTo(std::ostream & save);
49   virtual std::istream & LoadFrom(std::istream & load);
50   friend std::ostream & operator << (std::ostream & save, StdMeshers_MaxElementVolume & hyp);
51   friend std::istream & operator >> (std::istream & load, StdMeshers_MaxElementVolume & hyp);
52
53   /*!
54    * \brief Initialize maximal volume by the mesh built on the geometry
55    * \param theMesh - the built mesh
56    * \param theShape - the geometry of interest
57    * \retval bool - true if parameter values have been successfully defined
58    */
59   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
60
61   /*!
62    * \brief Initialize my parameter values by default parameters.
63    *  \retval bool - true if parameter values have been successfully defined
64    */
65   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
66
67 protected:
68   double _maxVolume;
69 };
70
71 #endif