src/SMESHUtils/SMESH_MeshAlgos.hxx

   1 // Copyright (C) 2007-2022  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 // File      : SMESH_MeshAlgos.hxx
  23 // Created   : Tue Apr 30 18:00:36 2013
  24 // Author    : Edward AGAPOV (eap)
  25
  26 // Initially this file held some low level algorithms extracted from SMESH_MeshEditor
  27 // to make them accessible from Controls package, and more
  28
  29
  30 #ifndef __SMESH_MeshAlgos_HXX__
  31 #define __SMESH_MeshAlgos_HXX__
  32
  33 #include "SMESH_Utils.hxx"
  34
  35 #include "SMDSAbs_ElementType.hxx"
  36 #include "SMDS_ElemIterator.hxx"
  37 #include "SMESH_TypeDefs.hxx"
  38
  39 #include <TopAbs_State.hxx>
  40 #include <gp_Pnt.hxx>
  41 #include <gp_Vec.hxx>
  42
  43 #include <vector>
  44
  45 class Bnd_B3d;
  46 class gp_Ax1;
  47 class SMDS_Mesh;
  48 class SMDS_MeshElement;
  49 class SMDS_MeshGroup;
  50 class SMDS_MeshNode;
  51
  52 //=======================================================================
  53 /*!
  54  * \brief Searcher for the node closest to a point
  55  */
  56 //=======================================================================
  57
  58 struct SMESHUtils_EXPORT SMESH_NodeSearcher
  59 {
  60   virtual const SMDS_MeshNode* FindClosestTo( const gp_Pnt& pnt ) = 0;
  61   virtual void MoveNode( const SMDS_MeshNode* node, const gp_Pnt& toPnt ) = 0;
  62   virtual int  FindNearPoint(const gp_Pnt&                        point,
  63                              const double                         tolerance,
  64                              std::vector< const SMDS_MeshNode* >& foundNodes) = 0;
  65   virtual ~SMESH_NodeSearcher() {}
  66 };
  67
  68 //=======================================================================
  69 /*!
  70  * \brief Searcher for elements
  71  */
  72 //=======================================================================
  73
  74 struct SMESHUtils_EXPORT SMESH_ElementSearcher
  75 {
  76   /*!
  77    * \brief Find elements of given type where the given point is IN or ON.
  78    *        Returns nb of found elements and elements them-selves.
  79    *
  80    * 'ALL' type means elements of any type excluding nodes and 0D elements
  81    */
  82   virtual int FindElementsByPoint(const gp_Pnt&                           point,
  83                                   SMDSAbs_ElementType                     type,
  84                                   std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  85   /*!
  86    * \brief Return an element most close to the given point
  87    */
  88   virtual const SMDS_MeshElement* FindClosestTo( const gp_Pnt&       point,
  89                                                  SMDSAbs_ElementType type) = 0;
  90   /*!
  91    * \brief Return elements possibly intersecting the line
  92    */
  93   virtual void GetElementsNearLine( const gp_Ax1&                           line,
  94                                     SMDSAbs_ElementType                     type,
  95                                     std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  96   /*!
  97    * \brief Return elements whose bounding box intersects a sphere
  98    */
  99   virtual void GetElementsInSphere( const gp_XYZ&                           center,
 100                                     const double                            radius,
 101                                     SMDSAbs_ElementType                     type,
 102                                     std::vector< const SMDS_MeshElement* >& foundElems) = 0;
 103   /*!
 104    * \brief Return elements whose bounding box intersects a given bounding box
 105    */
 106   virtual void GetElementsInBox( const Bnd_B3d&                          box,
 107                                  SMDSAbs_ElementType                     type,
 108                                  std::vector< const SMDS_MeshElement* >& foundElems) = 0;
 109   /*!
 110    * \brief Find out if the given point is out of closed 2D mesh.
 111    */
 112   virtual TopAbs_State GetPointState(const gp_Pnt& point) = 0;
 113
 114   /*!
 115    * \brief Return a projection of a given point to a 2D mesh.
 116    *        Optionally return the closest face
 117    */
 118   virtual gp_XYZ Project(const gp_Pnt&            point,
 119                          SMDSAbs_ElementType      type,
 120                          const SMDS_MeshElement** closestFace= 0) = 0;
 121
 122   virtual ~SMESH_ElementSearcher();
 123 };
 124
 125 namespace SMESH_MeshAlgos
 126 {
 127   /*!
 128    * \brief Return SMESH_NodeSearcher. The caller is responsible for deleting it
 129    */
 130   SMESHUtils_EXPORT
 131   SMESH_NodeSearcher* GetNodeSearcher( SMDS_Mesh& mesh );
 132
 133   SMESHUtils_EXPORT
 134   SMESH_NodeSearcher* GetNodeSearcher( SMDS_ElemIteratorPtr elemIt );
 135
 136   /*!
 137    * \brief Return SMESH_ElementSearcher. The caller is responsible for deleting it
 138    */
 139   SMESHUtils_EXPORT
 140   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
 141                                              double     tolerance=-1.);
 142   SMESHUtils_EXPORT
 143   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
 144                                              SMDS_ElemIteratorPtr elemIt,
 145                                              double     tolerance=-1. );
 146
 147
 148   /*!
 149    * \brief Return true if the point is IN or ON of the element
 150    */
 151   SMESHUtils_EXPORT
 152   bool IsOut( const SMDS_MeshElement* element, const gp_Pnt& point, double tol );
 153
 154   SMESHUtils_EXPORT
 155   double GetDistance( const SMDS_MeshElement* elem, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 156
 157   SMESHUtils_EXPORT
 158   double GetDistance( const SMDS_MeshEdge* edge, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 159
 160   SMESHUtils_EXPORT
 161   double GetDistance( const SMDS_MeshFace* face, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 162
 163   SMESHUtils_EXPORT
 164   double GetDistance( const SMDS_MeshVolume* volume, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 165
 166   SMESHUtils_EXPORT
 167   void GetBarycentricCoords( const gp_XY& point,
 168                              const gp_XY& t0, const gp_XY& t1, const gp_XY& t2,
 169                              double &    bc0, double &    bc1);
 170
 171   /*!
 172    * Return a face having linked nodes n1 and n2 and which is
 173    * - not in avoidSet,
 174    * - in elemSet provided that !elemSet.empty()
 175    * i1 and i2 optionally returns indices of n1 and n2
 176    */
 177   SMESHUtils_EXPORT
 178   const SMDS_MeshElement* FindFaceInSet(const SMDS_MeshNode*    n1,
 179                                         const SMDS_MeshNode*    n2,
 180                                         const TIDSortedElemSet& elemSet,
 181                                         const TIDSortedElemSet& avoidSet,
 182                                         int*                    i1=0,
 183                                         int*                    i2=0);
 184   /*!
 185    * \brief Calculate normal of a mesh face
 186    */
 187   SMESHUtils_EXPORT
 188   bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true);
 189
 190   /*!
 191    * \brief Return number of nodes common to two elements
 192    */
 193   SMESHUtils_EXPORT
 194   int NbCommonNodes(const SMDS_MeshElement* e1,
 195                     const SMDS_MeshElement* e2);
 196   /*!
 197    * \brief Return nodes common to two elements
 198    */
 199   SMESHUtils_EXPORT
 200   std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1,
 201                                                     const SMDS_MeshElement* e2);
 202   /*!
 203    * \brief Return true if a node is on a boundary of 2D mesh.
 204    *        Optionally returns two neighboring boundary nodes (or more in non-manifold mesh)
 205    */
 206   SMESHUtils_EXPORT bool IsOn2DBoundary( const SMDS_MeshNode* node,
 207                                          std::vector< const SMDS_MeshNode*> * neibors = nullptr );
 208   /*!
 209    * \brief Return true if node1 encounters first in the face and node2, after.
 210    *        The nodes are supposed to be neighbor nodes in the face.
 211    */
 212   SMESHUtils_EXPORT
 213   bool IsRightOrder( const SMDS_MeshElement* face,
 214                      const SMDS_MeshNode*    node0,
 215                      const SMDS_MeshNode*    node1 );
 216
 217   typedef std::vector< std::vector< const SMDS_MeshElement* > > TElemGroupVector;
 218   typedef std::vector< std::vector< const SMDS_MeshNode* > >    TNodeGroupVector;
 219   /*!
 220    * \brief Partition given 1D elements into groups of contiguous edges.
 221    *        A node where number of meeting edges != 2 is a group end.
 222    *        An optional startNode is used to orient groups it belongs to.
 223    * \return a list of edge groups and a list of corresponding node groups.
 224    *         If a group is closed, the first and last nodes of the group are same.
 225    */
 226   SMESHUtils_EXPORT
 227   void Get1DBranches( SMDS_ElemIteratorPtr edgeIt,
 228                       TElemGroupVector&    edgeGroups,
 229                       TNodeGroupVector&    nodeGroups,
 230                       const SMDS_MeshNode* startNode = 0 );
 231
 232   /*!
 233    * \brief Mark elements given by SMDS_Iterator
 234    * \sa SMDS_Mesh::SetAllNodesNotMarked() and SMDS_Mesh::SetAllCellsNotMarked()
 235    */
 236   template< class ElemIter >
 237   void MarkElems( ElemIter it, const bool isMarked )
 238   {
 239     while ( it->more() ) it->next()->setIsMarked( isMarked );
 240   }
 241   /*!
 242    * \brief Mark elements given by std iterators
 243    */
 244   template< class ElemIter >
 245   void MarkElems( ElemIter it, ElemIter end, const bool isMarked )
 246   {
 247     for ( ; it != end; ++it ) (*it)->setIsMarked( isMarked );
 248   }
 249   /*!
 250    * \brief Mark nodes of elements given by SMDS_Iterator
 251    */
 252   template< class ElemIter >
 253   void MarkElemNodes( ElemIter it, const bool isMarked, const bool markElem = false )
 254   {
 255     if ( markElem )
 256       while ( it->more() ) {
 257         const SMDS_MeshElement* e = it->next();
 258         e->setIsMarked( isMarked );
 259         MarkElems( e->nodesIterator(), isMarked );
 260       }
 261     else
 262       while ( it->more() )
 263         MarkElems( it->next()->nodesIterator(), isMarked );
 264   }
 265   /*!
 266    * \brief Mark elements given by std iterators
 267    */
 268   template< class ElemIter >
 269   void MarkElemNodes( ElemIter it, ElemIter end, const bool isMarked, const bool markElem = false )
 270   {
 271     if ( markElem )
 272       for ( ; it != end; ++it ) {
 273         (*it)->setIsMarked( isMarked );
 274         MarkElems( (*it)->nodesIterator(), isMarked );
 275       }
 276     else
 277       for ( ; it != end; ++it )
 278         MarkElems( (*it)->nodesIterator(), isMarked );
 279   }
 280
 281   // 2 nodes + optional medium node
 282   struct Edge
 283   {
 284     const SMDS_MeshNode* _node1;
 285     const SMDS_MeshNode* _node2;
 286     const SMDS_MeshNode* _medium;
 287   };
 288
 289   /*!
 290    * Return sharp edges of faces and non-manifold ones.
 291    * Optionally adds existing edges to the result. Angle is in degrees.
 292    */
 293   SMESHUtils_EXPORT
 294   std::vector< Edge > FindSharpEdges( SMDS_Mesh* mesh,
 295                                       double     angle,
 296                                       bool       addExisting );
 297
 298   /*!
 299    * Distribute all faces of the mesh between groups using given edges.
 300    */
 301   SMESHUtils_EXPORT
 302   std::vector< std::vector< const SMDS_MeshElement* > >
 303   SeparateFacesByEdges( SMDS_Mesh* mesh, const std::vector< Edge >& edges );
 304
 305
 306   typedef std::vector<const SMDS_MeshNode*> TFreeBorder;
 307   typedef std::vector<TFreeBorder>          TFreeBorderVec;
 308   struct TFreeBorderPart
 309   {
 310     int _border; // border index within a TFreeBorderVec
 311     int _node1;  // node index within the border-th TFreeBorder
 312     int _node2;
 313     int _nodeLast;
 314   };
 315   typedef std::vector<TFreeBorderPart>  TCoincidentGroup;
 316   typedef std::vector<TCoincidentGroup> TCoincidentGroupVec;
 317   struct CoincidentFreeBorders
 318   {
 319     TFreeBorderVec      _borders;          // nodes of all free borders
 320     TCoincidentGroupVec _coincidentGroups; // groups of coincident parts of borders
 321   };
 322
 323   /*!
 324    * Returns TFreeBorder's coincident within the given tolerance.
 325    * If the tolerance <= 0.0 then one tenth of an average size of elements adjacent
 326    * to free borders being compared is used.
 327    */
 328   SMESHUtils_EXPORT
 329   void FindCoincidentFreeBorders(SMDS_Mesh&              mesh,
 330                                  double                  tolerance,
 331                                  CoincidentFreeBorders & foundFreeBordes);
 332   // Implemented in ./SMESH_FreeBorders.cxx
 333
 334   /*!
 335    * Returns all or only closed TFreeBorder's.
 336    * Optionally check if the mesh is manifold and if faces are correctly oriented.
 337    */
 338   SMESHUtils_EXPORT
 339   void FindFreeBorders(SMDS_Mesh&       mesh,
 340                        TFreeBorderVec & foundFreeBordes,
 341                        const bool       closedOnly,
 342                        bool*            isManifold = 0,
 343                        bool*            isGoodOri = 0);
 344   // Implemented in ./SMESH_FreeBorders.cxx
 345
 346   /*!
 347    * Fill a hole defined by a TFreeBorder with 2D elements.
 348    */
 349   SMESHUtils_EXPORT
 350   void FillHole(const TFreeBorder &                   freeBorder,
 351                 SMDS_Mesh&                            mesh,
 352                 std::vector<const SMDS_MeshElement*>& newFaces);
 353   // Implemented in ./SMESH_FillHole.cxx
 354
 355   /*!
 356    * \brief Find nodes whose merge makes the element invalid
 357    */
 358   SMESHUtils_EXPORT
 359   void DeMerge(const SMDS_MeshElement*              elem,
 360                std::vector< const SMDS_MeshNode* >& newNodes,
 361                std::vector< const SMDS_MeshNode* >& noMergeNodes);
 362   // Implemented in SMESH_DeMerge.cxx
 363
 364
 365   typedef std::vector< std::pair< const SMDS_MeshElement*, int > > TElemIntPairVec;
 366   typedef std::vector< std::pair< const SMDS_MeshNode*,    int > > TNodeIntPairVec;
 367   /*!
 368    * \brief Create an offset mesh of given faces
 369    *  \param [in] faceIt - the input faces
 370    *  \param [in] theFixIntersections - to fix self intersections of the offset mesh or not
 371    *  \param [out] new2OldFaces - history of faces
 372    *  \param [out] new2OldNodes - history of nodes
 373    *  \return SMDS_Mesh* - the new offset mesh, a caller should delete
 374    */
 375   SMESHUtils_EXPORT
 376   SMDS_Mesh* MakeOffset( SMDS_ElemIteratorPtr faceIt,
 377                          SMDS_Mesh&           mesh,
 378                          const double         offset,
 379                          const bool           theFixIntersections,
 380                          TElemIntPairVec&           new2OldFaces,
 381                          TNodeIntPairVec&           new2OldNodes );
 382   // Implemented in ./SMESH_Offset.cxx
 383
 384
 385   //=======================================================================
 386   /*!
 387    * \brief Cut faces of a triangular mesh.
 388    *  Usage work-flow: 1) call Cut() methods as many times as needed
 389    *                   2) call MakeNewFaces() to really modify the mesh faces
 390    */
 391   //=======================================================================
 392   // implemented in SMESH_Offset.cxx
 393
 394   class SMESHUtils_EXPORT Intersector
 395   {
 396   public:
 397     Intersector( SMDS_Mesh* mesh, double tol, const std::vector< gp_XYZ >& normals );
 398     ~Intersector();
 399
 400     //! Compute cut of two faces of the mesh
 401     void Cut( const SMDS_MeshElement* face1,
 402               const SMDS_MeshElement* face2,
 403               const int               nbCommonNodes = -1 );
 404
 405     //! Store a face cut by a line given by its ends lying either on face edges or inside the face.
 406     //  Line ends are accompanied by indices of intersected face edges.
 407     //  Edge index is <0 if a line end is inside the face.
 408     void Cut( const SMDS_MeshElement* face,
 409               SMESH_NodeXYZ&          lineEnd1,
 410               int                     edgeIndex1,
 411               SMESH_NodeXYZ&          lineEnd2,
 412               int                     edgeIndex2 );
 413
 414     //! Split all faces intersected by Cut() methods.
 415     //  theSign = (-1|1) is used to choose which part of a face cut by another one to remove.
 416     //  1 means to remove a part opposite to face normal.
 417     //  Optionally optimize quality of split faces by edge swapping.
 418     void MakeNewFaces( SMESH_MeshAlgos::TElemIntPairVec& theNew2OldFaces,
 419                        SMESH_MeshAlgos::TNodeIntPairVec& theNew2OldNodes,
 420                        const double                      theSign = 1.,
 421                        const bool                        theOptimize = false );
 422
 423     typedef std::vector< SMESH_NodeXYZ > TFace;
 424
 425     //! Cut a face by planes, whose normals point to parts to keep.
 426     //  Return true if the whole face is cut off
 427     static bool CutByPlanes(const SMDS_MeshElement*       face,
 428                             const std::vector< gp_Ax1 > & planes,
 429                             const double                  tol,
 430                             std::vector< TFace > &        newFaceConnectivity );
 431
 432   private:
 433     struct Algo;
 434     Algo* myAlgo;
 435   };
 436
 437   //=======================================================================
 438   /*!
 439    * \brief Divide a mesh face into triangles
 440    */
 441   //=======================================================================
 442   // Implemented in ./SMESH_Triangulate.cxx
 443
 444   class SMESHUtils_EXPORT Triangulate
 445   {
 446   public:
 447
 448     Triangulate(bool optimize=false);
 449     ~Triangulate();
 450
 451     static int GetNbTriangles( const SMDS_MeshElement* face );
 452
 453     int GetTriangles( const SMDS_MeshElement*             face,
 454                       std::vector< const SMDS_MeshNode*>& nodes);
 455   private:
 456
 457     bool triangulate( std::vector< const SMDS_MeshNode*>& nodes, const size_t nbNodes );
 458
 459     struct PolyVertex;
 460     struct Optimizer;
 461     struct Data;
 462
 463     Data*      _data;
 464     Optimizer* _optimizer;
 465   };
 466
 467   // structure used in MakePolyLine() to define a cutting plane
 468   struct PolySegment
 469   {
 470     // 2 points, each defined as follows:
 471     // ( myNode1 &&  myNode2 ) ==> point is in the middle of an edge defined by two nodes
 472     // ( myNode1 && !myNode2 ) ==> point is at myNode1 of a some face
 473     // else                    ==> point is at myXYZ
 474     const SMDS_MeshNode*    myNode1[2];
 475     const SMDS_MeshNode*    myNode2[2];
 476     gp_XYZ                  myXYZ  [2];
 477
 478     // face on which myXYZ projects (found by MakePolyLine())
 479     const SMDS_MeshElement* myFace [2];
 480
 481     // vector on the plane; to use a default plane set vector = (0,0,0)
 482     gp_Vec myVector;
 483
 484     // point returning coordinates of a middle of the two points, projected to mesh
 485     gp_Pnt myMidProjPoint;
 486   };
 487   typedef std::vector<PolySegment> TListOfPolySegments;
 488
 489   /*!
 490    * \brief Create a polyline consisting of 1D mesh elements each lying on a 2D element of
 491    *        the initial mesh. Positions of new nodes are found by cutting the mesh by the
 492    *        plane passing through pairs of points specified by each PolySegment structure.
 493    *        If there are several paths connecting a pair of points, the shortest path is
 494    *        selected by the module. Position of the cutting plane is defined by the two
 495    *        points and an optional vector lying on the plane specified by a PolySegment.
 496    *        By default the vector is defined by Mesh module as following. A middle point
 497    *        of the two given points is computed. The middle point is projected to the mesh.
 498    *        The vector goes from the middle point to the projection point. In case of planar
 499    *        mesh, the vector is normal to the mesh.
 500    *  \param [inout] segments - PolySegment's defining positions of cutting planes.
 501    *        Return the used vector and position of the middle point.
 502    *  \param [in] group - an optional group where created mesh segments will
 503    *        be added.
 504    */
 505   // Implemented in ./SMESH_PolyLine.cxx
 506   SMESHUtils_EXPORT
 507   void MakePolyLine( SMDS_Mesh*                            mesh,
 508                      TListOfPolySegments&                  segments,
 509                      std::vector<const SMDS_MeshElement*>& newEdges,
 510                      std::vector<const SMDS_MeshNode*>&    newNodes,
 511                      SMDS_MeshGroup*                       group=0,
 512                      SMESH_ElementSearcher*                searcher=0);
 513
 514   /*!
 515    * Create a slot of given width around given 1D elements lying on a triangle mesh.
 516    * The slot is constructed by cutting faces by cylindrical surfaces made around each segment.
 517    * \return Edges located at the slot boundary
 518    */
 519   // Implemented in ./SMESH_Slot.cxx
 520   SMESHUtils_EXPORT
 521   std::vector< Edge > MakeSlot( SMDS_ElemIteratorPtr             segmentIt,
 522                                 double                           width,
 523                                 SMDS_Mesh*                       mesh,
 524                                 std::vector< SMDS_MeshGroup* > & groupsToUpdate);
 525
 526 } // namespace SMESH_MeshAlgos
 527
 528 #endif