Salome HOME
Merge from BR_phase16 branch (09/12/09)
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
index 891cd876c3297fa9c3481786b5a2a19a9f0c2904..b26a2047d6304d2eceaa3691f45a4efc62bdf4fd 100644 (file)
-//  SMESH SMESH : implementaion of SMESH idl descriptions
+//  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+//  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
 //
-//  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 
+//  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.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+//  SMESH SMESH : implementaion of SMESH idl descriptions
 //  File   : SMESH_Gen.hxx
 //  Author : Paul RASCLE, EDF
 //  Module : SMESH
-//  $Header$
+//
 
 #ifndef _SMESH_GEN_HXX_
 #define _SMESH_GEN_HXX_
 
+#include "SMESH_SMESH.hxx"
+
 #include "Utils_SALOME_Exception.hxx"
 
-#include "SMESH_HypothesisFactory.hxx"
 #include "SMESH_Hypothesis.hxx"
+#include "SMESH_ComputeError.hxx"
 #include "SMESH_Algo.hxx"
+#include "SMESH_0D_Algo.hxx"
 #include "SMESH_1D_Algo.hxx"
 #include "SMESH_2D_Algo.hxx"
 #include "SMESH_3D_Algo.hxx"
 #include "SMESH_Mesh.hxx"
 
-#include "SMESHDS_Document.hxx"
-
 #include <TopoDS_Shape.hxx>
 
 #include <map>
+#include <list>
+
+class SMESHDS_Document;
+
+typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
 
 typedef struct studyContextStruct
 {
-  map<int, SMESH_Hypothesis*> mapHypothesis;
-  map<int, SMESH_Mesh*> mapMesh;
-  Handle (SMESHDS_Document) myDocument;
-} StudyContextStruct ;
+  std::map < int, SMESH_Hypothesis * >mapHypothesis;
+  std::map < int, SMESH_Mesh * >mapMesh;
+  SMESHDS_Document * myDocument;
+} StudyContextStruct;
+
+typedef std::set<int> TSetOfInt;
 
-class SMESH_Gen
+class SMESH_EXPORT  SMESH_Gen
 {
 public:
   SMESH_Gen();
   ~SMESH_Gen();
 
-  SMESH_Hypothesis* CreateHypothesis(const char* anHyp, int studyId)
-    throw (SALOME_Exception);
-  SMESH_Mesh* Init(int studyId, const TopoDS_Shape& aShape)
-    throw (SALOME_Exception);
-  bool Compute(::SMESH_Mesh& aMesh, const TopoDS_Shape& aShape)
-    throw (SALOME_Exception);
-  StudyContextStruct* GetStudyContext(int studyId);
-
-  static int GetShapeDim(const TopoDS_Shape& aShape);
-  SMESH_Algo* GetAlgo(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
-
-  // inherited methods from SALOMEDS::Driver
+  SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
+    throw(SALOME_Exception);
+
+  /*!
+   * \brief Computes aMesh on aShape 
+   *  \param anUpward - compute from vertices up to more complex shape (internal usage)
+   *  \param aDim - upper level dimension of the mesh computation
+   *  \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
+   *  \retval bool - true if none submesh failed to compute
+   */
+  bool Compute(::SMESH_Mesh &        aMesh,
+               const TopoDS_Shape &  aShape,
+               const bool            anUpward=false,
+               const ::MeshDimension aDim=::MeshDim_3D,
+               TSetOfInt*            aShapesId=0);
+
+  /*!
+   * \brief evaluates size of prospective mesh on a shape 
+   * \param aMesh - the mesh
+   * \param aShape - the shape
+   * \param aResMap - map for prospective numbers of elements
+   * \retval bool - is a success
+   */
+  bool Evaluate(::SMESH_Mesh &        aMesh,
+                const TopoDS_Shape &  aShape,
+                MapShapeNbElems&      aResMap,
+                const bool            anUpward=false,
+                TSetOfInt*            aShapesId=0);
+
+  bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
+  // notify on bad state of attached algos, return false
+  // if Compute() would fail because of some algo bad state
+
+  /*!
+   * \brief Sets number of segments per diagonal of boundary box of geometry by which
+   *        default segment length of appropriate 1D hypotheses is defined
+   */
+  void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
+  int  GetBoundaryBoxSegmentation() const { return _segmentation; }
+  /*!
+   * \brief Sets default number of segments per edge
+   */
+  void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
+  int GetDefaultNbSegments() const { return _nbSegments; }
+
+  struct TAlgoStateError
+  {
+    TAlgoStateErrorName _name;
+    const SMESH_Algo*   _algo;
+    int                 _algoDim;
+    bool                _isGlobalAlgo;
+
+    TAlgoStateError(): _algoDim(0),_algo(0),_name(SMESH_Hypothesis::HYP_OK) {}
+    void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
+    { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
+    void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
+    { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
+  };
+
+  bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
+                    std::list< SMESH_Gen::TAlgoStateError > & theErrors);
+  // notify on bad state of attached algos, return false
+  // if Compute() would fail because of some algo bad state
+  // theErrors list contains problems description
+
+  StudyContextStruct *GetStudyContext(int studyId);
+
+  static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
+  static int GetShapeDim(const TopoDS_Shape & aShape)
+  { return GetShapeDim( aShape.ShapeType() ); }
+  SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
+  static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
+
+  int GetANewId();
+
+  std::map < int, SMESH_Algo * >_mapAlgo;
+  std::map < int, SMESH_0D_Algo * >_map0D_Algo;
+  std::map < int, SMESH_1D_Algo * >_map1D_Algo;
+  std::map < int, SMESH_2D_Algo * >_map2D_Algo;
+  std::map < int, SMESH_3D_Algo * >_map3D_Algo;
 
-  void Save(int studyId, const char *aUrlOfFile);
-  void Load(int studyId, const char *aUrlOfFile); 
-  void Close(int studyId); 
-  const char* ComponentDataType();
-
-  const char* IORToLocalPersistentID(const char* IORString, bool& IsAFile);
-  const char* LocalPersistentIDToIOR(const char* aLocalPersistentID);
+private:
 
-  SMESH_HypothesisFactory _hypothesisFactory;
+  int _localId;                                // unique Id of created objects, within SMESH_Gen entity
+  std::map < int, StudyContextStruct * >_mapStudyContext;
 
-  map<int, SMESH_Algo*> _mapAlgo;
-  map<int, SMESH_1D_Algo*> _map1D_Algo;
-  map<int, SMESH_2D_Algo*> _map2D_Algo;
-  map<int, SMESH_3D_Algo*> _map3D_Algo;
+  // hypotheses managing
+  int _hypId;
 
-private:
-  int _localId; // unique Id of created objects, within SMESH_Gen entity
-  map<int, StudyContextStruct*> _mapStudyContext;
-  map<int, SMESH_Hypothesis*> _mapHypothesis;
+  // number of segments per diagonal of boundary box of geometry by which
+  // default segment length of appropriate 1D hypotheses is defined
+  int _segmentation;
+  // default of segments
+  int _nbSegments;
 };
 
 #endif