src/SMESH/SMESH_Algo.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  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 //
  24 //  File   : SMESH_Algo.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_ALGO_HXX_
  30 #define _SMESH_ALGO_HXX_
  31
  32 #include "SMESH_Hypothesis.hxx"
  33
  34 #include <TopoDS_Shape.hxx>
  35 #include <TopoDS_Edge.hxx>
  36 #include <gp_XY.hxx>
  37
  38 #include <string>
  39 #include <vector>
  40 #include <list>
  41 #include <map>
  42
  43 class SMESH_Gen;
  44 class SMESH_Mesh;
  45 class SMESH_HypoFilter;
  46 class TopoDS_Face;
  47 class TopoDS_Shape;
  48 class SMESHDS_Mesh;
  49 class SMDS_MeshNode;
  50
  51 class SMESH_Algo:public SMESH_Hypothesis
  52 {
  53   public:
  54         SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
  55           virtual ~ SMESH_Algo();
  56
  57         const std::vector < std::string > &GetCompatibleHypothesis();
  58         virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
  59                                      const TopoDS_Shape& aShape,
  60                                      SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
  61
  62         virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
  63
  64         virtual const std::list <const SMESHDS_Hypothesis *> &
  65                 GetUsedHypothesis(SMESH_Mesh &         aMesh,
  66                                   const TopoDS_Shape & aShape,
  67                                   const bool           ignoreAuxiliary=true);
  68
  69         const list <const SMESHDS_Hypothesis *> &
  70                 GetAppliedHypothesis(SMESH_Mesh &         aMesh,
  71                                      const TopoDS_Shape & aShape,
  72                                      const bool           ignoreAuxiliary=true);
  73
  74         static double EdgeLength(const TopoDS_Edge & E);
  75
  76
  77   /*!
  78    * \brief Make filter recognize only compatible hypotheses
  79     * \param theFilter - the filter to initialize
  80     * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
  81     * \retval bool - true if the algo has compatible hypotheses
  82    */
  83   bool InitCompatibleHypoFilter( SMESH_HypoFilter & theFilter,
  84                                  const bool         ignoreAuxiliary) const;
  85
  86   /*!
  87    * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
  88     * \param theMesh - The mesh containing nodes
  89     * \param theEdge - The geometrical edge of interest
  90     * \param theParams - The resulting vector of sorted node parameters
  91     * \retval bool - false if not all parameters are OK
  92    */
  93   static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
  94                                  const TopoDS_Edge&      theEdge,
  95                                  std::vector< double > & theParams);
  96
  97   //static bool GetSegmentLengths();
  98
  99   /*!
 100    * \brief Find out elements orientation on a geometrical face
 101    * \param theFace - The face correctly oriented in the shape being meshed
 102    * \param theMeshDS - The mesh data structure
 103    * \retval bool - true if the face normal and the normal of first element
 104    *                in the correspoding submesh point in different directions
 105    */
 106   static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
 107                                  SMESHDS_Mesh*       theMeshDS);
 108
 109   /*!
 110    * \brief Initialize my parameter values by the mesh built on the geometry
 111     * \param theMesh - the built mesh
 112     * \param theShape - the geometry of interest
 113     * \retval bool - true if parameter values have been successfully defined
 114     *
 115     * Just return false as the algorithm does not hold parameters values
 116    */
 117   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 118
 119  public:
 120         // algo features
 121
 122         // SMESH_Hypothesis::GetDim();
 123         // 1 - dimention of target mesh
 124
 125         bool OnlyUnaryInput() const { return _onlyUnaryInput; }
 126         // 2 - is collection of tesselatable shapes inacceptable as input;
 127         // "collection" means a shape containing shapes of dim equal
 128         // to GetDim().
 129         // Algo which can process a collection shape should expect
 130         // an input temporary shape that is neither MainShape nor
 131         // its child.
 132
 133         bool NeedDescretBoundary() const { return _requireDescretBoundary; }
 134         // 3 - is a Dim-1 mesh prerequisite
 135
 136  protected:
 137         bool _onlyUnaryInput;
 138         bool _requireDescretBoundary;
 139         std::vector<std::string> _compatibleHypothesis;
 140         std::list<const SMESHDS_Hypothesis *> _appliedHypList;
 141         std::list<const SMESHDS_Hypothesis *> _usedHypList;
 142
 143   // quadratic mesh creation required
 144   bool _quadraticMesh;
 145 };
 146
 147 #endif