Salome HOME
Merge from V6_main 01/04/2013
[modules/smesh.git] / src / StdMeshers / StdMeshers_ViscousLayers.hxx
1 // Copyright (C) 2007-2013  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 boundary shapes to exclude from treatment, faces in 3D, edges in 2D
43   void SetBndShapesToIgnore(const std::vector<int>& shapeIds);
44   std::vector<int> GetBndShapesToIgnore() const { return _ignoreBndShapeIds; }
45   bool IsIgnoredShape(const int shapeID) const;
46
47   // Set total thickness of layers of prisms
48   void SetTotalThickness(double thickness);
49   double GetTotalThickness() const { return _thickness; }
50
51   // Set number of layers of prisms
52   void SetNumberLayers(int nb);
53   int GetNumberLayers() const { return _nbLayers; }
54
55   // Set factor (>1.0) of growth of layer thickness towards inside of mesh
56   void SetStretchFactor(double factor);
57   double GetStretchFactor() const { return _stretchFactor; }
58
59   // Computes temporary 2D mesh to be used by 3D algorithm.
60   // Return SMESH_ProxyMesh for each SOLID in theShape
61   SMESH_ProxyMesh::Ptr Compute(SMESH_Mesh&         theMesh,
62                                const TopoDS_Shape& theShape,
63                                const bool          toMakeN2NMap=false) const;
64
65   virtual std::ostream & SaveTo(std::ostream & save);
66   virtual std::istream & LoadFrom(std::istream & load);
67
68   /*!
69    * \brief Initialize my parameter values by the mesh built on the geometry
70     * \param theMesh - the built mesh
71     * \param theShape - the geometry of interest
72     * \retval bool - true if parameter values have been successfully defined
73     *
74     * Just return false as this hypothesis does not have parameters values
75    */
76   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
77
78   /*!
79    * \brief Initialize my parameter values by default parameters.
80    *  \retval bool - true if parameter values have been successfully defined
81    */
82   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)
83   { return false; }
84
85   static const char* GetHypType() { return "ViscousLayers"; }
86
87  private:
88
89   std::vector<int> _ignoreBndShapeIds;
90   int              _nbLayers;
91   double           _thickness;
92   double           _stretchFactor;
93 };
94
95 class SMESH_subMesh;
96 namespace VISCOUS_3D
97 {
98   // sets a sub-mesh event listener to clear sub-meshes of sub-shapes of
99   // the main shape when sub-mesh of the main shape is cleared,
100   // for example to clear sub-meshes of FACEs when sub-mesh of a SOLID
101   // is cleared
102   void ToClearSubWithMain( SMESH_subMesh* sub, const TopoDS_Shape& main);
103 }
104
105 #endif