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