src/SMESH/SMESH_Algo.hxx

   1 // Copyright (C) 2007-2024  CEA, EDF, 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
  23 //  SMESH SMESH : implementation of SMESH idl descriptions
  24 //  File   : SMESH_Algo.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_ALGO_HXX_
  29 #define _SMESH_ALGO_HXX_
  30
  31 #include "SMESH_SMESH.hxx"
  32
  33 #include "SMDSAbs_ElementType.hxx"
  34 #include "SMESH_Comment.hxx"
  35 #include "SMESH_ComputeError.hxx"
  36 #include "SMESH_Hypothesis.hxx"
  37
  38 #include <GeomAbs_Shape.hxx>
  39 #include <TopoDS_Shape.hxx>
  40
  41 #include <string>
  42 #include <vector>
  43 #include <list>
  44 #include <map>
  45 #include <set>
  46
  47 class SMDS_MeshNode;
  48 class SMESHDS_Mesh;
  49 class SMESHDS_SubMesh;
  50 class SMESH_Gen;
  51 class SMESH_HypoFilter;
  52 class SMESH_Mesh;
  53 class SMESH_MesherHelper;
  54 class SMESH_ProxyMesh;
  55 class SMESH_subMesh;
  56 class TopoDS_Edge;
  57 class TopoDS_Face;
  58 class TopoDS_Shape;
  59 class TopoDS_Vertex;
  60 class TopoDS_Wire;
  61 class gp_XYZ;
  62
  63 typedef std::map< SMESH_subMesh*, std::vector<smIdType> >           MapShapeNbElems;
  64 typedef std::map< SMESH_subMesh*, std::vector<smIdType> >::iterator MapShapeNbElemsItr;
  65
  66 // ==================================================================================
  67 /*!
  68  * \brief Root of all algorithms
  69  *
  70  *  Methods of the class are grouped into several parts:
  71  *  - main lifecycle methods, like Compute()
  72  *  - methods describing features of the algorithm, like NeedShape()
  73  *  - methods related to dependencies between sub-meshes imposed by the algorithm
  74  *  - static utilities, like EdgeLength()
  75  */
  76 // ==================================================================================
  77
  78 class SMESH_EXPORT SMESH_Algo : public SMESH_Hypothesis
  79 {
  80  public:
  81   //==================================================================================
  82   /*!
  83    * \brief Structure describing algorithm features
  84    */
  85   // --------------------------------------------------------------------------------
  86   struct Features
  87   {
  88     int                            _dim;
  89     std::set<SMDSAbs_GeometryType> _inElemTypes;  // acceptable types of input mesh element
  90     std::set<SMDSAbs_GeometryType> _outElemTypes; // produced types of mesh elements
  91     std::string                    _label;        // GUI type name
  92
  93     Features(): _dim( -1 ) {}
  94     bool IsCompatible( const Features& algo2 ) const;
  95   };
  96   /*!
  97    * \brief Return a structure describing algorithm features
  98    */
  99   static const Features& GetFeatures( const std::string& algoType );
 100   const Features&        GetFeatures() const { return GetFeatures( _name ); }
 101
 102  public:
 103   //==================================================================================
 104   /*!
 105    * \brief Creates algorithm
 106     * \param hypId - algorithm ID
 107     * \param gen - SMESH_Gen
 108    */
 109   SMESH_Algo(int hypId, SMESH_Gen * gen);
 110
 111   /*!
 112    * \brief Destructor
 113    */
 114   virtual ~ SMESH_Algo();
 115
 116   /*!
 117    * \brief Saves nothing in a stream
 118     * \param save - the stream
 119     * \retval std::ostream & - the stream
 120    */
 121   virtual std::ostream & SaveTo(std::ostream & save);
 122
 123   /*!
 124    * \brief Loads nothing from a stream
 125     * \param load - the stream
 126     * \retval std::ostream & - the stream
 127    */
 128   virtual std::istream & LoadFrom(std::istream & load);
 129
 130   /*!
 131    * \brief Return all types of compatible hypotheses
 132    */
 133   const std::vector < std::string > & GetCompatibleHypothesis();
 134
 135   /*!
 136    * \brief Check hypothesis definition to mesh a shape
 137     * \param aMesh - the mesh
 138     * \param aShape - the shape
 139     * \param aStatus - check result
 140     * \retval bool - true if hypothesis is well defined
 141     *
 142     * Textual description of a problem can be stored in _comment field.
 143    */
 144   virtual bool CheckHypothesis(SMESH_Mesh&                          aMesh,
 145                                const TopoDS_Shape&                  aShape,
 146                                SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
 147   /*!
 148    * \brief Computes mesh on a shape
 149     * \param aMesh - the mesh
 150     * \param aShape - the shape
 151     * \retval bool - is a success
 152     *
 153     * Algorithms that !NeedDiscreteBoundary() || !OnlyUnaryInput() are
 154     * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError()
 155     * to report problematic sub-shapes
 156    */
 157   virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
 158
 159   /*!
 160    * \brief Computes mesh without geometry
 161     * \param aMesh - the mesh
 162     * \param aHelper - helper that must be used for adding elements to \aaMesh
 163     * \retval bool - is a success
 164     *
 165     * The method is called if ( !aMesh->HasShapeToMesh() )
 166    */
 167   virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper);
 168
 169   /*!
 170    * \brief Return true if the algorithm can mesh a given shape
 171    *  \param [in] aShape - shape to check
 172    *  \param [in] toCheckAll - if true, this check returns OK if all shapes are OK,
 173    *              else, returns OK if at least one shape is OK
 174    *  \retval bool - \c true by default
 175    */
 176   virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const;
 177
 178   /*!
 179    * \brief Sets _computeCanceled to true. It's usage depends on
 180    *        implementation of a particular mesher.
 181    */
 182   virtual void CancelCompute();
 183
 184   /*!
 185    * \brief If possible, returns progress of computation [0.,1.]
 186    */
 187   virtual double GetProgress() const;
 188
 189   /*!
 190    * \brief evaluates size of prospective mesh on a shape
 191    *  \param aMesh - the mesh
 192    *  \param aShape - the shape
 193    *  \param aResMap - prospective number of elements by SMDSAbs_ElementType by a sub-mesh
 194    *  \retval bool - is a success
 195    */
 196   virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
 197                         MapShapeNbElems& aResMap) = 0;
 198
 199   /*!
 200    * \brief Return a list of compatible hypotheses used to mesh a shape
 201     * \param aMesh - the mesh
 202     * \param aShape - the shape
 203     * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
 204     * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
 205    *
 206    *  List the hypothesis used by the algorithm associated to the shape.
 207    *  Hypothesis associated to father shape -are- taken into account (see
 208    *  GetAppliedHypothesis). Relevant hypothesis have a name (type) listed in
 209    *  the algorithm. This method could be surcharged by specific algorithms, in
 210    *  case of several hypothesis simultaneously applicable.
 211    */
 212   virtual const std::list <const SMESHDS_Hypothesis *> &
 213   GetUsedHypothesis(SMESH_Mesh &         aMesh,
 214                     const TopoDS_Shape & aShape,
 215                     const bool           ignoreAuxiliary=true) const;
 216   /*!
 217    * \brief Return sub-shape to which hypotheses returned by GetUsedHypothesis() are assigned
 218    */
 219   virtual const std::list < TopoDS_Shape > & GetAssignedShapes() const;
 220   /*!
 221    * \brief Return the filter recognizing only compatible hypotheses
 222    *  \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
 223    *  \retval SMESH_HypoFilter* - the filter that can be NULL
 224    */
 225   const SMESH_HypoFilter* GetCompatibleHypoFilter(const bool ignoreAuxiliary) const;
 226
 227   /*!
 228    * \brief Just return false as the algorithm does not hold parameters values
 229    */
 230   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 231   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 232
 233   /*!
 234    * \brief return compute error
 235    */
 236   SMESH_ComputeErrorPtr GetComputeError() const;
 237   /*!
 238    * \brief initialize compute error etc. before call of Compute()
 239    */
 240   void InitComputeError();
 241   /*!
 242    * \brief Return compute progress by nb of calls of this method
 243    */
 244   double GetProgressByTic() const;
 245   /*!
 246    * Return a vector of sub-meshes to Compute()
 247    */
 248   std::vector<SMESH_subMesh*>& SubMeshesToCompute() { return _smToCompute; }
 249
 250 public:
 251   // ==================================================================
 252   // Algo features influencing how Compute() is called:
 253   // in what turn and with what input shape
 254   // ==================================================================
 255
 256   // SMESH_Hypothesis::GetDim();
 257   // 1 - dimension of target mesh
 258
 259   bool OnlyUnaryInput() const { return _onlyUnaryInput; }
 260   // 2 - is collection of tesselatable shapes inacceptable as input;
 261   // "collection" means a shape containing shapes of dim equal
 262   // to GetDim().
 263   // Algo which can process a collection shape should expect
 264   // an input temporary shape that is neither MainShape nor
 265   // its child.
 266
 267   bool NeedDiscreteBoundary() const { return _requireDiscreteBoundary; }
 268   // 3 - is a Dim-1 mesh prerequisite
 269
 270   bool NeedShape() const { return _requireShape; }
 271   // 4 - is shape existence required
 272
 273   bool SupportSubmeshes() const { return _supportSubmeshes; }
 274   // 5 - whether supports submeshes if !NeedDiscreteBoundary()
 275
 276   bool NeedLowerHyps(int dim) const { return _neededLowerHyps[ dim ]; }
 277   // 6 - if algo !NeedDiscreteBoundary() but requires presence of
 278   // hypotheses of dimension <dim> to generate all-dimensional mesh.
 279   // This info is used not to issue warnings on hiding of lower global algos.
 280   //
 281
 282   virtual void setSubMeshesToCompute(SMESH_subMesh * aSubMesh) {SubMeshesToCompute().assign( 1, aSubMesh );}
 283
 284 public:
 285   // ==================================================================
 286   // Methods to track non hierarchical dependencies between submeshes
 287   // ==================================================================
 288
 289   /*!
 290    * \brief Sets event listener to submeshes if necessary
 291     * \param subMesh - submesh where algo is set
 292    *
 293    * This method is called when a submesh gets HYP_OK algo_state.
 294    * After being set, event listener is notified on each event of a submesh.
 295    * By default none listener is set
 296    */
 297   virtual void SetEventListener(SMESH_subMesh* subMesh);
 298
 299   /*!
 300    * \brief Allow algo to do something after persistent restoration
 301     * \param subMesh - restored submesh
 302    *
 303    * This method is called only if a submesh has HYP_OK algo_state.
 304    */
 305   virtual void SubmeshRestored(SMESH_subMesh* subMesh);
 306
 307 public:
 308   // ==================================================================
 309   // Common algo utilities
 310   // ==================================================================
 311   /*!
 312    * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
 313    * \param theMesh - The mesh containing nodes
 314    * \param theEdge - The geometrical edge of interest
 315    * \param theParams - The resulting vector of sorted node parameters
 316    * \retval bool - false if not all parameters are OK
 317    * \warning Nodes moved to other geometry by MergeNodes() are NOT returned.
 318    */
 319   static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
 320                                  const TopoDS_Edge&      theEdge,
 321                                  std::vector< double > & theParams);
 322   /*!
 323    * \brief Fill map of node parameter on geometrical edge to node it-self
 324    * \param theMesh - The mesh containing nodes
 325    * \param theEdge - The geometrical edge of interest
 326    * \param theNodes - The resulting map
 327    * \param ignoreMediumNodes - to store medium nodes of quadratic elements or not
 328    * \param typeToCheck - type of elements to check for medium nodes
 329    * \retval bool - false if not all parameters are OK
 330    * \warning Nodes moved to other geometry by MergeNodes() are NOT returned.
 331    */
 332   static bool GetSortedNodesOnEdge(const SMESHDS_Mesh*                        theMesh,
 333                                    const TopoDS_Edge&                         theEdge,
 334                                    const bool                                 ignoreMediumNodes,
 335                                    std::map< double, const SMDS_MeshNode* > & theNodes,
 336                                    const SMDSAbs_ElementType                  typeToCheck = SMDSAbs_All);
 337
 338   /*!
 339    * \brief Compute length of an edge
 340     * \param E - the edge
 341     * \retval double - the length
 342    */
 343   static double EdgeLength(const TopoDS_Edge & E);
 344
 345   smIdType NumberOfPoints(SMESH_Mesh& aMesh,const TopoDS_Wire& W);
 346
 347   /*!
 348    * \brief Return continuity of two edges
 349     * \param E1 - the 1st edge
 350     * \param E2 - the 2nd edge
 351     * \retval GeomAbs_Shape - regularity at the junction between E1 and E2
 352    */
 353   static GeomAbs_Shape Continuity(const TopoDS_Edge& E1, const TopoDS_Edge& E2);
 354
 355   /*!
 356    * \brief Return true if an edge can be considered as a continuation of another
 357    */
 358   static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) {
 359     return ( Continuity( E1, E2 ) >= GeomAbs_G1 );
 360   }
 361   /*!
 362    * \brief Return true if an edge can be considered straight
 363    */
 364   static bool IsStraight( const TopoDS_Edge & E, const bool degenResult=false );
 365   /*!
 366    * \brief Return true if an edge has no 3D curve
 367    */
 368   static bool isDegenerated( const TopoDS_Edge & E, const bool checkLength=false );
 369
 370   /*!
 371    * \brief Return the node built on a vertex
 372     * \param V - the vertex
 373     * \param meshDS - mesh data structure
 374     * \retval const SMDS_MeshNode* - found node or NULL
 375    */
 376   static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESHDS_Mesh* meshDS);
 377
 378   /*!
 379    * \brief Return the node built on a vertex.
 380    *        A node moved to other geometry by MergeNodes() is also returned.
 381     * \param V - the vertex
 382     * \param mesh - mesh
 383     * \retval const SMDS_MeshNode* - found node or NULL
 384    */
 385   static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESH_Mesh* mesh);
 386
 387   /*!
 388    * \brief Return the node built on a vertex.
 389    *        A node moved to other geometry by MergeNodes() is also returned.
 390     * \param V - the vertex
 391     * \param edgeSM - sub-mesh of a meshed EDGE sharing the vertex
 392     * \param mesh - the mesh
 393     * \param checkV - if \c true, presence of a node on the vertex is checked
 394     * \retval const SMDS_MeshNode* - found node or NULL
 395    */
 396   static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex&   V,
 397                                          const SMESHDS_SubMesh* edgeSM,
 398                                          const SMESH_Mesh*      mesh,
 399                                          const bool             checkV=true);
 400
 401   enum EMeshError { MEr_OK = 0, MEr_HOLES, MEr_BAD_ORI, MEr_EMPTY };
 402
 403   /*!
 404    * \brief Finds topological errors of a sub-mesh
 405    */
 406   static EMeshError GetMeshError(SMESH_subMesh* subMesh);
 407
 408  protected:
 409
 410   /*!
 411    * \brief store error and comment and then return ( error == COMPERR_OK )
 412    */
 413   bool error(int error, const SMESH_Comment& comment = "");
 414   /*!
 415    * \brief store COMPERR_ALGO_FAILED error and comment and then return false
 416    */
 417   bool error(const SMESH_Comment& comment = "")
 418   { return error(COMPERR_ALGO_FAILED, comment); }
 419   /*!
 420    * \brief store error and return error->IsOK()
 421    */
 422   bool error(SMESH_ComputeErrorPtr error);
 423   /*!
 424    * \brief store a bad input element preventing computation,
 425    *        which may be a temporary one i.e. not residing the mesh,
 426    *        then it will be deleted by InitComputeError()
 427    */
 428   void addBadInputElement(const SMDS_MeshElement* elem);
 429
 430   void addBadInputElements(const SMESHDS_SubMesh* sm,
 431                            const bool             addNodes=false);
 432
 433 protected:
 434
 435   const SMESH_HypoFilter *              _compatibleAllHypFilter;
 436   const SMESH_HypoFilter *              _compatibleNoAuxHypFilter;
 437   std::vector<std::string>              _compatibleHypothesis;
 438   std::list<const SMESHDS_Hypothesis *> _usedHypList;
 439   std::list<TopoDS_Shape>               _assigedShapeList; // _usedHypList assigned to
 440
 441
 442   // Algo features influencing which Compute() and how is called:
 443   // in what turn and with what input shape.
 444   // These fields must be redefined if necessary by each descendant at constructor.
 445   bool _onlyUnaryInput;         // mesh one shape of GetDim() at once. Default TRUE
 446   bool _requireDiscreteBoundary;// GetDim()-1 mesh must be present. Default TRUE
 447   bool _requireShape;           // work with GetDim()-1 mesh bound to geom only. Default TRUE
 448   bool _supportSubmeshes;       // if !_requireDiscreteBoundary. Default FALSE
 449   bool _neededLowerHyps[4];     // hyp dims needed by algo that !_requireDiscreteBoundary. Df. FALSE
 450
 451   // indicates if quadratic mesh creation is required,
 452   // is usually set like this: _quadraticMesh = SMESH_MesherHelper::IsQuadraticSubMesh(shape)
 453   bool _quadraticMesh;
 454
 455   int         _error;    //!< SMESH_ComputeErrorName or anything algo specific
 456   std::string _comment;  //!< any text explaining what is wrong in Compute()
 457   std::list<const SMDS_MeshElement*> _badInputElements; //!< to explain COMPERR_BAD_INPUT_MESH
 458   const SMDS_Mesh* _mesh; //!< mesh being computed, needed to create SMESH_BadInputElements
 459
 460   volatile bool _computeCanceled; //!< is set to True while computing to stop it
 461
 462   double        _progress;        /* progress of Compute() [0.,1.],
 463                                      to be set by an algo really tracking the progress */
 464   int           _progressTic;     // counter of calls from SMESH_Mesh::GetComputeProgress()
 465   std::vector<SMESH_subMesh*> _smToCompute; // sub-meshes to Compute()
 466 };
 467
 468
 469 class SMESH_EXPORT SMESH_0D_Algo: public SMESH_Algo
 470 {
 471 public:
 472   SMESH_0D_Algo(int hypId, SMESH_Gen* gen);
 473 };
 474
 475 class SMESH_EXPORT SMESH_1D_Algo: public SMESH_Algo
 476 {
 477 public:
 478   SMESH_1D_Algo(int hypId, SMESH_Gen* gen);
 479   /*!
 480    * \brief Return true if the algorithm can mesh a given shape
 481    *  \param [in] aShape - shape to check
 482    *  \param [in] toCheckAll - if true, this check returns OK if all shapes are OK,
 483    *              else, returns OK if at least one shape is OK
 484    *  \retval bool - \c true by default
 485    */
 486   virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const;
 487 };
 488
 489 class SMESH_EXPORT SMESH_2D_Algo: public SMESH_Algo
 490 {
 491 public:
 492   SMESH_2D_Algo(int hypId, SMESH_Gen* gen);
 493   /*!
 494    * \brief Return true if the algorithm can mesh a given shape
 495    *  \param [in] aShape - shape to check
 496    *  \param [in] toCheckAll - if true, this check returns OK if all shapes are OK,
 497    *              else, returns OK if at least one shape is OK
 498    *  \retval bool - \c true by default
 499    */
 500   virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const;
 501   /*!
 502    * \brief Method in which an algorithm generating a structured mesh
 503    *        fixes positions of in-face nodes after there movement
 504    *        due to insertion of viscous layers.
 505    */
 506   virtual bool FixInternalNodes(const SMESH_ProxyMesh& mesh,
 507                                 const TopoDS_Face&     face);
 508 };
 509
 510 class SMESH_EXPORT SMESH_3D_Algo: public SMESH_Algo
 511 {
 512 public:
 513   SMESH_3D_Algo(int hypId, SMESH_Gen* gen);
 514   /*!
 515    * \brief Return true if the algorithm can mesh a given shape
 516    *  \param [in] aShape - shape to check
 517    *  \param [in] toCheckAll - if true, this check returns OK if all shapes are OK,
 518    *              else, returns OK if at least one shape is OK
 519    *  \retval bool - \c true by default
 520    */
 521   virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const;
 522 };
 523
 524 #endif