Salome HOME
22361: EDF SMESH: Quadrangle (mapping) algorithm: faces with more than 4 edges
[modules/smesh.git] / src / StdMeshers / StdMeshers_FaceSide.hxx
1 // Copyright (C) 2007-2013  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.
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_FaceSide.hxx
24 // Created   : Wed Jan 31 18:41:25 2007
25 // Author    : Edward AGAPOV (eap)
26 // Module    : SMESH
27 //
28 #ifndef StdMeshers_FaceSide_HeaderFile
29 #define StdMeshers_FaceSide_HeaderFile
30
31 #include "SMESH_StdMeshers.hxx"
32
33 #include "SMESH_ProxyMesh.hxx"
34
35 #include <Geom2d_Curve.hxx>
36 #include <GeomAdaptor_Curve.hxx>
37 #include <TopoDS_Edge.hxx>
38 #include <TopoDS_Vertex.hxx>
39 #include <gp_Pnt2d.hxx>
40
41 #include <vector>
42 #include <list>
43 #include <boost/shared_ptr.hpp>
44
45 class SMDS_MeshNode;
46 class SMESH_Mesh;
47 class Adaptor2d_Curve2d;
48 class Adaptor3d_Curve;
49 class BRepAdaptor_CompCurve;
50 class TopoDS_Face;
51 struct SMESH_ComputeError;
52 class StdMeshers_FaceSide;
53
54 typedef boost::shared_ptr< SMESH_ComputeError >  TError;
55 typedef boost::shared_ptr< StdMeshers_FaceSide > StdMeshers_FaceSidePtr;
56 typedef std::vector< StdMeshers_FaceSidePtr >    TSideVector;
57
58 //================================================================================
59 /*!
60  * \brief Represents a side of a quasi quadrilateral face.
61  * It can be composed of several edges. Gives access to geometry and 1D mesh of a side.
62  */
63 //================================================================================
64
65 class STDMESHERS_EXPORT StdMeshers_FaceSide
66 {
67 public:
68   /*!
69    * \brief Wrap one edge
70    */
71   StdMeshers_FaceSide(const TopoDS_Face&   theFace,
72                       const TopoDS_Edge&   theEdge,
73                       SMESH_Mesh*          theMesh,
74                       const bool           theIsForward,
75                       const bool           theIgnoreMediumNodes,
76                       SMESH_ProxyMesh::Ptr theProxyMesh = SMESH_ProxyMesh::Ptr());
77   /*!
78    * \brief Wrap several edges. Edges must be properly ordered and oriented.
79    */
80   StdMeshers_FaceSide(const TopoDS_Face&      theFace,
81                       std::list<TopoDS_Edge>& theEdges,
82                       SMESH_Mesh*             theMesh,
83                       const bool              theIsForward,
84                       const bool              theIgnoreMediumNodes,
85                       SMESH_ProxyMesh::Ptr    theProxyMesh = SMESH_ProxyMesh::Ptr());
86   /*!
87    * \brief Simulate a side from a vertex using data from other FaceSide
88    */
89   StdMeshers_FaceSide(const StdMeshers_FaceSide*  theSide,
90                       const SMDS_MeshNode*        theNode,
91                       const gp_Pnt2d*             thePnt2d1,
92                       const gp_Pnt2d*             thePnt2d2=NULL,
93                       const Handle(Geom2d_Curve)& theC2d=NULL,
94                       const double                theUFirst=0.,
95                       const double                theULast=1.);
96   /*!
97    * \brief Return wires of a face as StdMeshers_FaceSide's
98    */
99   static TSideVector GetFaceWires(const TopoDS_Face&   theFace,
100                                   SMESH_Mesh &         theMesh,
101                                   const bool           theIgnoreMediumNodes,
102                                   TError &             theError,
103                                   SMESH_ProxyMesh::Ptr theProxyMesh = SMESH_ProxyMesh::Ptr());
104   /*!
105    * \brief Change orientation of side geometry
106    */
107   void Reverse();
108   /*!
109    * \brief Make ignore medium nodes
110    */
111   void SetIgnoreMediumNodes(bool toIgnore);
112
113   /*!
114    * \brief Return nb nodes on edges and vertices (+1 to be == GetUVPtStruct().size() ).
115    *        Call it with update == true if mesh of this side can be recomputed
116    *        since creation of this side
117    */
118   int NbPoints(const bool update = false) const;
119   /*!
120    * \brief Return nb edges
121    *        Call it with update == true if mesh of this side can be recomputed
122    *        since creation of this side
123    */
124   int NbSegments(const bool update = false) const;
125   /*!
126    * \brief Return mesh
127    */
128   SMESH_Mesh* GetMesh() const { return myProxyMesh->GetMesh(); }
129   /*!
130    * \brief Return true if there are vertices without nodes
131    */
132   bool MissVertexNode() const { return myMissingVertexNodes; }
133
134   /*!
135    * \brief Return detailed data on nodes
136     * \param isXConst - true if normalized parameter X is constant
137     * \param constValue - constant parameter value
138     *
139     * Missing nodes are allowed only on internal vertices.
140     * For a closed side, the 1st point repeats at end
141    */
142   const UVPtStructVec& GetUVPtStruct(bool isXConst =0, double constValue =0) const;
143   /*!
144    * \brief Simulates detailed data on nodes
145     * \param isXConst - true if normalized parameter X is constant
146     * \param constValue - constant parameter value
147    */
148   const UVPtStructVec& SimulateUVPtStruct(int    nbSeg,
149                                           bool   isXConst   = 0,
150                                           double constValue = 0) const;
151   /*!
152    * \brief Return nodes in the order they encounter while walking along the side.
153     * For a closed side, the 1st point repeats at end
154    */
155   std::vector<const SMDS_MeshNode*> GetOrderedNodes() const;
156
157   /*!
158    * \brief Return edge and parameter on edge by normalized parameter
159    */
160   inline double Parameter(double U, TopoDS_Edge & edge) const;
161   /*!
162    * \brief Return UV by normalized parameter
163    */
164   gp_Pnt2d Value2d(double U) const;
165   /*!
166    * \brief Return XYZ by normalized parameter
167    */
168   gp_Pnt   Value3d(double U) const;
169   /*!
170    * \brief Creates a Adaptor2d_Curve2d to be used in SMESH_Block
171    */
172   Adaptor2d_Curve2d* GetCurve2d() const;
173   /*!
174    * \brief Creates a fully functional Adaptor_Curve
175    */
176   BRepAdaptor_CompCurve* GetCurve3d() const;
177   /*!
178    * \brief Return nb of wrapped edges
179    */
180   int NbEdges() const { return myEdge.size(); }
181   /*!
182    * \brief Return i-th wrapped edge (count starts from zero)
183    */
184   const TopoDS_Edge& Edge(int i) const { return myEdge[i]; }
185   /*!
186    * \brief Return all edges
187    */
188   const std::vector<TopoDS_Edge>& Edges() const { return myEdge; }
189   /*!
190    * \brief Return 1st vertex of the i-the edge (count starts from zero)
191    */
192   TopoDS_Vertex FirstVertex(int i=0) const;
193   /*!
194    * \brief Return last vertex of the i-the edge (count starts from zero)
195    */
196   TopoDS_Vertex LastVertex(int i=-1) const;
197   /*!
198    * \brief Return side length
199    */
200   double Length() const { return myLength; }
201   /*!
202    * \brief Return edge index corresponding to normalized parameter
203    */
204   inline int EdgeIndex( double U ) const;
205
206   //virtual gp_Pnt Value(double U) const;
207   
208   void dump(const char* msg=0) const;
209   
210   /*!
211    * \brief Return ID of i-th wrapped edge (count starts from zero)
212    */
213   inline int EdgeID(int i) const;
214   /*!
215    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
216    */
217   inline Handle(Geom2d_Curve) Curve2d(int i) const;
218   /*!
219    * \brief Return first normalized parameter of the i-the edge (count starts from zero)
220    */
221   inline double FirstParameter(int i) const;
222   /*!
223    * \brief Return last normalized parameter of the i-the edge (count starts from zero)
224    */
225   inline double LastParameter(int i) const;
226   /*!
227    * \brief Return first parameter of the i-the edge (count starts from zero).
228    *        EDGE orientation is taken into account
229    */
230   inline double FirstU(int i) const;
231   /*!
232    * \brief Return last parameter of the i-the edge (count starts from zero).
233    *        EDGE orientation is taken into account
234    */
235   inline double LastU(int i) const;
236   /*!
237    * \brief Return length of i-th wrapped edge (count starts from zero)
238    */
239   inline double EdgeLength(int i) const;
240   /*!
241    * \brief Return orientation of i-th wrapped edge (count starts from zero)
242    */
243   inline bool IsReversed(int i) const;
244
245 protected:
246
247   void reverseProxySubmesh( const TopoDS_Edge& E );
248
249   // DON't FORGET to update Reverse() when adding one more vector!
250   std::vector<uvPtStruct>           myPoints, myFalsePoints;
251   std::vector<TopoDS_Edge>          myEdge;
252   std::vector<int>                  myEdgeID;
253   std::vector<Handle(Geom2d_Curve)> myC2d;
254   std::vector<GeomAdaptor_Curve>    myC3dAdaptor;
255   std::vector<double>               myFirst, myLast;
256   std::vector<double>               myNormPar;
257   std::vector<double>               myEdgeLength;
258   std::vector<int>                  myIsUniform;
259   double                            myLength;
260   int                               myNbPonits, myNbSegments;
261   SMESH_ProxyMesh::Ptr              myProxyMesh;
262   bool                              myMissingVertexNodes, myIgnoreMediumNodes;
263   gp_Pnt2d                          myDefaultPnt2d;
264 };
265
266
267 //================================================================================
268 /*!
269  * \brief Return edge index corresponding to normalized parameter
270   * \param U - the parameter
271   * \retval int - index
272  */
273 //================================================================================
274
275 inline int StdMeshers_FaceSide::EdgeIndex( double U ) const
276 {
277   int i = myNormPar.size() - 1;
278   while ( i > 0 && U < myNormPar[ i-1 ] ) --i;
279   return i;
280 }
281
282 //================================================================================
283 /*!
284  * \brief Return edge and parameter on edge by normalized parameter
285   * \param U - the parameter
286   * \retval double - pameter on a curve
287  */
288 //================================================================================
289
290 inline double StdMeshers_FaceSide::Parameter(double U, TopoDS_Edge & edge) const
291 {
292   int i = EdgeIndex( U );
293   edge = myEdge[ i ];
294   double prevU = i ? myNormPar[ i-1 ] : 0;
295   double r = ( U - prevU )/ ( myNormPar[ i ] - prevU );
296   return myFirst[i] * ( 1 - r ) + myLast[i] * r;
297 }
298
299 //================================================================================
300 /*!
301  * \brief Return first normalized parameter of the i-the edge
302  */
303 //================================================================================
304
305 inline double StdMeshers_FaceSide::FirstParameter(int i) const
306 {
307   return i==0 ? 0. : i<(int)myNormPar.size() ? myNormPar[i-1] : 1.;
308 }
309
310 //================================================================================
311 /*!
312  * \brief Return ast normalized parameter of the i-the edge
313  */
314 //================================================================================
315
316 inline double StdMeshers_FaceSide::LastParameter(int i) const
317 {
318   return i < (int)myNormPar.size() ? myNormPar[i] : 1;
319 }
320
321 //================================================================================
322 /*!
323  * \brief Return first parameter of the i-the edge
324  */
325 //================================================================================
326
327 inline double StdMeshers_FaceSide::FirstU(int i) const
328 {
329   return myFirst[ i % myFirst.size() ];
330 }
331
332 //================================================================================
333 /*!
334  * \brief Return last parameter of the i-the edge
335  */
336 //================================================================================
337
338 inline double StdMeshers_FaceSide::LastU(int i) const
339 {
340   return myLast[ i % myLast.size() ];
341 }
342
343 //================================================================================
344   /*!
345    * \brief Return ID of i-th wrapped edge (count starts from zero)
346    */
347 //================================================================================
348
349 inline int StdMeshers_FaceSide::EdgeID(int i) const
350 {
351   return myEdgeID[ i % myEdgeID.size() ];
352 }
353
354 //================================================================================
355 /*!
356    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
357    */
358 //================================================================================
359
360 inline Handle(Geom2d_Curve) StdMeshers_FaceSide::Curve2d(int i) const
361 {
362   return myC2d[ i % myC2d.size() ];
363 }
364
365 //================================================================================
366 /*!
367  * \brief Return length of i-th wrapped edge (count starts from zero)
368  */
369  //================================================================================
370
371 inline double StdMeshers_FaceSide::EdgeLength(int i) const
372 {
373   return myEdgeLength[ i % myEdgeLength.size() ];
374 }
375
376 //================================================================================
377 /*!
378  * \brief Return orientation of i-th wrapped edge (count starts from zero)
379  */
380  //================================================================================
381
382 inline bool StdMeshers_FaceSide::IsReversed(int i) const
383 {
384   return myFirst[i] > myLast[i];
385 }
386
387 #endif