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