]> SALOME platform Git repositories - modules/smesh.git/blob - src/StdMeshers/StdMeshers_CartesianParameters3D.hxx
Salome HOME
Merge branch 'occ/shaper2smesh'
[modules/smesh.git] / src / StdMeshers / StdMeshers_CartesianParameters3D.hxx
1 // Copyright (C) 2007-2019  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 //  File   : StdMeshers_CartesianParameters3D.hxx
24 //  Author : Edward AGAPOV
25 //  Module : SMESH
26 //
27 #ifndef _SMESH_CartesianParameters3D_HXX_
28 #define _SMESH_CartesianParameters3D_HXX_
29
30 #include "SMESH_StdMeshers.hxx"
31
32 #include "SMESH_Hypothesis.hxx"
33 #include "Utils_SALOME_Exception.hxx"
34
35 #include <vector>
36
37 class SMESH_Gen;
38 class Bnd_Box;
39
40 // =========================================================
41 /*!
42  * This hypothesis specifies
43  * - Definition of the Cartesian grid
44  * - Size threshold
45  */
46 // =========================================================
47
48 class STDMESHERS_EXPORT StdMeshers_CartesianParameters3D:  public SMESH_Hypothesis
49 {
50 public:
51   // Constructor
52   StdMeshers_CartesianParameters3D( int hypId, SMESH_Gen * gen );
53
54   /*!
55    * Sets coordinates of node positions along an axis (countered from 0)
56    */
57   void SetGrid(std::vector<double>& xNodes, int axis) throw ( SALOME_Exception );
58   /*!
59    * Return coordinates of node positions along the three axes
60    */
61   void GetGrid(std::vector<double>& xNodes, int axis) const throw ( SALOME_Exception );
62
63   /*!
64    * \brief Set grid spacing along the three axes
65    *  \param spaceFunctions - functions defining spacing values at given point on axis
66    *  \param internalPoints - points dividing a grid into parts along each direction
67    *
68    * Parameter t of spaceFunction f(t) is a position [0,1] within bounding box of
69    * the shape to mesh
70    */
71   void SetGridSpacing(std::vector<std::string>& spaceFunctions,
72                       std::vector<double>&      internalPoints,
73                       const int                 axis) throw ( SALOME_Exception );
74
75   void GetGridSpacing(std::vector<std::string>& spaceFunctions,
76                       std::vector<double>&      internalPoints,
77                       const int                 axis) const throw ( SALOME_Exception );
78
79   bool IsGridBySpacing(const int axis) const throw ( SALOME_Exception );
80
81   /*!
82    * Set/unset a fixed point, at which a node will be created provided that grid
83    * is defined by spacing in all directions
84    */
85   void SetFixedPoint(const double p[3], bool toUnset);
86   bool GetFixedPoint(double p[3]) const;
87
88   /*!
89    * \brief Computes node coordinates by spacing functions
90    *  \param x0 - lower coordinate
91    *  \param x1 - upper coordinate
92    *  \param spaceFuns - space functions
93    *  \param points - internal points
94    *  \param coords - the computed coordinates
95    */
96   static void ComputeCoordinates(const double              x0,
97                                  const double              x1,
98                                  std::vector<std::string>& spaceFuns,
99                                  std::vector<double>&      points,
100                                  std::vector<double>&      coords,
101                                  const std::string&        axis,
102                                  const double*             xForced=0) throw (SALOME_Exception);
103   /*!
104    * Return coordinates of node positions along the three axes.
105    * If the grid is defined by spacing functions, the coordinates are computed
106    */
107   void GetCoordinates(std::vector<double>& xNodes,
108                       std::vector<double>& yNodes,
109                       std::vector<double>& zNodes,
110                       const Bnd_Box&       bndBox) const throw ( SALOME_Exception );
111
112   /*!
113    * \brief Set custom direction of axes
114    */
115   void SetAxisDirs(const double* the9DirComps) throw ( SALOME_Exception );
116   const double* GetAxisDirs() const { return _axisDirs; }
117   /*!
118    * \brief Returns axes at which number of hexahedra is maximal
119    */
120   static void ComputeOptimalAxesDirs(const TopoDS_Shape& shape,
121                                      const bool          isOrthogonal,
122                                      double              dirCoords[9]);
123   /*!
124    * Set size threshold. A polyhedral cell got by cutting an initial
125    * hexahedron by geometry boundary is considered small and is removed if
126    * it's size is \athreshold times less than the size of the initial hexahedron.
127    */
128   void SetSizeThreshold(const double threshold) throw ( SALOME_Exception );
129   /*!
130    * \brief Return size threshold
131    */
132   double GetSizeThreshold() const;
133
134   /*!
135    * \brief Enables implementation of geometrical edges into the mesh. If this feature
136    *        is disabled, sharp edges of the shape are lost ("smoothed") in the mesh if
137    *        they don't coincide with the grid lines
138    */
139   void SetToAddEdges(bool toAdd);
140   bool GetToAddEdges() const;
141
142   /*!
143    * \brief Enables treatment of geom faces either shared by solids or internal.
144    */
145   void SetToConsiderInternalFaces(bool toTreat);
146   bool GetToConsiderInternalFaces() const { return _toConsiderInternalFaces; }
147
148   /*!
149    * \brief Enables applying size threshold to grid cells cut by internal geom faces.
150    */
151   void SetToUseThresholdForInternalFaces(bool toUse);
152   bool GetToUseThresholdForInternalFaces() const { return _toUseThresholdForInternalFaces; }
153
154   /*!
155    * \brief Enables creation of mesh faces.
156    */
157   void SetToCreateFaces(bool toCreate);
158   bool GetToCreateFaces() const { return _toCreateFaces; }
159
160
161   /*!
162    * \brief Return true if parameters are well defined
163    */
164   bool IsDefined() const;
165
166   /*!
167    * \brief Persistence methods
168    */
169   virtual std::ostream & SaveTo(std::ostream & save);
170   virtual std::istream & LoadFrom(std::istream & load);
171
172   /*!
173    * \brief Initialize my parameter values by the mesh built on the geometry
174    */
175   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
176
177   /*!
178    * \brief Initialize my parameter values by default parameters.
179    */
180   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
181
182  protected:
183
184   std::vector<double>      _coords[3];
185   std::vector<std::string> _spaceFunctions[3];
186   std::vector<double>      _internalPoints[3];
187
188   double _axisDirs  [9];
189   double _fixedPoint[3];
190
191   double _sizeThreshold;
192   bool   _toAddEdges;
193   bool   _toConsiderInternalFaces;
194   bool   _toUseThresholdForInternalFaces;
195   bool   _toCreateFaces;
196 };
197
198 #endif
199