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