Salome HOME
Merge from V6_main (04/10/2012)
[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 error - container of fixed distorted elements
199    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
200    */
201   void FixQuadraticElements(SMESH_ComputeErrorPtr& error, bool volumeOnly=true);
202
203   /*!
204    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
205    *        or the next methods. By defaul elements are set on the shape if
206    *        a mesh has no shape to be meshed
207    */
208   void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
209
210   /*!
211    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
212    */
213   void SetSubShape(const int           subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
214   void SetSubShape(const TopoDS_Shape& subShape);
215   /*!
216    * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape() 
217     * \retval int - shape index in SMESHDS
218    */
219   int GetSubShapeID() const { return myShapeID; }
220   /*!
221    * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape() 
222    */
223   const TopoDS_Shape& GetSubShape() const  { return myShape; }
224
225   /*!
226    * Creates a node
227    */
228   SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
229   /*!
230    * Creates quadratic or linear edge
231    */
232   SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
233                          const SMDS_MeshNode* n2,
234                          const int id = 0, 
235                          const bool force3d = true);
236   /*!
237    * Creates quadratic or linear triangle
238    */
239   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
240                          const SMDS_MeshNode* n2,
241                          const SMDS_MeshNode* n3,
242                          const int id=0, 
243                          const bool force3d = false);
244   /*!
245    * Creates quadratic or linear quadrangle
246    */
247   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
248                          const SMDS_MeshNode* n2,
249                          const SMDS_MeshNode* n3,
250                          const SMDS_MeshNode* n4,
251                          const int id = 0,
252                          const bool force3d = false);
253
254   /*!
255    * Creates polygon, with additional nodes in quadratic mesh
256    */
257   SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
258                                    const int id = 0,
259                                    const bool force3d = false);
260   /*!
261    * Creates quadratic or linear tetrahedron
262    */
263   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
264                              const SMDS_MeshNode* n2,
265                              const SMDS_MeshNode* n3,
266                              const SMDS_MeshNode* n4,
267                              const int id = 0,
268                              const bool force3d = true);
269   /*!
270    * Creates quadratic or linear pyramid
271    */
272   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
273                              const SMDS_MeshNode* n2,
274                              const SMDS_MeshNode* n3,
275                              const SMDS_MeshNode* n4,
276                              const SMDS_MeshNode* n5,
277                              const int id = 0,
278                              const bool force3d = true);
279   /*!
280    * Creates quadratic or linear pentahedron
281    */
282   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
283                              const SMDS_MeshNode* n2,
284                              const SMDS_MeshNode* n3,
285                              const SMDS_MeshNode* n4,
286                              const SMDS_MeshNode* n5,
287                              const SMDS_MeshNode* n6,
288                              const int id = 0, 
289                              const bool force3d = true);
290   /*!
291    * Creates quadratic or linear hexahedron
292    */
293   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
294                              const SMDS_MeshNode* n2,
295                              const SMDS_MeshNode* n3,
296                              const SMDS_MeshNode* n4,
297                              const SMDS_MeshNode* n5,
298                              const SMDS_MeshNode* n6,
299                              const SMDS_MeshNode* n7,
300                              const SMDS_MeshNode* n8,
301                              const int id = 0, 
302                              bool force3d = true);
303
304   /*!
305    * Creates LINEAR!!!!!!!!! octahedron
306    */
307   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
308                              const SMDS_MeshNode* n2,
309                              const SMDS_MeshNode* n3,
310                              const SMDS_MeshNode* n4,
311                              const SMDS_MeshNode* n5,
312                              const SMDS_MeshNode* n6,
313                              const SMDS_MeshNode* n7,
314                              const SMDS_MeshNode* n8,
315                              const SMDS_MeshNode* n9,
316                              const SMDS_MeshNode* n10,
317                              const SMDS_MeshNode* n11,
318                              const SMDS_MeshNode* n12,
319                              const int id = 0, 
320                              bool force3d = true);
321
322   /*!
323    * Creates polyhedron. In quadratic mesh, adds medium nodes
324    */
325   SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
326                                         const std::vector<int>&                  quantities,
327                                         const int                                ID=0,
328                                         const bool                               force3d = true);
329   /*!
330    * \brief Enables fixing node parameters on EDGEs and FACEs by
331    * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
332    * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
333    * Default is False
334    */
335   void ToFixNodeParameters(bool toFix);
336
337   /*!
338    * \brief Return U of the given node on the edge
339    */
340   double GetNodeU(const TopoDS_Edge&   theEdge,
341                   const SMDS_MeshNode* theNode,
342                   const SMDS_MeshNode* inEdgeNode=0,
343                   bool*                check=0);
344   /*!
345    * \brief Return node UV on face
346    *  \param inFaceNode - a node of element being created located inside a face
347    */
348   gp_XY GetNodeUV(const TopoDS_Face&   F,
349                   const SMDS_MeshNode* n,
350                   const SMDS_MeshNode* inFaceNode=0,
351                   bool*                check=0) const;
352   /*!
353    * \brief Check and fix node UV on a face
354    *  \param force - check even if checks of other nodes on this face passed OK
355    *  \param distXYZ - returns result distance and point coordinates
356    *  \retval bool - false if UV is bad and could not be fixed
357    */
358   bool CheckNodeUV(const TopoDS_Face&   F,
359                    const SMDS_MeshNode* n,
360                    gp_XY&               uv,
361                    const double         tol,
362                    const bool           force=false,
363                    double               distXYZ[4]=0) const;
364   /*!
365    * \brief Check and fix node U on an edge
366    *  \param force - check even if checks of other nodes on this edge passed OK
367    *  \param distXYZ - returns result distance and point coordinates
368    *  \retval bool - false if U is bad and could not be fixed
369    */
370   bool CheckNodeU(const TopoDS_Edge&   E,
371                   const SMDS_MeshNode* n,
372                   double&              u,
373                   const double         tol,
374                   const bool           force=false,
375                   double               distXYZ[4]=0) const;
376   /*!
377    * \brief Return middle UV taking in account surface period
378    */
379   static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
380                            const gp_XY&                uv1,
381                            const gp_XY&                uv2);
382   /*!
383    * \brief Define a pointer to wrapper over a function of gp_XY class,
384    *       suitable to pass as xyFunPtr to applyIn2D().
385    *       For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
386    *       calling gp_XY::Added(gp_XY), which is to be used like following
387    *       applyIn2D(surf, uv1, uv2, gp_XY_Added)
388    */
389 #define gp_XY_FunPtr(meth) \
390   static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
391   static xyFunPtr gp_XY_##meth = & __gpXY_##meth
392
393   /*!
394    * \brief Perform given operation on two 2d points in parameric space of given surface.
395    *        It takes into account period of the surface. Use gp_XY_FunPtr macro
396    *        to easily define pointer to function of gp_XY class.
397    */
398   static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
399                          const gp_XY&                uv1,
400                          const gp_XY&                uv2,
401                          xyFunPtr                    fun,
402                          const bool                  resultInPeriod=true);
403                           
404   /*!
405    * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
406     * \retval bool - return true if the face is periodic
407     *
408     * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
409     * SetSubShape()
410    */
411   bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
412
413   /*!
414    * \brief Return projector intitialized by given face without location, which is returned
415    */
416   GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
417                                            TopLoc_Location&   loc,
418                                            double             tol=0 ) const; 
419
420   /*!
421    * \brief Check if shape is a degenerated edge or it's vertex
422     * \param subShape - edge or vertex index in SMESHDS
423     * \retval bool - true if subShape is a degenerated shape
424     *
425     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
426    */
427   bool IsDegenShape(const int subShape) const
428   { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
429   /*!
430    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
431    *        has a degenerated edges
432     * \retval bool - true if it has
433    */
434   bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
435
436   /*!
437    * \brief Check if shape is a seam edge or it's vertex
438     * \param subShape - edge or vertex index in SMESHDS
439     * \retval bool - true if subShape is a seam shape
440     *
441     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
442     * Seam shape has two 2D alternative represenations on the face
443    */
444   bool IsSeamShape(const int subShape) const
445   { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
446   /*!
447    * \brief Check if shape is a seam edge or it's vertex
448     * \param subShape - edge or vertex
449     * \retval bool - true if subShape is a seam shape
450     *
451     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
452     * Seam shape has two 2D alternative represenations on the face
453    */
454   bool IsSeamShape(const TopoDS_Shape& subShape) const
455   { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
456   /*!
457    * \brief Return true if an edge or a vertex encounters twice in face wire
458    *  \param subShape - Id of edge or vertex
459    */
460   bool IsRealSeam(const int subShape) const
461   { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
462   /*!
463    * \brief Return true if an edge or a vertex encounters twice in face wire
464    *  \param subShape - edge or vertex
465    */
466   bool IsRealSeam(const TopoDS_Shape& subShape) const
467   { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
468   /*!
469    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
470    *        has a seam edge
471     * \retval bool - true if it has
472    */
473   bool HasSeam() const { return !mySeamShapeIds.empty(); }
474   /*!
475    * \brief Return index of periodic parametric direction of a closed face
476     * \retval int - 1 for U, 2 for V direction
477    */
478   int GetPeriodicIndex() const { return myParIndex; }
479   /*!
480    * \brief Return an alternative parameter for a node on seam
481    */
482   double GetOtherParam(const double param) const;
483
484   /*!
485    * \brief Return existing or create new medium nodes between given ones
486    *  \param force3d - true means node creation at the middle between the
487    *                   two given nodes, else node position is found on its
488    *                   supporting geometrical shape, if any.
489    */
490   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
491                                      const SMDS_MeshNode* n2,
492                                      const bool force3d);
493   /*!
494    * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
495    */
496   std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
497                                                 const SMDS_MeshNode* n2);
498   /*!
499    * \brief Add a link in my data structure
500    */
501   void AddTLinkNode(const SMDS_MeshNode* n1,
502                     const SMDS_MeshNode* n2,
503                     const SMDS_MeshNode* n12);
504   /*!
505    * \brief Add many links in my data structure
506    */
507   void AddTLinkNodeMap(const TLinkNodeMap& aMap)
508     { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
509
510   void AddTLinks(const SMDS_MeshEdge*   edge);
511   void AddTLinks(const SMDS_MeshFace*   face);
512   void AddTLinks(const SMDS_MeshVolume* vol);
513
514   /**
515    * Returns myTLinkNodeMap
516    */
517   const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
518
519   /**
520    * Check mesh without geometry for: if all elements on this shape are quadratic,
521    * quadratic elements will be created.
522    * Used then generated 3D mesh without geometry.
523    */
524   enum MType{ LINEAR, QUADRATIC, COMP };
525   MType IsQuadraticMesh();
526   
527   virtual ~SMESH_MesherHelper();
528
529 protected:
530
531   /*!
532    * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
533     * \param uv1 - UV on the seam
534     * \param uv2 - UV within a face
535     * \retval gp_Pnt2d - selected UV
536    */
537   gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
538
539   const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
540                                                    const SMDS_MeshNode* n2,
541                                                    bool                 force3d);
542  private:
543
544   // Forbiden copy constructor
545   SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
546
547   // special map for using during creation of quadratic elements
548   TLinkNodeMap    myTLinkNodeMap;
549
550   std::set< int > myDegenShapeIds;
551   std::set< int > mySeamShapeIds;
552   double          myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
553   int             myParIndex;     // bounds' index (1-U, 2-V, 3-both)
554
555   typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2ProjectorOnSurf;
556   TID2ProjectorOnSurf myFace2Projector;
557   typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
558   TID2ProjectorOnCurve myEdge2Projector;
559
560   TopoDS_Shape    myShape;
561   SMESH_Mesh*     myMesh;
562   int             myShapeID;
563
564   bool            myCreateQuadratic;
565   bool            mySetElemOnShape;
566   bool            myFixNodeParameters;
567
568   std::map< int,bool > myNodePosShapesValidity;
569   bool toCheckPosOnShape(int shapeID ) const;
570   void setPosOnShapeValidity(int shapeID, bool ok ) const;
571
572 };
573
574
575 #endif