src/SMESH/SMESH_MesherHelper.hxx

   1 //  Copyright (C) 2007-2008  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.
  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_MesherHelper.hxx
  23 // Created:   15.02.06 14:48:09
  24 // Author:    Sergey KUUL
  25 //
  26 #ifndef SMESH_MesherHelper_HeaderFile
  27 #define SMESH_MesherHelper_HeaderFile
  28
  29 #include "SMESH_SMESH.hxx"
  30
  31 #include "SMESH_MeshEditor.hxx" // needed for many meshers
  32 #include <SMDS_MeshNode.hxx>
  33 #include <SMDS_QuadraticEdge.hxx>
  34
  35 #include <Geom_Surface.hxx>
  36 #include <TopoDS_Face.hxx>
  37 #include <TopoDS_Shape.hxx>
  38 #include <gp_Pnt2d.hxx>
  39
  40 #include <map>
  41
  42 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>           TLinkNodeMap;
  43 typedef std::map<SMESH_TLink, const SMDS_MeshNode*>::iterator ItTLinkNode;
  44
  45 /*!
  46  * \brief It helps meshers to add elements
  47  *
  48  * It allow meshers not to care about creation of medium nodes
  49  * when filling a quadratic mesh. Helper does it itself.
  50  * It defines degree of elements to create when IsQuadraticSubMesh()
  51  * is called.
  52  */
  53
  54 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
  55 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
  56
  57 class SMESH_EXPORT SMESH_MesherHelper
  58 {
  59 public:
  60   // ---------- PUBLIC UTILITIES ----------
  61
  62   /*!
  63    * \brief Returns true if given node is medium
  64     * \param n - node to check
  65     * \param typeToCheck - type of elements containing the node to ask about node status
  66     * \retval bool - check result
  67    */
  68   static bool IsMedium(const SMDS_MeshNode*      node,
  69                        const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
  70
  71   /*!
  72    * \brief Load nodes bound to face into a map of node columns
  73     * \param theParam2ColumnMap - map of node columns to fill
  74     * \param theFace - the face on which nodes are searched for
  75     * \param theBaseEdge - the edge nodes of which are columns' bases
  76     * \param theMesh - the mesh containing nodes
  77     * \retval bool - false if something is wrong
  78    *
  79    * The key of the map is a normalized parameter of each
  80    * base node on theBaseEdge.
  81    * This method works in supposition that nodes on the face
  82    * forms a rectangular grid and elements can be quardrangles or triangles
  83    */
  84   static bool LoadNodeColumns(TParam2ColumnMap & theParam2ColumnMap,
  85                               const TopoDS_Face& theFace,
  86                               const TopoDS_Edge& theBaseEdge,
  87                               SMESHDS_Mesh*      theMesh);
  88   /*!
  89    * \brief Return support shape of a node
  90    * \param node - the node
  91    * \param meshDS - mesh DS
  92    * \retval TopoDS_Shape - found support shape
  93    */
  94   static TopoDS_Shape GetSubShapeByNode(const SMDS_MeshNode* node,
  95                                         SMESHDS_Mesh*        meshDS);
  96
  97   /*!
  98    * \brief Return a valid node index, fixing the given one if necessary
  99     * \param ind - node index
 100     * \param nbNodes - total nb of nodes
 101     * \retval int - valid node index
 102    */
 103   static int WrapIndex(const int ind, const int nbNodes) {
 104     if ( ind < 0 ) return nbNodes + ind % nbNodes;
 105     if ( ind >= nbNodes ) return ind % nbNodes;
 106     return ind;
 107   }
 108
 109   /*!
 110    * \brief Return number of unique ancestors of the shape
 111    */
 112   static int NbAncestors(const TopoDS_Shape& shape,
 113                          const SMESH_Mesh&   mesh,
 114                          TopAbs_ShapeEnum    ancestorType=TopAbs_SHAPE);
 115
 116 public:
 117   // ---------- PUBLIC INSTANCE METHODS ----------
 118
 119   // constructor
 120   SMESH_MesherHelper(SMESH_Mesh& theMesh);
 121
 122   SMESH_Mesh* GetMesh() const { return myMesh; }
 123
 124   SMESHDS_Mesh* GetMeshDS() const { return GetMesh()->GetMeshDS(); }
 125
 126   /*!
 127    * Check submesh for given shape: if all elements on this shape are quadratic,
 128    * quadratic elements will be created. Also fill myTLinkNodeMap
 129    */
 130   bool IsQuadraticSubMesh(const TopoDS_Shape& theShape);
 131   /*!
 132    * \brief Set order of elements to create without calling IsQuadraticSubMesh()
 133    */
 134   void SetIsQuadratic(const bool theBuildQuadratic)
 135   { myCreateQuadratic = theBuildQuadratic; }
 136   /*!
 137    * \brief Return myCreateQuadratic flag
 138    */
 139   bool GetIsQuadratic() const { return myCreateQuadratic; }
 140
 141   /*!
 142    * \brief Move medium nodes of faces and volumes to fix distorted elements
 143    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
 144    */
 145   void FixQuadraticElements(bool volumeOnly=true);
 146
 147   /*!
 148    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
 149    *        or the next methods. By defaul elements are set on the shape if
 150    *        a mesh has no shape to be meshed
 151    */
 152   void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
 153
 154   /*!
 155    * \brief Enable/disable checking of node parameters on shapes while adding elements.
 156    * In case of incorrect parameters mudium node place is computed as the middle
 157    * of two nodes. Default is false.
 158    * NOTE that this flag is reset to "not to check" if check with non-default partameter
 159    * is successful
 160    */
 161   void SetCheckNodePosition(bool toCheck) { myCheckNodePos = toCheck; }
 162
 163   /*!
 164    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
 165    */
 166   void SetSubShape(const int           subShapeID);//!==SMESHDS_Mesh::ShapeToIndex(shape)
 167   void SetSubShape(const TopoDS_Shape& subShape);
 168   /*!
 169    * \brief Return ID of the shape set by IsQuadraticSubMesh() or SetSubShape()
 170     * \retval int - shape index in SMESHDS
 171    */
 172   int GetSubShapeID() const { return myShapeID; }
 173   /*!
 174    * \brief Return the shape set by IsQuadraticSubMesh() or SetSubShape()
 175    */
 176   TopoDS_Shape GetSubShape() const  { return myShape; }
 177
 178   /*!
 179    * Creates a node
 180    */
 181   SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0);
 182   /*!
 183    * Creates quadratic or linear edge
 184    */
 185   SMDS_MeshEdge* AddEdge(const SMDS_MeshNode* n1,
 186                          const SMDS_MeshNode* n2,
 187                          const int id = 0,
 188                          const bool force3d = true);
 189   /*!
 190    * Creates quadratic or linear triangle
 191    */
 192   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
 193                          const SMDS_MeshNode* n2,
 194                          const SMDS_MeshNode* n3,
 195                          const int id=0,
 196                          const bool force3d = false);
 197   /*!
 198    * Creates quadratic or linear quadrangle
 199    */
 200   SMDS_MeshFace* AddFace(const SMDS_MeshNode* n1,
 201                          const SMDS_MeshNode* n2,
 202                          const SMDS_MeshNode* n3,
 203                          const SMDS_MeshNode* n4,
 204                          const int id = 0,
 205                          const bool force3d = false);
 206   /*!
 207    * Creates quadratic or linear tetraahedron
 208    */
 209   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 210                              const SMDS_MeshNode* n2,
 211                              const SMDS_MeshNode* n3,
 212                              const SMDS_MeshNode* n4,
 213                              const int id = 0,
 214                              const bool force3d = true);
 215   /*!
 216    * Creates quadratic or linear pyramid
 217    */
 218   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 219                              const SMDS_MeshNode* n2,
 220                              const SMDS_MeshNode* n3,
 221                              const SMDS_MeshNode* n4,
 222                              const SMDS_MeshNode* n5,
 223                              const int id = 0,
 224                              const bool force3d = true);
 225   /*!
 226    * Creates quadratic or linear pentahedron
 227    */
 228   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 229                              const SMDS_MeshNode* n2,
 230                              const SMDS_MeshNode* n3,
 231                              const SMDS_MeshNode* n4,
 232                              const SMDS_MeshNode* n5,
 233                              const SMDS_MeshNode* n6,
 234                              const int id = 0,
 235                              const bool force3d = true);
 236   /*!
 237    * Creates quadratic or linear hexahedron
 238    */
 239   SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
 240                              const SMDS_MeshNode* n2,
 241                              const SMDS_MeshNode* n3,
 242                              const SMDS_MeshNode* n4,
 243                              const SMDS_MeshNode* n5,
 244                              const SMDS_MeshNode* n6,
 245                              const SMDS_MeshNode* n7,
 246                              const SMDS_MeshNode* n8,
 247                              const int id = 0,
 248                              bool force3d = true);
 249   /*!
 250    * \brief Return U of the given node on the edge
 251    */
 252   double GetNodeU(const TopoDS_Edge&   theEdge,
 253                   const SMDS_MeshNode* theNode,
 254                   bool*                check=0);
 255   /*!
 256    * \brief Return node UV on face
 257    *  \param inFaceNode - a node of element being created located inside a face
 258    */
 259   gp_XY GetNodeUV(const TopoDS_Face&   F,
 260                   const SMDS_MeshNode* n,
 261                   const SMDS_MeshNode* inFaceNode=0,
 262                   bool*                check=0) const;
 263   /*!
 264    * \brief Return middle UV taking in account surface period
 265    */
 266   static gp_XY GetMiddleUV(const Handle(Geom_Surface)& surface,
 267                            const gp_XY&                uv1,
 268                            const gp_XY&                uv2);
 269   /*!
 270    * \brief Check if inFaceNode argument is necessary for call GetNodeUV(F,..)
 271     * \retval bool - return true if the face is periodic
 272     *
 273     * if F is Null, answer about subshape set through IsQuadraticSubMesh() or
 274     * SetSubShape()
 275    */
 276   bool GetNodeUVneedInFaceNode(const TopoDS_Face& F = TopoDS_Face()) const;
 277
 278   /*!
 279    * \brief Check if shape is a degenerated edge or it's vertex
 280     * \param subShape - edge or vertex index in SMESHDS
 281     * \retval bool - true if subShape is a degenerated shape
 282     *
 283     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called
 284    */
 285   bool IsDegenShape(const int subShape) const
 286   { return myDegenShapeIds.find( subShape ) != myDegenShapeIds.end(); }
 287   /*!
 288    * \brief Check if shape is a seam edge or it's vertex
 289     * \param subShape - edge or vertex index in SMESHDS
 290     * \retval bool - true if subShape is a seam shape
 291     *
 292     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
 293     * Seam shape has two 2D alternative represenations on the face
 294    */
 295   bool IsSeamShape(const int subShape) const
 296   { return mySeamShapeIds.find( subShape ) != mySeamShapeIds.end(); }
 297   /*!
 298    * \brief Check if shape is a seam edge or it's vertex
 299     * \param subShape - edge or vertex
 300     * \retval bool - true if subShape is a seam shape
 301     *
 302     * It works only if IsQuadraticSubMesh() or SetSubShape() has been called.
 303     * Seam shape has two 2D alternative represenations on the face
 304    */
 305   bool IsSeamShape(const TopoDS_Shape& subShape) const
 306   { return IsSeamShape( GetMeshDS()->ShapeToIndex( subShape )); }
 307   /*!
 308    * \brief Return true if an edge or a vertex encounters twice in face wire
 309    *  \param subShape - Id of edge or vertex
 310    */
 311   bool IsRealSeam(const int subShape) const
 312   { return mySeamShapeIds.find( -subShape ) != mySeamShapeIds.end(); }
 313   /*!
 314    * \brief Return true if an edge or a vertex encounters twice in face wire
 315    *  \param subShape - edge or vertex
 316    */
 317   bool IsRealSeam(const TopoDS_Shape& subShape) const
 318   { return IsRealSeam( GetMeshDS()->ShapeToIndex( subShape)); }
 319   /*!
 320    * \brief Check if the shape set through IsQuadraticSubMesh() or SetSubShape()
 321    *        has a seam edge
 322     * \retval bool - true if it has
 323    */
 324   bool HasSeam() const { return !mySeamShapeIds.empty(); }
 325   /*!
 326    * \brief Return index of periodic parametric direction of a closed face
 327     * \retval int - 1 for U, 2 for V direction
 328    */
 329   int GetPeriodicIndex() const { return myParIndex; }
 330   /*!
 331    * \brief Return an alternative parameter for a node on seam
 332    */
 333   double GetOtherParam(const double param) const;
 334
 335   /**
 336    * Special function for search or creation medium node
 337    */
 338   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
 339                                      const SMDS_MeshNode* n2,
 340                                      const bool force3d);
 341   /*!
 342    * Auxilary function for filling myTLinkNodeMap
 343    */
 344   void AddTLinkNode(const SMDS_MeshNode* n1,
 345                     const SMDS_MeshNode* n2,
 346                     const SMDS_MeshNode* n12);
 347   /**
 348    * Auxilary function for filling myTLinkNodeMap
 349    */
 350   void AddTLinkNodeMap(const TLinkNodeMap& aMap)
 351     { myTLinkNodeMap.insert(aMap.begin(), aMap.end()); }
 352
 353   /**
 354    * Returns myTLinkNodeMap
 355    */
 356   const TLinkNodeMap& GetTLinkNodeMap() const { return myTLinkNodeMap; }
 357
 358   /**
 359    * Check mesh without geometry for: if all elements on this shape are quadratic,
 360    * quadratic elements will be created.
 361    * Used then generated 3D mesh without geometry.
 362    */
 363   enum MType{ LINEAR, QUADRATIC, COMP };
 364   MType IsQuadraticMesh();
 365
 366 protected:
 367
 368   /*!
 369    * \brief Select UV on either of 2 pcurves of a seam edge, closest to the given UV
 370     * \param uv1 - UV on the seam
 371     * \param uv2 - UV within a face
 372     * \retval gp_Pnt2d - selected UV
 373    */
 374   gp_Pnt2d GetUVOnSeam( const gp_Pnt2d& uv1, const gp_Pnt2d& uv2 ) const;
 375
 376  private:
 377
 378   // Forbiden copy constructor
 379   SMESH_MesherHelper (const SMESH_MesherHelper& theOther) {};
 380
 381   // special map for using during creation of quadratic elements
 382   TLinkNodeMap    myTLinkNodeMap;
 383
 384   std::set< int > myDegenShapeIds;
 385   std::set< int > mySeamShapeIds;
 386   double          myPar1, myPar2; // bounds of a closed periodic surface
 387   int             myParIndex;     // bounds' index (1-U, 2-V)
 388
 389   TopoDS_Shape    myShape;
 390   SMESH_Mesh*     myMesh;
 391   int             myShapeID;
 392
 393   // to create quadratic elements
 394   bool            myCreateQuadratic;
 395   bool            mySetElemOnShape;
 396   bool            myCheckNodePos;
 397
 398 };
 399
 400
 401 #endif