src/SMESHUtils/SMESH_MeshAlgos.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 // File      : SMESH_MeshAlgos.hxx
  23 // Created   : Tue Apr 30 18:00:36 2013
  24 // Author    : Edward AGAPOV (eap)
  25
  26 // This file holds some low level algorithms extracted from SMESH_MeshEditor
  27 // to make them accessible from Controls package
  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 <vector>
  41
  42 class gp_Pnt;
  43 class gp_Ax1;
  44 class SMDS_MeshNode;
  45 class SMDS_MeshElement;
  46 class SMDS_Mesh;
  47
  48 //=======================================================================
  49 /*!
  50  * \brief Searcher for the node closest to a point
  51  */
  52 //=======================================================================
  53
  54 struct SMESHUtils_EXPORT SMESH_NodeSearcher
  55 {
  56   virtual const SMDS_MeshNode* FindClosestTo( const gp_Pnt& pnt ) = 0;
  57   virtual void MoveNode( const SMDS_MeshNode* node, const gp_Pnt& toPnt ) = 0;
  58   virtual int  FindNearPoint(const gp_Pnt&                        point,
  59                              const double                         tolerance,
  60                              std::vector< const SMDS_MeshNode* >& foundNodes) = 0;
  61 };
  62
  63 //=======================================================================
  64 /*!
  65  * \brief Searcher for elements
  66  */
  67 //=======================================================================
  68
  69 struct SMESHUtils_EXPORT SMESH_ElementSearcher
  70 {
  71   /*!
  72    * \brief Find elements of given type where the given point is IN or ON.
  73    *        Returns nb of found elements and elements them-selves.
  74    *
  75    * 'ALL' type means elements of any type excluding nodes and 0D elements
  76    */
  77   virtual int FindElementsByPoint(const gp_Pnt&                           point,
  78                                   SMDSAbs_ElementType                     type,
  79                                   std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  80   /*!
  81    * \brief Return an element most close to the given point
  82    */
  83   virtual const SMDS_MeshElement* FindClosestTo( const gp_Pnt&       point,
  84                                                  SMDSAbs_ElementType type) = 0;
  85   /*!
  86    * \brief Return elements possibly intersecting the line
  87    */
  88   virtual void GetElementsNearLine( const gp_Ax1&                           line,
  89                                     SMDSAbs_ElementType                     type,
  90                                     std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  91   /*!
  92    * \brief Return elements whose bounding box intersects a sphere
  93    */
  94   virtual void GetElementsInSphere( const gp_XYZ&                           center,
  95                                     const double                            radius,
  96                                     SMDSAbs_ElementType                     type,
  97                                     std::vector< const SMDS_MeshElement* >& foundElems) = 0;
  98   /*!
  99    * \brief Find out if the given point is out of closed 2D mesh.
 100    */
 101   virtual TopAbs_State GetPointState(const gp_Pnt& point) = 0;
 102   virtual ~SMESH_ElementSearcher();
 103 };
 104
 105 namespace SMESH_MeshAlgos
 106 {
 107   /*!
 108    * \brief Return true if the point is IN or ON of the element
 109    */
 110   SMESHUtils_EXPORT
 111   bool IsOut( const SMDS_MeshElement* element, const gp_Pnt& point, double tol );
 112
 113   SMESHUtils_EXPORT
 114   double GetDistance( const SMDS_MeshElement* elem, const gp_Pnt& point );
 115
 116   SMESHUtils_EXPORT
 117   double GetDistance( const SMDS_MeshEdge* edge, const gp_Pnt& point );
 118
 119   SMESHUtils_EXPORT
 120   double GetDistance( const SMDS_MeshFace* face, const gp_Pnt& point );
 121
 122   SMESHUtils_EXPORT
 123   double GetDistance( const SMDS_MeshVolume* volume, const gp_Pnt& point );
 124
 125   SMESHUtils_EXPORT
 126   void GetBarycentricCoords( const gp_XY& point,
 127                              const gp_XY& t0, const gp_XY& t1, const gp_XY& t2,
 128                              double &    bc0, double &    bc1);
 129
 130   /*!
 131    * Return a face having linked nodes n1 and n2 and which is
 132    * - not in avoidSet,
 133    * - in elemSet provided that !elemSet.empty()
 134    * i1 and i2 optionally returns indices of n1 and n2
 135    */
 136   SMESHUtils_EXPORT
 137   const SMDS_MeshElement* FindFaceInSet(const SMDS_MeshNode*    n1,
 138                                         const SMDS_MeshNode*    n2,
 139                                         const TIDSortedElemSet& elemSet,
 140                                         const TIDSortedElemSet& avoidSet,
 141                                         int*                    i1=0,
 142                                         int*                    i2=0);
 143   /*!
 144    * \brief Calculate normal of a mesh face
 145    */
 146   SMESHUtils_EXPORT
 147   bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true);
 148
 149   /*!
 150    * \brief Return nodes common to two elements
 151    */
 152   SMESHUtils_EXPORT
 153   std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1,
 154                                                     const SMDS_MeshElement* e2);
 155
 156   /*!
 157    * \brief Return SMESH_NodeSearcher. The caller is responsible for deleteing it
 158    */
 159   SMESHUtils_EXPORT
 160   SMESH_NodeSearcher* GetNodeSearcher( SMDS_Mesh& mesh );
 161
 162   SMESHUtils_EXPORT
 163   SMESH_NodeSearcher* GetNodeSearcher( SMDS_ElemIteratorPtr elemIt );
 164
 165   /*!
 166    * \brief Return SMESH_ElementSearcher. The caller is responsible for deleting it
 167    */
 168   SMESHUtils_EXPORT
 169   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
 170                                              double     tolerance=-1.);
 171   SMESHUtils_EXPORT
 172   SMESH_ElementSearcher* GetElementSearcher( SMDS_Mesh& mesh,
 173                                              SMDS_ElemIteratorPtr elemIt,
 174                                              double     tolerance=-1. );
 175
 176
 177
 178   typedef std::vector<const SMDS_MeshNode*> TFreeBorder;
 179   typedef std::vector<TFreeBorder>          TFreeBorderVec;
 180   struct TFreeBorderPart
 181   {
 182     int _border; // border index within a TFreeBorderVec
 183     int _node1;  // node index within the border-th TFreeBorder
 184     int _node2;
 185     int _nodeLast;
 186   };
 187   typedef std::vector<TFreeBorderPart>  TCoincidentGroup;
 188   typedef std::vector<TCoincidentGroup> TCoincidentGroupVec;
 189   struct CoincidentFreeBorders
 190   {
 191     TFreeBorderVec      _borders;          // nodes of all free borders
 192     TCoincidentGroupVec _coincidentGroups; // groups of coincident parts of borders
 193   };
 194
 195   /*!
 196    * Returns TFreeBorder's coincident within the given tolerance.
 197    * If the tolerance <= 0.0 then one tenth of an average size of elements adjacent
 198    * to free borders being compared is used.
 199    *
 200    * (Implemented in ./SMESH_FreeBorders.cxx)
 201    */
 202   SMESHUtils_EXPORT
 203   void FindCoincidentFreeBorders(SMDS_Mesh&              mesh,
 204                                  double                  tolerance,
 205                                  CoincidentFreeBorders & foundFreeBordes);
 206
 207
 208 } // SMESH_MeshAlgos
 209
 210 #endif