]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMESH/SMESH_Gen.hxx
Salome HOME
fix indentation
[modules/smesh.git] / src / SMESH / SMESH_Gen.hxx
1 //  Copyright (C) 2007-2008  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.
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 //  SMESH SMESH : implementaion of SMESH idl descriptions
23 //  File   : SMESH_Gen.hxx
24 //  Author : Paul RASCLE, EDF
25 //  Module : SMESH
26 //
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_0D_Algo.hxx"
39 #include "SMESH_1D_Algo.hxx"
40 #include "SMESH_2D_Algo.hxx"
41 #include "SMESH_3D_Algo.hxx"
42 #include "SMESH_Mesh.hxx"
43
44 #include <TopoDS_Shape.hxx>
45
46 #include <map>
47 #include <list>
48
49 class SMESHDS_Document;
50
51 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
52
53 typedef struct studyContextStruct
54 {
55   std::map < int, SMESH_Hypothesis * >mapHypothesis;
56   std::map < int, SMESH_Mesh * >mapMesh;
57   SMESHDS_Document * myDocument;
58 } StudyContextStruct;
59
60 typedef std::set<int> TSetOfInt;
61
62 class SMESH_EXPORT  SMESH_Gen
63 {
64 public:
65   SMESH_Gen();
66   ~SMESH_Gen();
67
68   SMESH_Mesh* CreateMesh(int theStudyId, bool theIsEmbeddedMode)
69     throw(SALOME_Exception);
70
71   /*!
72    * \brief Computes aMesh on aShape 
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            anUpward=false,
81                const ::MeshDimension aDim=::MeshDim_3D,
82                TSetOfInt*            aShapesId=0);
83
84   /*!
85    * \brief evaluates size of prospective mesh on a shape 
86    * \param aMesh - the mesh
87    * \param aShape - the shape
88    * \param aResMap - map for prospective numbers of elements
89    * \retval bool - is a success
90    */
91   bool Evaluate(::SMESH_Mesh &        aMesh,
92                 const TopoDS_Shape &  aShape,
93                 MapShapeNbElems&      aResMap,
94                 const bool            anUpward=false,
95                 TSetOfInt*            aShapesId=0);
96
97   bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
98   // notify on bad state of attached algos, return false
99   // if Compute() would fail because of some algo bad state
100
101   /*!
102    * \brief Sets number of segments per diagonal of boundary box of geometry by which
103    *        default segment length of appropriate 1D hypotheses is defined
104    */
105   void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
106   int  GetBoundaryBoxSegmentation() const { return _segmentation; }
107   /*!
108    * \brief Sets default number of segments per edge
109    */
110   void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
111   int GetDefaultNbSegments() const { return _nbSegments; }
112
113   struct TAlgoStateError
114   {
115     TAlgoStateErrorName _name;
116     const SMESH_Algo*   _algo;
117     int                 _algoDim;
118     bool                _isGlobalAlgo;
119
120     TAlgoStateError(): _algoDim(0),_algo(0),_name(SMESH_Hypothesis::HYP_OK) {}
121     void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
122     { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
123     void Set(TAlgoStateErrorName name, const int algoDim,      bool isGlobal)
124     { _name = name; _algo = 0;    _algoDim = algoDim;        _isGlobalAlgo = isGlobal; }
125   };
126
127   bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
128                     std::list< SMESH_Gen::TAlgoStateError > & theErrors);
129   // notify on bad state of attached algos, return false
130   // if Compute() would fail because of some algo bad state
131   // theErrors list contains problems description
132
133   StudyContextStruct *GetStudyContext(int studyId);
134
135   static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
136   static int GetShapeDim(const TopoDS_Shape & aShape)
137   { return GetShapeDim( aShape.ShapeType() ); }
138   SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
139   static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
140
141   int GetANewId();
142
143   std::map < int, SMESH_Algo * >_mapAlgo;
144   std::map < int, SMESH_0D_Algo * >_map0D_Algo;
145   std::map < int, SMESH_1D_Algo * >_map1D_Algo;
146   std::map < int, SMESH_2D_Algo * >_map2D_Algo;
147   std::map < int, SMESH_3D_Algo * >_map3D_Algo;
148
149 private:
150
151   int _localId;                     // unique Id of created objects, within SMESH_Gen entity
152   std::map < int, StudyContextStruct * >_mapStudyContext;
153
154   // hypotheses managing
155   int _hypId;
156
157   // number of segments per diagonal of boundary box of geometry by which
158   // default segment length of appropriate 1D hypotheses is defined
159   int _segmentation;
160   // default of segments
161   int _nbSegments;
162 };
163
164 #endif