Salome HOME
fix bug PAL10974: add IsReversedSubMesh()
[modules/smesh.git] / src / SMESH / SMESH_Algo.hxx
index de6c671626fb8b8c44c5226e6eb1711af0b568d5..12c72d828f284a56bb442fa84c4cf1128e63b3c9 100644 (file)
@@ -1,11 +1,30 @@
-//=============================================================================
-// File      : SMESH_Algo.hxx
-// Created   : sam mai 18 09:20:46 CEST 2002
-// Author    : Paul RASCLE, EDF
-// Project   : SALOME
-// Copyright : EDF 2002
-// $Header$
-//=============================================================================
+//  SMESH SMESH : implementaion of SMESH idl descriptions
+//
+//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
+// 
+//  This library is free software; you can redistribute it and/or 
+//  modify it under the terms of the GNU Lesser General Public 
+//  License as published by the Free Software Foundation; either 
+//  version 2.1 of the License. 
+// 
+//  This library is distributed in the hope that it will be useful, 
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
+//  Lesser General Public License for more details. 
+// 
+//  You should have received a copy of the GNU Lesser General Public 
+//  License along with this library; if not, write to the Free Software 
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
+// 
+//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+//
+//
+//
+//  File   : SMESH_Algo.hxx
+//  Author : Paul RASCLE, EDF
+//  Module : SMESH
+//  $Header$
 
 #ifndef _SMESH_ALGO_HXX_
 #define _SMESH_ALGO_HXX_
 #include <vector>
 #include <list>
 
-class SMESH_gen;
+class SMESH_Gen;
 class SMESH_Mesh;
+class TopoDS_Face;
+class SMESHDS_Mesh;
 
-class SMESH_Algo:
-  public SMESH_Hypothesis
+class SMESH_Algo:public SMESH_Hypothesis
 {
-public:
-  SMESH_Algo(int hypId, int studyId, SMESH_Gen* gen);
-  virtual ~SMESH_Algo();
+  public:
+       SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
+         virtual ~ SMESH_Algo();
 
-  const vector<string> & GetCompatibleHypothesis();
-  virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
-                              const TopoDS_Shape& aShape);
+       const std::vector < std::string > &GetCompatibleHypothesis();
+       virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
+                                     const TopoDS_Shape& aShape,
+                                     SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
 
-  virtual bool Compute(SMESH_Mesh& aMesh,
-                      const TopoDS_Shape& aShape);
+       virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
 
-  virtual const list<SMESHDS_Hypothesis*>&
-  GetUsedHypothesis(SMESH_Mesh& aMesh,
-                   const TopoDS_Shape& aShape);
+       virtual const std::list <const SMESHDS_Hypothesis *> &
+               GetUsedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
 
-  const list<SMESHDS_Hypothesis*>&
-  GetAppliedHypothesis(SMESH_Mesh& aMesh,
-                      const TopoDS_Shape& aShape);
+       const list <const SMESHDS_Hypothesis *> &
+               GetAppliedHypothesis(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape);
 
-  static double EdgeLength(const TopoDS_Edge& E);
+       static double EdgeLength(const TopoDS_Edge & E);
 
-  virtual ostream & SaveTo(ostream & save);
-  virtual istream & LoadFrom(istream & load);
-  friend ostream& operator << (ostream & save, SMESH_Algo & hyp);
-  friend istream& operator >> (istream & load, SMESH_Algo & hyp);
+  /*!
+   * \brief Find out elements orientation on a geometrical face
+   * \param theFace - The face correctly oriented in the shape being meshed
+   * \param theMeshDS - The mesh data structure
+   * \retval bool - true if the face normal and the normal of first element
+   *                in the correspoding submesh point in different directions
+   */
+  static bool IsReversedSubMesh (const TopoDS_Face&  theFace,
+                                 SMESHDS_Mesh*       theMeshDS);
 
-protected:
-  vector<string> _compatibleHypothesis;
-  list<SMESHDS_Hypothesis*> _appliedHypList;
-  list<SMESHDS_Hypothesis*> _usedHypList;
+ public:
+        // algo features
+
+        // SMESH_Hypothesis::GetDim();
+        // 1 - dimention of target mesh
+
+        bool OnlyUnaryInput() const { return _onlyUnaryInput; }
+        // 2 - is collection of tesselatable shapes inacceptable as input;
+        // "collection" means a shape containing shapes of dim equal
+        // to GetDim().
+        // Algo which can process a collection shape should expect
+        // an input temporary shape that is neither MainShape nor
+        // its child.
+        
+        bool NeedDescretBoundary() const { return _requireDescretBoundary; }
+        // 3 - is a Dim-1 mesh prerequisite
+
+ protected:
+        bool _onlyUnaryInput;
+        bool _requireDescretBoundary;
+        std::vector<std::string> _compatibleHypothesis;
+        std::list<const SMESHDS_Hypothesis *> _appliedHypList;
+        std::list<const SMESHDS_Hypothesis *> _usedHypList;
 };
 
 #endif