1 // Copyright (C) 2007-2016 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, or (at your option) any later version.
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
21 // File : HYBRIDPlugin_Algorithm.idl
22 // Author : Christian VAN WAMBEKE (CEA)
25 #ifndef _HYBRID_Algorithm_IDL_
26 #define _HYBRID_Algorithm_IDL_
28 #include "SALOME_Exception.idl"
29 #include "SMESH_Hypothesis.idl"
30 #include "SMESH_Mesh.idl"
33 * HYBRIDPlugin: interfaces to HYBRID related hypotheses and algorithms
37 typedef sequence<double,3> TCoords;
38 struct HYBRIDEnforcedVertex {
47 typedef sequence<HYBRIDEnforcedVertex> HYBRIDEnforcedVertexList;
49 struct HYBRIDEnforcedMesh {
52 SMESH::ElementType elementType;
56 typedef sequence<HYBRIDEnforcedMesh> HYBRIDEnforcedMeshList;
59 * HYBRIDPlugin_HYBRID: interface of "Tetra-hexahedron (HYBRID)" algorithm
61 interface HYBRIDPlugin_HYBRID : SMESH::SMESH_3D_Algo
63 SMESH::SMESH_Mesh importGMFMesh(in string aGMFFileName);
67 * Parameters of "Tetra-hexahedron (HYBRID)" algorithm
69 interface HYBRIDPlugin_Hypothesis : SMESH::SMESH_Hypothesis
72 * To mesh "holes" in a solid or not. Default is to mesh.
74 void SetToMeshHoles(in boolean toMesh);
75 boolean GetToMeshHoles();
77 * To mesh layers on all wrap Default is yes.
79 void SetLayersOnAllWrap(in boolean toMesh);
80 boolean GetLayersOnAllWrap();
82 * To make groups of volumes of different domains when mesh is generated from skin.
83 * Default is to make groups.
84 * This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
86 void SetToMakeGroupsOfDomains(in boolean toMakeGroups);
87 boolean GetToMakeGroupsOfDomains();
89 * Maximal size of memory to be used by the algorithm (in Megabytes).
90 * Negative value means not to use this option
92 void SetMaximumMemory(in double MB) raises (SALOME::SALOME_Exception);
93 double GetMaximumMemory();
95 * Initial size of memory to be used by the algorithm (in Megabytes) in
96 * automatic memory adjustment mode. Default is zero.
97 * Negative value means not to use this option
99 void SetInitialMemory(in double MB) raises (SALOME::SALOME_Exception);
100 double GetInitialMemory();
102 * Optimization level: 0-none, 1-light, 2-medium, 3-strong. Default is medium
104 void SetOptimizationLevel(in short level) raises (SALOME::SALOME_Exception);
105 short GetOptimizationLevel();
109 * Collision mode: 0-decrease, 1-stop. Default is decrease
111 void SetCollisionMode(in short level) raises (SALOME::SALOME_Exception);
112 short GetCollisionMode();
114 * BoundaryLayersGrowth: 0-Layer_Growth_Inward, 1-Layer_Growth_Outward. Default is Layer_Growth_Inward
116 void SetBoundaryLayersGrowth(in short level) raises (SALOME::SALOME_Exception);
117 short GetBoundaryLayersGrowth();
119 * ElementGeneration: 0-Generation_Tetra_Dominant, 1-Generation_Hexa_Dominant. Default is Generation_Tetra_Dominant
121 void SetElementGeneration(in short level) raises (SALOME::SALOME_Exception);
122 short GetElementGeneration();
125 * To mesh adding extra normals at opening ridges and corners.
128 void SetAddMultinormals(in boolean toAddMultinormals);
129 boolean GetAddMultinormals();
131 * To mesh smoothing normals at closed ridges and corners.
134 void SetSmoothNormals(in boolean toSmoothNormals);
135 boolean GetSmoothNormals();
137 * To set height of the first layer.
139 void SetHeightFirstLayer(in double HFL) raises (SALOME::SALOME_Exception);
140 double GetHeightFirstLayer();
142 * To set boundary layers coefficient of geometric progression.
145 void SetBoundaryLayersProgression(in double BLP) raises (SALOME::SALOME_Exception);
146 double GetBoundaryLayersProgression();
148 * To set multinormals angle threshold at opening ridges.
151 void SetMultinormalsAngle(in double MNA) raises (SALOME::SALOME_Exception);
152 double GetMultinormalsAngle();
154 * To set number of boundary layers.
157 void SetNbOfBoundaryLayers(in short NBL) raises (SALOME::SALOME_Exception);
158 short GetNbOfBoundaryLayers();
163 * Path to working directory
165 void SetWorkingDirectory(in string path) raises (SALOME::SALOME_Exception);
166 string GetWorkingDirectory();
168 * To keep working files or remove them. Log file remains in case of errors anyway.
170 void SetKeepFiles(in boolean toKeep);
171 boolean GetKeepFiles();
173 * Verbose level [0-10]
174 * 0 - no standard output,
175 * 2 - prints the data, quality statistics of the skin and final meshes and
176 * indicates when the final mesh is being saved. In addition the software
177 * gives indication regarding the CPU time.
178 * 10 - same as 2 plus the main steps in the computation, quality statistics
179 * histogram of the skin mesh, quality statistics histogram together with
180 * the characteristics of the final mesh.
182 void SetVerboseLevel(in short level);
183 short GetVerboseLevel();
185 * To create new nodes
187 void SetToCreateNewNodes(in boolean toCreate);
188 boolean GetToCreateNewNodes();
190 * To use boundary recovery version which tries to create mesh on a very poor
191 * quality surface mesh
193 void SetToUseBoundaryRecoveryVersion(in boolean toUse);
194 boolean GetToUseBoundaryRecoveryVersion();
196 * Applies finite-element correction by replacing overconstrained elements where
197 * it is possible. The process is cutting first the overconstrained edges and
198 * second the overconstrained facets. This insure that no edges have two boundary
199 * vertices and that no facets have three boundary vertices.
201 void SetFEMCorrection(in boolean toUseFem);
202 boolean GetFEMCorrection();
204 * To removes initial central point.
206 void SetToRemoveCentralPoint(in boolean toRemove);
207 boolean GetToRemoveCentralPoint();
209 * To set hiden/undocumented/advanced options
211 void SetTextOption(in string option);
212 string GetTextOption();
214 * To define the volumic gradation
216 void SetGradation(in double gradation);
217 double GetGradation();
219 * Print log in standard output
221 void SetStandardOutputLog(in boolean logInStandardOutput);
222 boolean GetStandardOutputLog();
224 * Remove log file on success
226 void SetRemoveLogOnSuccess(in boolean removeLogOnSuccess);
227 boolean GetRemoveLogOnSuccess();
229 * To set an enforced vertex
231 boolean SetEnforcedVertex(in double x, in double y, in double z, in double size) raises (SALOME::SALOME_Exception);
232 boolean SetEnforcedVertexNamed(in double x, in double y, in double z, in double size, in string vertexName) raises (SALOME::SALOME_Exception);
233 boolean SetEnforcedVertexWithGroup(in double x, in double y, in double z, in double size, in string groupName) raises (SALOME::SALOME_Exception);
234 boolean SetEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in double size, in string vertexName, in string groupName) raises (SALOME::SALOME_Exception);
235 boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex, in double size) raises (SALOME::SALOME_Exception);
236 boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in double size, in string groupName) raises (SALOME::SALOME_Exception);
237 double GetEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
238 double GetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
239 boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
240 boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
241 HYBRIDEnforcedVertexList GetEnforcedVertices();
242 void ClearEnforcedVertices();
244 * Set/get/unset an enforced vertex (private method for GUI)
246 boolean p_SetEnforcedVertex(in double size, in double x, in double y, in double z,
247 in string theVertexName, in string theVertexEntry, in string groupName,
248 in boolean isCompound) raises (SALOME::SALOME_Exception);
250 boolean SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType) raises (SALOME::SALOME_Exception);
251 boolean SetEnforcedMeshWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string groupName) raises (SALOME::SALOME_Exception);
253 /* OBSOLETE FUNCTIONS */
254 boolean SetEnforcedMeshSize(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size) raises (SALOME::SALOME_Exception);
255 boolean SetEnforcedMeshSizeWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size, in string groupName) raises (SALOME::SALOME_Exception);
256 /* OBSOLETE FUNCTIONS */
258 HYBRIDEnforcedMeshList GetEnforcedMeshes();
259 void ClearEnforcedMeshes();
262 * Set/get/unset an enforced vertex (private method for GUI)
264 boolean p_SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string name, in string groupName) raises (SALOME::SALOME_Exception);