Salome HOME
0021845: EDF 1855 SMESH : A no-regression test fails on RadialQuadrangle meshing
[modules/smesh.git] / src / SMESH / SMESH_MesherHelper.hxx
1 // Copyright (C) 2007-2012  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
62  *
63  * It allow meshers not to care about creation of medium nodes
64  * when filling a quadratic mesh. Helper does it itself.
65  * It defines degree of elements to create when IsQuadraticSubMesh()
66  * is called.
67  */
68 //=======================================================================
69
70 class SMESH_EXPORT SMESH_MesherHelper
71 {
72 public:
73   // ---------- PUBLIC UTILITIES ----------
74   
75   /*!
76    * \brief Returns true if given node is medium
77     * \param n - node to check
78     * \param typeToCheck - type of elements containing the node to ask about node status
79     * \retval bool - check result
80    */
81   static bool IsMedium(const SMDS_MeshNode*      node,
82                        const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
83
84   /*!
85    * \brief Load nodes bound to face into a map of node columns
86     * \param theParam2ColumnMap - map of node columns to fill
87     * \param theFace - the face on which nodes are searched for
88     * \param theBaseSide - the edges holding nodes on which columns' bases
89     * \param theMesh - the mesh containing nodes
90     * \retval bool - false if something is wrong
91    * 
92    * The key of the map is a normalized parameter of each
93    * base node on theBaseSide. Edges in theBaseSide must be sequenced.
94    * This method works in supposition that nodes on the face
95    * forms a rectangular grid and elements can be quardrangles or triangles
96    */
97   static bool LoadNodeColumns(TParam2ColumnMap &            theParam2ColumnMap,
98                               const TopoDS_Face&            theFace,
99                               const std::list<TopoDS_Edge>& theBaseSide,
100                               SMESHDS_Mesh*                 theMesh,
101                               SMESH_ProxyMesh*              theProxyMesh=0);
102   /*!
103    * \brief Variant of LoadNodeColumns() above with theBaseSide given by one edge
104    */
105   static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
106                               const TopoDS_Face& theFace,
107                               const TopoDS_Edge& theBaseEdge,
108                               SMESHDS_Mesh*      theMesh,
109                               SMESH_ProxyMesh*   theProxyMesh=0);
110   /*!
111    * \brief Return support shape of a node
112    * \param node - the node
113    * \param meshDS - mesh DS
114    * \retval TopoDS_Shape - found support shape
115    */
116   static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
117                                         const SMESHDS_Mesh*  meshDS);
118
119   /*!
120    * \brief Return a valid node index, fixing the given one if necessary
121     * \param ind - node index
122     * \param nbNodes - total nb of nodes
123     * \retval int - valid node index
124    */
125   static int WrapIndex(const int ind, const int nbNodes) {
126     if ( ind < 0 ) return nbNodes + ind % nbNodes;
127     if ( ind >= nbNodes ) return ind % nbNodes;
128     return ind;
129   }
130
131   /*!
132    * \brief Return number of unique ancestors of the shape
133    */
134   static int NbAncestors(const TopoDS_Shape& shape,
135                          const SMESH_Mesh&   mesh,
136                          TopAbs_ShapeEnum    ancestorType=TopAbs_SHAPE);
137   /*!
138    * \brief Return iterator on ancestors of the given type
139    */
140   static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
141                                         const SMESH_Mesh&   mesh,
142                                         TopAbs_ShapeEnum    ancestorType);
143   /*!
144    * \brief Find a common ancestors of two shapes of the given type
145    */
146   static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
147                                         const TopoDS_Shape& shape2,
148                                         const SMESH_Mesh&   mesh,
149                                         TopAbs_ShapeEnum    ancestorType);
150
151   /*!
152    * \brief Return orientation of sub-shape in the main shape
153    */
154   static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
155                                            const TopoDS_Shape& subShape);
156
157   static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
158
159   static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
160
161   static double MaxTolerance( const TopoDS_Shape& shape );
162
163   static bool IsClosedEdge( const TopoDS_Edge& anEdge );
164
165   static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
166
167   static TopAbs_ShapeEnum GetGroupType(const TopoDS_Shape& group,
168                                        const bool          avoidCompound=false);
169
170
171 public:
172   // ---------- PUBLIC INSTANCE METHODS ----------
173
174   // constructor
175   SMESH_MesherHelper(SMESH_Mesh& theMesh);
176
177   SMESH_Mesh* GetMesh() const { return myMesh; }
178     
179   SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
180     
181   /*!
182    * Check submesh for given shape: if all elements on this shape are quadratic,
183    * quadratic elements will be created. Also fill myTLinkNodeMap
184    */
185   bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
186   /*!
187    * \brief Set order of elements to create without calling IsQuadraticSubMesh()
188    */
189   void SetIsQuadratic(const bool theBuildQuadratic)
190   { myCreateQuadratic = theBuildQuadratic; }
191   /*!
192    * \brief Return myCreateQuadratic flag
193    */
194   bool GetIsQuadratic() const { return myCreateQuadratic; }
195
196   /*!
197    * \brief Move medium nodes of faces and volumes to fix distorted elements
198    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
199    */
200   void FixQuadraticElements(bool volumeOnly=true);
201
202   /*!
203    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
204    *        or the next methods. By defaul elements are set on the shape if
205    *        a mesh has no shape to be meshed
206    */
207   void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
208
209   /*!
210    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
211    */
212   void SetSubShape(const int           subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
213   void SetSubShape(const TopoDS_Shape& subShape);
214   /*!
215    * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape() 
216     * \retval int - shape index in SMESHDS
217    */
218   int GetSubShapeID() const { return myShapeID; }
219   /*!
220    * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape() 
221    */
222   const TopoDS_Shape& GetSubShape() const  { return myShape; }
223
224   /*!
225    * Creates a node
226    */
227   SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
228   /*!
229    * Creates quadratic or linear edge
230    */
231   SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
232                          const SMDS_MeshNode* n2,
233                          const int id = 0, 
234                          const bool force3d = true);
235   /*!
236    * Creates quadratic or linear triangle
237    */
238   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
239                          const SMDS_MeshNode* n2,
240                          const SMDS_MeshNode* n3,
241                          const int id=0, 
242                          const bool force3d = false);
243   /*!
244    * Creates quadratic or linear quadrangle
245    */
246   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
247                          const SMDS_MeshNode* n2,
248                          const SMDS_MeshNode* n3,
249                          const SMDS_MeshNode* n4,
250                          const int id = 0,
251                          const bool force3d = false);
252
253   /*!
254    * Creates polygon, with additional nodes in quadratic mesh
255    */
256   SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
257                                    const int id = 0,
258                                    const bool force3d = false);
259   /*!
260    * Creates quadratic or linear tetrahedron
261    */
262   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
263                              const SMDS_MeshNode* n2,
264                              const SMDS_MeshNode* n3,
265                              const SMDS_MeshNode* n4,
266                              const int id = 0,
267                              const bool force3d = true);
268   /*!
269    * Creates quadratic or linear pyramid
270    */
271   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
272                              const SMDS_MeshNode* n2,
273                              const SMDS_MeshNode* n3,
274                              const SMDS_MeshNode* n4,
275                              const SMDS_MeshNode* n5,
276                              const int id = 0,
277                              const bool force3d = true);
278   /*!
279    * Creates quadratic or linear pentahedron
280    */
281   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
282                              const SMDS_MeshNode* n2,
283                              const SMDS_MeshNode* n3,
284                              const SMDS_MeshNode* n4,
285                              const SMDS_MeshNode* n5,
286                              const SMDS_MeshNode* n6,
287                              const int id = 0, 
288                              const bool force3d = true);
289   /*!
290    * Creates quadratic or linear hexahedron
291    */
292   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
293                              const SMDS_MeshNode* n2,
294                              const SMDS_MeshNode* n3,
295                              const SMDS_MeshNode* n4,
296                              const SMDS_MeshNode* n5,
297                              const SMDS_MeshNode* n6,
298                              const SMDS_MeshNode* n7,
299                              const SMDS_MeshNode* n8,
300                              const int id = 0, 
301                              bool force3d = true);
302
303   /*!
304    * Creates LINEAR!!!!!!!!! octahedron
305    */
306   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
307                              const SMDS_MeshNode* n2,
308                              const SMDS_MeshNode* n3,
309                              const SMDS_MeshNode* n4,
310                              const SMDS_MeshNode* n5,
311                              const SMDS_MeshNode* n6,
312                              const SMDS_MeshNode* n7,
313                              const SMDS_MeshNode* n8,
314                              const SMDS_MeshNode* n9,
315                              const SMDS_MeshNode* n10,
316                              const SMDS_MeshNode* n11,
317                              const SMDS_MeshNode* n12,
318                              const int id = 0, 
319                              bool force3d = true);
320
321   /*!
322    * Creates polyhedron. In quadratic mesh, adds medium nodes
323    */
324   SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
325                                         const std::vector<int>&                  quantities,
326                                         const int                                ID=0,
327                                         const bool                               force3d = true);
328   /*!
329    * \brief Enables fixing node parameters on EDGEs and FACEs by
330    * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
331    * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
332    * Default is False
333    */
334   void ToFixNodeParameters(bool toFix);
335
336   /*!
337    * \brief Return U of the given node on the edge
338    */
339   double GetNodeU(const TopoDS_Edge&   theEdge,
340                   const SMDS_MeshNode* theNode,
341                   const SMDS_MeshNode* inEdgeNode=0,
342                   bool*                check=0);
343   /*!
344    * \brief Return node UV on face
345    *  \param inFaceNode - a node of element being created located inside a face
346    */
347   gp_XY GetNodeUV(const TopoDS_Face&   F,
348                   const SMDS_MeshNode* n,
349                   const SMDS_MeshNode* inFaceNode=0,
350                   bool*                check=0) const;
351   /*!
352    * \brief Check and fix node UV on a face
353    *  \param force - check even if checks of other nodes on this face passed OK
354    *  \param distXYZ - returns result distance and point coordinates
355    *  \retval bool - false if UV is bad and could not be fixed
356    */
357   bool CheckNodeUV(const TopoDS_Face&   F,
358                    const SMDS_MeshNode* n,
359                    gp_XY&               uv,
360                    const double         tol,
361                    const bool           force=false,
362                    double               distXYZ[4]=0) const;
363   /*!
364    * \brief Check and fix node U on an edge
365    *  \param force - check even if checks of other nodes on this edge passed OK
366    *  \param distXYZ - returns result distance and point coordinates
367    *  \retval bool - false if U is bad and could not be fixed
368    */
369   bool CheckNodeU(const TopoDS_Edge&   E,
370                   const SMDS_MeshNode* n,
371                   double&              u,
372                   const double         tol,
373                   const bool           force=false,
374                   double               distXYZ[4]=0) const;
375   /*!
376    * \brief Return middle UV taking in account surface period
377    */
378   static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
379                            const gp_XY&                uv1,
380                            const gp_XY&                uv2);
381   /*!
382    * \brief Define a pointer to wrapper over a function of gp_XY class,
383    *       suitable to pass as xyFunPtr to applyIn2D().
384    *       For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
385    *       calling gp_XY::Added(gp_XY), which is to be used like following
386    *       applyIn2D(surf, uv1, uv2, gp_XY_Added)
387    */
388 #define gp_XY_FunPtr(meth) \
389   static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
390   static xyFunPtr gp_XY_##meth = & __gpXY_##meth
391
392   /*!
393    * \brief Perform given operation on two 2d points in parameric space of given surface.
394    *        It takes into account period of the surface. Use gp_XY_FunPtr macro
395    *        to easily define pointer to function of gp_XY class.
396    */
397   static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
398                          const gp_XY&                uv1,
399                          const gp_XY&                uv2,
400                          xyFunPtr                    fun,
401                          const bool                  resultInPeriod=true);
402                           
403   /*!
404    * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
405     * \retval bool - return true if the face is periodic
406     *
407     * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
408     * SetSubShape()
409    */
410   bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
411
412   /*!
413    * \brief Return projector intitialized by given face without location, which is returned
414    */
415   GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
416                                            TopLoc_Location&   loc,
417                                            double             tol=0 ) const; 
418
419   /*!
420    * \brief Check if shape is a degenerated edge or it's vertex
421     * \param subShape - edge or vertex index in SMESHDS
422     * \retval bool - true if subShape is a degenerated shape
423     *
424     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
425    */
426   bool IsDegenShape(const int subShape) const
427   { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
428   /*!
429    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
430    *        has a degenerated edges
431     * \retval bool - true if it has
432    */
433   bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
434
435   /*!
436    * \brief Check if shape is a seam edge or it's vertex
437     * \param subShape - edge or vertex index in SMESHDS
438     * \retval bool - true if subShape is a seam shape
439     *
440     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
441     * Seam shape has two 2D alternative represenations on the face
442    */
443   bool IsSeamShape(const int subShape) const
444   { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
445   /*!
446    * \brief Check if shape is a seam edge or it's vertex
447     * \param subShape - edge or vertex
448     * \retval bool - true if subShape is a seam shape
449     *
450     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
451     * Seam shape has two 2D alternative represenations on the face
452    */
453   bool IsSeamShape(const TopoDS_Shape& subShape) const
454   { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
455   /*!
456    * \brief Return true if an edge or a vertex encounters twice in face wire
457    *  \param subShape - Id of edge or vertex
458    */
459   bool IsRealSeam(const int subShape) const
460   { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
461   /*!
462    * \brief Return true if an edge or a vertex encounters twice in face wire
463    *  \param subShape - edge or vertex
464    */
465   bool IsRealSeam(const TopoDS_Shape& subShape) const
466   { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
467   /*!
468    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
469    *        has a seam edge
470     * \retval bool - true if it has
471    */
472   bool HasSeam() const { return !mySeamShapeIds.empty(); }
473   /*!
474    * \brief Return index of periodic parametric direction of a closed face
475     * \retval int - 1 for U, 2 for V direction
476    */
477   int GetPeriodicIndex() const { return myParIndex; }
478   /*!
479    * \brief Return an alternative parameter for a node on seam
480    */
481   double GetOtherParam(const double param) const;
482
483   /*!
484    * \brief Return existing or create new medium nodes between given ones
485    *  \param force3d - true means node creation at the middle between the
486    *                   two given nodes, else node position is found on its
487    *                   supporting geometrical shape, if any.
488    */
489   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
490                                      const SMDS_MeshNode* n2,
491                                      const bool force3d);
492   /*!
493    * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
494    */
495   std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
496                                                 const SMDS_MeshNode* n2);
497   /*!
498    * \brief Add a link in my data structure
499    */
500   void AddTLinkNode(const SMDS_MeshNode* n1,
501                     const SMDS_MeshNode* n2,
502                     const SMDS_MeshNode* n12);
503   /*!
504    * \brief Add many links in my data structure
505    */
506   void AddTLinkNodeMap(const TLinkNodeMap& aMap)
507     { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
508
509   void AddTLinks(const SMDS_MeshEdge*   edge);
510   void AddTLinks(const SMDS_MeshFace*   face);
511   void AddTLinks(const SMDS_MeshVolume* vol);
512
513   /**
514    * Returns myTLinkNodeMap
515    */
516   const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
517
518   /**
519    * Check mesh without geometry for: if all elements on this shape are quadratic,
520    * quadratic elements will be created.
521    * Used then generated 3D mesh without geometry.
522    */
523   enum MType{ LINEAR, QUADRATIC, COMP };
524   MType IsQuadraticMesh();
525   
526   virtual ~SMESH_MesherHelper();
527
528 protected:
529
530   /*!
531    * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
532     * \param uv1 - UV on the seam
533     * \param uv2 - UV within a face
534     * \retval gp_Pnt2d - selected UV
535    */
536   gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
537
538   const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
539                                                    const SMDS_MeshNode* n2,
540                                                    bool                 force3d);
541  private:
542
543   // Forbiden copy constructor
544   SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
545
546   // special map for using during creation of quadratic elements
547   TLinkNodeMap    myTLinkNodeMap;
548
549   std::set< int > myDegenShapeIds;
550   std::set< int > mySeamShapeIds;
551   double          myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
552   int             myParIndex;     // bounds' index (1-U, 2-V, 3-both)
553
554   typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2ProjectorOnSurf;
555   TID2ProjectorOnSurf myFace2Projector;
556   typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
557   TID2ProjectorOnCurve myEdge2Projector;
558
559   TopoDS_Shape    myShape;
560   SMESH_Mesh*     myMesh;
561   int             myShapeID;
562
563   bool            myCreateQuadratic;
564   bool            mySetElemOnShape;
565   bool            myFixNodeParameters;
566
567   std::map< int,bool > myNodePosShapesValidity;
568   bool toCheckPosOnShape(int shapeID ) const;
569   void setPosOnShapeValidity(int shapeID, bool ok ) const;
570
571 };
572
573
574 #endif