Salome HOME
52453: Impossible to get viscous layers on a given shape
[modules/smesh.git] / src / SMESH / SMESH_MesherHelper.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:      SMESH_MesherHelper.hxx
24 // Created:   15.02.06 14:48:09
25 // Author:    Sergey KUUL
26 //
27 #ifndef SMESH_MesherHelper_HeaderFile
28 #define SMESH_MesherHelper_HeaderFile
29
30 #include "SMESH_SMESH.hxx"
31
32 #include "SMESH_MeshEditor.hxx" // needed for many meshers
33 #include <SMDS_MeshNode.hxx>
34 #include <SMDS_QuadraticEdge.hxx>
35
36 #include <Geom_Surface.hxx>
37 #include <TopoDS_Face.hxx>
38 #include <TopoDS_Shape.hxx>
39 #include <gp_Pnt2d.hxx>
40
41 #include <map>
42 #include <vector>
43
44 class GeomAPI_ProjectPointOnSurf;
45 class GeomAPI_ProjectPointOnCurve;
46 class SMESH_ProxyMesh;
47
48 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>           TLinkNodeMap;
49 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
50
51 typedef SMDS_Iterator<const TopoDS_Shape*>  PShapeIterator;
52 typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
53   
54 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
55 typedef std::map< double, TNodeColumn >    TParam2ColumnMap;
56
57 typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
58
59 //=======================================================================
60 /*!
61  * \brief It helps meshers to add elements and provides other utilities
62  *
63  * - It allows meshers not to care about creation of medium nodes
64  * when filling a quadratic mesh. Helper does it itself.
65  * It defines order of elements to create when IsQuadraticSubMesh()
66  * is called.
67  * - It provides information on a shape it is initialized with:
68  * periodicity, presence of singularities etc.
69  * - ...
70  */
71 //=======================================================================
72
73 class SMESH_EXPORT SMESH_MesherHelper
74 {
75  public:
76   // ---------- PUBLIC UTILITIES ----------
77   
78   /*!
79    * \brief Returns true if all elements of a sub-mesh are of same shape
80     * \param smDS - sub-mesh to check elements of
81     * \param shape - expected shape of elements
82     * \param nullSubMeshRes - result value for the case of smDS == NULL
83     * \retval bool - check result
84    */
85   static bool IsSameElemGeometry(const SMESHDS_SubMesh* smDS,
86                                  SMDSAbs_GeometryType   shape,
87                                  const bool             nullSubMeshRes = true);
88
89   /*!
90    * \brief Load nodes bound to face into a map of node columns
91     * \param theParam2ColumnMap - map of node columns to fill
92     * \param theFace - the face on which nodes are searched for
93     * \param theBaseSide - the edges holding nodes on which columns' bases
94     * \param theMesh - the mesh containing nodes
95     * \retval bool - false if something is wrong
96    * 
97    * The key of the map is a normalized parameter of each
98    * base node on theBaseSide. Edges in theBaseSide must be sequenced.
99    * This method works in supposition that nodes on the face
100    * forms a structured grid and elements can be quardrangles or triangles
101    */
102   static bool LoadNodeColumns(TParam2ColumnMap &            theParam2ColumnMap,
103                               const TopoDS_Face&            theFace,
104                               const std::list<TopoDS_Edge>& theBaseSide,
105                               SMESHDS_Mesh*                 theMesh,
106                               SMESH_ProxyMesh*              theProxyMesh=0);
107   /*!
108    * \brief Variant of LoadNodeColumns() above with theBaseSide given by one edge
109    */
110   static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
111                               const TopoDS_Face& theFace,
112                               const TopoDS_Edge& theBaseEdge,
113                               SMESHDS_Mesh*      theMesh,
114                               SMESH_ProxyMesh*   theProxyMesh=0);
115   /*!
116    * \brief Return true if 2D mesh on FACE is structured
117    */
118   static bool IsStructured( SMESH_subMesh* faceSM );
119
120   /*!
121    * \brief Returns true if given node is medium
122     * \param n - node to check
123     * \param typeToCheck - type of elements containing the node to ask about node status
124     * \retval bool - check result
125    */
126   static bool IsMedium(const SMDS_MeshNode*      node,
127                        const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
128   /*!
129    * \brief Return support shape of a node
130    * \param node - the node
131    * \param meshDS - mesh DS
132    * \retval TopoDS_Shape - found support shape
133    * \sa SMESH_Algo::VertexNode( const TopoDS_Vertex&, SMESHDS_Mesh* )
134    */
135   static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
136                                         const SMESHDS_Mesh*  meshDS);
137
138   /*!
139    * \brief Return a valid node index, fixing the given one if necessary
140     * \param ind - node index
141     * \param nbNodes - total nb of nodes
142     * \retval int - valid node index
143    */
144   static inline int WrapIndex(int ind, const int nbNodes) {
145     return (( ind %= nbNodes ) < 0 ) ? ind + nbNodes : ind;
146   }
147
148   /*!
149    * \brief Return UV of a point inside a quadrilateral FACE by it's
150    *        normalized parameters within a unit quadrangle and the
151    *        corresponding projections on sub-shapes of the real-world FACE.
152    *        The used calculation method is called Trans-Finite Interpolation (TFI).
153    *  \param x,y - normalized parameters that should be in range [0,1]
154    *  \param a0,a1,a2,a3 - UV of VERTEXes of the FACE == projections on VERTEXes
155    *  \param p0,p1,p2,p3 - UV of the point projections on EDGEs of the FACE
156    *  \return gp_XY - UV of the point on the FACE
157    *
158    *  Y ^              Order of those UV in the FACE is as follows.
159    *    |
160    *   a3   p2    a2
161    *    o---x-----o
162    *    |   :     |
163    *    |   :UV   |
164    * p3 x...O.....x p1
165    *    |   :     |
166    *    o---x-----o    ----> X
167    *   a0   p0    a1
168    */
169   inline static gp_XY calcTFI(double x, double y,
170                               const gp_XY a0,const gp_XY a1,const gp_XY a2,const gp_XY a3,
171                               const gp_XY p0,const gp_XY p1,const gp_XY p2,const gp_XY p3);
172
173   /*!
174    * \brief Same as "gp_XY calcTFI(...)" but in 3D
175    */
176   inline static gp_XYZ calcTFI(double x, double y,
177                                const gp_XYZ a0,const gp_XYZ a1,const gp_XYZ a2,const gp_XYZ a3,
178                                const gp_XYZ p0,const gp_XYZ p1,const gp_XYZ p2,const gp_XYZ p3);
179   /*!
180    * \brief Count nb of sub-shapes
181     * \param shape - the shape
182     * \param type - the type of sub-shapes to count
183     * \param ignoreSame - if true, use map not to count same shapes, esle use explorer
184     * \retval int - the calculated number
185    */
186   static int Count(const TopoDS_Shape&    shape,
187                    const TopAbs_ShapeEnum type,
188                    const bool             ignoreSame);
189
190   /*!
191    * \brief Return number of unique ancestors of the shape
192    */
193   static int NbAncestors(const TopoDS_Shape& shape,
194                          const SMESH_Mesh&   mesh,
195                          TopAbs_ShapeEnum    ancestorType=TopAbs_SHAPE);
196   /*!
197    * \brief Return iterator on ancestors of the given type
198    */
199   static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
200                                         const SMESH_Mesh&   mesh,
201                                         TopAbs_ShapeEnum    ancestorType);
202   /*!
203    * \brief Find a common ancestor, of the given type, of two shapes
204    */
205   static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
206                                         const TopoDS_Shape& shape2,
207                                         const SMESH_Mesh&   mesh,
208                                         TopAbs_ShapeEnum    ancestorType);
209   /*!
210    * \brief Return orientation of sub-shape in the main shape
211    */
212   static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
213                                            const TopoDS_Shape& subShape);
214
215   static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
216
217   static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
218
219   static double MaxTolerance( const TopoDS_Shape& shape );
220
221   static double GetAngle( const TopoDS_Edge & E1, const TopoDS_Edge & E2,
222                           const TopoDS_Face & F,  const TopoDS_Vertex & V,
223                           gp_Vec* faceNormal=0);
224
225   static bool IsClosedEdge( const TopoDS_Edge& anEdge );
226
227   static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
228
229   static TopAbs_ShapeEnum GetGroupType(const TopoDS_Shape& group,
230                                        const bool          avoidCompound=false);
231
232
233 public:
234   // ---------- PUBLIC INSTANCE METHODS ----------
235
236   // constructor
237   SMESH_MesherHelper(SMESH_Mesh& theMesh);
238
239   SMESH_Mesh* GetMesh() const { return myMesh; }
240     
241   SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
242     
243   /*!
244    * Check submesh for given shape: if all elements on this shape are quadratic,
245    * quadratic elements will be created. Also fill myTLinkNodeMap
246    */
247   bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
248   /*!
249    * \brief Set order of elements to create without calling IsQuadraticSubMesh()
250    */
251
252   /*!
253    * \brief Set myCreateQuadratic flag
254    */
255   void SetIsQuadratic(const bool theBuildQuadratic)
256   { myCreateQuadratic = theBuildQuadratic; }
257
258   /*!
259    * \brief Set myCreateBiQuadratic flag
260    */
261   void SetIsBiQuadratic(const bool theBuildBiQuadratic)
262   { myCreateBiQuadratic = theBuildBiQuadratic; }
263   
264   /*!
265    * \brief Return myCreateQuadratic flag
266    */
267   bool GetIsQuadratic() const { return myCreateQuadratic; }
268
269   /*
270    * \brief Find out elements orientation on a geometrical face
271    */
272   bool IsReversedSubMesh (const TopoDS_Face& theFace);
273
274   /*!
275    * \brief Return myCreateBiQuadratic flag
276    */
277   bool GetIsBiQuadratic() const { return myCreateBiQuadratic; }
278
279   /*!
280    * \brief Move medium nodes of faces and volumes to fix distorted elements
281    * \param error - container of fixed distorted elements
282    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
283    */
284   void FixQuadraticElements(SMESH_ComputeErrorPtr& error, bool volumeOnly=true);
285
286   /*!
287    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
288    *        or the next methods. By defaul elements are set on the shape if
289    *        a mesh has no shape to be meshed
290    */
291   bool SetElementsOnShape(bool toSet)
292   { bool res = mySetElemOnShape; mySetElemOnShape = toSet; return res; }
293
294   /*!
295    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
296    */
297   void SetSubShape(const int           subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
298   void SetSubShape(const TopoDS_Shape& subShape);
299   /*!
300    * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape() 
301     * \retval int - shape index in SMESHDS
302    */
303   int GetSubShapeID() const { return myShapeID; }
304   /*!
305    * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape() 
306    */
307   const TopoDS_Shape& GetSubShape() const  { return myShape; }
308
309   /*!
310    * Creates a node (!Note ID before u=0.,v0.)
311    */
312   SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
313   /*!
314    * Creates quadratic or linear edge
315    */
316   SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
317                          const SMDS_MeshNode* n2,
318                          const int id = 0, 
319                          const bool force3d = true);
320   /*!
321    * Creates quadratic or linear triangle
322    */
323   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
324                          const SMDS_MeshNode* n2,
325                          const SMDS_MeshNode* n3,
326                          const int id=0, 
327                          const bool force3d = false);
328   /*!
329    * Creates bi-quadratic, quadratic or linear quadrangle
330    */
331   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
332                          const SMDS_MeshNode* n2,
333                          const SMDS_MeshNode* n3,
334                          const SMDS_MeshNode* n4,
335                          const int id = 0,
336                          const bool force3d = false);
337   /*!
338    * Creates polygon, with additional nodes in quadratic mesh
339    */
340   SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
341                                    const int id = 0,
342                                    const bool force3d = false);
343   /*!
344    * Creates quadratic or linear tetrahedron
345    */
346   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
347                              const SMDS_MeshNode* n2,
348                              const SMDS_MeshNode* n3,
349                              const SMDS_MeshNode* n4,
350                              const int id = 0,
351                              const bool force3d = true);
352   /*!
353    * Creates quadratic or linear pyramid
354    */
355   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
356                              const SMDS_MeshNode* n2,
357                              const SMDS_MeshNode* n3,
358                              const SMDS_MeshNode* n4,
359                              const SMDS_MeshNode* n5,
360                              const int id = 0,
361                              const bool force3d = true);
362   /*!
363    * Creates quadratic or linear pentahedron
364    */
365   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
366                              const SMDS_MeshNode* n2,
367                              const SMDS_MeshNode* n3,
368                              const SMDS_MeshNode* n4,
369                              const SMDS_MeshNode* n5,
370                              const SMDS_MeshNode* n6,
371                              const int id = 0, 
372                              const bool force3d = true);
373   /*!
374    * Creates bi-quadratic, quadratic or linear hexahedron
375    */
376   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
377                              const SMDS_MeshNode* n2,
378                              const SMDS_MeshNode* n3,
379                              const SMDS_MeshNode* n4,
380                              const SMDS_MeshNode* n5,
381                              const SMDS_MeshNode* n6,
382                              const SMDS_MeshNode* n7,
383                              const SMDS_MeshNode* n8,
384                              const int id = 0, 
385                              bool force3d = true);
386
387   /*!
388    * Creates LINEAR!!!!!!!!! octahedron
389    */
390   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
391                              const SMDS_MeshNode* n2,
392                              const SMDS_MeshNode* n3,
393                              const SMDS_MeshNode* n4,
394                              const SMDS_MeshNode* n5,
395                              const SMDS_MeshNode* n6,
396                              const SMDS_MeshNode* n7,
397                              const SMDS_MeshNode* n8,
398                              const SMDS_MeshNode* n9,
399                              const SMDS_MeshNode* n10,
400                              const SMDS_MeshNode* n11,
401                              const SMDS_MeshNode* n12,
402                              const int id = 0, 
403                              bool force3d = true);
404
405   /*!
406    * Creates polyhedron. In quadratic mesh, adds medium nodes
407    */
408   SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
409                                         const std::vector<int>&                  quantities,
410                                         const int                                ID=0,
411                                         const bool                               force3d = true);
412   /*!
413    * \brief Enables fixing node parameters on EDGEs and FACEs by
414    * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
415    * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
416    * Default is False
417    */
418   void ToFixNodeParameters(bool toFix);
419
420   /*!
421    * \brief Return U of the given node on the edge
422    */
423   double GetNodeU(const TopoDS_Edge&   theEdge,
424                   const SMDS_MeshNode* theNode,
425                   const SMDS_MeshNode* inEdgeNode=0,
426                   bool*                check=0) const;
427   /*!
428    * \brief Return node UV on face
429    *  \param inFaceNode - a node of element being created located inside a face
430    *  \param check - if provided, returns result of UV check that it enforces
431    */
432   gp_XY GetNodeUV(const TopoDS_Face&   F,
433                   const SMDS_MeshNode* n,
434                   const SMDS_MeshNode* inFaceNode=0,
435                   bool*                check=0) const;
436   /*!
437    * \brief Check and fix node UV on a face
438    *  \param force - check even if checks of other nodes on this face passed OK
439    *  \param distXYZ - returns result distance and point coordinates
440    *  \retval bool - false if UV is bad and could not be fixed
441    */
442   bool CheckNodeUV(const TopoDS_Face&   F,
443                    const SMDS_MeshNode* n,
444                    gp_XY&               uv,
445                    const double         tol,
446                    const bool           force=false,
447                    double               distXYZ[4]=0) const;
448   /*!
449    * \brief Check and fix node U on an edge
450    *  \param force - check even if checks of other nodes on this edge passed OK
451    *  \param distXYZ - returns result distance and point coordinates
452    *  \retval bool - false if U is bad and could not be fixed
453    */
454   bool CheckNodeU(const TopoDS_Edge&   E,
455                   const SMDS_MeshNode* n,
456                   double&              u,
457                   const double         tol,
458                   const bool           force=false,
459                   double               distXYZ[4]=0) const;
460   /*!
461    * \brief Return middle UV taking in account surface period
462    */
463   static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
464                            const gp_XY&                uv1,
465                            const gp_XY&                uv2);
466   /*!
467    * \brief Return UV for the central node of a biquadratic triangle
468    */
469   static gp_XY GetCenterUV(const gp_XY& uv1,
470                            const gp_XY& uv2, 
471                            const gp_XY& uv3, 
472                            const gp_XY& uv12,
473                            const gp_XY& uv23,
474                            const gp_XY& uv31,
475                            bool *       isBadTria=0);
476   /*!
477    * \brief Define a pointer to wrapper over a function of gp_XY class,
478    *       suitable to pass as xyFunPtr to applyIn2D().
479    *       For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
480    *       calling gp_XY::Added(gp_XY), which is to be used like following
481    *       applyIn2D(surf, uv1, uv2, gp_XY_Added)
482    */
483 #define gp_XY_FunPtr(meth) \
484   static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
485   static xyFunPtr gp_XY_##meth = & __gpXY_##meth
486
487   /*!
488    * \brief Perform given operation on two 2d points in parameric space of given surface.
489    *        It takes into account period of the surface. Use gp_XY_FunPtr macro
490    *        to easily define pointer to function of gp_XY class.
491    */
492   static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
493                          const gp_XY&                uv1,
494                          const gp_XY&                uv2,
495                          xyFunPtr                    fun,
496                          const bool                  resultInPeriod=true);
497                           
498   /*!
499    * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
500     * \retval bool - return true if the face is periodic
501     *
502     * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
503     * SetSubShape()
504    */
505   bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
506
507   /*!
508    * \brief Return projector intitialized by given face without location, which is returned
509    */
510   GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
511                                            TopLoc_Location&   loc,
512                                            double             tol=0 ) const; 
513
514   /*!
515    * \brief Check if shape is a degenerated edge or it's vertex
516     * \param subShape - edge or vertex index in SMESHDS
517     * \retval bool - true if subShape is a degenerated shape
518     *
519     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
520    */
521   bool IsDegenShape(const int subShape) const
522   { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
523   /*!
524    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
525    *        has a degenerated edges
526     * \retval bool - true if it has
527    */
528   bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
529
530   /*!
531    * \brief Check if shape is a seam edge or it's vertex
532     * \param subShape - edge or vertex index in SMESHDS
533     * \retval bool - true if subShape is a seam shape
534     *
535     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
536     * Seam shape has two 2D alternative represenations on the face
537    */
538   bool IsSeamShape(const int subShape) const
539   { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
540   /*!
541    * \brief Check if shape is a seam edge or it's vertex
542     * \param subShape - edge or vertex
543     * \retval bool - true if subShape is a seam shape
544     *
545     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
546     * Seam shape has two 2D alternative represenations on the face
547    */
548   bool IsSeamShape(const TopoDS_Shape& subShape) const
549   { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
550   /*!
551    * \brief Return true if an edge or a vertex encounters twice in face wire
552    *  \param subShape - Id of edge or vertex
553    */
554   bool IsRealSeam(const int subShape) const
555   { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
556   /*!
557    * \brief Return true if an edge or a vertex encounters twice in face wire
558    *  \param subShape - edge or vertex
559    */
560   bool IsRealSeam(const TopoDS_Shape& subShape) const
561   { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
562   /*!
563    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
564    *        has a seam edge, i.e. an edge that has two parametric representations
565    *        on a surface
566    *  \retval bool - true if it has
567    */
568   bool HasSeam() const { return !mySeamShapeIds.empty(); }
569   /*!
570    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
571    *        has a seam edge that encounters twice in a wire
572    *  \retval bool - true if it has
573    */
574   bool HasRealSeam() const { return HasSeam() && ( *mySeamShapeIds.begin() < 0 ); }
575   /*!
576    * \brief Return index of periodic parametric direction of a closed face
577    *  \retval int - 1 for U, 2 for V direction
578    */
579   int GetPeriodicIndex() const { return myParIndex; }
580   /*!
581    * \brief Return an alternative parameter for a node on seam
582    */
583   double GetOtherParam(const double param) const;
584
585   /*!
586    * \brief Return existing or create new medium nodes between given ones
587    *  \param force3d - true means node creation at the middle between the
588    *                   two given nodes, else node position is found on its
589    *                   supporting geometrical shape, if any.
590    */
591   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
592                                      const SMDS_MeshNode* n2,
593                                      const bool force3d);
594   /*!
595    * \brief Return existing or create a new central node for a quardilateral
596    *       quadratic face given its 8 nodes.
597    *  \param force3d - true means node creation in between the given nodes,
598    *                   else node position is found on a geometrical face if any.
599    */
600   const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
601                                       const SMDS_MeshNode* n2,
602                                       const SMDS_MeshNode* n3,
603                                       const SMDS_MeshNode* n4,
604                                       const SMDS_MeshNode* n12,
605                                       const SMDS_MeshNode* n23,
606                                       const SMDS_MeshNode* n34,
607                                       const SMDS_MeshNode* n41,
608                                       bool                 force3d);
609   /*!
610    * \brief Return existing or create a new central node for a 
611    *       quadratic triangle given its 6 nodes.
612    *  \param force3d - true means node creation in between the given nodes,
613    *                   else node position is found on a geometrical face if any.
614    */
615   const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
616                                       const SMDS_MeshNode* n2,
617                                       const SMDS_MeshNode* n3,
618                                       const SMDS_MeshNode* n12,
619                                       const SMDS_MeshNode* n23,
620                                       const SMDS_MeshNode* n31,
621                                       bool                 force3d);
622   /*!
623    * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
624    */
625   std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
626                                                 const SMDS_MeshNode* n2,
627                                                 const bool           useCurSubShape=false);
628   /*!
629    * \brief Add a link in my data structure
630    */
631   void AddTLinkNode(const SMDS_MeshNode* n1,
632                     const SMDS_MeshNode* n2,
633                     const SMDS_MeshNode* n12);
634   /*!
635    * \brief Add many links in my data structure
636    */
637   void AddTLinkNodeMap(const TLinkNodeMap& aMap)
638     { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
639
640   void AddTLinks(const SMDS_MeshEdge*   edge);
641   void AddTLinks(const SMDS_MeshFace*   face);
642   void AddTLinks(const SMDS_MeshVolume* vol);
643
644   /**
645    * Returns myTLinkNodeMap
646    */
647   const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
648
649   /**
650    * Check mesh without geometry for: if all elements on this shape are quadratic,
651    * quadratic elements will be created.
652    * Used then generated 3D mesh without geometry.
653    */
654   enum MType{ LINEAR, QUADRATIC, COMP };
655   MType IsQuadraticMesh();
656   
657   virtual ~SMESH_MesherHelper();
658
659  protected:
660
661   /*!
662    * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
663    *  \param uv1 - UV on the seam
664    *  \param uv2 - UV within a face
665    *  \retval gp_Pnt2d - selected UV
666    */
667   gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
668
669   const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
670                                                    const SMDS_MeshNode* n2,
671                                                    bool                 force3d);
672  private:
673
674   // Forbiden copy constructor
675   SMESH_MesherHelper (const SMESH_MesherHelper& theOther);
676
677   // key of a map of bi-quadratic face to it's central node
678   struct TBiQuad: public std::pair<int, std::pair<int, int> >
679   {
680     TBiQuad(const SMDS_MeshNode* n1,
681             const SMDS_MeshNode* n2, 
682             const SMDS_MeshNode* n3,
683             const SMDS_MeshNode* n4=0)
684     {
685       TIDSortedNodeSet s;
686       s.insert(n1);
687       s.insert(n2);
688       s.insert(n3);
689       if ( n4 ) s.insert(n4);
690       TIDSortedNodeSet::iterator n = s.begin();
691       first = (*n++)->GetID();
692       second.first = (*n++)->GetID();
693       second.second = (*n++)->GetID();
694     }
695   };
696
697   // maps used during creation of quadratic elements
698   TLinkNodeMap                              myTLinkNodeMap;       // medium nodes on links
699   std::map< TBiQuad, const SMDS_MeshNode* > myMapWithCentralNode; // central nodes of faces
700
701   std::set< int > myDegenShapeIds;
702   std::set< int > mySeamShapeIds;
703   double          myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
704   int             myParIndex;     // bounds' index (1-U, 2-V, 3-both)
705
706   typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2ProjectorOnSurf;
707   TID2ProjectorOnSurf myFace2Projector;
708   typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
709   TID2ProjectorOnCurve myEdge2Projector;
710
711   TopoDS_Shape    myShape;
712   SMESH_Mesh*     myMesh;
713   int             myShapeID;
714
715   bool            myCreateQuadratic;
716   bool            myCreateBiQuadratic;
717   bool            mySetElemOnShape;
718   bool            myFixNodeParameters;
719
720   std::map< int,bool > myNodePosShapesValidity;
721   bool toCheckPosOnShape(int shapeID ) const;
722   void setPosOnShapeValidity(int shapeID, bool ok ) const;
723 };
724
725 //=======================================================================
726 inline gp_XY
727 SMESH_MesherHelper::calcTFI(double x, double y,
728                             const gp_XY a0,const gp_XY a1,const gp_XY a2,const gp_XY a3,
729                             const gp_XY p0,const gp_XY p1,const gp_XY p2,const gp_XY p3)
730 {
731   return
732     ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
733     ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
734 }
735 //=======================================================================
736 inline gp_XYZ
737 SMESH_MesherHelper::calcTFI(double x, double y,
738                             const gp_XYZ a0,const gp_XYZ a1,const gp_XYZ a2,const gp_XYZ a3,
739                             const gp_XYZ p0,const gp_XYZ p1,const gp_XYZ p2,const gp_XYZ p3)
740 {
741   return
742     ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
743     ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
744 }
745 //=======================================================================
746
747 #endif