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