SMESH_MesherHelper.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_MesherHelper.hxx
// Created:   15.02.06 14:48:09
// Author:    Sergey KUUL
//
#ifndef SMESH_MesherHelper_HeaderFile
#define SMESH_MesherHelper_HeaderFile
 
#include "SMESH_SMESH.hxx"
 
#include "SMESH_ComputeError.hxx"
#include "SMESH_TypeDefs.hxx"
 
#include <Geom_Surface.hxx>
#include <ShapeAnalysis_Surface.hxx>
#include <TopoDS_Face.hxx>
#include <TopoDS_Shape.hxx>
#include <gp_Pnt2d.hxx>
 
#include <map>
#include <vector>
 
class GeomAPI_ProjectPointOnCurve;
class GeomAPI_ProjectPointOnSurf;
class SMDS_MeshNode;
class SMESHDS_Hypothesis;
class SMESHDS_Mesh;
class SMESHDS_SubMesh;
class SMESH_Gen;
class SMESH_Mesh;
class SMESH_ProxyMesh;
class SMESH_subMesh;
class TopoDS_Edge;
class TopoDS_Face;
class TopoDS_Vertex;
 
typedef std::map<SMESH_TLink, const SMDS_MeshNode*>           TLinkNodeMap;
typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
 
typedef SMDS_Iterator<const TopoDS_Shape*>  PShapeIterator;
typedef boost::shared_ptr< PShapeIterator > PShapeIteratorPtr;
 
typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
typedef std::map< double, TNodeColumn >    TParam2ColumnMap;
 
typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
 
//=======================================================================
//=======================================================================
 
class SMESH_EXPORT SMESH_MesherHelper
{
 public:
  // ---------- PUBLIC UTILITIES ----------
  
  static bool IsSameElemGeometry(const SMESHDS_SubMesh* smDS,
                                 SMDSAbs_GeometryType   shape,
                                 const bool             nullSubMeshRes = true);
 
  static bool LoadNodeColumns(TParam2ColumnMap &            theParam2ColumnMap,
                              const TopoDS_Face&            theFace,
                              const std::list<TopoDS_Edge>& theBaseSide,
                              SMESHDS_Mesh*                 theMesh,
                              SMESH_ProxyMesh*              theProxyMesh=0);
  static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
                              const TopoDS_Face& theFace,
                              const TopoDS_Edge& theBaseEdge,
                              SMESHDS_Mesh*      theMesh,
                              SMESH_ProxyMesh*   theProxyMesh=0);
  static bool IsStructured( SMESH_subMesh* faceSM );
 
  static bool IsCornerOfStructure( const SMDS_MeshNode*   n,
                                   const SMESHDS_SubMesh* faceSM,
                                   SMESH_MesherHelper&    faceAnalyser );
 
  static bool IsDistorted2D( SMESH_subMesh*      faceSM,
                             bool                checkUV = false,
                             SMESH_MesherHelper* faceHelper = NULL);
 
  static bool IsMedium(const SMDS_MeshNode*      node,
                       const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
  static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
                                        const SMESHDS_Mesh*  meshDS);
 
  static inline int WrapIndex(int ind, const int nbNodes) {
    return (( ind %= nbNodes ) < 0 ) ? ind + nbNodes : ind;
  }
 
  inline static gp_XY calcTFI(double x, double y,
                              const gp_XY& a0,const gp_XY& a1,const gp_XY& a2,const gp_XY& a3,
                              const gp_XY& p0,const gp_XY& p1,const gp_XY& p2,const gp_XY& p3);
 
  inline static gp_XYZ calcTFI(double x, double y,
                               const gp_XYZ& a0,const gp_XYZ& a1,const gp_XYZ& a2,const gp_XYZ& a3,
                               const gp_XYZ& p0,const gp_XYZ& p1,const gp_XYZ& p2,const gp_XYZ& p3);
  static int Count(const TopoDS_Shape&    shape,
                   const TopAbs_ShapeEnum type,
                   const bool             ignoreSame);
 
  static int NbAncestors(const TopoDS_Shape& shape,
                         const SMESH_Mesh&   mesh,
                         TopAbs_ShapeEnum    ancestorType=TopAbs_SHAPE);
  static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
                                        const SMESH_Mesh&   mesh,
                                        TopAbs_ShapeEnum    ancestorType,
                                        const TopoDS_Shape* container = 0);
  static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
                                        const TopoDS_Shape& shape2,
                                        const SMESH_Mesh&   mesh,
                                        TopAbs_ShapeEnum    ancestorType);
  static TopAbs_Orientation GetSubShapeOri(const TopoDS_Shape& shape,
                                           const TopoDS_Shape& subShape);
 
  static bool IsSubShape( const TopoDS_Shape& shape, const TopoDS_Shape& mainShape );
 
  static bool IsSubShape( const TopoDS_Shape& shape, SMESH_Mesh* aMesh );
 
  static bool IsBlock( const TopoDS_Shape& shape );
 
  static double MaxTolerance( const TopoDS_Shape& shape );
 
  static double GetAngle( const TopoDS_Edge & E1, const TopoDS_Edge & E2,
                          const TopoDS_Face & F,  const TopoDS_Vertex & V,
                          gp_Vec* faceNormal=0);
 
  static bool IsClosedEdge( const TopoDS_Edge& anEdge );
 
  static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
 
  static TopAbs_ShapeEnum GetGroupType(const TopoDS_Shape& group,
                                       const bool          avoidCompound=false);
 
  static TopoDS_Shape GetShapeOfHypothesis( const SMESHDS_Hypothesis * hyp,
                                            const TopoDS_Shape&        shape,
                                            SMESH_Mesh*                mesh);
 
 
public:
  // ---------- PUBLIC INSTANCE METHODS ----------
 
  // constructor
  SMESH_MesherHelper(SMESH_Mesh& theMesh);
 
  SMESH_Gen*    GetGen() const;
    
  SMESH_Mesh*   GetMesh() const { return myMesh; }
    
  SMESHDS_Mesh* GetMeshDS() const;
 
  bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
 
  void SetIsQuadratic(const bool theBuildQuadratic)
  { myCreateQuadratic = theBuildQuadratic; }
 
  void SetIsBiQuadratic(const bool theBuildBiQuadratic)
  { myCreateBiQuadratic = theBuildBiQuadratic; }
  
  bool GetIsQuadratic() const { return myCreateQuadratic; }
 
  /*
   * \brief Find out elements orientation on a geometrical face
   */
  bool IsReversedSubMesh (const TopoDS_Face& theFace);
 
  bool GetIsBiQuadratic() const { return myCreateBiQuadratic; }
 
  void FixQuadraticElements(SMESH_ComputeErrorPtr& error, bool volumeOnly=true);
 
  bool SetElementsOnShape(bool toSet)
  { bool res = mySetElemOnShape; mySetElemOnShape = toSet; return res; }
 
  void SetSubShape(const int           subShapeID);
  void SetSubShape(const TopoDS_Shape& subShape);
  int GetSubShapeID() const { return myShapeID; }
  const TopoDS_Shape& GetSubShape() const  { return myShape; }
  void CopySubShapeInfo(const SMESH_MesherHelper& other);
 
 
  int ShapeToIndex( const TopoDS_Shape& S ) const;
 
  SMDS_MeshNode* AddNode(double x, double y, double z, smIdType ID = 0, double u=0., double v=0.);
  SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
                         const SMDS_MeshNode* n2,
                         const smIdType id = 0, 
                         const bool force3d = true);
  SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
                         const SMDS_MeshNode* n2,
                         const SMDS_MeshNode* n3,
                         const smIdType id=0, 
                         const bool force3d = false);
  SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
                         const SMDS_MeshNode* n2,
                         const SMDS_MeshNode* n3,
                         const SMDS_MeshNode* n4,
                         const smIdType id = 0,
                         const bool force3d = false);
  SMDS_MeshFace* AddPolygonalFace (const std::vector<const SMDS_MeshNode*>& nodes,
                                   const smIdType id = 0,
                                   const bool force3d = false);
  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
                             const SMDS_MeshNode* n2,
                             const SMDS_MeshNode* n3,
                             const SMDS_MeshNode* n4,
                             const smIdType id = 0,
                             const bool force3d = true);
  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
                             const SMDS_MeshNode* n2,
                             const SMDS_MeshNode* n3,
                             const SMDS_MeshNode* n4,
                             const SMDS_MeshNode* n5,
                             const smIdType id = 0,
                             const bool force3d = true);
  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
                             const SMDS_MeshNode* n2,
                             const SMDS_MeshNode* n3,
                             const SMDS_MeshNode* n4,
                             const SMDS_MeshNode* n5,
                             const SMDS_MeshNode* n6,
                             const smIdType id = 0, 
                             const bool force3d = true);
  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
                             const SMDS_MeshNode* n2,
                             const SMDS_MeshNode* n3,
                             const SMDS_MeshNode* n4,
                             const SMDS_MeshNode* n5,
                             const SMDS_MeshNode* n6,
                             const SMDS_MeshNode* n7,
                             const SMDS_MeshNode* n8,
                             const smIdType id = 0, 
                             bool force3d = true);
 
  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
                             const SMDS_MeshNode* n2,
                             const SMDS_MeshNode* n3,
                             const SMDS_MeshNode* n4,
                             const SMDS_MeshNode* n5,
                             const SMDS_MeshNode* n6,
                             const SMDS_MeshNode* n7,
                             const SMDS_MeshNode* n8,
                             const SMDS_MeshNode* n9,
                             const SMDS_MeshNode* n10,
                             const SMDS_MeshNode* n11,
                             const SMDS_MeshNode* n12,
                             const smIdType id = 0, 
                             bool force3d = true);
 
  SMDS_MeshVolume* AddPolyhedralVolume (const std::vector<const SMDS_MeshNode*>& nodes,
                                        const std::vector<int>&                  quantities,
                                        const smIdType                           ID=0,
                                        const bool                               force3d = true);
  void ToFixNodeParameters(bool toFix);
 
  double GetNodeU(const TopoDS_Edge&   theEdge,
                  const SMDS_MeshNode* theNode,
                  const SMDS_MeshNode* inEdgeNode=0,
                  bool*                check=0) const;
  gp_XY GetNodeUV(const TopoDS_Face&   F,
                  const SMDS_MeshNode* n,
                  const SMDS_MeshNode* inFaceNode=0,
                  bool*                check=0) const;
  bool CheckNodeUV(const TopoDS_Face&   F,
                   const SMDS_MeshNode* n,
                   gp_XY&               uv,
                   const double         tol,
                   const bool           force=false,
                   double               distXYZ[4]=0) const;
  bool CheckNodeU(const TopoDS_Edge&   E,
                  const SMDS_MeshNode* n,
                  double&              u,
                  const double         tol,
                  const bool           force=false,
                  double               distXYZ[4]=0) const;
  static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
                           const gp_XY&                uv1,
                           const gp_XY&                uv2);
  static gp_XY GetCenterUV(const gp_XY& uv1,
                           const gp_XY& uv2, 
                           const gp_XY& uv3, 
                           const gp_XY& uv12,
                           const gp_XY& uv23,
                           const gp_XY& uv31,
                           bool *       isBadTria=0);
#define gp_XY_FunPtr(meth) \
  static gp_XY __gpXY_##meth (const gp_XY& uv1, const gp_XY& uv2) { return uv1.meth( uv2 ); } \
  static xyFunPtr gp_XY_##meth = & __gpXY_##meth
 
  static gp_XY ApplyIn2D(Handle(Geom_Surface) surface,
                         const gp_XY&         uv1,
                         const gp_XY&         uv2,
                         xyFunPtr             fun,
                         const bool           resultInPeriod=true);
 
  void AdjustByPeriod( const TopoDS_Face& face, gp_XY uv[], const int nbUV );
 
  bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
 
  GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
                                           TopLoc_Location&   loc,
                                           double             tol=0 ) const;
  GeomAPI_ProjectPointOnSurf& GetProjector(const TopoDS_Face& F,
                                           double             tol=0 ) const;
  GeomAPI_ProjectPointOnCurve& GetPCProjector(const TopoDS_Edge& E ) const;
  Handle(ShapeAnalysis_Surface) GetSurface(const TopoDS_Face& F ) const;
 
  bool IsDegenShape(const int subShape) const
  { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
  bool HasDegeneratedEdges() const { return !myDegenShapeIds.empty(); }
  size_t NbDegeneratedEdges() const { return myDegenShapeIds.size(); }
 
  bool IsSeamShape(const int subShape) const
  { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
  bool IsSeamShape(const TopoDS_Shape& subShape) const
  { return IsSeamShape( ShapeToIndex( subShape )); }
  bool IsRealSeam(const int subShape) const
  { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
  bool IsRealSeam(const TopoDS_Shape& subShape) const
  { return IsRealSeam( ShapeToIndex( subShape )); }
  bool HasSeam() const { return !mySeamShapeIds.empty(); }
  bool HasRealSeam() const { return HasSeam() && ( *mySeamShapeIds.begin() < 0 ); }
  size_t NbRealSeam() const;
  int GetPeriodicIndex() const { return myParIndex; }
  double GetPeriod(int perioIndex) const { return myPar2[ perioIndex-1 ] - myPar1[ perioIndex-1 ]; }
  double GetOtherParam(const double param) const;
  int IsOnSeam(const gp_XY& uv) const;
 
  const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
                                     const SMDS_MeshNode* n2,
                                     const bool           force3d,
                                     TopAbs_ShapeEnum     expectedSupport=TopAbs_SHAPE);
  const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
                                      const SMDS_MeshNode* n2,
                                      const SMDS_MeshNode* n3,
                                      const SMDS_MeshNode* n4,
                                      const SMDS_MeshNode* n12,
                                      const SMDS_MeshNode* n23,
                                      const SMDS_MeshNode* n34,
                                      const SMDS_MeshNode* n41,
                                      bool                 force3d);
  const SMDS_MeshNode* GetCentralNode(const SMDS_MeshNode* n1,
                                      const SMDS_MeshNode* n2,
                                      const SMDS_MeshNode* n3,
                                      const SMDS_MeshNode* n12,
                                      const SMDS_MeshNode* n23,
                                      const SMDS_MeshNode* n31,
                                      bool                 force3d);
  std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
                                                const SMDS_MeshNode* n2,
                                                const bool           useCurSubShape=false,
                                                TopAbs_ShapeEnum     expectedSupport=TopAbs_SHAPE);
  void AddTLinkNode(const SMDS_MeshNode* n1,
                    const SMDS_MeshNode* n2,
                    const SMDS_MeshNode* n12);
  void AddTLinkNodeMap(const TLinkNodeMap& aMap)
    { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
 
  bool AddTLinks(const SMDS_MeshEdge*   edge);
  bool AddTLinks(const SMDS_MeshFace*   face);
  bool AddTLinks(const SMDS_MeshVolume* vol);
 
  const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
 
  enum MType{ LINEAR, QUADRATIC, COMP };
  MType IsQuadraticMesh();
  
  virtual ~SMESH_MesherHelper();
 
  static void WriteShape(const TopoDS_Shape& s);
 
 
 protected:
 
  gp_Pnt2d getUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
 
  const SMDS_MeshNode* getMediumNodeOnComposedWire(const SMDS_MeshNode* n1,
                                                   const SMDS_MeshNode* n2,
                                                   bool                 force3d);
 
  double getFaceMaxTol( const TopoDS_Shape& face ) const;
 
 
 private:
 
  // forbidden copy constructor
  SMESH_MesherHelper (const SMESH_MesherHelper& theOther);
 
  // key of a map of bi-quadratic face to it's central node
  struct TBiQuad: public std::pair<smIdType, std::pair<smIdType, smIdType> >
  {
    TBiQuad(const SMDS_MeshNode* n1,
            const SMDS_MeshNode* n2, 
            const SMDS_MeshNode* n3,
            const SMDS_MeshNode* n4=0)
    {
      TIDSortedNodeSet s;
      s.insert(n1);
      s.insert(n2);
      s.insert(n3);
      if ( n4 ) s.insert(n4);
      TIDSortedNodeSet::iterator n = s.begin();
      first = (*n++)->GetID();
      second.first = (*n++)->GetID();
      second.second = (*n++)->GetID();
    }
  };
 
  // maps used during creation of quadratic elements
  TLinkNodeMap                              myTLinkNodeMap;       // medium nodes on links
  std::map< TBiQuad, const SMDS_MeshNode* > myMapWithCentralNode; // central nodes of faces
 
  std::set< int > myDegenShapeIds;
  std::set< int > mySeamShapeIds;
  double          myPar1[2], myPar2[2]; // U and V bounds of a closed periodic surface
  int             myParIndex;     // bounds' index (1-U, 2-V, 3-both)
 
  std::map< int, double > myFaceMaxTol;
 
  typedef std::map< int, Handle(ShapeAnalysis_Surface)> TID2Surface;
  typedef std::map< int, GeomAPI_ProjectPointOnSurf* >  TID2ProjectorOnSurf;
  typedef std::map< int, GeomAPI_ProjectPointOnCurve* > TID2ProjectorOnCurve;
  mutable TID2Surface  myFace2Surface;
  TID2ProjectorOnSurf  myFace2Projector;
  TID2ProjectorOnCurve myEdge2Projector;
 
  TopoDS_Shape    myShape;
  SMESH_Mesh*     myMesh;
  int             myShapeID;
 
  bool            myCreateQuadratic;
  bool            myCreateBiQuadratic;
  bool            mySetElemOnShape;
  bool            myFixNodeParameters;
 
  std::map< int,bool > myNodePosShapesValidity;
  bool toCheckPosOnShape(int shapeID ) const;
  void setPosOnShapeValidity(int shapeID, bool ok ) const;
};
 
//=======================================================================
inline gp_XY
SMESH_MesherHelper::calcTFI(double x, double y,
                            const gp_XY& a0,const gp_XY& a1,const gp_XY& a2,const gp_XY& a3,
                            const gp_XY& p0,const gp_XY& p1,const gp_XY& p2,const gp_XY& p3)
{
  return
    ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
    ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
}
//=======================================================================
inline gp_XYZ
SMESH_MesherHelper::calcTFI(double x, double y,
                            const gp_XYZ& a0,const gp_XYZ& a1,const gp_XYZ& a2,const gp_XYZ& a3,
                            const gp_XYZ& p0,const gp_XYZ& p1,const gp_XYZ& p2,const gp_XYZ& p3)
{
  return
    ((1 - y) * p0 + x * p1 + y * p2 + (1 - x) * p3 ) -
    ((1 - x) * (1 - y) * a0 + x * (1 - y) * a1 + x * y * a2 + (1 - x) * y * a3);
}
//=======================================================================
 
#endif