Salome HOME
Issue 0022816: duplicated files
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007  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, or (at your option) any later version.
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.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22
23 //  SMESH SMESH : implementaion of SMESH idl descriptions
24 //  File   : SMESH_Gen.hxx
25 //  Author : Paul RASCLE, EDF
26 //  Module : SMESH
27 //
28 #ifndef _SMESH_GEN_HXX_
29 #define _SMESH_GEN_HXX_
30
31 #include "SMESH_SMESH.hxx"
32
33 #include "Utils_SALOME_Exception.hxx"
34
35 #include "SMESH_Hypothesis.hxx"
36 #include "SMESH_ComputeError.hxx"
37 #include "SMESH_Algo.hxx"
38 #include "SMESH_Mesh.hxx"
39
40 #include <TopoDS_Shape.hxx>
41
42 #include <map>
43 #include <list>
44 #include <vector>
45 #include <string>
46
47 class SMESHDS_Document;
48
49 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
50
51 typedef struct studyContextStruct
52 {
53   std::map < int, SMESH_Hypothesis * >mapHypothesis;
54   std::map < int, SMESH_Mesh * >mapMesh;
55   SMESHDS_Document * myDocument;
56 } StudyContextStruct;
57
58 typedef std::set<int> TSetOfInt;
59
60 class SMESH_EXPORT  SMESH_Gen
61 {
62 public:
63   SMESH_Gen();
64   ~SMESH_Gen();
65
66   SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
67     throw(SALOME_Exception);
68
69   /*!
70    * \brief Computes aMesh on aShape 
71    *  \param aShapeOnly - if true, algo->OnlyUnaryInput() feature is ignored and
72    *                      only \a aShape is computed.
73    *  \param anUpward - compute from vertices up to more complex shape (internal usage)
74    *  \param aDim - upper level dimension of the mesh computation
75    *  \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
76    *  \retval bool - true if none submesh failed to compute
77    */
78   bool Compute(::SMESH_Mesh &        aMesh,
79                const TopoDS_Shape &  aShape,
80                const bool            aShapeOnly=false,
81                const bool            anUpward=false,
82                const ::MeshDimension aDim=::MeshDim_3D,
83                TSetOfInt*            aShapesId=0);
84
85   void PrepareCompute(::SMESH_Mesh &        aMesh,
86                       const TopoDS_Shape &  aShape);
87   void CancelCompute(::SMESH_Mesh &        aMesh,
88                      const TopoDS_Shape &  aShape);
89
90   const SMESH_subMesh* GetCurrentSubMesh() const { return _sm_current; }
91
92   /*!
93    * \brief evaluates size of prospective mesh on a shape 
94    * \param aMesh - the mesh
95    * \param aShape - the shape
96    * \param aResMap - map for prospective numbers of elements
97    * \retval bool - is a success
98    */
99   bool Evaluate(::SMESH_Mesh &        aMesh,
100                 const TopoDS_Shape &  aShape,
101                 MapShapeNbElems&      aResMap,
102                 const bool            anUpward=false,
103                 TSetOfInt*            aShapesId=0);
104
105   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
106   // notify on bad state of attached algos, return false
107   // if Compute() would fail because of some algo bad state
108
109   /*!
110    * \brief Sets number of segments per diagonal of boundary box of geometry by which
111    *        default segment length of appropriate 1D hypotheses is defined
112    */
113   void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
114   int  GetBoundaryBoxSegmentation() const { return _segmentation; }
115   /*!
116    * \brief Sets default number of segments per edge
117    */
118   void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
119   int GetDefaultNbSegments() const { return _nbSegments; }
120
121   struct TAlgoStateError
122   {
123     TAlgoStateErrorName _name;
124     const SMESH_Algo*   _algo;
125     int                 _algoDim;
126     bool                _isGlobalAlgo;
127
128     TAlgoStateError(): _algoDim(0),_algo(0),_name(SMESH_Hypothesis::HYP_OK) {}
129     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
130     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
131     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
132     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
133   };
134
135   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
136                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
137   // notify on bad state of attached algos, return false
138   // if Compute() would fail because of some algo bad state
139   // theErrors list contains problems description
140
141   StudyContextStruct *GetStudyContext(int studyId);
142
143   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
144   static int GetShapeDim(const TopoDS_Shape & aShape)
145   { return GetShapeDim( aShape.ShapeType() ); }
146
147   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
148   SMESH_Algo* GetAlgo(SMESH_subMesh * aSubMesh, TopoDS_Shape* assignedTo=0);
149
150   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
151
152   static std::vector< std::string > GetPluginXMLPaths();
153
154   int GetANewId();
155
156   // std::map < int, SMESH_Algo * >_mapAlgo;
157   // std::map < int, SMESH_0D_Algo * >_map0D_Algo;
158   // std::map < int, SMESH_1D_Algo * >_map1D_Algo;
159   // std::map < int, SMESH_2D_Algo * >_map2D_Algo;
160   // std::map < int, SMESH_3D_Algo * >_map3D_Algo;
161
162 private:
163
164   int _localId;                         // unique Id of created objects, within SMESH_Gen entity
165   std::map < int, StudyContextStruct * >_mapStudyContext;
166
167   // hypotheses managing
168   int _hypId;
169
170   // number of segments per diagonal of boundary box of geometry by which
171   // default segment length of appropriate 1D hypotheses is defined
172   int _segmentation;
173   // default number of segments
174   int _nbSegments;
175
176   volatile bool  _compute_canceled;
177   SMESH_subMesh* _sm_current;
178 };
179
180 #endif