1 // Copyright (C) 2004-2012 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 // GHS3DPlugin : C++ implementation
21 // File : GHS3DPlugin_Hypothesis.hxx
22 // Created : Wed Apr 2 12:21:17 2008
23 // Author : Edward AGAPOV (eap)
25 #ifndef GHS3DPlugin_Hypothesis_HeaderFile
26 #define GHS3DPlugin_Hypothesis_HeaderFile
28 #include "GHS3DPlugin_Defs.hxx"
30 #include <SMDS_MeshNode.hxx>
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"
43 class GHS3DPLUGIN_EXPORT GHS3DPlugin_Hypothesis: public SMESH_Hypothesis
47 GHS3DPlugin_Hypothesis(int hypId, int studyId, SMESH_Gen * gen);
49 typedef std::map<std::vector<double>,double> TGHS3DEnforcedVertexCoordsValues;
50 typedef std::map<std::string,double> TGHS3DEnforcedVertexEntryValues;
52 struct TGHS3DEnforcedVertex {
54 std::string geomEntry;
56 std::vector<double> coords;
57 std::string groupName;
61 struct CompareGHS3DEnforcedVertex {
62 bool operator () (const TGHS3DEnforcedVertex* e1, const TGHS3DEnforcedVertex* e2) const {
64 if (e1->coords.size() && e2->coords.size())
65 return (e1->coords < e2->coords);
67 return (e1->geomEntry < e2->geomEntry);
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;
84 struct TGHS3DEnforcedMesh {
88 std::string groupName;
89 SMESH::ElementType elementType;
92 struct CompareGHS3DEnforcedMesh {
93 bool operator () (const TGHS3DEnforcedMesh* e1, const TGHS3DEnforcedMesh* e2) const {
95 if (e1->entry == e2->entry)
96 return (e1->elementType < e2->elementType);
98 return (e1->entry < e2->entry);
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, ""),
107 // ("Mesh_1", "0:1:2:1", TopAbs_EDGE, "edge group")]
108 typedef std::map< std::string, TGHS3DEnforcedMeshList > TEntryGHS3DEnforcedMeshListMap;
110 typedef std::map<int,double> TID2SizeMap;
112 struct TIDMeshIDCompare {
113 bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
114 { return e1->getMeshId() == e2->getMeshId() ? e1->GetID() < e2->GetID() : e1->getMeshId() < e2->getMeshId() ; }
117 typedef std::map<const SMDS_MeshElement*, std::string, TIDMeshIDCompare > TIDSortedElemGroupMap;
118 typedef std::map<const SMDS_MeshNode*, std::string, TIDMeshIDCompare > TIDSortedNodeGroupMap;
119 typedef std::set<std::string> TSetStrings;
121 static const char* GetHypType() { return "GHS3D_Parameters"; }
123 * To mesh "holes" in a solid or not. Default is to mesh.
125 void SetToMeshHoles(bool toMesh);
126 bool GetToMeshHoles(bool checkFreeOption = false) const;
128 * Maximal size of memory to be used by the algorithm (in Megabytes)
130 void SetMaximumMemory(short MB);
131 short GetMaximumMemory() const;
133 * Initial size of memory to be used by the algorithm (in Megabytes) in
134 * automatic memory adjustment mode. Default is zero
136 void SetInitialMemory(short MB);
137 short GetInitialMemory() const;
139 * Optimization level: 0-none, 1-light, 2-medium, 3-standard+, 4-strong. Default is medium
141 enum OptimizationLevel { None = 0, Light, Medium, StandardPlus, Strong };
142 void SetOptimizationLevel(OptimizationLevel level);
143 OptimizationLevel GetOptimizationLevel() const;
145 * Path to working directory
147 void SetWorkingDirectory(const std::string& path);
148 std::string GetWorkingDirectory() const;
150 * To keep working files or remove them. Log file remains in case of errors anyway.
152 void SetKeepFiles(bool toKeep);
153 bool GetKeepFiles() const;
155 * Verbose level [0-10]
156 * 0 - no standard output,
157 * 2 - prints the data, quality statistics of the skin and final meshes and
158 * indicates when the final mesh is being saved. In addition the software
159 * gives indication regarding the CPU time.
160 * 10 - same as 2 plus the main steps in the computation, quality statistics
161 * histogram of the skin mesh, quality statistics histogram together with
162 * the characteristics of the final mesh.
164 void SetVerboseLevel(short level);
165 short GetVerboseLevel() const;
167 * To create new nodes
169 void SetToCreateNewNodes(bool toCreate);
170 bool GetToCreateNewNodes() const;
172 * To use boundary recovery version which tries to create mesh on a very poor
173 * quality surface mesh
175 void SetToUseBoundaryRecoveryVersion(bool toUse);
176 bool GetToUseBoundaryRecoveryVersion() const;
178 * Applies finite-element correction by replacing overconstrained elements where
179 * it is possible. The process is cutting first the overconstrained edges and
180 * second the overconstrained facets. This insure that no edges have two boundary
181 * vertices and that no facets have three boundary vertices.
183 void SetFEMCorrection(bool toUseFem);
184 bool GetFEMCorrection() const;
186 * To removes initial central point.
188 void SetToRemoveCentralPoint(bool toRemove);
189 bool GetToRemoveCentralPoint() const;
191 * To set hiden/undocumented/advanced options
193 void SetTextOption(const std::string& option);
194 std::string GetTextOption() const;
196 * To define the volumic gradation
198 void SetGradation(double gradation);
199 double GetGradation() const ;
202 // struct TEnforcedEdge {
206 // std::string groupName;
211 * \brief Return command to run ghs3d mesher excluding file prefix (-f)
213 static std::string CommandToRun(const GHS3DPlugin_Hypothesis* hyp,
214 const bool hasShapeToMesh=true);
216 * \brief Return a unique file name
218 static std::string GetFileName(const GHS3DPlugin_Hypothesis* hyp);
221 * To set an enforced vertex
223 bool SetEnforcedVertex(std::string aName, std::string anEntry, std::string aGroupName,
224 double size, double x=0.0, double y=0.0, double z=0.0, bool isCompound = false);
225 TGHS3DEnforcedVertex* GetEnforcedVertex(double x, double y, double z) throw (std::invalid_argument);
226 TGHS3DEnforcedVertex* GetEnforcedVertex(const std::string anEntry) throw (std::invalid_argument);
227 bool RemoveEnforcedVertex(double x=0.0, double y=0.0, double z=0.0, const std::string anEntry="" ) throw (std::invalid_argument);
228 const TGHS3DEnforcedVertexCoordsValues _GetEnforcedVerticesCoordsSize() const {return _enfVertexCoordsSizeList; }
229 const TGHS3DEnforcedVertexEntryValues _GetEnforcedVerticesEntrySize() const {return _enfVertexEntrySizeList; }
230 const TGHS3DEnforcedVertexList _GetEnforcedVertices() const { return _enfVertexList; }
231 const TCoordsGHS3DEnforcedVertexMap _GetEnforcedVerticesByCoords() const { return _coordsEnfVertexMap; }
232 const TGeomEntryGHS3DEnforcedVertexMap _GetEnforcedVerticesByEntry() const { return _geomEntryEnfVertexMap; }
233 void ClearEnforcedVertices();
236 * To set enforced elements
238 bool SetEnforcedMesh(SMESH_Mesh& theMesh, SMESH::ElementType elementType, std::string name, std::string entry, std::string groupName = "");
239 bool SetEnforcedGroup(const SMESHDS_Mesh* theMeshDS, SMESH::long_array_var theIDs, SMESH::ElementType elementType, std::string name, std::string entry, std::string groupName = "");
240 bool SetEnforcedElements(TIDSortedElemSet theElemSet, SMESH::ElementType elementType, std::string groupName = "");
241 const TGHS3DEnforcedMeshList _GetEnforcedMeshes() const { return _enfMeshList; }
242 const TEntryGHS3DEnforcedMeshListMap _GetEnforcedMeshesByEntry() const { return _entryEnfMeshMap; }
243 void ClearEnforcedMeshes();
244 const TIDSortedNodeGroupMap _GetEnforcedNodes() const { return _enfNodes; }
245 const TIDSortedElemGroupMap _GetEnforcedEdges() const { return _enfEdges; }
246 const TIDSortedElemGroupMap _GetEnforcedTriangles() const { return _enfTriangles; }
247 const TID2SizeMap _GetNodeIDToSizeMap() const {return _nodeIDToSizeMap; }
248 const TSetStrings _GetGroupsToRemove() const {return _groupsToRemove; }
249 void RestoreEnfElemsByMeshes(); // persistence
251 * \brief Return the enforced vertices
253 static TGHS3DEnforcedVertexList GetEnforcedVertices(const GHS3DPlugin_Hypothesis* hyp);
254 static TGHS3DEnforcedVertexCoordsValues GetEnforcedVerticesCoordsSize(const GHS3DPlugin_Hypothesis* hyp);
255 static TGHS3DEnforcedVertexEntryValues GetEnforcedVerticesEntrySize(const GHS3DPlugin_Hypothesis* hyp);
256 static TCoordsGHS3DEnforcedVertexMap GetEnforcedVerticesByCoords(const GHS3DPlugin_Hypothesis* hyp);
257 static TGeomEntryGHS3DEnforcedVertexMap GetEnforcedVerticesByEntry(const GHS3DPlugin_Hypothesis* hyp);
259 static TGHS3DEnforcedMeshList GetEnforcedMeshes(const GHS3DPlugin_Hypothesis* hyp);
260 static TEntryGHS3DEnforcedMeshListMap GetEnforcedMeshesByEntry(const GHS3DPlugin_Hypothesis* hyp);
261 static TIDSortedNodeGroupMap GetEnforcedNodes(const GHS3DPlugin_Hypothesis* hyp);
262 static TIDSortedElemGroupMap GetEnforcedEdges(const GHS3DPlugin_Hypothesis* hyp);
263 static TIDSortedElemGroupMap GetEnforcedTriangles(const GHS3DPlugin_Hypothesis* hyp);
264 static TID2SizeMap GetNodeIDToSizeMap(const GHS3DPlugin_Hypothesis* hyp);
265 static TSetStrings GetGroupsToRemove(const GHS3DPlugin_Hypothesis* hyp);
266 void ClearGroupsToRemove();
268 static bool DefaultMeshHoles();
269 static short DefaultMaximumMemory();
270 static short DefaultInitialMemory();
271 static short DefaultOptimizationLevel();
272 static std::string DefaultWorkingDirectory();
273 static bool DefaultKeepFiles();
274 static short DefaultVerboseLevel();
275 static bool DefaultToCreateNewNodes();
276 static bool DefaultToUseBoundaryRecoveryVersion();
277 static bool DefaultToUseFEMCorrection();
278 static bool DefaultToRemoveCentralPoint();
279 static double DefaultGradation();
281 static TGHS3DEnforcedVertex DefaultGHS3DEnforcedVertex() {return TGHS3DEnforcedVertex();}
282 static TGHS3DEnforcedVertexList DefaultGHS3DEnforcedVertexList() {return TGHS3DEnforcedVertexList();}
283 static TGHS3DEnforcedVertexCoordsValues DefaultGHS3DEnforcedVertexCoordsValues() {return TGHS3DEnforcedVertexCoordsValues();}
284 static TGHS3DEnforcedVertexEntryValues DefaultGHS3DEnforcedVertexEntryValues() {return TGHS3DEnforcedVertexEntryValues();}
285 static TCoordsGHS3DEnforcedVertexMap DefaultCoordsGHS3DEnforcedVertexMap() {return TCoordsGHS3DEnforcedVertexMap();}
286 static TGeomEntryGHS3DEnforcedVertexMap DefaultGeomEntryGHS3DEnforcedVertexMap() {return TGeomEntryGHS3DEnforcedVertexMap();}
287 static TGroupNameGHS3DEnforcedVertexMap DefaultGroupNameGHS3DEnforcedVertexMap() {return TGroupNameGHS3DEnforcedVertexMap();}
289 static TGHS3DEnforcedMesh DefaultGHS3DEnforcedMesh() {return TGHS3DEnforcedMesh();}
290 static TGHS3DEnforcedMeshList DefaultGHS3DEnforcedMeshList() {return TGHS3DEnforcedMeshList();}
291 static TEntryGHS3DEnforcedMeshListMap DefaultEntryGHS3DEnforcedMeshListMap() {return TEntryGHS3DEnforcedMeshListMap();}
292 static TIDSortedNodeGroupMap DefaultIDSortedNodeGroupMap() {return TIDSortedNodeGroupMap();}
293 static TIDSortedElemGroupMap DefaultIDSortedElemGroupMap() {return TIDSortedElemGroupMap();}
294 static TID2SizeMap DefaultID2SizeMap() {return TID2SizeMap();}
295 static TSetStrings DefaultGroupsToRemove() {return TSetStrings();}
298 virtual std::ostream & SaveTo(std::ostream & save);
299 virtual std::istream & LoadFrom(std::istream & load);
300 friend GHS3DPLUGIN_EXPORT std::ostream & operator <<(std::ostream & save, GHS3DPlugin_Hypothesis & hyp);
301 friend GHS3DPLUGIN_EXPORT std::istream & operator >>(std::istream & load, GHS3DPlugin_Hypothesis & hyp);
304 * \brief Does nothing
306 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
309 * \brief Does nothing
311 virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
316 short myMaximumMemory;
317 short myInitialMemory;
318 short myOptimizationLevel;
320 std::string myWorkingDirectory;
321 short myVerboseLevel;
322 bool myToCreateNewNodes;
323 bool myToUseBoundaryRecoveryVersion;
324 bool myToUseFemCorrection;
325 bool myToRemoveCentralPoint;
326 std::string myTextOption;
329 TGHS3DEnforcedVertexList _enfVertexList;
330 TGHS3DEnforcedVertexCoordsValues _enfVertexCoordsSizeList;
331 TGHS3DEnforcedVertexEntryValues _enfVertexEntrySizeList;
332 // map to get "manual" enf vertex (through the coordinates)
333 TCoordsGHS3DEnforcedVertexMap _coordsEnfVertexMap;
334 // map to get "geom" enf vertex (through the geom entries)
335 TGeomEntryGHS3DEnforcedVertexMap _geomEntryEnfVertexMap;
338 TGHS3DEnforcedMeshList _enfMeshList;
339 // map to get enf meshes through the entries
340 TEntryGHS3DEnforcedMeshListMap _entryEnfMeshMap;
341 TIDSortedNodeGroupMap _enfNodes;
342 TIDSortedElemGroupMap _enfEdges;
343 TIDSortedElemGroupMap _enfTriangles;
344 TID2SizeMap _nodeIDToSizeMap;
345 std::map<std::string, TIDSortedElemSet > _entryToElemsMap;
347 TSetStrings _groupsToRemove;