Salome HOME
changes for mpi compilation
[modules/smesh.git] / src / StdMeshers / StdMeshers_ViscousLayers.hxx
1 // Copyright (C) 2007-2014  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 /*!
36  * \brief Hypothesis defining parameters of viscous layers
37  */
38 class STDMESHERS_EXPORT StdMeshers_ViscousLayers : public SMESH_Hypothesis
39 {
40 public:
41   StdMeshers_ViscousLayers(int hypId, int studyId, SMESH_Gen* gen);
42
43   // Set boundary shapes (faces in 3D, edges in 2D) either to exclude from
44   // treatment or to make the Viscous Layers on
45   void SetBndShapes(const std::vector<int>& shapeIds, bool toIgnore);
46   std::vector<int> GetBndShapes() const { return _shapeIds; }
47   bool IsToIgnoreShapes() const { return _isToIgnoreShapes; }
48
49   // Set total thickness of layers of prisms
50   void SetTotalThickness(double thickness);
51   double GetTotalThickness() const { return _thickness; }
52
53   // Set number of layers of prisms
54   void SetNumberLayers(int nb);
55   int GetNumberLayers() const { return _nbLayers; }
56
57   // Set factor (>1.0) of growth of layer thickness towards inside of mesh
58   void SetStretchFactor(double factor);
59   double GetStretchFactor() const { return _stretchFactor; }
60
61   // Computes temporary 2D mesh to be used by 3D algorithm.
62   // Return SMESH_ProxyMesh for each SOLID in theShape
63   SMESH_ProxyMesh::Ptr Compute(SMESH_Mesh&         theMesh,
64                                const TopoDS_Shape& theShape,
65                                const bool          toMakeN2NMap=false) const;
66
67   // Checks compatibility of assigned StdMeshers_ViscousLayers hypotheses 
68   static SMESH_ComputeErrorPtr
69     CheckHypothesis(SMESH_Mesh&                          aMesh,
70                     const TopoDS_Shape&                  aShape,
71                     SMESH_Hypothesis::Hypothesis_Status& aStatus);
72
73   // Checks if viscous layers should be constructed on a shape
74   bool IsShapeWithLayers(int shapeIndex) const;
75
76   virtual std::ostream & SaveTo(std::ostream & save);
77   virtual std::istream & LoadFrom(std::istream & load);
78
79   /*!
80    * \brief Initialize my parameter values by the mesh built on the geometry
81     * \param theMesh - the built mesh
82     * \param theShape - the geometry of interest
83     * \retval bool - true if parameter values have been successfully defined
84     *
85     * Just return false as this hypothesis does not have parameters values
86    */
87   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
88
89   /*!
90    * \brief Initialize my parameter values by default parameters.
91    *  \retval bool - true if parameter values have been successfully defined
92    */
93   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0)
94   { return false; }
95
96   static const char* GetHypType() { return "ViscousLayers"; }
97
98  private:
99
100   std::vector<int> _shapeIds;
101   bool             _isToIgnoreShapes;
102   int              _nbLayers;
103   double           _thickness;
104   double           _stretchFactor;
105 };
106
107 class SMESH_subMesh;
108 namespace VISCOUS_3D
109 {
110   // sets a sub-mesh event listener to clear sub-meshes of sub-shapes of
111   // the main shape when sub-mesh of the main shape is cleared,
112   // for example to clear sub-meshes of FACEs when sub-mesh of a SOLID
113   // is cleared
114   void ToClearSubWithMain( SMESH_subMesh* sub, const TopoDS_Shape& main);
115 }
116
117 #endif