Salome HOME
Merge from V6_3_BR 06/06/2011
[modules/smesh.git] / src / StdMeshers / StdMeshers_ViscousLayers.hxx
1 // Copyright (C) 2007-2011  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.
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 // File      : StdMeshers_ViscousLayers.hxx
21 // Created   : Wed Dec  1 15:15:34 2010
22 // Author    : Edward AGAPOV (eap)
23
24 #ifndef __StdMeshers_ViscousLayers_HXX__
25 #define __StdMeshers_ViscousLayers_HXX__
26
27 #include "SMESH_StdMeshers.hxx"
28
29 #include "SMESH_Hypothesis.hxx"
30 #include "SMESH_ProxyMesh.hxx"
31
32 #include <vector>
33
34 /*!
35  * \brief Hypothesis defining parameters of viscous layers
36  */
37 class STDMESHERS_EXPORT StdMeshers_ViscousLayers : public SMESH_Hypothesis
38 {
39 public:
40   StdMeshers_ViscousLayers(int hypId, int studyId, SMESH_Gen* gen);
41
42   // Set faces to exclude from treatment
43   void SetIgnoreFaces(const std::vector<int>& faceIds);
44   std::vector<int> GetIgnoreFaces() const { return _ignoreFaceIds; }
45
46   // Set total thickness of layers of prisms
47   void SetTotalThickness(double thickness);
48   double GetTotalThickness() const { return _thickness; }
49
50   // Set number of layers of prisms
51   void SetNumberLayers(int nb);
52   int GetNumberLayers() const { return _nbLayers; }
53
54   // Set factor (>1.0) of growth of layer thickness towards inside of mesh
55   void SetStretchFactor(double factor);
56   double GetStretchFactor() const { return _stretchFactor; }
57
58   // Computes temporary 2D mesh to be used by 3D algorithm.
59   // Return SMESH_ProxyMesh for each SOLID in theShape
60   SMESH_ProxyMesh::Ptr Compute(SMESH_Mesh&         theMesh,
61                                const TopoDS_Shape& theShape,
62                                const bool          toMakeN2NMap=false) const;
63
64   virtual std::ostream & SaveTo(std::ostream & save);
65   virtual std::istream & LoadFrom(std::istream & load);
66
67   /*!
68    * \brief Initialize my parameter values by the mesh built on the geometry
69     * \param theMesh - the built mesh
70     * \param theShape - the geometry of interest
71     * \retval bool - true if parameter values have been successfully defined
72     *
73     * Just return false as this hypothesis does not have parameters values
74    */
75   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
76
77   /*!
78    * \brief Initialize my parameter values by default parameters.
79    *  \retval bool - true if parameter values have been successfully defined
80    */
81   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)
82   { return false; }
83
84   static const char* GetHypType() { return "ViscousLayers"; }
85
86  private:
87
88   std::vector<int> _ignoreFaceIds;
89   int              _nbLayers;
90   double           _thickness;
91   double           _stretchFactor;
92 };
93
94 #endif