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