src/SMESH/SMESH_MesherHelper.hxx

   1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
  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
  34 #include <Geom_Surface.hxx>
  35 #include <ShapeAnalysis_Surface.hxx>
  36 #include <TopoDS_Face.hxx>
  37 #include <TopoDS_Shape.hxx>
  38 #include <gp_Pnt2d.hxx>
  39
  40 #include <map>
  41 #include <vector>
  42
  43 class GeomAPI_ProjectPointOnCurve;
  44 class GeomAPI_ProjectPointOnSurf;
  45 class SMDS_MeshNode;
  46 class SMESHDS_Hypothesis;
  47 class SMESH_Gen;
  48 class SMESH_ProxyMesh;
  49
  50 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>           TLinkNodeMap;
  51 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
  52
  53 typedef SMDS_Iterator<const TopoDS_Shape*>  PShapeIterator;
  54 typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
  55
  56 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
  57 typedef std::map< double, TNodeColumn >    TParam2ColumnMap;
  58
  59 typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
  60
  61 //=======================================================================
  62 /*!
  63  * \brief It helps meshers to add elements and provides other utilities
  64  *
  65  * - It allows meshers not to care about creation of medium nodes
  66  * when filling a quadratic mesh. Helper does it itself.
  67  * It defines order of elements to create when IsQuadraticSubMesh()
  68  * is called.
  69  * - It provides information on a shape it is initialized with:
  70  * periodicity, presence of singularities etc.
  71  * - ...
  72  */
  73 //=======================================================================
  74
  75 class SMESH_EXPORT SMESH_MesherHelper
  76 {
  77  public:
  78   // ---------- PUBLIC UTILITIES ----------
  79
  80   /*!
  81    * \brief Returns true if all elements of a sub-mesh are of same shape
  82     * \param smDS - sub-mesh to check elements of
  83     * \param shape - expected shape of elements
  84     * \param nullSubMeshRes - result value for the case of smDS == NULL
  85     * \retval bool - check result
  86    */
  87   static bool IsSameElemGeometry(const SMESHDS_SubMesh* smDS,
  88                                  SMDSAbs_GeometryType   shape,
  89                                  const bool             nullSubMeshRes = true);
  90
  91   /*!
  92    * \brief Load nodes bound to face into a map of node columns
  93     * \param theParam2ColumnMap - map of node columns to fill
  94     * \param theFace - the face on which nodes are searched for
  95     * \param theBaseSide - the edges holding nodes on which columns' bases
  96     * \param theMesh - the mesh containing nodes
  97     * \retval bool - false if something is wrong
  98    *
  99    * The key of the map is a normalized parameter of each
 100    * base node on theBaseSide. Edges in theBaseSide must be sequenced.
 101    * This method works in supposition that nodes on the face
 102    * forms a structured grid and elements can be quardrangles or triangles
 103    */
 104   static bool LoadNodeColumns(TParam2ColumnMap &            theParam2ColumnMap,
 105                               const TopoDS_Face&            theFace,
 106                               const std::list<TopoDS_Edge>& theBaseSide,
 107                               SMESHDS_Mesh*                 theMesh,
 108                               SMESH_ProxyMesh*              theProxyMesh=0);
 109   /*!
 110    * \brief Variant of LoadNodeColumns() above with theBaseSide given by one edge
 111    */
 112   static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
 113                               const TopoDS_Face& theFace,
 114                               const TopoDS_Edge& theBaseEdge,
 115                               SMESHDS_Mesh*      theMesh,
 116                               SMESH_ProxyMesh*   theProxyMesh=0);
 117   /*!
 118    * \brief Return true if 2D mesh on FACE is structured
 119    */
 120   static bool IsStructured( SMESH_subMesh* faceSM );
 121
 122   /*!
 123    * \brief Return true if 2D mesh on FACE is distored
 124    */
 125   static bool IsDistorted2D( SMESH_subMesh* faceSM, bool checkUV=false );
 126
 127   /*!
 128    * \brief Returns true if given node is medium
 129     * \param n - node to check
 130     * \param typeToCheck - type of elements containing the node to ask about node status
 131     * \retval bool - check result
 132    */
 133   static bool IsMedium(const SMDS_MeshNode*      node,
 134                        const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
 135   /*!
 136    * \brief Return support shape of a node
 137    * \param node - the node
 138    * \param meshDS - mesh DS
 139    * \retval TopoDS_Shape - found support shape
 140    * \sa SMESH_Algo::VertexNode( const TopoDS_Vertex&, SMESHDS_Mesh* )
 141    */
 142   static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
 143                                         const SMESHDS_Mesh*  meshDS);
 144
 145   /*!
 146    * \brief Return a valid node index, fixing the given one if necessary
 147     * \param ind - node index
 148     * \param nbNodes - total nb of nodes
 149     * \retval int - valid node index
 150    */
 151   static inline int WrapIndex(int ind, const int nbNodes) {
 152     return (( ind %= nbNodes ) < 0 ) ? ind + nbNodes : ind;
 153   }
 154
 155   /*!
 156    * \brief Return UV of a point inside a quadrilateral FACE by it's
 157    *        normalized parameters within a unit quadrangle and the
 158    *        corresponding projections on sub-shapes of the real-world FACE.
 159    *        The used calculation method is called Trans-Finite Interpolation (TFI).
 160    *  \param x,y - normalized parameters that should be in range [0,1]
 161    *  \param a0,a1,a2,a3 - UV of VERTEXes of the FACE == projections on VERTEXes
 162    *  \param p0,p1,p2,p3 - UV of the point projections on EDGEs of the FACE
 163    *  \return gp_XY - UV of the point on the FACE
 164    *
 165    *  Y ^              Order of those UV in the FACE is as follows.
 166    *    |
 167    *   a3   p2    a2
 168    *    o---x-----o
 169    *    |   :     |
 170    *    |   :UV   |
 171    * p3 x...O.....x p1
 172    *    |   :     |
 173    *    o---x-----o    ----> X
 174    *   a0   p0    a1
 175    */
 176   inline static gp_XY calcTFI(double x, double y,
 177                               const gp_XY& a0,const gp_XY& a1,const gp_XY& a2,const gp_XY& a3,
 178                               const gp_XY& p0,const gp_XY& p1,const gp_XY& p2,const gp_XY& p3);
 179
 180   /*!
 181    * \brief Same as "gp_XY calcTFI(...)" but in 3D
 182    */
 183   inline static gp_XYZ calcTFI(double x, double y,
 184                                const gp_XYZ& a0,const gp_XYZ& a1,const gp_XYZ& a2,const gp_XYZ& a3,
 185                                const gp_XYZ& p0,const gp_XYZ& p1,const gp_XYZ& p2,const gp_XYZ& p3);
 186   /*!
 187    * \brief Count nb of sub-shapes
 188     * \param shape - the shape
 189     * \param type - the type of sub-shapes to count
 190     * \param ignoreSame - if true, use map not to count same shapes, esle use explorer
 191     * \retval int - the calculated number
 192    */
 193   static int Count(const TopoDS_Shape&    shape,
 194                    const TopAbs_ShapeEnum type,
 195                    const bool             ignoreSame);
 196
 197   /*!
 198    * \brief Return number of unique ancestors of the shape
 199    */
 200   static int NbAncestors(const TopoDS_Shape& shape,
 201                          const SMESH_Mesh&   mesh,
 202                          TopAbs_ShapeEnum    ancestorType=TopAbs_SHAPE);
 203   /*!
 204    * \brief Return iterator on ancestors of the given type
 205    */
 206   static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
 207                                         const SMESH_Mesh&   mesh,
 208                                         TopAbs_ShapeEnum    ancestorType);
 209   /*!
 210    * \brief Find a common ancestor, of the given type, of two shapes
 211    */
 212   static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
 213                                         const TopoDS_Shape& shape2,
 214                                         const SMESH_Mesh&   mesh,
 215                                         TopAbs_ShapeEnum    ancestorType);
 216   /*!
 217    * \brief Return orientation of sub-shape in the main shape
 218    */
 219   static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
 220                                            const TopoDS_Shape& subShape);
 221
 222   static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
 223
 224   static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
 225
 226   static bool IsBlock( const TopoDS_Shape& shape );
 227
 228   static double MaxTolerance( const TopoDS_Shape& shape );
 229
 230   static double GetAngle( const TopoDS_Edge & E1, const TopoDS_Edge & E2,
 231                           const TopoDS_Face & F,  const TopoDS_Vertex & V,
 232                           gp_Vec* faceNormal=0);
 233
 234   static bool IsClosedEdge( const TopoDS_Edge& anEdge );
 235
 236   static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
 237
 238   static TopAbs_ShapeEnum GetGroupType(const TopoDS_Shape& group,
 239                                        const bool          avoidCompound=false);
 240
 241   static TopoDS_Shape GetShapeOfHypothesis( const SMESHDS_Hypothesis * hyp,
 242                                             const TopoDS_Shape&        shape,
 243                                             SMESH_Mesh*                mesh);
 244
 245
 246 public:
 247   // ---------- PUBLIC INSTANCE METHODS ----------
 248
 249   // constructor
 250   SMESH_MesherHelper(SMESH_Mesh& theMesh);
 251
 252   SMESH_Gen*    GetGen() const;
 253
 254   SMESH_Mesh*   GetMesh() const { return myMesh; }
 255
 256   SMESHDS_Mesh* GetMeshDS() const;
 257
 258   /*!
 259    * Check submesh for given shape: if all elements on this shape are quadratic,
 260    * quadratic elements will be created. Also fill myTLinkNodeMap
 261    */
 262   bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
 263
 264   /*!
 265    * \brief Set order of elements to create without calling IsQuadraticSubMesh()
 266    */
 267   void SetIsQuadratic(const bool theBuildQuadratic)
 268   { myCreateQuadratic = theBuildQuadratic; }
 269
 270   /*!
 271    * \brief Set myCreateBiQuadratic flag
 272    */
 273   void SetIsBiQuadratic(const bool theBuildBiQuadratic)
 274   { myCreateBiQuadratic = theBuildBiQuadratic; }
 275
 276   /*!
 277    * \brief Return myCreateQuadratic flag
 278    */
 279   bool GetIsQuadratic() const { return myCreateQuadratic; }
 280
 281   /*
 282    * \brief Find out elements orientation on a geometrical face
 283    */
 284   bool IsReversedSubMesh (const TopoDS_Face& theFace);
 285
 286   /*!
 287    * \brief Return myCreateBiQuadratic flag
 288    */
 289   bool GetIsBiQuadratic() const { return myCreateBiQuadratic; }
 290
 291   /*!
 292    * \brief Move medium nodes of faces and volumes to fix distorted elements
 293    * \param error - container of fixed distorted elements
 294    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
 295    */
 296   void FixQuadraticElements(SMESH_ComputeErrorPtr& error, bool volumeOnly=true);
 297
 298   /*!
 299    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
 300    *        or the next methods. By defaul elements are set on the shape if
 301    *        a mesh has no shape to be meshed
 302    */
 303   bool SetElementsOnShape(bool toSet)
 304   { bool res = mySetElemOnShape; mySetElemOnShape = toSet; return res; }
 305
 306   /*!
 307    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
 308    */
 309   void SetSubShape(const int           subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
 310   void SetSubShape(const TopoDS_Shape& subShape);
 311   /*!
 312    * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape()
 313     * \retval int - shape index in SMESHDS
 314    */
 315   int GetSubShapeID() const { return myShapeID; }
 316   /*!
 317    * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape()
 318    */
 319   const TopoDS_Shape& GetSubShape() const  { return myShape; }
 320
 321   /*!
 322    * \brief Convert a shape to its index in the SMESHDS_Mesh
 323    */
 324   int ShapeToIndex( const TopoDS_Shape& S ) const;
 325
 326   /*!
 327    * Creates a node (!Note ID before u=0.,v0.)
 328    */
 329   SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
 330   /*!
 331    * Creates quadratic or linear edge
 332    */
 333   SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
 334                          const SMDS_MeshNode* n2,
 335                          const int id = 0,
 336                          const bool force3d = true);
 337   /*!
 338    * Creates quadratic or linear triangle
 339    */
 340   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
 341                          const SMDS_MeshNode* n2,
 342                          const SMDS_MeshNode* n3,
 343                          const int id=0,
 344                          const bool force3d = false);
 345   /*!
 346    * Creates bi-quadratic, quadratic or linear quadrangle
 347    */
 348   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
 349                          const SMDS_MeshNode* n2,
 350                          const SMDS_MeshNode* n3,
 351                          const SMDS_MeshNode* n4,
 352                          const int id = 0,
 353                          const bool force3d = false);
 354   /*!
 355    * Creates polygon, with additional nodes in quadratic mesh
 356    */
 357   SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
 358                                    const int id = 0,
 359                                    const bool force3d = false);
 360   /*!
 361    * Creates quadratic or linear tetrahedron
 362    */
 363   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 364                              const SMDS_MeshNode* n2,
 365                              const SMDS_MeshNode* n3,
 366                              const SMDS_MeshNode* n4,
 367                              const int id = 0,
 368                              const bool force3d = true);
 369   /*!
 370    * Creates quadratic or linear pyramid
 371    */
 372   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 373                              const SMDS_MeshNode* n2,
 374                              const SMDS_MeshNode* n3,
 375                              const SMDS_MeshNode* n4,
 376                              const SMDS_MeshNode* n5,
 377                              const int id = 0,
 378                              const bool force3d = true);
 379   /*!
 380    * Creates quadratic or linear pentahedron
 381    */
 382   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 383                              const SMDS_MeshNode* n2,
 384                              const SMDS_MeshNode* n3,
 385                              const SMDS_MeshNode* n4,
 386                              const SMDS_MeshNode* n5,
 387                              const SMDS_MeshNode* n6,
 388                              const int id = 0,
 389                              const bool force3d = true);
 390   /*!
 391    * Creates bi-quadratic, quadratic or linear hexahedron
 392    */
 393   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 394                              const SMDS_MeshNode* n2,
 395                              const SMDS_MeshNode* n3,
 396                              const SMDS_MeshNode* n4,
 397                              const SMDS_MeshNode* n5,
 398                              const SMDS_MeshNode* n6,
 399                              const SMDS_MeshNode* n7,
 400                              const SMDS_MeshNode* n8,
 401                              const int id = 0,
 402                              bool force3d = true);
 403
 404   /*!
 405    * Creates LINEAR!!!!!!!!! octahedron
 406    */
 407   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 408                              const SMDS_MeshNode* n2,
 409                              const SMDS_MeshNode* n3,
 410                              const SMDS_MeshNode* n4,
 411                              const SMDS_MeshNode* n5,
 412                              const SMDS_MeshNode* n6,
 413                              const SMDS_MeshNode* n7,
 414                              const SMDS_MeshNode* n8,
 415                              const SMDS_MeshNode* n9,
 416                              const SMDS_MeshNode* n10,
 417                              const SMDS_MeshNode* n11,
 418                              const SMDS_MeshNode* n12,
 419                              const int id = 0,
 420                              bool force3d = true);
 421
 422   /*!
 423    * Creates polyhedron. In quadratic mesh, adds medium nodes
 424    */
 425   SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
 426                                         const std::vector<int>&                  quantities,
 427                                         const int                                ID=0,
 428                                         const bool                               force3d = true);
 429   /*!
 430    * \brief Enables fixing node parameters on EDGEs and FACEs by
 431    * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
 432    * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
 433    * Default is False
 434    */
 435   void ToFixNodeParameters(bool toFix);
 436
 437   /*!
 438    * \brief Return U of the given node on the edge
 439    */
 440   double GetNodeU(const TopoDS_Edge&   theEdge,
 441                   const SMDS_MeshNode* theNode,
 442                   const SMDS_MeshNode* inEdgeNode=0,
 443                   bool*                check=0) const;
 444   /*!
 445    * \brief Return node UV on face
 446    *  \param inFaceNode - a node of element being created located inside a face
 447    *  \param check - if provided, returns result of UV check that it enforces
 448    */
 449   gp_XY GetNodeUV(const TopoDS_Face&   F,
 450                   const SMDS_MeshNode* n,
 451                   const SMDS_MeshNode* inFaceNode=0,
 452                   bool*                check=0) const;
 453   /*!
 454    * \brief Check and fix node UV on a face
 455    *  \param force - check even if checks of other nodes on this face passed OK
 456    *  \param distXYZ - returns result distance and point coordinates
 457    *  \retval bool - false if UV is bad and could not be fixed
 458    */
 459   bool CheckNodeUV(const TopoDS_Face&   F,
 460                    const SMDS_MeshNode* n,
 461                    gp_XY&               uv,
 462                    const double         tol,
 463                    const bool           force=false,
 464                    double               distXYZ[4]=0) const;
 465   /*!
 466    * \brief Check and fix node U on an edge
 467    *  \param force - check even if checks of other nodes on this edge passed OK
 468    *  \param distXYZ - returns result distance and point coordinates
 469    *  \retval bool - false if U is bad and could not be fixed
 470    */
 471   bool CheckNodeU(const TopoDS_Edge&   E,
 472                   const SMDS_MeshNode* n,
 473                   double&              u,
 474                   const double         tol,
 475                   const bool           force=false,
 476                   double               distXYZ[4]=0) const;
 477   /*!
 478    * \brief Return middle UV taking in account surface period
 479    */
 480   static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
 481                            const gp_XY&                uv1,
 482                            const gp_XY&                uv2);
 483   /*!
 484    * \brief Return UV for the central node of a biquadratic triangle
 485    */
 486   static gp_XY GetCenterUV(const gp_XY& uv1,
 487                            const gp_XY& uv2,
 488                            const gp_XY& uv3,
 489                            const gp_XY& uv12,
 490                            const gp_XY& uv23,
 491                            const gp_XY& uv31,
 492                            bool *       isBadTria=0);
 493   /*!
 494    * \brief Define a pointer to wrapper over a function of gp_XY class,
 495    *       suitable to pass as xyFunPtr to ApplyIn2D().
 496    *       For exaple gp_XY_FunPtr(Added) defines pointer gp_XY_Added to function
 497    *       calling gp_XY::Added(gp_XY), which is to be used like following
 498    *       ApplyIn2D(surf, uv1, uv2, gp_XY_Added)
 499    */
 500 #define gp_XY_FunPtr(meth) \
 501   static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
 502   static xyFunPtr gp_XY_##meth = & __gpXY_##meth
 503
 504   /*!
 505    * \brief Perform given operation on two 2d points in parameric space of given surface.
 506    *        It takes into account period of the surface. Use gp_XY_FunPtr macro
 507    *        to easily define pointer to function of gp_XY class.
 508    */
 509   static gp_XY ApplyIn2D(Handle(Geom_Surface) surface,
 510                          const gp_XY&         uv1,
 511                          const gp_XY&         uv2,
 512                          xyFunPtr             fun,
 513                          const bool           resultInPeriod=true);
 514
 515   /*!
 516    * \brief Move node positions on a FACE within surface period
 517    *  \param [in] face - the FACE
 518    *  \param [inout] uv - node positions to adjust
 519    *  \param [in] nbUV - nb of \a uv
 520    */
 521   void AdjustByPeriod( const TopoDS_Face& face, gp_XY uv[], const int nbUV );
 522
 523   /*!
 524    * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
 525    *  \retval bool - return true if the face is periodic
 526    *
 527    * If F is Null, answer about subshape set through IsQuadraticSubMesh() or
 528    * SetSubShape()
 529    */
 530   bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
 531
 532   /*!
 533    * \brief Return projector intitialized by given face without location, which is returned
 534    */
 535   GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
 536                                            TopLoc_Location&   loc,
 537                                            double             tol=0 ) const;
 538   /*!
 539    * \brief Return a cached ShapeAnalysis_Surface of a FACE
 540    */
 541   Handle(ShapeAnalysis_Surface) GetSurface(const TopoDS_Face& F ) const;
 542
 543   /*!
 544    * \brief Check if shape is a degenerated edge or it's vertex
 545    *  \param subShape - edge or vertex index in SMESHDS
 546    *  \retval bool - true if subShape is a degenerated shape
 547    *
 548    * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
 549    */
 550   bool IsDegenShape(const int subShape) const
 551   { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
 552   /*!
 553    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
 554    *        has a degenerated edges
 555     * \retval bool - true if it has
 556    */
 557   bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
 558
 559   /*!
 560    * \brief Check if shape is a seam edge or it's vertex
 561     * \param subShape - edge or vertex index in SMESHDS
 562     * \retval bool - true if subShape is a seam shape
 563     *
 564     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
 565     * Seam shape has two 2D alternative represenations on the face
 566    */
 567   bool IsSeamShape(const int subShape) const
 568   { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
 569   /*!
 570    * \brief Check if shape is a seam edge or it's vertex
 571     * \param subShape - edge or vertex
 572     * \retval bool - true if subShape is a seam shape
 573     *
 574     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
 575     * Seam shape has two 2D alternative represenations on the face
 576    */
 577   bool IsSeamShape(const TopoDS_Shape& subShape) const
 578   { return IsSeamShape( ShapeToIndex( subShape )); }
 579   /*!
 580    * \brief Return true if an edge or a vertex encounters twice in face wire
 581    *  \param subShape - Id of edge or vertex
 582    */
 583   bool IsRealSeam(const int subShape) const
 584   { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
 585   /*!
 586    * \brief Return true if an edge or a vertex encounters twice in face wire
 587    *  \param subShape - edge or vertex
 588    */
 589   bool IsRealSeam(const TopoDS_Shape& subShape) const
 590   { return IsRealSeam( ShapeToIndex( subShape )); }
 591   /*!
 592    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
 593    *        has a seam edge, i.e. an edge that has two parametric representations
 594    *        on a surface
 595    *  \retval bool - true if it has
 596    */
 597   bool HasSeam() const { return !mySeamShapeIds.empty(); }
 598   /*!
 599    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
 600    *        has a seam edge that encounters twice in a wire
 601    *  \retval bool - true if it has
 602    */
 603   bool HasRealSeam() const { return HasSeam() && ( *mySeamShapeIds.begin() < 0 ); }
 604   /*!
 605    * \brief Return index of periodic parametric direction of a closed face
 606    *  \retval int - 1 for U, 2 for V direction
 607    */
 608   int GetPeriodicIndex() const { return myParIndex; }
 609   /*!
 610    * \brief Return an alternative parameter for a node on seam
 611    */
 612   double GetOtherParam(const double param) const;
 613
 614   /*!
 615    * \brief Return existing or create new medium nodes between given ones
 616    *  \param force3d - true means node creation at the middle between the
 617    *                   two given nodes, else node position is found on its
 618    *                   supporting geometrical shape, if any.
 619    *  \param expectedSupport - shape type corresponding to element being created
 620    *                           , e.g TopAbs_EDGE if SMDSAbs_Edge is created
 621    *                           basing on \a n1 and \a n2
 622    */
 623   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
 624                                      const SMDS_MeshNode* n2,
 625                                      const bool           force3d,
 626                                      TopAbs_ShapeEnum     expectedSupport=TopAbs_SHAPE);
 627   /*!
 628    * \brief Return existing or create a new central node for a quardilateral
 629    *       quadratic face given its 8 nodes.
 630    *  \param force3d - true means node creation in between the given nodes,
 631    *                   else node position is found on a geometrical face if any.
 632    */
 633   const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
 634                                       const SMDS_MeshNode* n2,
 635                                       const SMDS_MeshNode* n3,
 636                                       const SMDS_MeshNode* n4,
 637                                       const SMDS_MeshNode* n12,
 638                                       const SMDS_MeshNode* n23,
 639                                       const SMDS_MeshNode* n34,
 640                                       const SMDS_MeshNode* n41,
 641                                       bool                 force3d);
 642   /*!
 643    * \brief Return existing or create a new central node for a
 644    *       quadratic triangle given its 6 nodes.
 645    *  \param force3d - true means node creation in between the given nodes,
 646    *                   else node position is found on a geometrical face if any.
 647    */
 648   const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
 649                                       const SMDS_MeshNode* n2,
 650                                       const SMDS_MeshNode* n3,
 651                                       const SMDS_MeshNode* n12,
 652                                       const SMDS_MeshNode* n23,
 653                                       const SMDS_MeshNode* n31,
 654                                       bool                 force3d);
 655   /*!
 656    * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
 657    */
 658   std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
 659                                                 const SMDS_MeshNode* n2,
 660                                                 const bool           useCurSubShape=false,
 661                                                 TopAbs_ShapeEnum     expectedSupport=TopAbs_SHAPE);
 662   /*!
 663    * \brief Add a link in my data structure
 664    */
 665   void AddTLinkNode(const SMDS_MeshNode* n1,
 666                     const SMDS_MeshNode* n2,
 667                     const SMDS_MeshNode* n12);
 668   /*!
 669    * \brief Add many links in my data structure
 670    */
 671   void AddTLinkNodeMap(const TLinkNodeMap& aMap)
 672     { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
 673
 674   bool AddTLinks(const SMDS_MeshEdge*   edge);
 675   bool AddTLinks(const SMDS_MeshFace*   face);
 676   bool AddTLinks(const SMDS_MeshVolume* vol);
 677
 678   /**
 679    * Returns myTLinkNodeMap
 680    */
 681   const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
 682
 683   /**
 684    * Check mesh without geometry for: if all elements on this shape are quadratic,
 685    * quadratic elements will be created.
 686    * Used then generated 3D mesh without geometry.
 687    */
 688   enum MType{ LINEAR, QUADRATIC, COMP };
 689   MType IsQuadraticMesh();
 690
 691   virtual ~SMESH_MesherHelper();
 692
 693   static void WriteShape(const TopoDS_Shape& s);
 694
 695  protected:
 696
 697   /*!
 698    * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
 699    *  \param uv1 - UV on the seam
 700    *  \param uv2 - UV within a face
 701    *  \retval gp_Pnt2d - selected UV
 702    */
 703   gp_Pnt2d getUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
 704
 705   const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
 706                                                    const SMDS_MeshNode* n2,
 707                                                    bool                 force3d);
 708
 709   double getFaceMaxTol( const TopoDS_Shape& face ) const;
 710
 711  private:
 712
 713   // Forbiden copy constructor
 714   SMESH_MesherHelper (const SMESH_MesherHelper& theOther);
 715
 716   // key of a map of bi-quadratic face to it's central node
 717   struct TBiQuad: public std::pair<int, std::pair<int, int> >
 718   {
 719     TBiQuad(const SMDS_MeshNode* n1,
 720             const SMDS_MeshNode* n2,
 721             const SMDS_MeshNode* n3,
 722             const SMDS_MeshNode* n4=0)
 723     {
 724       TIDSortedNodeSet s;
 725       s.insert(n1);
 726       s.insert(n2);
 727       s.insert(n3);
 728       if ( n4 ) s.insert(n4);
 729       TIDSortedNodeSet::iterator n = s.begin();
 730       first = (*n++)->GetID();
 731       second.first = (*n++)->GetID();
 732       second.second = (*n++)->GetID();
 733     }
 734   };
 735
 736   // maps used during creation of quadratic elements
 737   TLinkNodeMap                              myTLinkNodeMap;       // medium nodes on links
 738   std::map< TBiQuad, const SMDS_MeshNode* > myMapWithCentralNode; // central nodes of faces
 739
 740   std::set< int > myDegenShapeIds;
 741   std::set< int > mySeamShapeIds;
 742   double          myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
 743   int             myParIndex;     // bounds' index (1-U, 2-V, 3-both)
 744
 745   std::map< int, double > myFaceMaxTol;
 746
 747   typedef std::map< int, Handle(ShapeAnalysis_Surface)> TID2Surface;
 748   typedef std::map< int, GeomAPI_ProjectPointOnSurf* >  TID2ProjectorOnSurf;
 749   typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
 750   mutable TID2Surface  myFace2Surface;
 751   TID2ProjectorOnSurf  myFace2Projector;
 752   TID2ProjectorOnCurve myEdge2Projector;
 753
 754   TopoDS_Shape    myShape;
 755   SMESH_Mesh*     myMesh;
 756   int             myShapeID;
 757
 758   bool            myCreateQuadratic;
 759   bool            myCreateBiQuadratic;
 760   bool            mySetElemOnShape;
 761   bool            myFixNodeParameters;
 762
 763   std::map< int,bool > myNodePosShapesValidity;
 764   bool toCheckPosOnShape(int shapeID ) const;
 765   void setPosOnShapeValidity(int shapeID, bool ok ) const;
 766 };
 767
 768 //=======================================================================
 769 inline gp_XY
 770 SMESH_MesherHelper::calcTFI(double x, double y,
 771                             const gp_XY& a0,const gp_XY& a1,const gp_XY& a2,const gp_XY& a3,
 772                             const gp_XY& p0,const gp_XY& p1,const gp_XY& p2,const gp_XY& p3)
 773 {
 774   return
 775     ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
 776     ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
 777 }
 778 //=======================================================================
 779 inline gp_XYZ
 780 SMESH_MesherHelper::calcTFI(double x, double y,
 781                             const gp_XYZ& a0,const gp_XYZ& a1,const gp_XYZ& a2,const gp_XYZ& a3,
 782                             const gp_XYZ& p0,const gp_XYZ& p1,const gp_XYZ& p2,const gp_XYZ& p3)
 783 {
 784   return
 785     ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
 786     ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
 787 }
 788 //=======================================================================
 789
 790 #endif