1 // Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File: SMESH_MesherHelper.hxx
24 // Created: 15.02.06 14:48:09
25 // Author: Sergey KUUL
27 #ifndef SMESH_MesherHelper_HeaderFile
28 #define SMESH_MesherHelper_HeaderFile
30 #include "SMESH_SMESH.hxx"
32 #include "SMESH_MeshEditor.hxx" // needed for many meshers
33 #include <SMDS_MeshNode.hxx>
34 #include <SMDS_QuadraticEdge.hxx>
36 #include <Geom_Surface.hxx>
37 #include <TopoDS_Face.hxx>
38 #include <TopoDS_Shape.hxx>
39 #include <gp_Pnt2d.hxx>
44 class GeomAPI_ProjectPointOnSurf;
45 class GeomAPI_ProjectPointOnCurve;
46 class SMESH_ProxyMesh;
48 typedef std::map<SMESH_TLink, const SMDS_MeshNode*> TLinkNodeMap;
49 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
51 typedef SMDS_Iterator<const TopoDS_Shape*> PShapeIterator;
52 typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
54 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
55 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
57 typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
59 //=======================================================================
61 * \brief It helps meshers to add elements
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()
68 //=======================================================================
70 class SMESH_EXPORT SMESH_MesherHelper
73 // ---------- PUBLIC UTILITIES ----------
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
81 static bool IsMedium(const SMDS_MeshNode* node,
82 const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
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
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
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);
103 * \brief Variant of LoadNodeColumns() above with theBaseSide given by one edge
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);
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
116 static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
117 const SMESHDS_Mesh* meshDS);
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
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;
132 * \brief Return number of unique ancestors of the shape
134 static int NbAncestors(const TopoDS_Shape& shape,
135 const SMESH_Mesh& mesh,
136 TopAbs_ShapeEnum ancestorType=TopAbs_SHAPE);
138 * \brief Return iterator on ancestors of the given type
140 static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
141 const SMESH_Mesh& mesh,
142 TopAbs_ShapeEnum ancestorType);
144 * \brief Find a common ancestors of two shapes of the given type
146 static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
147 const TopoDS_Shape& shape2,
148 const SMESH_Mesh& mesh,
149 TopAbs_ShapeEnum ancestorType);
152 * \brief Return orientation of sub-shape in the main shape
154 static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
155 const TopoDS_Shape& subShape);
157 static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
159 static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
161 static double MaxTolerance( const TopoDS_Shape& shape );
163 static bool IsClosedEdge( const TopoDS_Edge& anEdge );
165 static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
169 // ---------- PUBLIC INSTANCE METHODS ----------
172 SMESH_MesherHelper(SMESH_Mesh& theMesh);
174 SMESH_Mesh* GetMesh() const { return myMesh; }
176 SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
179 * Check submesh for given shape: if all elements on this shape are quadratic,
180 * quadratic elements will be created. Also fill myTLinkNodeMap
182 bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
184 * \brief Set order of elements to create without calling IsQuadraticSubMesh()
186 void SetIsQuadratic(const bool theBuildQuadratic)
187 { myCreateQuadratic = theBuildQuadratic; }
189 * \brief Return myCreateQuadratic flag
191 bool GetIsQuadratic() const { return myCreateQuadratic; }
194 * \brief Move medium nodes of faces and volumes to fix distorted elements
195 * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
197 void FixQuadraticElements(bool volumeOnly=true);
200 * \brief To set created elements on the shape set by IsQuadraticSubMesh()
201 * or the next methods. By defaul elements are set on the shape if
202 * a mesh has no shape to be meshed
204 void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
207 * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
209 void SetSubShape(const int subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
210 void SetSubShape(const TopoDS_Shape& subShape);
212 * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape()
213 * \retval int - shape index in SMESHDS
215 int GetSubShapeID() const { return myShapeID; }
217 * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape()
219 const TopoDS_Shape& GetSubShape() const { return myShape; }
224 SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
226 * Creates quadratic or linear edge
228 SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
229 const SMDS_MeshNode* n2,
231 const bool force3d = true);
233 * Creates quadratic or linear triangle
235 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
236 const SMDS_MeshNode* n2,
237 const SMDS_MeshNode* n3,
239 const bool force3d = false);
241 * Creates quadratic or linear quadrangle
243 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
244 const SMDS_MeshNode* n2,
245 const SMDS_MeshNode* n3,
246 const SMDS_MeshNode* n4,
248 const bool force3d = false);
251 * Creates polygon, with additional nodes in quadratic mesh
253 SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
255 const bool force3d = false);
257 * Creates quadratic or linear tetrahedron
259 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
260 const SMDS_MeshNode* n2,
261 const SMDS_MeshNode* n3,
262 const SMDS_MeshNode* n4,
264 const bool force3d = true);
266 * Creates quadratic or linear pyramid
268 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
269 const SMDS_MeshNode* n2,
270 const SMDS_MeshNode* n3,
271 const SMDS_MeshNode* n4,
272 const SMDS_MeshNode* n5,
274 const bool force3d = true);
276 * Creates quadratic or linear pentahedron
278 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
279 const SMDS_MeshNode* n2,
280 const SMDS_MeshNode* n3,
281 const SMDS_MeshNode* n4,
282 const SMDS_MeshNode* n5,
283 const SMDS_MeshNode* n6,
285 const bool force3d = true);
287 * Creates quadratic or linear hexahedron
289 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
290 const SMDS_MeshNode* n2,
291 const SMDS_MeshNode* n3,
292 const SMDS_MeshNode* n4,
293 const SMDS_MeshNode* n5,
294 const SMDS_MeshNode* n6,
295 const SMDS_MeshNode* n7,
296 const SMDS_MeshNode* n8,
298 bool force3d = true);
301 * Creates LINEAR!!!!!!!!! octahedron
303 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
304 const SMDS_MeshNode* n2,
305 const SMDS_MeshNode* n3,
306 const SMDS_MeshNode* n4,
307 const SMDS_MeshNode* n5,
308 const SMDS_MeshNode* n6,
309 const SMDS_MeshNode* n7,
310 const SMDS_MeshNode* n8,
311 const SMDS_MeshNode* n9,
312 const SMDS_MeshNode* n10,
313 const SMDS_MeshNode* n11,
314 const SMDS_MeshNode* n12,
316 bool force3d = true);
319 * Creates polyhedron. In quadratic mesh, adds medium nodes
321 SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
322 const std::vector<int>& quantities,
324 const bool force3d = true);
326 * \brief Enables fixing node parameters on EDGEs and FACEs by
327 * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
328 * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
331 void ToFixNodeParameters(bool toFix);
334 * \brief Return U of the given node on the edge
336 double GetNodeU(const TopoDS_Edge& theEdge,
337 const SMDS_MeshNode* theNode,
338 const SMDS_MeshNode* inEdgeNode=0,
341 * \brief Return node UV on face
342 * \param inFaceNode - a node of element being created located inside a face
344 gp_XY GetNodeUV(const TopoDS_Face& F,
345 const SMDS_MeshNode* n,
346 const SMDS_MeshNode* inFaceNode=0,
347 bool* check=0) const;
349 * \brief Check and fix node UV on a face
350 * \param force - check even if checks of other nodes on this face passed OK
351 * \param distXYZ - returns result distance and point coordinates
352 * \retval bool - false if UV is bad and could not be fixed
354 bool CheckNodeUV(const TopoDS_Face& F,
355 const SMDS_MeshNode* n,
358 const bool force=false,
359 double distXYZ[4]=0) const;
361 * \brief Check and fix node U on an edge
362 * \param force - check even if checks of other nodes on this edge passed OK
363 * \param distXYZ - returns result distance and point coordinates
364 * \retval bool - false if U is bad and could not be fixed
366 bool CheckNodeU(const TopoDS_Edge& E,
367 const SMDS_MeshNode* n,
370 const bool force=false,
371 double distXYZ[4]=0) const;
373 * \brief Return middle UV taking in account surface period
375 static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
379 * \brief Define a pointer to wrapper over a function of gp_XY class,
380 * suitable to pass as xyFunPtr to applyIn2D().
381 * For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
382 * calling gp_XY::Added(gp_XY), which is to be used like following
383 * applyIn2D(surf, uv1, uv2, gp_XY_Added)
385 #define gp_XY_FunPtr(meth) \
386 static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
387 static xyFunPtr gp_XY_##meth = & __gpXY_##meth
390 * \brief Perform given operation on two 2d points in parameric space of given surface.
391 * It takes into account period of the surface. Use gp_XY_FunPtr macro
392 * to easily define pointer to function of gp_XY class.
394 static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
398 const bool resultInPeriod=true);
401 * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
402 * \retval bool - return true if the face is periodic
404 * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
407 bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
410 * \brief Return projector intitialized by given face without location, which is returned
412 GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
413 TopLoc_Location& loc,
414 double tol=0 ) const;
417 * \brief Check if shape is a degenerated edge or it's vertex
418 * \param subShape - edge or vertex index in SMESHDS
419 * \retval bool - true if subShape is a degenerated shape
421 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
423 bool IsDegenShape(const int subShape) const
424 { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
426 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
427 * has a degenerated edges
428 * \retval bool - true if it has
430 bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
433 * \brief Check if shape is a seam edge or it's vertex
434 * \param subShape - edge or vertex index in SMESHDS
435 * \retval bool - true if subShape is a seam shape
437 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
438 * Seam shape has two 2D alternative represenations on the face
440 bool IsSeamShape(const int subShape) const
441 { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
443 * \brief Check if shape is a seam edge or it's vertex
444 * \param subShape - edge or vertex
445 * \retval bool - true if subShape is a seam shape
447 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
448 * Seam shape has two 2D alternative represenations on the face
450 bool IsSeamShape(const TopoDS_Shape& subShape) const
451 { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
453 * \brief Return true if an edge or a vertex encounters twice in face wire
454 * \param subShape - Id of edge or vertex
456 bool IsRealSeam(const int subShape) const
457 { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
459 * \brief Return true if an edge or a vertex encounters twice in face wire
460 * \param subShape - edge or vertex
462 bool IsRealSeam(const TopoDS_Shape& subShape) const
463 { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
465 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
467 * \retval bool - true if it has
469 bool HasSeam() const { return !mySeamShapeIds.empty(); }
471 * \brief Return index of periodic parametric direction of a closed face
472 * \retval int - 1 for U, 2 for V direction
474 int GetPeriodicIndex() const { return myParIndex; }
476 * \brief Return an alternative parameter for a node on seam
478 double GetOtherParam(const double param) const;
481 * \brief Return existing or create new medium nodes between given ones
482 * \param force3d - true means node creation at the middle between the
483 * two given nodes, else node position is found on its
484 * supporting geometrical shape, if any.
486 const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
487 const SMDS_MeshNode* n2,
490 * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
492 std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
493 const SMDS_MeshNode* n2);
495 * \brief Add a link in my data structure
497 void AddTLinkNode(const SMDS_MeshNode* n1,
498 const SMDS_MeshNode* n2,
499 const SMDS_MeshNode* n12);
501 * \brief Add many links in my data structure
503 void AddTLinkNodeMap(const TLinkNodeMap& aMap)
504 { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
506 void AddTLinks(const SMDS_MeshEdge* edge);
507 void AddTLinks(const SMDS_MeshFace* face);
508 void AddTLinks(const SMDS_MeshVolume* vol);
511 * Returns myTLinkNodeMap
513 const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
516 * Check mesh without geometry for: if all elements on this shape are quadratic,
517 * quadratic elements will be created.
518 * Used then generated 3D mesh without geometry.
520 enum MType{ LINEAR, QUADRATIC, COMP };
521 MType IsQuadraticMesh();
523 virtual ~SMESH_MesherHelper();
528 * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
529 * \param uv1 - UV on the seam
530 * \param uv2 - UV within a face
531 * \retval gp_Pnt2d - selected UV
533 gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
535 const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
536 const SMDS_MeshNode* n2,
540 // Forbiden copy constructor
541 SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
543 // special map for using during creation of quadratic elements
544 TLinkNodeMap myTLinkNodeMap;
546 std::set< int > myDegenShapeIds;
547 std::set< int > mySeamShapeIds;
548 double myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
549 int myParIndex; // bounds' index (1-U, 2-V, 3-both)
551 typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2ProjectorOnSurf;
552 TID2ProjectorOnSurf myFace2Projector;
553 typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
554 TID2ProjectorOnCurve myEdge2Projector;
556 TopoDS_Shape myShape;
560 bool myCreateQuadratic;
561 bool mySetElemOnShape;
562 bool myFixNodeParameters;
564 std::map< int,bool > myNodePosShapesValidity;
565 bool toCheckPosOnShape(int shapeID ) const;
566 void setPosOnShapeValidity(int shapeID, bool ok ) const;