Salome HOME
SALOME_TESTS/Grids/smesh/mesh_Projection_2D_00/A0
[modules/smesh.git] / src / StdMeshers / StdMeshers_FaceSide.hxx
1 // Copyright (C) 2007-2014  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_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_Face.hxx>
39 #include <TopoDS_Vertex.hxx>
40 #include <gp_Pnt2d.hxx>
41
42 #include <vector>
43 #include <list>
44 #include <boost/shared_ptr.hpp>
45
46 class SMDS_MeshNode;
47 class SMESH_Mesh;
48 class Adaptor2d_Curve2d;
49 class Adaptor3d_Curve;
50 class BRepAdaptor_CompCurve;
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 Create a side from an UVPtStructVec
98    */
99   StdMeshers_FaceSide(UVPtStructVec&     theSideNodes,
100                       const TopoDS_Face& theFace = TopoDS_Face());
101
102   // static "consrtuctors"
103   static StdMeshers_FaceSidePtr New(const TopoDS_Face&   Face,
104                                     const TopoDS_Edge&   Edge,
105                                     SMESH_Mesh*          Mesh,
106                                     const bool           IsForward,
107                                     const bool           IgnoreMediumNodes,
108                                     SMESH_ProxyMesh::Ptr ProxyMesh = SMESH_ProxyMesh::Ptr())
109   { return StdMeshers_FaceSidePtr
110       ( new StdMeshers_FaceSide( Face,Edge,Mesh,IsForward,IgnoreMediumNodes,ProxyMesh ));
111   }
112   static StdMeshers_FaceSidePtr New (const TopoDS_Face&      Face,
113                                      std::list<TopoDS_Edge>& Edges,
114                                      SMESH_Mesh*             Mesh,
115                                      const bool              IsForward,
116                                      const bool              IgnoreMediumNodes,
117                                      SMESH_ProxyMesh::Ptr    ProxyMesh = SMESH_ProxyMesh::Ptr())
118   { return StdMeshers_FaceSidePtr
119       ( new StdMeshers_FaceSide( Face,Edges,Mesh,IsForward,IgnoreMediumNodes,ProxyMesh ));
120   }
121   static StdMeshers_FaceSidePtr New (const StdMeshers_FaceSide*  Side,
122                                      const SMDS_MeshNode*        Node,
123                                      const gp_Pnt2d*             Pnt2d1,
124                                      const gp_Pnt2d*             Pnt2d2=NULL,
125                                      const Handle(Geom2d_Curve)& C2d=NULL,
126                                      const double                UFirst=0.,
127                                      const double                ULast=1.)
128   { return StdMeshers_FaceSidePtr
129       ( new StdMeshers_FaceSide( Side,Node,Pnt2d1,Pnt2d2,C2d,UFirst,ULast ));
130   }
131   static StdMeshers_FaceSidePtr New (UVPtStructVec&     theSideNodes,
132                                      const TopoDS_Face& theFace = TopoDS_Face())
133   {
134     return StdMeshers_FaceSidePtr( new StdMeshers_FaceSide( theSideNodes, theFace ));
135   }
136
137   /*!
138    * \brief Return wires of a face as StdMeshers_FaceSide's
139    */
140   static TSideVector GetFaceWires(const TopoDS_Face&   theFace,
141                                   SMESH_Mesh &         theMesh,
142                                   const bool           theIgnoreMediumNodes,
143                                   TError &             theError,
144                                   SMESH_ProxyMesh::Ptr theProxyMesh = SMESH_ProxyMesh::Ptr());
145   /*!
146    * \brief Change orientation of side geometry
147    */
148   void Reverse();
149   /*!
150    * \brief Make ignore medium nodes
151    */
152   void SetIgnoreMediumNodes(bool toIgnore);
153
154   /*!
155    * \brief Return nb nodes on edges and vertices (+1 to be == GetUVPtStruct().size() ).
156    *        Call it with update == true if mesh of this side can be recomputed
157    *        since creation of this side
158    */
159   int NbPoints(const bool update = false) const;
160   /*!
161    * \brief Return nb edges
162    *        Call it with update == true if mesh of this side can be recomputed
163    *        since creation of this side
164    */
165   int NbSegments(const bool update = false) const;
166   /*!
167    * \brief Return mesh
168    */
169   SMESH_Mesh* GetMesh() const { return myProxyMesh->GetMesh(); }
170   /*!
171    * \brief Return true if there are vertices without nodes
172    */
173   bool MissVertexNode() const { return myMissingVertexNodes; }
174
175   /*!
176    * \brief Return detailed data on nodes
177     * \param isXConst - true if normalized parameter X is constant
178     * \param constValue - constant parameter value
179     *
180     * Missing nodes are allowed only on internal vertices.
181     * For a closed side, the 1st point repeats at end
182    */
183   const UVPtStructVec& GetUVPtStruct(bool isXConst =0, double constValue =0) const;
184   /*!
185    * \brief Simulates detailed data on nodes
186     * \param isXConst - true if normalized parameter X is constant
187     * \param constValue - constant parameter value
188    */
189   const UVPtStructVec& SimulateUVPtStruct(int    nbSeg,
190                                           bool   isXConst   = 0,
191                                           double constValue = 0) const;
192   /*!
193    * \brief Return nodes in the order they encounter while walking along the side.
194     * For a closed side, the 1st point repeats at end
195    */
196   std::vector<const SMDS_MeshNode*> GetOrderedNodes() const;
197
198   /*!
199    * \brief Return edge and parameter on edge by normalized parameter
200    */
201   inline double Parameter(double U, TopoDS_Edge & edge) const;
202   /*!
203    * \brief Return UV by normalized parameter
204    */
205   gp_Pnt2d Value2d(double U) const;
206   /*!
207    * \brief Return XYZ by normalized parameter
208    */
209   gp_Pnt   Value3d(double U) const;
210   /*!
211    * \brief Creates a Adaptor2d_Curve2d to be used in SMESH_Block
212    */
213   Adaptor2d_Curve2d* GetCurve2d() const;
214   /*!
215    * \brief Creates a fully functional Adaptor_Curve
216    */
217   BRepAdaptor_CompCurve* GetCurve3d() const;
218   /*!
219    * \brief Return nb of wrapped edges
220    */
221   int NbEdges() const { return myEdge.size(); }
222   /*!
223    * \brief Return i-th edge (count starts from zero)
224    */
225   const TopoDS_Edge& Edge(int i) const { return myEdge[i]; }
226   /*!
227    * \brief Return all edges
228    */
229   const std::vector<TopoDS_Edge>& Edges() const { return myEdge; }
230   /*!
231    * \brief Return 1st vertex of the i-the edge (count starts from zero)
232    */
233   TopoDS_Vertex FirstVertex(int i=0) const;
234   /*!
235    * \brief Return last vertex of the i-the edge (count starts from zero)
236    */
237   TopoDS_Vertex LastVertex(int i=-1) const;
238   /*!
239    * \brief Return side length
240    */
241   double Length() const { return myLength; }
242   /*!
243    * \brief Return edge index corresponding to normalized parameter
244    */
245   inline int EdgeIndex( double U ) const;
246
247   //virtual gp_Pnt Value(double U) const;
248   
249   void dump(const char* msg=0) const;
250   
251   /*!
252    * \brief Return ID of i-th wrapped edge (count starts from zero)
253    */
254   inline int EdgeID(int i) const;
255   /*!
256    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
257    */
258   inline Handle(Geom2d_Curve) Curve2d(int i) const;
259   /*!
260    * \brief Return first normalized parameter of the i-the edge (count starts from zero)
261    */
262   inline double FirstParameter(int i) const;
263   /*!
264    * \brief Return last normalized parameter of the i-the edge (count starts from zero)
265    */
266   inline double LastParameter(int i) const;
267   /*!
268    * \brief Return first parameter of the i-the edge (count starts from zero).
269    *        EDGE orientation is taken into account
270    */
271   inline double FirstU(int i) const;
272   /*!
273    * \brief Return last parameter of the i-the edge (count starts from zero).
274    *        EDGE orientation is taken into account
275    */
276   inline double LastU(int i) const;
277   /*!
278    * \brief Return length of i-th wrapped edge (count starts from zero)
279    */
280   inline double EdgeLength(int i) const;
281   /*!
282    * \brief Return orientation of i-th wrapped edge (count starts from zero)
283    */
284   inline bool IsReversed(int i) const;
285
286 protected:
287
288   void reverseProxySubmesh( const TopoDS_Edge& E );
289
290   // DON't FORGET to update Reverse() when adding one more vector!
291   std::vector<uvPtStruct>           myPoints, myFalsePoints;
292   std::vector<TopoDS_Edge>          myEdge;
293   std::vector<int>                  myEdgeID;
294   std::vector<Handle(Geom2d_Curve)> myC2d;
295   std::vector<GeomAdaptor_Curve>    myC3dAdaptor;
296   std::vector<double>               myFirst, myLast;
297   std::vector<double>               myNormPar;
298   std::vector<double>               myEdgeLength;
299   std::vector<int>                  myIsUniform;
300   double                            myLength;
301   int                               myNbPonits, myNbSegments;
302   SMESH_ProxyMesh::Ptr              myProxyMesh;
303   bool                              myMissingVertexNodes, myIgnoreMediumNodes;
304   gp_Pnt2d                          myDefaultPnt2d;
305 };
306
307
308 //================================================================================
309 /*!
310  * \brief Return edge index corresponding to normalized parameter
311   * \param U - the parameter
312   * \retval int - index
313  */
314 //================================================================================
315
316 inline int StdMeshers_FaceSide::EdgeIndex( double U ) const
317 {
318   int i = myNormPar.size() - 1;
319   while ( i > 0 && U < myNormPar[ i-1 ] ) --i;
320   return i;
321 }
322
323 //================================================================================
324 /*!
325  * \brief Return edge and parameter on edge by normalized parameter
326   * \param U - the parameter
327   * \retval double - pameter on a curve
328  */
329 //================================================================================
330
331 inline double StdMeshers_FaceSide::Parameter(double U, TopoDS_Edge & edge) const
332 {
333   int i = EdgeIndex( U );
334   edge = myEdge[ i ];
335   double prevU = i ? myNormPar[ i-1 ] : 0;
336   double r = ( U - prevU )/ ( myNormPar[ i ] - prevU );
337   return myFirst[i] * ( 1 - r ) + myLast[i] * r;
338 }
339
340 //================================================================================
341 /*!
342  * \brief Return first normalized parameter of the i-the edge
343  */
344 //================================================================================
345
346 inline double StdMeshers_FaceSide::FirstParameter(int i) const
347 {
348   return i==0 ? 0. : i<(int)myNormPar.size() ? myNormPar[i-1] : 1.;
349 }
350
351 //================================================================================
352 /*!
353  * \brief Return ast normalized parameter of the i-the edge
354  */
355 //================================================================================
356
357 inline double StdMeshers_FaceSide::LastParameter(int i) const
358 {
359   return i < (int)myNormPar.size() ? myNormPar[i] : 1;
360 }
361
362 //================================================================================
363 /*!
364  * \brief Return first parameter of the i-the edge
365  */
366 //================================================================================
367
368 inline double StdMeshers_FaceSide::FirstU(int i) const
369 {
370   return myFirst[ i % myFirst.size() ];
371 }
372
373 //================================================================================
374 /*!
375  * \brief Return last parameter of the i-the edge
376  */
377 //================================================================================
378
379 inline double StdMeshers_FaceSide::LastU(int i) const
380 {
381   return myLast[ i % myLast.size() ];
382 }
383
384 //================================================================================
385   /*!
386    * \brief Return ID of i-th wrapped edge (count starts from zero)
387    */
388 //================================================================================
389
390 inline int StdMeshers_FaceSide::EdgeID(int i) const
391 {
392   return myEdgeID[ i % myEdgeID.size() ];
393 }
394
395 //================================================================================
396 /*!
397    * \brief Return p-curve of i-th wrapped edge (count starts from zero)
398    */
399 //================================================================================
400
401 inline Handle(Geom2d_Curve) StdMeshers_FaceSide::Curve2d(int i) const
402 {
403   return myC2d[ i % myC2d.size() ];
404 }
405
406 //================================================================================
407 /*!
408  * \brief Return length of i-th wrapped edge (count starts from zero)
409  */
410  //================================================================================
411
412 inline double StdMeshers_FaceSide::EdgeLength(int i) const
413 {
414   return myEdgeLength[ i % myEdgeLength.size() ];
415 }
416
417 //================================================================================
418 /*!
419  * \brief Return orientation of i-th wrapped edge (count starts from zero)
420  */
421  //================================================================================
422
423 inline bool StdMeshers_FaceSide::IsReversed(int i) const
424 {
425   return myFirst[i] > myLast[i];
426 }
427
428 #endif