Salome HOME
Merge from V6_main_20120808 08Aug12
[plugins/hybridplugin.git] / src / GHS3DPlugin / GHS3DPlugin_Hypothesis.hxx
1 // Copyright (C) 2004-2012  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 //  GHS3DPlugin : C++ implementation
21 // File      : GHS3DPlugin_Hypothesis.hxx
22 // Created   : Wed Apr  2 12:21:17 2008
23 // Author    : Edward AGAPOV (eap)
24 //
25 #ifndef GHS3DPlugin_Hypothesis_HeaderFile
26 #define GHS3DPlugin_Hypothesis_HeaderFile
27
28 #include "GHS3DPlugin_Defs.hxx"
29
30 #include <SMDS_MeshNode.hxx>
31
32 #include "SMESH_Hypothesis.hxx"
33 #include "SMESH_Mesh_i.hxx"
34 #include "SMESH_Gen_i.hxx"
35 #include "SMESH_TypeDefs.hxx"
36 #include "utilities.h"
37
38 #include <stdexcept>
39 #include <map>
40 #include <vector>
41 #include <cstdio>
42
43 class GHS3DPLUGIN_EXPORT GHS3DPlugin_Hypothesis: public SMESH_Hypothesis
44 {
45 public:
46
47   GHS3DPlugin_Hypothesis(int hypId, int studyId, SMESH_Gen * gen);
48
49   typedef std::map<std::vector<double>,double> TGHS3DEnforcedVertexCoordsValues;
50   typedef std::map<std::string,double> TGHS3DEnforcedVertexEntryValues;
51   
52   struct TGHS3DEnforcedVertex {
53     std::string name;
54     std::string geomEntry;
55     bool isCompound;
56     std::vector<double> coords;
57     std::string groupName;
58     double size;
59   };
60   
61   struct CompareGHS3DEnforcedVertex {
62     bool operator () (const TGHS3DEnforcedVertex* e1, const TGHS3DEnforcedVertex* e2) const {
63       if (e1 && e2) {
64         if (e1->coords.size() && e2->coords.size())
65           return (e1->coords < e2->coords);
66         else
67           return (e1->geomEntry < e2->geomEntry);
68       }
69       return false;
70     }
71   };
72   typedef std::set< TGHS3DEnforcedVertex*, CompareGHS3DEnforcedVertex > TGHS3DEnforcedVertexList;
73   // Map Coords / Enforced node
74   typedef std::map< std::vector<double>, TGHS3DEnforcedVertex* > TCoordsGHS3DEnforcedVertexMap;
75   // Map geom entry / Enforced node
76   typedef std::map< std::string, TGHS3DEnforcedVertex* > TGeomEntryGHS3DEnforcedVertexMap;
77   // Map groupName / Enforced node
78   typedef std::map< std::string, TGHS3DEnforcedVertexList > TGroupNameGHS3DEnforcedVertexMap;
79   
80   ////////////////////
81   // Enforced meshes
82   ////////////////////
83   
84   struct TGHS3DEnforcedMesh {
85     std::string name;
86     std::string entry;
87     SMESH::ElementType elementType;
88     std::string groupName;
89     double size;
90   };
91   
92   struct CompareGHS3DEnforcedMesh {
93     bool operator () (const TGHS3DEnforcedMesh* e1, const TGHS3DEnforcedMesh* e2) const {
94       if (e1 && e2) {
95         if (e1->entry == e2->entry)
96           return (e1->elementType < e2->elementType);
97         else
98           return (e1->entry < e2->entry);
99       }
100       else
101         return false;
102     }
103   };
104   typedef std::set< TGHS3DEnforcedMesh*, CompareGHS3DEnforcedMesh > TGHS3DEnforcedMeshList;
105   // Map mesh entry / Enforced mesh list
106   // ex: 0:1:2:1 -> [ ("Mesh_1", "0:1:2:1", TopAbs_NODE, "", -1),
107   //                  ("Mesh_1", "0:1:2:1", TopAbs_EDGE, "edge group", 5)]
108   typedef std::map< std::string, TGHS3DEnforcedMeshList > TEntryGHS3DEnforcedMeshListMap;
109   
110   typedef std::map<int,double> TID2SizeMap;
111   
112   typedef std::map<const SMDS_MeshElement*, std::string, TIDCompare > TIDSortedElemGroupMap;
113   typedef std::map<const SMDS_MeshNode*, std::string, TIDCompare > TIDSortedNodeGroupMap;
114   typedef std::set<std::string> TSetStrings;
115
116   static const char* GetHypType() { return "GHS3D_Parameters"; }
117   /*!
118    * To mesh "holes" in a solid or not. Default is to mesh.
119    */
120   void SetToMeshHoles(bool toMesh);
121   bool GetToMeshHoles(bool checkFreeOption = false) const;
122   /*!
123    * Maximal size of memory to be used by the algorithm (in Megabytes)
124    */
125   void SetMaximumMemory(short MB);
126   short GetMaximumMemory() const;
127   /*!
128    * Initial size of memory to be used by the algorithm (in Megabytes) in
129    * automatic memory adjustment mode. Default is zero
130    */
131   void SetInitialMemory(short MB);
132   short GetInitialMemory() const;
133   /*!
134    * Optimization level: 0-none, 1-light, 2-medium, 3-standard+, 4-strong. Default is medium
135    */
136   enum OptimizationLevel { None = 0, Light, Medium, StandardPlus, Strong };
137   void SetOptimizationLevel(OptimizationLevel level);
138   OptimizationLevel GetOptimizationLevel() const;
139   /*!
140    * Path to working directory
141    */
142   void SetWorkingDirectory(const std::string& path);
143   std::string GetWorkingDirectory() const;
144   /*!
145    * To keep working files or remove them. Log file remains in case of errors anyway.
146    */
147   void SetKeepFiles(bool toKeep);
148   bool GetKeepFiles() const;
149   /*!
150    * Verbose level [0-10]
151    *  0 - no standard output,
152    *  2 - prints the data, quality statistics of the skin and final meshes and
153    *     indicates when the final mesh is being saved. In addition the software
154    *     gives indication regarding the CPU time.
155    * 10 - same as 2 plus the main steps in the computation, quality statistics
156    *     histogram of the skin mesh, quality statistics histogram together with
157    *     the characteristics of the final mesh.
158    */
159   void SetVerboseLevel(short level);
160   short GetVerboseLevel() const;
161   /*!
162    * To create new nodes
163    */
164   void SetToCreateNewNodes(bool toCreate);
165   bool GetToCreateNewNodes() const;
166   /*!
167    * To use boundary recovery version which tries to create mesh on a very poor
168    * quality surface mesh
169    */
170   void SetToUseBoundaryRecoveryVersion(bool toUse);
171   bool GetToUseBoundaryRecoveryVersion() const;
172   /*!
173    * Applies finite-element correction by replacing overconstrained elements where
174    * it is possible. The process is cutting first the overconstrained edges and
175    * second the overconstrained facets. This insure that no edges have two boundary
176    * vertices and that no facets have three boundary vertices.
177    */
178   void SetFEMCorrection(bool toUseFem);
179   bool GetFEMCorrection() const;
180   /*!
181    * To removes initial central point.
182    */
183   void SetToRemoveCentralPoint(bool toRemove);
184   bool GetToRemoveCentralPoint() const;
185   /*!
186    * To set hiden/undocumented/advanced options
187    */
188   void SetTextOption(const std::string& option);
189   std::string GetTextOption() const;
190     
191   
192 //   struct TEnforcedEdge {
193 //     long ID;
194 //     long node1;
195 //     long node2;
196 //     std::string groupName;
197 //   };
198   
199
200   /*!
201    * \brief Return command to run ghs3d mesher excluding file prefix (-f)
202    */
203   static std::string CommandToRun(const GHS3DPlugin_Hypothesis* hyp,
204                                   const bool                    hasShapeToMesh=true);
205   /*!
206    * \brief Return a unique file name
207    */
208   static std::string GetFileName(const GHS3DPlugin_Hypothesis* hyp);
209
210   /*!
211    * To set an enforced vertex
212    */
213   bool SetEnforcedVertex(std::string aName, std::string anEntry, std::string aGroupName,
214                          double size, double x=0.0, double y=0.0, double z=0.0, bool isCompound = false);
215   TGHS3DEnforcedVertex* GetEnforcedVertex(double x, double y, double z) throw (std::invalid_argument);
216   TGHS3DEnforcedVertex* GetEnforcedVertex(const std::string anEntry) throw (std::invalid_argument);
217   bool RemoveEnforcedVertex(double x=0.0, double y=0.0, double z=0.0, const std::string anEntry="" ) throw (std::invalid_argument);
218   const TGHS3DEnforcedVertexCoordsValues _GetEnforcedVerticesCoordsSize() const {return _enfVertexCoordsSizeList; }
219   const TGHS3DEnforcedVertexEntryValues  _GetEnforcedVerticesEntrySize() const {return _enfVertexEntrySizeList; }
220   const TGHS3DEnforcedVertexList         _GetEnforcedVertices() const { return _enfVertexList; }
221   const TCoordsGHS3DEnforcedVertexMap    _GetEnforcedVerticesByCoords() const { return _coordsEnfVertexMap; }
222   const TGeomEntryGHS3DEnforcedVertexMap _GetEnforcedVerticesByEntry() const { return _geomEntryEnfVertexMap; }
223   void ClearEnforcedVertices();
224
225   /*!
226    * To set enforced elements
227    */
228   bool SetEnforcedMesh(SMESH_Mesh& theMesh, SMESH::ElementType elementType, std::string name, std::string entry, double size, std::string groupName = "");
229   bool SetEnforcedGroup(const SMESHDS_Mesh* theMeshDS, SMESH::long_array_var theIDs, SMESH::ElementType elementType, std::string name, std::string entry, double size, std::string groupName = "");
230   bool SetEnforcedElements(TIDSortedElemSet theElemSet, SMESH::ElementType elementType, double size, std::string groupName = "");
231   const TGHS3DEnforcedMeshList _GetEnforcedMeshes() const { return _enfMeshList; }
232   const TEntryGHS3DEnforcedMeshListMap _GetEnforcedMeshesByEntry() const { return _entryEnfMeshMap; }
233   void ClearEnforcedMeshes();
234   const TIDSortedNodeGroupMap _GetEnforcedNodes() const { return _enfNodes; }
235   const TIDSortedElemGroupMap _GetEnforcedEdges() const { return _enfEdges; }
236   const TIDSortedElemGroupMap _GetEnforcedTriangles() const { return _enfTriangles; }
237   const TID2SizeMap _GetNodeIDToSizeMap() const {return _nodeIDToSizeMap; }
238   const TID2SizeMap _GetElementIDToSizeMap() const {return _elementIDToSizeMap; }
239   const TSetStrings _GetGroupsToRemove() const {return _groupsToRemove; }
240   /*!
241    * \brief Return the enforced vertices
242    */
243   static TGHS3DEnforcedVertexList GetEnforcedVertices(const GHS3DPlugin_Hypothesis* hyp);
244   static TGHS3DEnforcedVertexCoordsValues GetEnforcedVerticesCoordsSize(const GHS3DPlugin_Hypothesis* hyp);
245   static TGHS3DEnforcedVertexEntryValues  GetEnforcedVerticesEntrySize(const GHS3DPlugin_Hypothesis* hyp);
246   static TCoordsGHS3DEnforcedVertexMap GetEnforcedVerticesByCoords(const GHS3DPlugin_Hypothesis* hyp);
247   static TGeomEntryGHS3DEnforcedVertexMap GetEnforcedVerticesByEntry(const GHS3DPlugin_Hypothesis* hyp);
248   
249   static TGHS3DEnforcedMeshList GetEnforcedMeshes(const GHS3DPlugin_Hypothesis* hyp);
250   static TEntryGHS3DEnforcedMeshListMap GetEnforcedMeshesByEntry(const GHS3DPlugin_Hypothesis* hyp);
251   static TIDSortedNodeGroupMap GetEnforcedNodes(const GHS3DPlugin_Hypothesis* hyp);
252   static TIDSortedElemGroupMap GetEnforcedEdges(const GHS3DPlugin_Hypothesis* hyp);
253   static TIDSortedElemGroupMap GetEnforcedTriangles(const GHS3DPlugin_Hypothesis* hyp);
254   static TID2SizeMap GetNodeIDToSizeMap(const GHS3DPlugin_Hypothesis* hyp);
255   static TID2SizeMap GetElementIDToSizeMap(const GHS3DPlugin_Hypothesis* hyp);
256   static TSetStrings GetGroupsToRemove(const GHS3DPlugin_Hypothesis* hyp);
257   void ClearGroupsToRemove();
258   
259   static bool   DefaultMeshHoles();
260   static short  DefaultMaximumMemory();
261   static short  DefaultInitialMemory();
262   static short  DefaultOptimizationLevel();
263   static std::string DefaultWorkingDirectory();
264   static bool   DefaultKeepFiles();
265   static short  DefaultVerboseLevel();
266   static bool   DefaultToCreateNewNodes();
267   static bool   DefaultToUseBoundaryRecoveryVersion();
268   static bool   DefaultToUseFEMCorrection();
269   static bool   DefaultToRemoveCentralPoint();
270   
271   static TGHS3DEnforcedVertex DefaultGHS3DEnforcedVertex() {return TGHS3DEnforcedVertex();}
272   static TGHS3DEnforcedVertexList DefaultGHS3DEnforcedVertexList() {return TGHS3DEnforcedVertexList();}
273   static TGHS3DEnforcedVertexCoordsValues DefaultGHS3DEnforcedVertexCoordsValues() {return TGHS3DEnforcedVertexCoordsValues();}
274   static TGHS3DEnforcedVertexEntryValues DefaultGHS3DEnforcedVertexEntryValues() {return TGHS3DEnforcedVertexEntryValues();}
275   static TCoordsGHS3DEnforcedVertexMap DefaultCoordsGHS3DEnforcedVertexMap() {return TCoordsGHS3DEnforcedVertexMap();}
276   static TGeomEntryGHS3DEnforcedVertexMap DefaultGeomEntryGHS3DEnforcedVertexMap() {return TGeomEntryGHS3DEnforcedVertexMap();}
277   static TGroupNameGHS3DEnforcedVertexMap DefaultGroupNameGHS3DEnforcedVertexMap() {return TGroupNameGHS3DEnforcedVertexMap();}
278   
279   static TGHS3DEnforcedMesh         DefaultGHS3DEnforcedMesh() {return TGHS3DEnforcedMesh();}
280   static TGHS3DEnforcedMeshList     DefaultGHS3DEnforcedMeshList() {return TGHS3DEnforcedMeshList();}
281   static TEntryGHS3DEnforcedMeshListMap DefaultEntryGHS3DEnforcedMeshListMap() {return TEntryGHS3DEnforcedMeshListMap();}
282   static TIDSortedNodeGroupMap      DefaultIDSortedNodeGroupMap() {return TIDSortedNodeGroupMap();}
283   static TIDSortedElemGroupMap      DefaultIDSortedElemGroupMap() {return TIDSortedElemGroupMap();}
284   static TID2SizeMap                DefaultID2SizeMap() {return TID2SizeMap();}
285   static TSetStrings                DefaultGroupsToRemove() {return TSetStrings();}
286   
287   // Persistence
288   virtual std::ostream & SaveTo(std::ostream & save);
289   virtual std::istream & LoadFrom(std::istream & load);
290   friend GHS3DPLUGIN_EXPORT std::ostream & operator <<(std::ostream & save, GHS3DPlugin_Hypothesis & hyp);
291   friend GHS3DPLUGIN_EXPORT std::istream & operator >>(std::istream & load, GHS3DPlugin_Hypothesis & hyp);
292
293   /*!
294    * \brief Does nothing
295    */
296   virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
297
298   /*!
299    * \brief Does nothing
300    */
301   virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
302
303 private:
304
305   bool   myToMeshHoles;
306   short  myMaximumMemory;
307   short  myInitialMemory;
308   short  myOptimizationLevel;
309   bool   myKeepFiles;
310   std::string myWorkingDirectory;
311   short  myVerboseLevel;
312   bool   myToCreateNewNodes;
313   bool   myToUseBoundaryRecoveryVersion;
314   bool   myToUseFemCorrection;
315   bool   myToRemoveCentralPoint;
316   std::string myTextOption;
317   
318   TGHS3DEnforcedVertexList _enfVertexList;
319   TGHS3DEnforcedVertexCoordsValues _enfVertexCoordsSizeList;
320   TGHS3DEnforcedVertexEntryValues _enfVertexEntrySizeList;
321   // map to get "manual" enf vertex (through the coordinates)
322   TCoordsGHS3DEnforcedVertexMap _coordsEnfVertexMap;
323   // map to get "geom" enf vertex (through the geom entries)
324   TGeomEntryGHS3DEnforcedVertexMap _geomEntryEnfVertexMap;
325   
326   
327   TGHS3DEnforcedMeshList _enfMeshList;
328   // map to get enf meshes through the entries
329   TEntryGHS3DEnforcedMeshListMap _entryEnfMeshMap;
330   TIDSortedNodeGroupMap _enfNodes;
331   TIDSortedElemGroupMap _enfEdges;
332   TIDSortedElemGroupMap _enfTriangles;
333   TID2SizeMap _nodeIDToSizeMap;
334   TID2SizeMap _elementIDToSizeMap;
335   std::map<std::string, TIDSortedElemSet > _entryToElemsMap;
336   
337   TSetStrings _groupsToRemove;
338 };
339
340
341 #endif