1 // Copyright (C) 2007-2010 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;
47 typedef std::map<SMESH_TLink, const SMDS_MeshNode*> TLinkNodeMap;
48 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
50 typedef SMDS_Iterator<const TopoDS_Shape*> PShapeIterator;
51 typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
53 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
54 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
56 typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
58 //=======================================================================
60 * \brief It helps meshers to add elements
62 * It allow meshers not to care about creation of medium nodes
63 * when filling a quadratic mesh. Helper does it itself.
64 * It defines degree of elements to create when IsQuadraticSubMesh()
67 //=======================================================================
69 class SMESH_EXPORT SMESH_MesherHelper
72 // ---------- PUBLIC UTILITIES ----------
75 * \brief Returns true if given node is medium
76 * \param n - node to check
77 * \param typeToCheck - type of elements containing the node to ask about node status
78 * \retval bool - check result
80 static bool IsMedium(const SMDS_MeshNode* node,
81 const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
84 * \brief Load nodes bound to face into a map of node columns
85 * \param theParam2ColumnMap - map of node columns to fill
86 * \param theFace - the face on which nodes are searched for
87 * \param theBaseEdge - the edge nodes of which are columns' bases
88 * \param theMesh - the mesh containing nodes
89 * \retval bool - false if something is wrong
91 * The key of the map is a normalized parameter of each
92 * base node on theBaseEdge.
93 * This method works in supposition that nodes on the face
94 * forms a rectangular grid and elements can be quardrangles or triangles
96 static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
97 const TopoDS_Face& theFace,
98 const TopoDS_Edge& theBaseEdge,
99 SMESHDS_Mesh* theMesh);
101 * \brief Return support shape of a node
102 * \param node - the node
103 * \param meshDS - mesh DS
104 * \retval TopoDS_Shape - found support shape
106 static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
107 SMESHDS_Mesh* meshDS);
110 * \brief Return a valid node index, fixing the given one if necessary
111 * \param ind - node index
112 * \param nbNodes - total nb of nodes
113 * \retval int - valid node index
115 static int WrapIndex(const int ind, const int nbNodes) {
116 if ( ind < 0 ) return nbNodes + ind % nbNodes;
117 if ( ind >= nbNodes ) return ind % nbNodes;
122 * \brief Return number of unique ancestors of the shape
124 static int NbAncestors(const TopoDS_Shape& shape,
125 const SMESH_Mesh& mesh,
126 TopAbs_ShapeEnum ancestorType=TopAbs_SHAPE);
128 * \brief Return iterator on ancestors of the given type
130 static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
131 const SMESH_Mesh& mesh,
132 TopAbs_ShapeEnum ancestorType);
135 * \brief Return orientation of sub-shape in the main shape
137 static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
138 const TopoDS_Shape& subShape);
140 static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
142 static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
144 static double MaxTolerance( const TopoDS_Shape& shape );
148 // ---------- PUBLIC INSTANCE METHODS ----------
151 SMESH_MesherHelper(SMESH_Mesh& theMesh);
153 SMESH_Mesh* GetMesh() const { return myMesh; }
155 SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
158 * Check submesh for given shape: if all elements on this shape are quadratic,
159 * quadratic elements will be created. Also fill myTLinkNodeMap
161 bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
163 * \brief Set order of elements to create without calling IsQuadraticSubMesh()
165 void SetIsQuadratic(const bool theBuildQuadratic)
166 { myCreateQuadratic = theBuildQuadratic; }
168 * \brief Return myCreateQuadratic flag
170 bool GetIsQuadratic() const { return myCreateQuadratic; }
173 * \brief Move medium nodes of faces and volumes to fix distorted elements
174 * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
176 void FixQuadraticElements(bool volumeOnly=true);
179 * \brief To set created elements on the shape set by IsQuadraticSubMesh()
180 * or the next methods. By defaul elements are set on the shape if
181 * a mesh has no shape to be meshed
183 void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
186 * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
188 void SetSubShape(const int subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
189 void SetSubShape(const TopoDS_Shape& subShape);
191 * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape()
192 * \retval int - shape index in SMESHDS
194 int GetSubShapeID() const { return myShapeID; }
196 * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape()
198 const TopoDS_Shape& GetSubShape() const { return myShape; }
203 SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0);
205 * Creates quadratic or linear edge
207 SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
208 const SMDS_MeshNode* n2,
210 const bool force3d = true);
212 * Creates quadratic or linear triangle
214 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
215 const SMDS_MeshNode* n2,
216 const SMDS_MeshNode* n3,
218 const bool force3d = false);
220 * Creates quadratic or linear quadrangle
222 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
223 const SMDS_MeshNode* n2,
224 const SMDS_MeshNode* n3,
225 const SMDS_MeshNode* n4,
227 const bool force3d = false);
230 * Creates polygon, with additional nodes in quadratic mesh
232 SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
234 const bool force3d = false);
236 * Creates quadratic or linear tetrahedron
238 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
239 const SMDS_MeshNode* n2,
240 const SMDS_MeshNode* n3,
241 const SMDS_MeshNode* n4,
243 const bool force3d = true);
245 * Creates quadratic or linear pyramid
247 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
248 const SMDS_MeshNode* n2,
249 const SMDS_MeshNode* n3,
250 const SMDS_MeshNode* n4,
251 const SMDS_MeshNode* n5,
253 const bool force3d = true);
255 * Creates quadratic or linear pentahedron
257 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
258 const SMDS_MeshNode* n2,
259 const SMDS_MeshNode* n3,
260 const SMDS_MeshNode* n4,
261 const SMDS_MeshNode* n5,
262 const SMDS_MeshNode* n6,
264 const bool force3d = true);
266 * Creates quadratic or linear hexahedron
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,
273 const SMDS_MeshNode* n6,
274 const SMDS_MeshNode* n7,
275 const SMDS_MeshNode* n8,
277 bool force3d = true);
280 * Creates polyhedron. In quadratic mesh, adds medium nodes
282 SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
283 const std::vector<int>& quantities,
285 const bool force3d = true);
287 * \brief Return U of the given node on the edge
289 double GetNodeU(const TopoDS_Edge& theEdge,
290 const SMDS_MeshNode* theNode,
291 const SMDS_MeshNode* inEdgeNode=0,
294 * \brief Return node UV on face
295 * \param inFaceNode - a node of element being created located inside a face
297 gp_XY GetNodeUV(const TopoDS_Face& F,
298 const SMDS_MeshNode* n,
299 const SMDS_MeshNode* inFaceNode=0,
300 bool* check=0) const;
302 * \brief Check and fix node UV on a face
303 * \param force - check even if checks of other nodes on this face passed OK
304 * \retval bool - false if UV is bad and could not be fixed
306 bool CheckNodeUV(const TopoDS_Face& F,
307 const SMDS_MeshNode* n,
310 const bool force=false) const;
312 * \brief Check and fix node U on an edge
313 * \param force - check even if checks of other nodes on this edge passed OK
314 * \retval bool - false if U is bad and could not be fixed
316 bool CheckNodeU(const TopoDS_Edge& E,
317 const SMDS_MeshNode* n,
320 const bool force=false,
321 double* distance=0) const;
323 * \brief Return middle UV taking in account surface period
325 static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
329 * \brief Define a pointer to wrapper over a function of gp_XY class,
330 * suitable to pass as xyFunPtr to applyIn2D().
331 * For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
332 * calling gp_XY::Added(gp_XY), which is to be used like following
333 * applyIn2D(surf, uv1, uv2, gp_XY_Added)
335 #define gp_XY_FunPtr(meth) \
336 static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
337 static xyFunPtr gp_XY_##meth = & __gpXY_##meth
340 * \brief Perform given operation on two 2d points in parameric space of given surface.
341 * It takes into account period of the surface. Use gp_XY_FunPtr macro
342 * to easily define pointer to function of gp_XY class.
344 static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
348 const bool resultInPeriod=true);
351 * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
352 * \retval bool - return true if the face is periodic
354 * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
357 bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
360 * \brief Return projector intitialized by given face without location, which is returned
362 GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
363 TopLoc_Location& loc,
364 double tol=0 ) const;
367 * \brief Check if shape is a degenerated edge or it's vertex
368 * \param subShape - edge or vertex index in SMESHDS
369 * \retval bool - true if subShape is a degenerated shape
371 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
373 bool IsDegenShape(const int subShape) const
374 { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
376 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
377 * has a degenerated edges
378 * \retval bool - true if it has
380 bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
383 * \brief Check if shape is a seam edge or it's vertex
384 * \param subShape - edge or vertex index in SMESHDS
385 * \retval bool - true if subShape is a seam shape
387 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
388 * Seam shape has two 2D alternative represenations on the face
390 bool IsSeamShape(const int subShape) const
391 { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
393 * \brief Check if shape is a seam edge or it's vertex
394 * \param subShape - edge or vertex
395 * \retval bool - true if subShape is a seam shape
397 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
398 * Seam shape has two 2D alternative represenations on the face
400 bool IsSeamShape(const TopoDS_Shape& subShape) const
401 { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
403 * \brief Return true if an edge or a vertex encounters twice in face wire
404 * \param subShape - Id of edge or vertex
406 bool IsRealSeam(const int subShape) const
407 { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
409 * \brief Return true if an edge or a vertex encounters twice in face wire
410 * \param subShape - edge or vertex
412 bool IsRealSeam(const TopoDS_Shape& subShape) const
413 { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
415 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
417 * \retval bool - true if it has
419 bool HasSeam() const { return !mySeamShapeIds.empty(); }
421 * \brief Return index of periodic parametric direction of a closed face
422 * \retval int - 1 for U, 2 for V direction
424 int GetPeriodicIndex() const { return myParIndex; }
426 * \brief Return an alternative parameter for a node on seam
428 double GetOtherParam(const double param) const;
431 * \brief Return existing or create new medium nodes between given ones
432 * \param force3d - true means node creation at the middle between the
433 * two given nodes, else node position is found on its
434 * supporting geometrical shape, if any.
436 const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
437 const SMDS_MeshNode* n2,
440 * \brief Add a link in my data structure
442 void AddTLinkNode(const SMDS_MeshNode* n1,
443 const SMDS_MeshNode* n2,
444 const SMDS_MeshNode* n12);
446 * \brief Add many links in my data structure
448 void AddTLinkNodeMap(const TLinkNodeMap& aMap)
449 { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
452 * Returns myTLinkNodeMap
454 const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
457 * Check mesh without geometry for: if all elements on this shape are quadratic,
458 * quadratic elements will be created.
459 * Used then generated 3D mesh without geometry.
461 enum MType{ LINEAR, QUADRATIC, COMP };
462 MType IsQuadraticMesh();
464 virtual ~SMESH_MesherHelper();
469 * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
470 * \param uv1 - UV on the seam
471 * \param uv2 - UV within a face
472 * \retval gp_Pnt2d - selected UV
474 gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
476 const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
477 const SMDS_MeshNode* n2,
481 // Forbiden copy constructor
482 SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
484 // special map for using during creation of quadratic elements
485 TLinkNodeMap myTLinkNodeMap;
487 std::set< int > myDegenShapeIds;
488 std::set< int > mySeamShapeIds;
489 double myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
490 int myParIndex; // bounds' index (1-U, 2-V, 3-both)
492 typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2ProjectorOnSurf;
493 TID2ProjectorOnSurf myFace2Projector;
494 typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
495 TID2ProjectorOnCurve myEdge2Projector;
497 TopoDS_Shape myShape;
501 // to create quadratic elements
502 bool myCreateQuadratic;
503 bool mySetElemOnShape;
505 std::map< int,bool > myNodePosShapesValidity;
506 bool toCheckPosOnShape(int shapeID ) const;
507 void setPosOnShapeValidity(int shapeID, bool ok ) const;