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 SMESHDS_Mesh;
  45
  46 class SMESH_Algo:public SMESH_Hypothesis
  47 {
  48   public:
  49         SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
  50           virtual ~ SMESH_Algo();
  51
  52         const std::vector < std::string > &GetCompatibleHypothesis();
  53         virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
  54                                      const TopoDS_Shape& aShape,
  55                                      SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
  56
  57         virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
  58
  59         virtual const std::list <const SMESHDS_Hypothesis *> &
  60                 GetUsedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  61
  62         const list <const SMESHDS_Hypothesis *> &
  63                 GetAppliedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
  64
  65         static double EdgeLength(const TopoDS_Edge & E);
  66
  67   /*!
  68    * \brief Find out elements orientation on a geometrical face
  69    * \param theFace - The face correctly oriented in the shape being meshed
  70    * \param theMeshDS - The mesh data structure
  71    * \retval bool - true if the face normal and the normal of first element
  72    *                in the correspoding submesh point in different directions
  73    */
  74   static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
  75                                  SMESHDS_Mesh*       theMeshDS);
  76
  77  public:
  78         // algo features
  79
  80         // SMESH_Hypothesis::GetDim();
  81         // 1 - dimention of target mesh
  82
  83         bool OnlyUnaryInput() const { return _onlyUnaryInput; }
  84         // 2 - is collection of tesselatable shapes inacceptable as input;
  85         // "collection" means a shape containing shapes of dim equal
  86         // to GetDim().
  87         // Algo which can process a collection shape should expect
  88         // an input temporary shape that is neither MainShape nor
  89         // its child.
  90
  91         bool NeedDescretBoundary() const { return _requireDescretBoundary; }
  92         // 3 - is a Dim-1 mesh prerequisite
  93
  94  protected:
  95         bool _onlyUnaryInput;
  96         bool _requireDescretBoundary;
  97         std::vector<std::string> _compatibleHypothesis;
  98         std::list<const SMESHDS_Hypothesis *> _appliedHypList;
  99         std::list<const SMESHDS_Hypothesis *> _usedHypList;
 100 };
 101
 102 #endif