src/SMESH/SMESH_Algo.hxx

   1 //  Copyright (C) 2007-2010  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
  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 "SMESH_Hypothesis.hxx"
  34 #include "SMESH_ComputeError.hxx"
  35 #include "SMESH_Comment.hxx"
  36
  37 #include <TopoDS_Shape.hxx>
  38 #include <TopoDS_Edge.hxx>
  39 #include <GeomAbs_Shape.hxx>
  40
  41 #include <string>
  42 #include <vector>
  43 #include <list>
  44 #include <map>
  45
  46 class SMESH_Gen;
  47 class SMESH_Mesh;
  48 class SMESH_HypoFilter;
  49 class TopoDS_Vertex;
  50 class TopoDS_Face;
  51 class TopoDS_Shape;
  52 class SMESHDS_Mesh;
  53 class SMDS_MeshNode;
  54 class SMESH_subMesh;
  55 class SMESH_MesherHelper;
  56 class gp_XYZ;
  57
  58 typedef std::map< SMESH_subMesh*, std::vector<int> >           MapShapeNbElems;
  59 typedef std::map< SMESH_subMesh*, std::vector<int> >::iterator MapShapeNbElemsItr;
  60
  61 /*!
  62  * \brief Root of all algorithms
  63  *
  64  *  Methods of the class are grouped into several parts:
  65  *  - main lifecycle methods, like Compute()
  66  *  - methods describing features of the algorithm, like NeedShape()
  67  *  - methods related to dependencies between sub-meshes imposed by the algorith
  68  *  - static utilities, like EdgeLength()
  69  */
  70 class SMESH_EXPORT SMESH_Algo:public SMESH_Hypothesis
  71 {
  72 public:
  73   /*!
  74    * \brief Creates algorithm
  75     * \param hypId - algorithm ID
  76     * \param studyId - study ID
  77     * \param gen - SMESH_Gen
  78    */
  79   SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
  80
  81   /*!
  82    * \brief Destructor
  83    */
  84   virtual ~ SMESH_Algo();
  85
  86   /*!
  87    * \brief Saves nothing in a stream
  88     * \param save - the stream
  89     * \retval virtual std::ostream & - the stream
  90    */
  91   virtual std::ostream & SaveTo(std::ostream & save);
  92
  93   /*!
  94    * \brief Loads nothing from a stream
  95     * \param load - the stream
  96     * \retval virtual std::ostream & - the stream
  97    */
  98   virtual std::istream & LoadFrom(std::istream & load);
  99
 100   /*!
 101    * \brief Returns all types of compatible hypotheses
 102    */
 103   const std::vector < std::string > & GetCompatibleHypothesis();
 104
 105   /*!
 106    * \brief Check hypothesis definition to mesh a shape
 107     * \param aMesh - the mesh
 108     * \param aShape - the shape
 109     * \param aStatus - check result
 110     * \retval bool - true if hypothesis is well defined
 111    */
 112   virtual bool CheckHypothesis(SMESH_Mesh&                          aMesh,
 113                                const TopoDS_Shape&                  aShape,
 114                                SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
 115   /*!
 116    * \brief Computes mesh on a shape
 117     * \param aMesh - the mesh
 118     * \param aShape - the shape
 119     * \retval bool - is a success
 120     *
 121     * Algorithms that !NeedDescretBoundary() || !OnlyUnaryInput() are
 122     * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError()
 123     * to report problematic subshapes
 124    */
 125   virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
 126
 127   /*!
 128    * \brief Computes mesh without geometry
 129     * \param aMesh - the mesh
 130     * \param aHelper - helper that must be used for adding elements to \aaMesh
 131     * \retval bool - is a success
 132     *
 133     * The method is called if ( !aMesh->HasShapeToMesh() )
 134    */
 135   virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper);
 136
 137   /*!
 138    * \brief evaluates size of prospective mesh on a shape
 139     * \param aMesh - the mesh
 140     * \param aShape - the shape
 141     * \param aNbElems - prospective number of elements by types
 142     * \retval bool - is a success
 143    */
 144   virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
 145                         MapShapeNbElems& aResMap) = 0;
 146
 147   /*!
 148    * \brief Returns a list of compatible hypotheses used to mesh a shape
 149     * \param aMesh - the mesh
 150     * \param aShape - the shape
 151     * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
 152     * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
 153    *
 154    *  List the hypothesis used by the algorithm associated to the shape.
 155    *  Hypothesis associated to father shape -are- taken into account (see
 156    *  GetAppliedHypothesis). Relevant hypothesis have a name (type) listed in
 157    *  the algorithm. This method could be surcharged by specific algorithms, in
 158    *  case of several hypothesis simultaneously applicable.
 159    */
 160   virtual const std::list <const SMESHDS_Hypothesis *> &
 161   GetUsedHypothesis(SMESH_Mesh &         aMesh,
 162                     const TopoDS_Shape & aShape,
 163                     const bool           ignoreAuxiliary=true);
 164   /*!
 165    * \brief Returns a list of compatible hypotheses assigned to a shape in a mesh
 166     * \param aMesh - the mesh
 167     * \param aShape - the shape
 168     * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
 169     * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
 170    *
 171    *  List the relevant hypothesis associated to the shape. Relevant hypothesis
 172    *  have a name (type) listed in the algorithm. Hypothesis associated to
 173    *  father shape -are not- taken into account (see GetUsedHypothesis)
 174    */
 175   const list <const SMESHDS_Hypothesis *> &
 176   GetAppliedHypothesis(SMESH_Mesh &         aMesh,
 177                        const TopoDS_Shape & aShape,
 178                        const bool           ignoreAuxiliary=true);
 179   /*!
 180    * \brief Make the filter recognize only compatible hypotheses
 181    * \param theFilter - the filter to initialize
 182    * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
 183    * \retval bool - true if the algo has compatible hypotheses
 184    */
 185   bool InitCompatibleHypoFilter( SMESH_HypoFilter & theFilter,
 186                                  const bool         ignoreAuxiliary) const;
 187   /*!
 188    * \brief Just return false as the algorithm does not hold parameters values
 189    */
 190   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 191   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
 192   /*!
 193    * \brief return compute error
 194    */
 195   SMESH_ComputeErrorPtr GetComputeError() const;
 196   /*!
 197    * \brief initialize compute error
 198    */
 199   void InitComputeError();
 200
 201 public:
 202   // ==================================================================
 203   // Algo features influencing how Compute() is called:
 204   // in what turn and with what input shape
 205   // ==================================================================
 206
 207   // SMESH_Hypothesis::GetDim();
 208   // 1 - dimention of target mesh
 209
 210   bool OnlyUnaryInput() const { return _onlyUnaryInput; }
 211   // 2 - is collection of tesselatable shapes inacceptable as input;
 212   // "collection" means a shape containing shapes of dim equal
 213   // to GetDim().
 214   // Algo which can process a collection shape should expect
 215   // an input temporary shape that is neither MainShape nor
 216   // its child.
 217
 218   bool NeedDescretBoundary() const { return _requireDescretBoundary; }
 219   // 3 - is a Dim-1 mesh prerequisite
 220
 221   bool NeedShape() const { return _requireShape; }
 222   // 4 - is shape existance required
 223
 224   bool SupportSubmeshes() const { return _supportSubmeshes; }
 225   // 5 - whether supports submeshes if !NeedDescretBoundary()
 226
 227
 228 public:
 229   // ==================================================================
 230   // Methods to track non hierarchical dependencies between submeshes
 231   // ==================================================================
 232
 233   /*!
 234    * \brief Sets event listener to submeshes if necessary
 235     * \param subMesh - submesh where algo is set
 236    *
 237    * This method is called when a submesh gets HYP_OK algo_state.
 238    * After being set, event listener is notified on each event of a submesh.
 239    * By default non listener is set
 240    */
 241   virtual void SetEventListener(SMESH_subMesh* subMesh);
 242
 243   /*!
 244    * \brief Allow algo to do something after persistent restoration
 245     * \param subMesh - restored submesh
 246    *
 247    * This method is called only if a submesh has HYP_OK algo_state.
 248    */
 249   virtual void SubmeshRestored(SMESH_subMesh* subMesh);
 250
 251 public:
 252   // ==================================================================
 253   // Common algo utilities
 254   // ==================================================================
 255   /*!
 256    * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
 257    * \param theMesh - The mesh containing nodes
 258    * \param theEdge - The geometrical edge of interest
 259    * \param theParams - The resulting vector of sorted node parameters
 260    * \retval bool - false if not all parameters are OK
 261    */
 262   static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
 263                                  const TopoDS_Edge&      theEdge,
 264                                  std::vector< double > & theParams);
 265   /*!
 266    * \brief Fill map of node parameter on geometrical edge to node it-self
 267    * \param theMesh - The mesh containing nodes
 268    * \param theEdge - The geometrical edge of interest
 269    * \param theNodes - The resulting map
 270    * \param ignoreMediumNodes - to store medium nodes of quadratic elements or not
 271    * \retval bool - false if not all parameters are OK
 272    */
 273   static bool GetSortedNodesOnEdge(const SMESHDS_Mesh*                        theMesh,
 274                                    const TopoDS_Edge&                         theEdge,
 275                                    const bool                                 ignoreMediumNodes,
 276                                    std::map< double, const SMDS_MeshNode* > & theNodes);
 277   /*!
 278    * \brief Find out elements orientation on a geometrical face
 279    * \param theFace - The face correctly oriented in the shape being meshed
 280    * \param theMeshDS - The mesh data structure
 281    * \retval bool - true if the face normal and the normal of first element
 282    *                in the correspoding submesh point in different directions
 283    */
 284   static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
 285                                  SMESHDS_Mesh*       theMeshDS);
 286   /*!
 287    * \brief Compute length of an edge
 288     * \param E - the edge
 289     * \retval double - the length
 290    */
 291   static double EdgeLength(const TopoDS_Edge & E);
 292
 293   /*!
 294    * \brief Calculate normal of a mesh face
 295    */
 296   static bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true);
 297
 298   /*!
 299    * \brief Return continuity of two edges
 300     * \param E1 - the 1st edge
 301     * \param E2 - the 2nd edge
 302     * \retval GeomAbs_Shape - regularity at the junction between E1 and E2
 303    */
 304   static GeomAbs_Shape Continuity(TopoDS_Edge E1, TopoDS_Edge E2);
 305
 306   /*!
 307    * \brief Return true if an edge can be considered as a continuation of another
 308    */
 309   static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) {
 310     return ( Continuity( E1, E2 ) >= GeomAbs_G1 );
 311   }
 312
 313   /*!
 314    * \brief Return the node built on a vertex
 315     * \param V - the vertex
 316     * \param meshDS - mesh
 317     * \retval const SMDS_MeshNode* - found node or NULL
 318    */
 319   static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESHDS_Mesh* meshDS);
 320
 321   /*!
 322    * \brief Return nodes common to two elements
 323    */
 324   static std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1,
 325                                                            const SMDS_MeshElement* e2);
 326 protected:
 327
 328   /*!
 329    * \brief store error and comment and then return ( error == COMPERR_OK )
 330    */
 331   bool error(int error, const SMESH_Comment& comment = "");
 332   /*!
 333    * \brief store COMPERR_ALGO_FAILED error and comment and then return false
 334    */
 335   bool error(const SMESH_Comment& comment = "")
 336   { return error(COMPERR_ALGO_FAILED, comment); }
 337   /*!
 338    * \brief store error and return error->IsOK()
 339    */
 340   bool error(SMESH_ComputeErrorPtr error);
 341   /*!
 342    * \brief store a bad input element preventing computation,
 343    *        which may be a temporary one i.e. not residing the mesh,
 344    *        then it will be deleted by InitComputeError()
 345    */
 346   void addBadInputElement(const SMDS_MeshElement* elem);
 347
 348 protected:
 349
 350   std::vector<std::string>              _compatibleHypothesis;
 351   std::list<const SMESHDS_Hypothesis *> _appliedHypList;
 352   std::list<const SMESHDS_Hypothesis *> _usedHypList;
 353
 354   // Algo features influencing which Compute() and how is called:
 355   // in what turn and with what input shape.
 356   // This fields must be redefined if necessary by each descendant at constructor.
 357   bool _onlyUnaryInput;         // mesh one shape of GetDim() at once. Default TRUE
 358   bool _requireDescretBoundary; // GetDim()-1 mesh must be present. Default TRUE
 359   bool _requireShape;           // work with GetDim()-1 mesh bound to geom only. Default TRUE
 360   bool _supportSubmeshes;       // if !_requireDescretBoundary. Default FALSE
 361
 362   // quadratic mesh creation required,
 363   // is usually set trough SMESH_MesherHelper::IsQuadraticSubMesh()
 364   bool _quadraticMesh;
 365
 366   int         _error;    //!< SMESH_ComputeErrorName or anything algo specific
 367   std::string _comment;  //!< any text explaining what is wrong in Compute()
 368   std::list<const SMDS_MeshElement*> _badInputElements; //!< to explain COMPERR_BAD_INPUT_MESH
 369 };
 370
 371 #endif