SMESH_MeshAlgos.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2026  CEA, EDF, OPEN CASCADE
//
// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
// File      : SMESH_MeshAlgos.hxx
// Created   : Tue Apr 30 18:00:36 2013
// Author    : Edward AGAPOV (eap)
 
// Initially this file held some low level algorithms extracted from SMESH_MeshEditor
// to make them accessible from Controls package, and more
 
 
#ifndef __SMESH_MeshAlgos_HXX__
#define __SMESH_MeshAlgos_HXX__
 
#include "SMESH_Utils.hxx"
 
#include "SMDSAbs_ElementType.hxx"
#include "SMDS_ElemIterator.hxx"
#include "SMESH_TypeDefs.hxx"
 
#include <TopAbs_State.hxx>
#include <gp_Pnt.hxx>
#include <gp_Vec.hxx>
 
#include <vector>
 
class Bnd_B3d;
class gp_Ax1;
class SMDS_Mesh;
class SMDS_MeshElement;
class SMDS_MeshGroup;
class SMDS_MeshNode;
 
//=======================================================================
//=======================================================================
 
struct SMESHUtils_EXPORT SMESH_NodeSearcher
{
  virtual const SMDS_MeshNode* FindClosestTo( const gp_Pnt& pnt ) = 0;
  virtual void MoveNode( const SMDS_MeshNode* node, const gp_Pnt& toPnt ) = 0;
  virtual int  FindNearPoint(const gp_Pnt&                        point,
                             const double                         tolerance,
                             std::vector< const SMDS_MeshNode* >& foundNodes) = 0;
  virtual ~SMESH_NodeSearcher() {}
};
 
//=======================================================================
//=======================================================================
 
struct SMESHUtils_EXPORT SMESH_ElementSearcher
{
  virtual int FindElementsByPoint(const gp_Pnt&                           point,
                                  SMDSAbs_ElementType                     type,
                                  std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  virtual const SMDS_MeshElement* FindClosestTo( const gp_Pnt&       point,
                                                 SMDSAbs_ElementType type) = 0;
  virtual void GetElementsNearLine( const gp_Ax1&                           line,
                                    SMDSAbs_ElementType                     type,
                                    std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  virtual void GetElementsInSphere( const gp_XYZ&                           center,
                                    const double                            radius,
                                    SMDSAbs_ElementType                     type,
                                    std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  virtual void GetElementsInBox( const Bnd_B3d&                          box,
                                 SMDSAbs_ElementType                     type,
                                 std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  virtual TopAbs_State GetPointState(const gp_Pnt& point) = 0;
 
  virtual gp_XYZ Project(const gp_Pnt&            point,
                         SMDSAbs_ElementType      type,
                         const SMDS_MeshElement** closestFace= 0) = 0;
 
  virtual ~SMESH_ElementSearcher();
};
 
namespace SMESH_MeshAlgos
{
  SMESHUtils_EXPORT
  SMESH_NodeSearcher* GetNodeSearcher( SMDS_Mesh& mesh );
 
  SMESHUtils_EXPORT
  SMESH_NodeSearcher* GetNodeSearcher( SMDS_ElemIteratorPtr elemIt );
 
  SMESHUtils_EXPORT
  SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
                                             double     tolerance=-1.);
  SMESHUtils_EXPORT
  SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
                                             SMDS_ElemIteratorPtr elemIt,
                                             double     tolerance=-1. );
 
 
  SMESHUtils_EXPORT
  bool IsOut( const SMDS_MeshElement* element, const gp_Pnt& point, double tol );
 
  SMESHUtils_EXPORT
  double GetDistance( const SMDS_MeshElement* elem, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 
  SMESHUtils_EXPORT
  double GetDistance( const SMDS_MeshEdge* edge, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 
  SMESHUtils_EXPORT
  double GetDistance( const SMDS_MeshFace* face, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 
  SMESHUtils_EXPORT
  double GetDistance( const SMDS_MeshVolume* volume, const gp_Pnt& point, gp_XYZ* closestPnt = 0 );
 
  SMESHUtils_EXPORT
  void GetBarycentricCoords( const gp_XY& point,
                             const gp_XY& t0, const gp_XY& t1, const gp_XY& t2,
                             double &    bc0, double &    bc1);
 
  bool IntersectRayVolume( const gp_Ax1& ray, const double rayLen,
                           const SMDS_MeshElement* vol,
                           double & tMin, double & tMax,
                           int & iFacetMin, int & iFacetMax);
  SMESHUtils_EXPORT
  const SMDS_MeshElement* FindFaceInSet(const SMDS_MeshNode*    n1,
                                        const SMDS_MeshNode*    n2,
                                        const TIDSortedElemSet& elemSet,
                                        const TIDSortedElemSet& avoidSet,
                                        int*                    i1=0,
                                        int*                    i2=0);
  SMESHUtils_EXPORT
  bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true);
 
  SMESHUtils_EXPORT
  int NbCommonNodes(const SMDS_MeshElement* e1,
                    const SMDS_MeshElement* e2);
  SMESHUtils_EXPORT
  std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1,
                                                    const SMDS_MeshElement* e2);
  SMESHUtils_EXPORT bool IsOn2DBoundary( const SMDS_MeshNode* node,
                                         std::vector< const SMDS_MeshNode*> * neibors = nullptr );
  SMESHUtils_EXPORT
  bool IsRightOrder( const SMDS_MeshElement* face,
                     const SMDS_MeshNode*    node0,
                     const SMDS_MeshNode*    node1 );
 
  typedef std::vector< std::vector< const SMDS_MeshElement* > > TElemGroupVector;
  typedef std::vector< std::vector< const SMDS_MeshNode* > >    TNodeGroupVector;
  SMESHUtils_EXPORT
  void Get1DBranches( SMDS_ElemIteratorPtr edgeIt,
                      TElemGroupVector&    edgeGroups,
                      TNodeGroupVector&    nodeGroups,
                      const SMDS_MeshNode* startNode = 0 );
 
  template< class ElemIter >
  void MarkElems( ElemIter it, const bool isMarked )
  {
    while ( it->more() ) it->next()->setIsMarked( isMarked );
  }
  template< class ElemIter >
  void MarkElems( ElemIter it, ElemIter end, const bool isMarked )
  {
    for ( ; it != end; ++it ) (*it)->setIsMarked( isMarked );
  }
  template< class ElemIter >
  void MarkElemNodes( ElemIter it, const bool isMarked, const bool markElem = false )
  {
    if ( markElem )
      while ( it->more() ) {
        const SMDS_MeshElement* e = it->next();
        e->setIsMarked( isMarked );
        MarkElems( e->nodesIterator(), isMarked );
      }
    else
      while ( it->more() )
        MarkElems( it->next()->nodesIterator(), isMarked );
  }
  template< class ElemIter >
  void MarkElemNodes( ElemIter it, ElemIter end, const bool isMarked, const bool markElem = false )
  {
    if ( markElem )
      for ( ; it != end; ++it ) {
        (*it)->setIsMarked( isMarked );
        MarkElems( (*it)->nodesIterator(), isMarked );
      }
    else
      for ( ; it != end; ++it )
        MarkElems( (*it)->nodesIterator(), isMarked );
  }
 
  // 2 nodes + optional medium node
  struct Edge
  {
    const SMDS_MeshNode* _node1;
    const SMDS_MeshNode* _node2;
    const SMDS_MeshNode* _medium;
  };
 
  SMESHUtils_EXPORT
  std::vector< Edge > FindSharpEdges( SMDS_Mesh* mesh,
                                      double     angle,
                                      bool       addExisting );
 
  SMESHUtils_EXPORT
  std::vector< std::vector< const SMDS_MeshElement* > >
  SeparateFacesByEdges( SMDS_Mesh* mesh, const std::vector< Edge >& edges );
 
 
  typedef std::vector<const SMDS_MeshNode*> TFreeBorder;
  typedef std::vector<TFreeBorder>          TFreeBorderVec;
  struct TFreeBorderPart
  {
    int _border; // border index within a TFreeBorderVec
    int _node1;  // node index within the border-th TFreeBorder
    int _node2;
    int _nodeLast;
  };
  typedef std::vector<TFreeBorderPart>  TCoincidentGroup;
  typedef std::vector<TCoincidentGroup> TCoincidentGroupVec;
  struct CoincidentFreeBorders
  {
    TFreeBorderVec      _borders;          // nodes of all free borders
    TCoincidentGroupVec _coincidentGroups; // groups of coincident parts of borders
  };
 
  SMESHUtils_EXPORT
  void FindCoincidentFreeBorders(SMDS_Mesh&              mesh,
                                 double                  tolerance,
                                 CoincidentFreeBorders & foundFreeBordes);
  // Implemented in ./SMESH_FreeBorders.cxx
 
  SMESHUtils_EXPORT
  void FindFreeBorders(SMDS_Mesh&       mesh,
                       TFreeBorderVec & foundFreeBordes,
                       const bool       closedOnly,
                       bool*            isManifold = 0,
                       bool*            isGoodOri = 0);
  // Implemented in ./SMESH_FreeBorders.cxx
 
  SMESHUtils_EXPORT
  void FillHole(const TFreeBorder &                   freeBorder,
                SMDS_Mesh&                            mesh,
                std::vector<const SMDS_MeshElement*>& newFaces);
  // Implemented in ./SMESH_FillHole.cxx
 
  SMESHUtils_EXPORT
  void DeMerge(const SMDS_MeshElement*              elem,
               std::vector< const SMDS_MeshNode* >& newNodes,
               std::vector< const SMDS_MeshNode* >& noMergeNodes);
  // Implemented in SMESH_DeMerge.cxx
 
 
  typedef std::vector< std::pair< const SMDS_MeshElement*, int > > TElemIntPairVec;
  typedef std::vector< std::pair< const SMDS_MeshNode*,    int > > TNodeIntPairVec;
  SMESHUtils_EXPORT
  SMDS_Mesh* MakeOffset( SMDS_ElemIteratorPtr faceIt,
                         SMDS_Mesh&           mesh,
                         const double         offset,
                         const bool           theFixIntersections,
                         TElemIntPairVec&           new2OldFaces,
                         TNodeIntPairVec&           new2OldNodes );
  // Implemented in ./SMESH_Offset.cxx
 
 
  //=======================================================================
  //=======================================================================
  // implemented in SMESH_Offset.cxx
 
  class SMESHUtils_EXPORT Intersector
  {
  public:
    Intersector( SMDS_Mesh* mesh, double tol, const std::vector< gp_XYZ >& normals );
    ~Intersector();
 
    void Cut( const SMDS_MeshElement* face1,
              const SMDS_MeshElement* face2,
              const int               nbCommonNodes = -1 );
 
    //  Line ends are accompanied by indices of intersected face edges.
    //  Edge index is <0 if a line end is inside the face.
    void Cut( const SMDS_MeshElement* face,
              SMESH_NodeXYZ&          lineEnd1,
              int                     edgeIndex1,
              SMESH_NodeXYZ&          lineEnd2,
              int                     edgeIndex2 );
 
    //  theSign = (-1|1) is used to choose which part of a face cut by another one to remove.
    //  1 means to remove a part opposite to face normal.
    //  Optionally optimize quality of split faces by edge swapping.
    void MakeNewFaces( SMESH_MeshAlgos::TElemIntPairVec& theNew2OldFaces,
                       SMESH_MeshAlgos::TNodeIntPairVec& theNew2OldNodes,
                       const double                      theSign = 1.,
                       const bool                        theOptimize = false );
 
    typedef std::vector< SMESH_NodeXYZ > TFace;
 
    //  Return true if the whole face is cut off
    static bool CutByPlanes(const SMDS_MeshElement*       face,
                            const std::vector< gp_Ax1 > & planes,
                            const double                  tol,
                            std::vector< TFace > &        newFaceConnectivity );
 
  private:
    struct Algo;
    Algo* myAlgo;
  };
 
  //=======================================================================
  //=======================================================================
  // Implemented in ./SMESH_Triangulate.cxx
 
  class SMESHUtils_EXPORT Triangulate
  {
  public:
 
    Triangulate(bool optimize=false);
    ~Triangulate();
 
    static int GetNbTriangles( const SMDS_MeshElement* face );
 
    int GetTriangles( const SMDS_MeshElement*             face,
                      std::vector< const SMDS_MeshNode*>& nodes);
  private:
 
    bool triangulate( std::vector< const SMDS_MeshNode*>& nodes, const size_t nbNodes );
 
    struct PolyVertex;
    struct Optimizer;
    struct Data;
 
    Data*      _data;
    Optimizer* _optimizer;
  };
 
  // structure used in MakePolyLine() to define a cutting plane
  struct PolySegment
  {
    // 2 points, each defined as follows:
    // ( myNode1 &&  myNode2 ) ==> point is in the middle of an edge defined by two nodes
    // ( myNode1 && !myNode2 ) ==> point is at myNode1 of a some face
    // else                    ==> point is at myXYZ
    const SMDS_MeshNode*    myNode1[2];
    const SMDS_MeshNode*    myNode2[2];
    gp_XYZ                  myXYZ  [2];
 
    // face on which myXYZ projects (found by MakePolyLine())
    const SMDS_MeshElement* myFace [2];
 
    // vector on the plane; to use a default plane set vector = (0,0,0)
    gp_Vec myVector;
 
    // point returning coordinates of a middle of the two points, projected to mesh
    gp_Pnt myMidProjPoint;
  };
  typedef std::vector<PolySegment> TListOfPolySegments;
 
  // Implemented in ./SMESH_PolyLine.cxx
  SMESHUtils_EXPORT
  void MakePolyLine( SMDS_Mesh*                            mesh,
                     TListOfPolySegments&                  segments,
                     std::vector<const SMDS_MeshElement*>& newEdges,
                     std::vector<const SMDS_MeshNode*>&    newNodes,
                     SMDS_MeshGroup*                       group=0,
                     SMESH_ElementSearcher*                searcher=0);
 
  // Implemented in ./SMESH_Slot.cxx
  SMESHUtils_EXPORT
  std::vector< Edge > MakeSlot( SMDS_ElemIteratorPtr             segmentIt,
                                double                           width,
                                SMDS_Mesh*                       mesh,
                                std::vector< SMDS_MeshGroup* > & groupsToUpdate);
 
} // namespace SMESH_MeshAlgos
 
#endif