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