src/SMESH/SMESH_MesherHelper.hxx

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