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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  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
  37 #include <string>
  38 #include <vector>
  39 #include <list>
  40
  41 class SMESH_Gen;
  42 class SMESH_Mesh;
  43 class TopoDS_Face;
  44 class TopoDS_Shape;
  45 class SMESHDS_Mesh;
  46
  47 class SMESH_Algo:public SMESH_Hypothesis
  48 {
  49   public:
  50         SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
  51           virtual ~ SMESH_Algo();
  52
  53         const std::vector < std::string > &GetCompatibleHypothesis();
  54         virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
  55                                      const TopoDS_Shape& aShape,
  56                                      SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
  57
  58         virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
  59
  60         virtual const std::list <const SMESHDS_Hypothesis *> &
  61                 GetUsedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  62
  63         const list <const SMESHDS_Hypothesis *> &
  64                 GetAppliedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  65
  66         static double EdgeLength(const TopoDS_Edge & E);
  67
  68   /*!
  69    * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
  70     * \param theMesh - The mesh containing nodes
  71     * \param theEdge - The geometrical edge of interest
  72     * \param theParams - The resulting vector of sorted node parameters
  73     * \retval bool - false if not all parameters are OK
  74    */
  75   static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
  76                                  const TopoDS_Edge&      theEdge,
  77                                  std::vector< double > & theParams);
  78
  79   //static bool GetSegmentLengths();
  80
  81   /*!
  82    * \brief Find out elements orientation on a geometrical face
  83    * \param theFace - The face correctly oriented in the shape being meshed
  84    * \param theMeshDS - The mesh data structure
  85    * \retval bool - true if the face normal and the normal of first element
  86    *                in the correspoding submesh point in different directions
  87    */
  88   static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
  89                                  SMESHDS_Mesh*       theMeshDS);
  90
  91   /*!
  92    * \brief Initialize my parameter values by the mesh built on the geometry
  93     * \param theMesh - the built mesh
  94     * \param theShape - the geometry of interest
  95     * \retval bool - true if parameter values have been successfully defined
  96     *
  97     * Just return false as the algorithm does not hold parameters values
  98    */
  99   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
 100
 101  public:
 102         // algo features
 103
 104         // SMESH_Hypothesis::GetDim();
 105         // 1 - dimention of target mesh
 106
 107         bool OnlyUnaryInput() const { return _onlyUnaryInput; }
 108         // 2 - is collection of tesselatable shapes inacceptable as input;
 109         // "collection" means a shape containing shapes of dim equal
 110         // to GetDim().
 111         // Algo which can process a collection shape should expect
 112         // an input temporary shape that is neither MainShape nor
 113         // its child.
 114
 115         bool NeedDescretBoundary() const { return _requireDescretBoundary; }
 116         // 3 - is a Dim-1 mesh prerequisite
 117
 118  protected:
 119         bool _onlyUnaryInput;
 120         bool _requireDescretBoundary;
 121         std::vector<std::string> _compatibleHypothesis;
 122         std::list<const SMESHDS_Hypothesis *> _appliedHypList;
 123         std::list<const SMESHDS_Hypothesis *> _usedHypList;
 124 };
 125
 126 #endif