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;
46 typedef std::map<SMESH_TLink, const SMDS_MeshNode*> TLinkNodeMap;
47 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
49 typedef SMDS_Iterator<const TopoDS_Shape*> PShapeIterator;
50 typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
52 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
53 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
55 typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
57 //=======================================================================
59 * \brief It helps meshers to add elements
61 * It allow meshers not to care about creation of medium nodes
62 * when filling a quadratic mesh. Helper does it itself.
63 * It defines degree of elements to create when IsQuadraticSubMesh()
66 //=======================================================================
68 class SMESH_EXPORT SMESH_MesherHelper
71 // ---------- PUBLIC UTILITIES ----------
74 * \brief Returns true if given node is medium
75 * \param n - node to check
76 * \param typeToCheck - type of elements containing the node to ask about node status
77 * \retval bool - check result
79 static bool IsMedium(const SMDS_MeshNode* node,
80 const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
83 * \brief Load nodes bound to face into a map of node columns
84 * \param theParam2ColumnMap - map of node columns to fill
85 * \param theFace - the face on which nodes are searched for
86 * \param theBaseEdge - the edge nodes of which are columns' bases
87 * \param theMesh - the mesh containing nodes
88 * \retval bool - false if something is wrong
90 * The key of the map is a normalized parameter of each
91 * base node on theBaseEdge.
92 * This method works in supposition that nodes on the face
93 * forms a rectangular grid and elements can be quardrangles or triangles
95 static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
96 const TopoDS_Face& theFace,
97 const TopoDS_Edge& theBaseEdge,
98 SMESHDS_Mesh* theMesh);
100 * \brief Return support shape of a node
101 * \param node - the node
102 * \param meshDS - mesh DS
103 * \retval TopoDS_Shape - found support shape
105 static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
106 SMESHDS_Mesh* meshDS);
109 * \brief Return a valid node index, fixing the given one if necessary
110 * \param ind - node index
111 * \param nbNodes - total nb of nodes
112 * \retval int - valid node index
114 static int WrapIndex(const int ind, const int nbNodes) {
115 if ( ind < 0 ) return nbNodes + ind % nbNodes;
116 if ( ind >= nbNodes ) return ind % nbNodes;
121 * \brief Return number of unique ancestors of the shape
123 static int NbAncestors(const TopoDS_Shape& shape,
124 const SMESH_Mesh& mesh,
125 TopAbs_ShapeEnum ancestorType=TopAbs_SHAPE);
127 * \brief Return iterator on ancestors of the given type
129 static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
130 const SMESH_Mesh& mesh,
131 TopAbs_ShapeEnum ancestorType);
134 * \brief Return orientation of sub-shape in the main shape
136 static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
137 const TopoDS_Shape& subShape);
139 static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
141 static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
145 // ---------- PUBLIC INSTANCE METHODS ----------
148 SMESH_MesherHelper(SMESH_Mesh& theMesh);
150 SMESH_Mesh* GetMesh() const { return myMesh; }
152 SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
155 * Check submesh for given shape: if all elements on this shape are quadratic,
156 * quadratic elements will be created. Also fill myTLinkNodeMap
158 bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
160 * \brief Set order of elements to create without calling IsQuadraticSubMesh()
162 void SetIsQuadratic(const bool theBuildQuadratic)
163 { myCreateQuadratic = theBuildQuadratic; }
165 * \brief Return myCreateQuadratic flag
167 bool GetIsQuadratic() const { return myCreateQuadratic; }
170 * \brief Move medium nodes of faces and volumes to fix distorted elements
171 * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
173 void FixQuadraticElements(bool volumeOnly=true);
176 * \brief To set created elements on the shape set by IsQuadraticSubMesh()
177 * or the next methods. By defaul elements are set on the shape if
178 * a mesh has no shape to be meshed
180 void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
183 * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
185 void SetSubShape(const int subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
186 void SetSubShape(const TopoDS_Shape& subShape);
188 * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape()
189 * \retval int - shape index in SMESHDS
191 int GetSubShapeID() const { return myShapeID; }
193 * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape()
195 const TopoDS_Shape& GetSubShape() const { return myShape; }
200 SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0);
202 * Creates quadratic or linear edge
204 SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
205 const SMDS_MeshNode* n2,
207 const bool force3d = true);
209 * Creates quadratic or linear triangle
211 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
212 const SMDS_MeshNode* n2,
213 const SMDS_MeshNode* n3,
215 const bool force3d = false);
217 * Creates quadratic or linear quadrangle
219 SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
220 const SMDS_MeshNode* n2,
221 const SMDS_MeshNode* n3,
222 const SMDS_MeshNode* n4,
224 const bool force3d = false);
227 * Creates polygon, with additional nodes in quadratic mesh
229 SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
231 const bool force3d = false);
233 * Creates quadratic or linear tetraahedron
235 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
236 const SMDS_MeshNode* n2,
237 const SMDS_MeshNode* n3,
238 const SMDS_MeshNode* n4,
240 const bool force3d = true);
242 * Creates quadratic or linear pyramid
244 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
245 const SMDS_MeshNode* n2,
246 const SMDS_MeshNode* n3,
247 const SMDS_MeshNode* n4,
248 const SMDS_MeshNode* n5,
250 const bool force3d = true);
252 * Creates quadratic or linear pentahedron
254 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
255 const SMDS_MeshNode* n2,
256 const SMDS_MeshNode* n3,
257 const SMDS_MeshNode* n4,
258 const SMDS_MeshNode* n5,
259 const SMDS_MeshNode* n6,
261 const bool force3d = true);
263 * Creates quadratic or linear hexahedron
265 SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
266 const SMDS_MeshNode* n2,
267 const SMDS_MeshNode* n3,
268 const SMDS_MeshNode* n4,
269 const SMDS_MeshNode* n5,
270 const SMDS_MeshNode* n6,
271 const SMDS_MeshNode* n7,
272 const SMDS_MeshNode* n8,
274 bool force3d = true);
277 * Creates polyhedron. In quadratic mesh, adds medium nodes
279 SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
280 const std::vector<int>& quantities,
282 const bool force3d = true);
284 * \brief Return U of the given node on the edge
286 double GetNodeU(const TopoDS_Edge& theEdge,
287 const SMDS_MeshNode* theNode,
288 const SMDS_MeshNode* inEdgeNode=0,
291 * \brief Return node UV on face
292 * \param inFaceNode - a node of element being created located inside a face
294 gp_XY GetNodeUV(const TopoDS_Face& F,
295 const SMDS_MeshNode* n,
296 const SMDS_MeshNode* inFaceNode=0,
297 bool* check=0) const;
299 * \brief Check and fix node UV on a face
300 * \param force - check even if checks of other nodes on this face passed OK
301 * \retval bool - false if UV is bad and could not be fixed
303 bool CheckNodeUV(const TopoDS_Face& F,
304 const SMDS_MeshNode* n,
307 const bool force=false) const;
309 * \brief Check and fix node U on an edge
310 * \param force - check even if checks of other nodes on this edge passed OK
311 * \retval bool - false if U is bad and could not be fixed
313 bool CheckNodeU(const TopoDS_Edge& E,
314 const SMDS_MeshNode* n,
317 const bool force=false,
318 double* distance=0) const;
320 * \brief Return middle UV taking in account surface period
322 static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
326 * \brief Define a pointer to wrapper over a function of gp_XY class,
327 * suitable to pass as xyFunPtr to applyIn2D().
328 * For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
329 * calling gp_XY::Added(gp_XY), which is to be used like following
330 * applyIn2D(surf, uv1, uv2, gp_XY_Added)
332 #define gp_XY_FunPtr(meth) \
333 static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
334 static xyFunPtr gp_XY_##meth = & __gpXY_##meth
337 * \brief Perform given operation on two 2d points in parameric space of given surface.
338 * It takes into account period of the surface. Use gp_XY_FunPtr macro
339 * to easily define pointer to function of gp_XY class.
341 static gp_XY applyIn2D(const Handle(Geom_Surface)& surface,
345 const bool resultInPeriod=true);
348 * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
349 * \retval bool - return true if the face is periodic
351 * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
354 bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
357 * \brief Return projector intitialized by given face without location, which is returned
359 GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
360 TopLoc_Location& loc,
361 double tol=0 ) const;
364 * \brief Check if shape is a degenerated edge or it's vertex
365 * \param subShape - edge or vertex index in SMESHDS
366 * \retval bool - true if subShape is a degenerated shape
368 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
370 bool IsDegenShape(const int subShape) const
371 { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
373 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
374 * has a degenerated edges
375 * \retval bool - true if it has
377 bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
380 * \brief Check if shape is a seam edge or it's vertex
381 * \param subShape - edge or vertex index in SMESHDS
382 * \retval bool - true if subShape is a seam shape
384 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
385 * Seam shape has two 2D alternative represenations on the face
387 bool IsSeamShape(const int subShape) const
388 { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
390 * \brief Check if shape is a seam edge or it's vertex
391 * \param subShape - edge or vertex
392 * \retval bool - true if subShape is a seam shape
394 * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
395 * Seam shape has two 2D alternative represenations on the face
397 bool IsSeamShape(const TopoDS_Shape& subShape) const
398 { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
400 * \brief Return true if an edge or a vertex encounters twice in face wire
401 * \param subShape - Id of edge or vertex
403 bool IsRealSeam(const int subShape) const
404 { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
406 * \brief Return true if an edge or a vertex encounters twice in face wire
407 * \param subShape - edge or vertex
409 bool IsRealSeam(const TopoDS_Shape& subShape) const
410 { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
412 * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
414 * \retval bool - true if it has
416 bool HasSeam() const { return !mySeamShapeIds.empty(); }
418 * \brief Return index of periodic parametric direction of a closed face
419 * \retval int - 1 for U, 2 for V direction
421 int GetPeriodicIndex() const { return myParIndex; }
423 * \brief Return an alternative parameter for a node on seam
425 double GetOtherParam(const double param) const;
428 * \brief Return existing or create new medium nodes between given ones
429 * \param force3d - true means node creation at the middle between the
430 * two given nodes, else node position is found on its
431 * supporting geometrical shape, if any.
433 const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
434 const SMDS_MeshNode* n2,
437 * \brief Add a link in my data structure
439 void AddTLinkNode(const SMDS_MeshNode* n1,
440 const SMDS_MeshNode* n2,
441 const SMDS_MeshNode* n12);
443 * \brief Add many links in my data structure
445 void AddTLinkNodeMap(const TLinkNodeMap& aMap)
446 { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
449 * Returns myTLinkNodeMap
451 const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
454 * Check mesh without geometry for: if all elements on this shape are quadratic,
455 * quadratic elements will be created.
456 * Used then generated 3D mesh without geometry.
458 enum MType{ LINEAR, QUADRATIC, COMP };
459 MType IsQuadraticMesh();
461 virtual ~SMESH_MesherHelper();
466 * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
467 * \param uv1 - UV on the seam
468 * \param uv2 - UV within a face
469 * \retval gp_Pnt2d - selected UV
471 gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
473 const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
474 const SMDS_MeshNode* n2,
478 // Forbiden copy constructor
479 SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
481 // special map for using during creation of quadratic elements
482 TLinkNodeMap myTLinkNodeMap;
484 std::set< int > myDegenShapeIds;
485 std::set< int > mySeamShapeIds;
486 double myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
487 int myParIndex; // bounds' index (1-U, 2-V, 3-both)
489 typedef std::map< int, GeomAPI_ProjectPointOnSurf* > TID2Projector;
490 TID2Projector myFace2Projector;
492 TopoDS_Shape myShape;
496 // to create quadratic elements
497 bool myCreateQuadratic;
498 bool mySetElemOnShape;
499 std::set< int > myOkNodePosShapes;