Salome HOME
Copyright update 2020
[modules/smesh.git] / src / StdMeshers / StdMeshers_ViscousLayers.hxx
1 // Copyright (C) 2007-2020  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, or (at your option) any later version.
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 #include "SMESH_ComputeError.hxx"
32
33 #include <vector>
34
35 class SMDS_MeshGroup;
36
37 /*!
38  * \brief Hypothesis defining parameters of viscous layers
39  */
40 class STDMESHERS_EXPORT StdMeshers_ViscousLayers : public SMESH_Hypothesis
41 {
42 public:
43   StdMeshers_ViscousLayers(int hypId, SMESH_Gen* gen);
44
45   // Set boundary shapes (faces in 3D, edges in 2D) either to exclude from
46   // treatment or to make the Viscous Layers on
47   void   SetBndShapes(const std::vector<int>& shapeIds, bool toIgnore);
48   std::vector<int> GetBndShapes() const { return _shapeIds; }
49   bool   IsToIgnoreShapes() const { return _isToIgnoreShapes; }
50
51   // Set total thickness of layers of prisms
52   void   SetTotalThickness(double thickness);
53   double GetTotalThickness() const { return _thickness; }
54
55   // Set number of layers of prisms
56   void   SetNumberLayers(int nb);
57   int    GetNumberLayers() const { return _nbLayers; }
58
59   // Set factor (>1.0) of growth of layer thickness towards inside of mesh
60   void   SetStretchFactor(double factor);
61   double GetStretchFactor() const { return _stretchFactor; }
62
63   // Method of computing node translation 
64   enum ExtrusionMethod {
65     // node is translated along normal to a surface with possible further smoothing
66     SURF_OFFSET_SMOOTH,
67     // node is translated along the average normal of surrounding faces till
68     // intersection with a neighbor face translated along its own normal 
69     // by the layers thickness
70     FACE_OFFSET,
71     // node is translated along the average normal of surrounding faces
72     // by the layers thickness
73     NODE_OFFSET
74   };
75   void   SetMethod( ExtrusionMethod how );
76   ExtrusionMethod GetMethod() const { return _method; }
77
78   // name of a group to create
79   void SetGroupName(const std::string& name);
80   const std::string& GetGroupName() const { return _groupName; }
81   static SMDS_MeshGroup* CreateGroup( const std::string&  theName,
82                                       SMESH_Mesh&         theMesh,
83                                       SMDSAbs_ElementType theType);
84
85   // Computes temporary 2D mesh to be used by 3D algorithm.
86   // Return SMESH_ProxyMesh for each SOLID in theShape
87   SMESH_ProxyMesh::Ptr Compute(SMESH_Mesh&         theMesh,
88                                const TopoDS_Shape& theShape,
89                                const bool          toMakeN2NMap=false) const;
90
91   // Checks compatibility of assigned StdMeshers_ViscousLayers hypotheses
92   static SMESH_ComputeErrorPtr
93     CheckHypothesis(SMESH_Mesh&                          aMesh,
94                     const TopoDS_Shape&                  aShape,
95                     SMESH_Hypothesis::Hypothesis_Status& aStatus);
96
97   // Checks if viscous layers should be constructed on a shape
98   bool IsShapeWithLayers(int shapeIndex) const;
99
100   virtual std::ostream & SaveTo(std::ostream & save);
101   virtual std::istream & LoadFrom(std::istream & load);
102
103   /*!
104    * \brief Initialize my parameter values by the mesh built on the geometry
105     * \param theMesh - the built mesh
106     * \param theShape - the geometry of interest
107     * \retval bool - true if parameter values have been successfully defined
108    */
109   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
110
111   /*!
112    * \brief Initialize my parameter values by default parameters.
113    *  \retval bool - true if parameter values have been successfully defined
114    */
115   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)
116   { return false; }
117
118   static const char* GetHypType() { return "ViscousLayers"; }
119
120  private:
121
122   std::vector<int> _shapeIds;
123   bool             _isToIgnoreShapes;
124   int              _nbLayers;
125   double           _thickness;
126   double           _stretchFactor;
127   ExtrusionMethod  _method;
128   std::string      _groupName;
129 };
130
131 class SMESH_subMesh;
132 namespace VISCOUS_3D
133 {
134   // sets a sub-mesh event listener to clear sub-meshes of sub-shapes of
135   // the main shape when sub-mesh of the main shape is cleared,
136   // for example to clear sub-meshes of FACEs when sub-mesh of a SOLID
137   // is cleared
138   void ToClearSubWithMain( SMESH_subMesh* sub, const TopoDS_Shape& main);
139 }
140
141 #endif