1 // Copyright (C) 2004-2013 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 // File : HYBRID_Algorithm.idl
21 // Author : Julia DOROVSKIKH
23 #ifndef _HYBRID_Algorithm_IDL_
24 #define _HYBRID_Algorithm_IDL_
26 #include "SALOME_Exception.idl"
27 #include "SMESH_Hypothesis.idl"
28 #include "SMESH_Mesh.idl"
31 * HYBRIDPlugin: interfaces to HYBRID related hypotheses and algorithms
35 typedef sequence<double,3> TCoords;
36 struct HYBRIDEnforcedVertex {
45 typedef sequence<HYBRIDEnforcedVertex> HYBRIDEnforcedVertexList;
47 struct HYBRIDEnforcedMesh {
50 SMESH::ElementType elementType;
54 typedef sequence<HYBRIDEnforcedMesh> HYBRIDEnforcedMeshList;
57 * HYBRIDPlugin_HYBRID: interface of "Tetrahedron (HYBRID)" algorithm
59 interface HYBRIDPlugin_HYBRID : SMESH::SMESH_3D_Algo
61 SMESH::SMESH_Mesh importGMFMesh(in string aGMFFileName);
65 * Parameters of "Tetrahedron (HYBRID)" algorithm
67 interface HYBRIDPlugin_Hypothesis : SMESH::SMESH_Hypothesis
70 * To mesh "holes" in a solid or not. Default is to mesh.
72 void SetToMeshHoles(in boolean toMesh);
73 boolean GetToMeshHoles();
75 * To make groups of volumes of different domains when mesh is generated from skin.
76 * Default is to make groups.
77 * This option works only (1) for the mesh w/o shape and (2) if GetToMeshHoles() == true
79 void SetToMakeGroupsOfDomains(in boolean toMakeGroups);
80 boolean GetToMakeGroupsOfDomains();
82 * Maximal size of memory to be used by the algorithm (in Megabytes).
83 * Negative value means not to use this option
85 void SetMaximumMemory(in double MB) raises (SALOME::SALOME_Exception);
86 double GetMaximumMemory();
88 * Initial size of memory to be used by the algorithm (in Megabytes) in
89 * automatic memory adjustment mode. Default is zero.
90 * Negative value means not to use this option
92 void SetInitialMemory(in double MB) raises (SALOME::SALOME_Exception);
93 double GetInitialMemory();
95 * Optimization level: 0-none, 1-light, 2-medium, 3-strong. Default is medium
97 void SetOptimizationLevel(in short level) raises (SALOME::SALOME_Exception);
98 short GetOptimizationLevel();
102 * Collision mode: 0-decrease, 1-stop. Default is decrease
104 void SetCollisionMode(in short level) raises (SALOME::SALOME_Exception);
105 short GetCollisionMode();
107 * BoundaryLayersGrowth: 0-Layer_Growth_Inward, 1-Layer_Growth_Outward. Default is Layer_Growth_Inward
109 void SetBoundaryLayersGrowth(in short level) raises (SALOME::SALOME_Exception);
110 short GetBoundaryLayersGrowth();
112 * ElementGeneration: 0-Generation_Tetra_Dominant, 1-Generation_Hexa_Dominant. Default is Generation_Tetra_Dominant
114 void SetElementGeneration(in short level) raises (SALOME::SALOME_Exception);
115 short GetElementGeneration();
118 * To mesh adding extra normals at opening ridges and corners.
121 void SetAddMultinormals(in boolean toAddMultinormals);
122 boolean GetAddMultinormals();
124 * To mesh smoothing normals at closed ridges and corners.
127 void SetSmoothNormals(in boolean toSmoothNormals);
128 boolean GetSmoothNormals();
130 * To set height of the first layer.
132 void SetHeightFirstLayer(in double HFL) raises (SALOME::SALOME_Exception);
133 double GetHeightFirstLayer();
135 * To set boundary layers coefficient of geometric progression.
138 void SetBoundaryLayersProgression(in double BLP) raises (SALOME::SALOME_Exception);
139 double GetBoundaryLayersProgression();
141 * To set multinormals angle threshold at opening ridges.
144 void SetMultinormalsAngle(in double MNA) raises (SALOME::SALOME_Exception);
145 double GetMultinormalsAngle();
147 * To set number of boundary layers.
150 void SetNbOfBoundaryLayers(in short NBL) raises (SALOME::SALOME_Exception);
151 short GetNbOfBoundaryLayers();
156 * Path to working directory
158 void SetWorkingDirectory(in string path) raises (SALOME::SALOME_Exception);
159 string GetWorkingDirectory();
161 * To keep working files or remove them. Log file remains in case of errors anyway.
163 void SetKeepFiles(in boolean toKeep);
164 boolean GetKeepFiles();
166 * Verbose level [0-10]
167 * 0 - no standard output,
168 * 2 - prints the data, quality statistics of the skin and final meshes and
169 * indicates when the final mesh is being saved. In addition the software
170 * gives indication regarding the CPU time.
171 * 10 - same as 2 plus the main steps in the computation, quality statistics
172 * histogram of the skin mesh, quality statistics histogram together with
173 * the characteristics of the final mesh.
175 void SetVerboseLevel(in short level);
176 short GetVerboseLevel();
178 * To create new nodes
180 void SetToCreateNewNodes(in boolean toCreate);
181 boolean GetToCreateNewNodes();
183 * To use boundary recovery version which tries to create mesh on a very poor
184 * quality surface mesh
186 void SetToUseBoundaryRecoveryVersion(in boolean toUse);
187 boolean GetToUseBoundaryRecoveryVersion();
189 * Applies finite-element correction by replacing overconstrained elements where
190 * it is possible. The process is cutting first the overconstrained edges and
191 * second the overconstrained facets. This insure that no edges have two boundary
192 * vertices and that no facets have three boundary vertices.
194 void SetFEMCorrection(in boolean toUseFem);
195 boolean GetFEMCorrection();
197 * To removes initial central point.
199 void SetToRemoveCentralPoint(in boolean toRemove);
200 boolean GetToRemoveCentralPoint();
202 * To set hiden/undocumented/advanced options
204 void SetTextOption(in string option);
205 string GetTextOption();
207 * To define the volumic gradation
209 void SetGradation(in double gradation);
210 double GetGradation();
212 * Print log in standard output
214 void SetStandardOutputLog(in boolean logInStandardOutput);
215 boolean GetStandardOutputLog();
217 * Remove log file on success
219 void SetRemoveLogOnSuccess(in boolean removeLogOnSuccess);
220 boolean GetRemoveLogOnSuccess();
222 * To set an enforced vertex
224 boolean SetEnforcedVertex(in double x, in double y, in double z, in double size) raises (SALOME::SALOME_Exception);
225 boolean SetEnforcedVertexNamed(in double x, in double y, in double z, in double size, in string vertexName) raises (SALOME::SALOME_Exception);
226 boolean SetEnforcedVertexWithGroup(in double x, in double y, in double z, in double size, in string groupName) raises (SALOME::SALOME_Exception);
227 boolean SetEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in double size, in string vertexName, in string groupName) raises (SALOME::SALOME_Exception);
228 boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex, in double size) raises (SALOME::SALOME_Exception);
229 boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in double size, in string groupName) raises (SALOME::SALOME_Exception);
230 double GetEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
231 double GetEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
232 boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
233 boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
234 HYBRIDEnforcedVertexList GetEnforcedVertices();
235 void ClearEnforcedVertices();
237 * Set/get/unset an enforced vertex (private method for GUI)
239 boolean p_SetEnforcedVertex(in double size, in double x, in double y, in double z,
240 in string theVertexName, in string theVertexEntry, in string groupName,
241 in boolean isCompound) raises (SALOME::SALOME_Exception);
243 boolean SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType) raises (SALOME::SALOME_Exception);
244 boolean SetEnforcedMeshWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string groupName) raises (SALOME::SALOME_Exception);
246 /* OBSOLETE FUNCTIONS */
247 boolean SetEnforcedMeshSize(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size) raises (SALOME::SALOME_Exception);
248 boolean SetEnforcedMeshSizeWithGroup(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in double size, in string groupName) raises (SALOME::SALOME_Exception);
249 /* OBSOLETE FUNCTIONS */
251 HYBRIDEnforcedMeshList GetEnforcedMeshes();
252 void ClearEnforcedMeshes();
255 * Set/get/unset an enforced vertex (private method for GUI)
257 boolean p_SetEnforcedMesh(in SMESH::SMESH_IDSource theSource, in SMESH::ElementType elementType, in string name, in string groupName) raises (SALOME::SALOME_Exception);