1 // Copyright (C) 2007-2010 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
21 // File : BLSURFPlugin_Algorithm.idl
22 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
23 // Size maps developement: Nicolas GEIMER (OCC) & Gilles DAVID (EURIWARE)
26 #ifndef _SMESH_BLSURFALGORITHM_IDL_
27 #define _SMESH_BLSURFALGORITHM_IDL_
29 #include "SMESH_Hypothesis.idl"
30 #include "GEOM_Gen.idl"
31 #include "SALOME_Exception.idl"
34 * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
38 typedef sequence<string> string_array;
41 typedef string TEnfEntry;
42 // Enforced vertex = 3 coordinates
43 typedef sequence<double,3> TEnfVertex;
44 // List of enforced vertices
45 typedef sequence<TEnfVertex> TEnfVertexList;
46 // Map Entry / List of enforced vertices
47 struct TEntryEnfVertexListMapElement {
49 TEnfVertexList vertexList;
51 typedef sequence<TEntryEnfVertexListMapElement> TEntryEnfVertexListMap;
54 typedef string TEnfGroupName;
55 // Map Group Name / List of enforced vertices
56 struct TGroupNameEnfVertexListMapElement {
57 TEnfGroupName groupName;
58 TEnfVertexList vertexList;
60 typedef sequence<TGroupNameEnfVertexListMapElement> TGroupNameEnfVertexListMap;
61 // Map Enforced vertex / Group Name
62 struct TEnfVertexGroupNameMapElement {
64 TEnfGroupName groupName;
66 typedef sequence<TEnfVertexGroupNameMapElement> TEnfVertexGroupNameMap;
71 * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
73 interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
78 * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
80 interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
83 * Sets topology usage way defining how mesh conformity is assured
84 * value=0 - mesh conformity is assured by conformity of a shape
85 * value=1,2 - mesh conformity is assured by pre-processing a CAD model
87 void SetTopology(in long way);
91 * Sets a way to define size of mesh elements to generate
92 * 0 - size is defined automatically
93 * 1 - size is set by SetPhySize() method
95 void SetPhysicalMesh(in long isCustom);
96 long GetPhysicalMesh();
99 * Sets size of mesh elements to generate
101 void SetPhySize(in double size);
105 * Sets lower boundary of mesh element size (PhySize)
107 void SetPhyMin(in double theMinSize);
111 * Sets upper boundary of mesh element size (PhySize)
113 void SetPhyMax(in double theMaxSize);
117 * Sets a way to define maximum angular deflection of mesh from CAD model
118 * 0 - deflection is defined automatically
119 * 1 - deflection is set by SetAngleMeshS() and SetAngleMeshC() methods
121 void SetGeometricMesh(in long isCustom);
122 long GetGeometricMesh();
125 * Sets angular deflection (in degrees) of a mesh face from CAD surface
127 void SetAngleMeshS(in double angle);
128 double GetAngleMeshS();
131 * Sets angular deflection (in degrees) of a mesh edge from CAD curve
133 void SetAngleMeshC(in double angle);
134 double GetAngleMeshC();
137 * Sets lower boundary of mesh element size computed to respect angular deflection
139 void SetGeoMin(in double theMinSize);
143 * Sets upper boundary of mesh element size computed to respect angular deflection
145 void SetGeoMax(in double theMaxSize);
149 * Sets maximal allowed ratio between the lengths of two adjacent edges
151 void SetGradation(in double ratio);
152 double GetGradation();
155 * Sets to create quadrilateral elements or not
157 void SetQuadAllowed(in boolean allowed);
158 boolean GetQuadAllowed();
161 * To respect geometrical edges or not
163 void SetDecimesh(in boolean toIgnoreEdges);
164 boolean GetDecimesh();
167 * Sets verbosity level in the range 0 to 100.
169 void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
170 short GetVerbosity();
173 * Sets advanced option value
175 void SetOptionValue(in string optionName,
176 in string optionValue) raises (SALOME::SALOME_Exception);
177 string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
179 * Unsets advanced option
181 void UnsetOption(in string optionName);
184 * Return array of strings each of which is option name concatenated
185 * with option value devided by semicolon - "option_name:option_value".
186 * Option value is empty if an option is not set.
187 * Note: the method is mostly for interaction with GUI.
189 string_array GetOptionValues();
192 * Set option values each in the form "option_name[:option_value]".
193 * Note: the method is mostly for interaction with GUI.
195 void SetOptionValues(in string_array options);
200 void SetSizeMapEntries(in string_array sizeMaps);
201 void ClearSizeMaps();
203 void UnsetEntry(in string entry);
206 * Set/unset a SizeMap on geom object
208 void SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
209 void UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
212 * Set a SizeMap on geom object given by entry
214 void SetSizeMapEntry(in string entry, in string sizeMap);
215 string GetSizeMapEntry(in string entry);
216 string_array GetSizeMapEntries();
219 * Set/unset an attractor on geom object
221 void SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
222 void UnsetAttractor(in GEOM::GEOM_Object GeomObj);
225 * Set an attractor on geom object given by entry
227 void SetAttractorEntry(in string entry, in string attractor);
228 string GetAttractorEntry(in string entry);
229 string_array GetAttractorEntries();
232 void SetCustomSizeMapEntry(in string entry, in string sizeMap);
233 string GetCustomSizeMapEntry(in string entry);
234 void SetCustomSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
235 void UnsetCustomSizeMap(in GEOM::GEOM_Object GeomObj);
236 string_array GetCustomSizeMapEntries();
238 ///////////////////////
239 // ENFORCED VERTEXES //
240 ///////////////////////
242 TEntryEnfVertexListMap GetAllEnforcedVertices();
243 void ClearAllEnforcedVertices();
246 * Set/get/unset an enforced vertex on geom object
248 void SetEnforcedVertex(in GEOM::GEOM_Object GeomObj, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
250 void SetEnforcedVertexWithGroup(in GEOM::GEOM_Object GeomObj, in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
252 // void SetEnforcedVertexList(in GEOM::GEOM_Object GeomObj, in TEnfVertexList vertexList) raises (SALOME::SALOME_Exception);
254 TEnfVertexList GetEnforcedVertices(in GEOM::GEOM_Object GeomObj) raises (SALOME::SALOME_Exception);
256 void UnsetEnforcedVertex(in GEOM::GEOM_Object GeomObj, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
257 // void UnsetEnforcedVertexList(in GEOM::GEOM_Object GeomObj, in TEnfVertexList vertexList) raises (SALOME::SALOME_Exception);
258 void UnsetEnforcedVertices(in GEOM::GEOM_Object GeomObj) raises (SALOME::SALOME_Exception);
261 * Set/get/unset an enforced vertex on geom object given by entry
263 void SetEnforcedVertexEntry(in TEnfEntry entry, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
265 void SetEnforcedVertexEntryWithGroup(in TEnfEntry entry, in double x, in double y, in double z, in TEnfGroupName groupName)
266 raises (SALOME::SALOME_Exception);
268 // void SetEnforcedVertexListEntry(in TEnfEntry entry, in TEnfVertexList vertexList) raises (SALOME::SALOME_Exception);
270 TEnfVertexList GetEnforcedVerticesEntry(in TEnfEntry entry) raises (SALOME::SALOME_Exception);
272 void UnsetEnforcedVertexEntry(in TEnfEntry entry, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
273 // void UnsetEnforcedVertexListEntry(in TEnfEntry entry, in TEnfVertexList vertexList) raises (SALOME::SALOME_Exception);
274 void UnsetEnforcedVerticesEntry(in TEnfEntry entry) raises (SALOME::SALOME_Exception);
277 * Set/get an enforced vertex on geom object and add it to a group
280 void SetEnforcedVertexGroupName(in double x, in double y, in double z, in TEnfGroupName groupName)
281 raises (SALOME::SALOME_Exception);
282 string GetEnforcedVertexGroupName(in double x, in double y, in double z)
283 raises (SALOME::SALOME_Exception);
285 ///////////////////////