Salome HOME
Update of CheckDone
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
index 891cd876c3297fa9c3481786b5a2a19a9f0c2904..275bc06dfbc97e4df817d035ae22443bd6764e98 100644 (file)
-//  SMESH SMESH : implementaion of SMESH idl descriptions
+// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
 //
-//  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 
+// Copyright (C) 2003-2007  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, or (at your option) any later version.
 //
+// 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 : implementation 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_Algo.hxx"
-#include "SMESH_1D_Algo.hxx"
-#include "SMESH_2D_Algo.hxx"
-#include "SMESH_3D_Algo.hxx"
-#include "SMESH_Mesh.hxx"
+#include "SMESH_ComputeError.hxx"
+#include "SMESH_subMesh.hxx"
+
+#include <map>
+#include <list>
+#include <set>
+#include <vector>
+#include <string>
 
-#include "SMESHDS_Document.hxx"
 
 #include <TopoDS_Shape.hxx>
+#include <TopTools_IndexedMapOfShape.hxx>
 
-#include <map>
+class SMESHDS_Document;
+class SMESH_Algo;
+class SMESH_Mesh;
+class SMESH_ParallelMesh;
+class TopoDS_Shape;
+
+
+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;
 
-class SMESH_Gen
+typedef std::set<int> TSetOfInt;
+
+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);
+  SMESH_Mesh* CreateMesh(bool theIsEmbeddedMode);
+  SMESH_ParallelMesh* CreateParallelMesh(bool theIsEmbeddedMode);
+
+  enum ComputeFlags
+  {
+    SHAPE_ONLY        = 1, // to ignore algo->OnlyUnaryInput() feature and to compute a given shape only.
+    UPWARD            = 2, // to compute from vertices up to more complex shape (internal usage)
+    COMPACT_MESH      = 4, // to compact the mesh at the end
+    SHAPE_ONLY_UPWARD = 3  // SHAPE_ONLY | UPWARD
+  };
+  /*!
+   * \brief Computes aMesh on aShape
+   *  \param aMesh - the mesh.
+   *  \param aShape - the shape.
+   *  \param aFlags - ComputeFlags. By default compute the whole mesh and compact at the end.
+   *  \param aDim - upper level dimension of the mesh computation (for preview)
+   *  \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
+   *  \param anAllowedSubShapes - shapes to mesh only. Mesh all if empty or nullptr
+   *  \retval bool - true if none sub-mesh failed to compute
+   */
+  bool Compute(::SMESH_Mesh &              aMesh,
+               const TopoDS_Shape &        aShape,
+               const int                   aFlags = COMPACT_MESH,
+               const ::MeshDimension       aDim=::MeshDim_3D,
+               TSetOfInt*                  aShapesId=0,
+               TopTools_IndexedMapOfShape* anAllowedSubShapes=0);
+
+  void PrepareCompute(::SMESH_Mesh &        aMesh,
+                      const TopoDS_Shape &  aShape);
+  void CancelCompute(::SMESH_Mesh &        aMesh,
+                     const TopoDS_Shape &  aShape);
+
+  const SMESH_subMesh* GetCurrentSubMesh() const;
+
+  /*!
+   * \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(): _name(SMESH_Hypothesis::HYP_OK), _algo(0), _algoDim(0) {}
+    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();
+
+  static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
+  static int GetShapeDim(const TopoDS_Shape &     aShape)
+  { return GetShapeDim( aShape.ShapeType() ); }
+  static int GetFlatShapeDim(const TopoDS_Shape &aShape);
+
+  SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
+  SMESH_Algo* GetAlgo(SMESH_subMesh * aSubMesh, TopoDS_Shape* assignedTo=0);
+
+  static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
+
+  static std::vector< std::string > GetPluginXMLPaths();
+
+  int GetANewId();
+
+public:
+  void send_mesh(SMESH_Mesh & aMesh, std::string filename);
+
+  bool parallelComputeSubMeshes(
+          SMESH_Mesh & aMesh,
+          const TopoDS_Shape & aShape,
+          const ::MeshDimension       aDim,
+          TSetOfInt*                  aShapesId,
+          TopTools_IndexedMapOfShape* allowedSubShapes,
+          SMESH_subMesh::compute_event &computeEvent,
+          const bool includeSelf,
+          const bool complexShapeFirst,
+          const bool   aShapeOnly);
+
+  bool sequentialComputeSubMeshes(
+          SMESH_Mesh & aMesh,
+          const TopoDS_Shape & aShape,
+          const ::MeshDimension       aDim,
+          TSetOfInt*                  aShapesId /*=0*/,
+          TopTools_IndexedMapOfShape* allowedSubShapes,
+          SMESH_subMesh::compute_event &computeEvent,
+          const bool includeSelf,
+          const bool complexShapeFirst,
+          const bool aShapeOnly);
+
+private:
 
-  static int GetShapeDim(const TopoDS_Shape& aShape);
-  SMESH_Algo* GetAlgo(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
 
-  // inherited methods from SALOMEDS::Driver
 
-  void Save(int studyId, const char *aUrlOfFile);
-  void Load(int studyId, const char *aUrlOfFile); 
-  void Close(int studyId); 
-  const char* ComponentDataType();
+  int _localId;                         // unique Id of created objects, within SMESH_Gen entity
+  StudyContextStruct* _studyContext;
 
-  const char* IORToLocalPersistentID(const char* IORString, bool& IsAFile);
-  const char* LocalPersistentIDToIOR(const char* aLocalPersistentID);
+  // hypotheses managing
+  int _hypId;
 
-  SMESH_HypothesisFactory _hypothesisFactory;
+  // number of segments per diagonal of boundary box of geometry by which
+  // default segment length of appropriate 1D hypotheses is defined
+  int _segmentation;
+  // default number of segments
+  int _nbSegments;
 
-  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;
+  void setCurrentSubMesh(SMESH_subMesh* sm);
+  void resetCurrentSubMesh();
 
-private:
-  int _localId; // unique Id of created objects, within SMESH_Gen entity
-  map<int, StudyContextStruct*> _mapStudyContext;
-  map<int, SMESH_Hypothesis*> _mapHypothesis;
+  volatile bool               _compute_canceled;
+  std::list< SMESH_subMesh* > _sm_current;
 };
 
 #endif