1 // Copyright (C) 2007-2012 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // File : SMESH_Gen.idl
23 // Author : Paul RASCLE, EDF
25 #ifndef _SMESH_GEN_IDL_
26 #define _SMESH_GEN_IDL_
28 #include "SALOME_Exception.idl"
29 #include "SALOME_Component.idl"
30 #include "SALOMEDS.idl"
32 #include "GEOM_Gen.idl"
34 #include "SMESH_Mesh.idl"
35 #include "SMESH_Hypothesis.idl"
39 typedef sequence<GEOM::GEOM_Object> object_array;
40 typedef sequence<SMESH_Mesh> mesh_array;
42 interface FilterManager;
43 interface SMESH_Pattern;
44 interface Measurements;
50 const long Tag_HypothesisRoot = 1; // hypotheses root
51 const long Tag_AlgorithmsRoot = 2; // algorithms root
52 const long Tag_FirstMeshRoot = 3; // first mesh root
54 const long Tag_RefOnShape = 1; // references to shape
55 const long Tag_RefOnAppliedHypothesis = 2; // applied hypotheses root
56 const long Tag_RefOnAppliedAlgorithms = 3; // applied algorithms root
57 // Mesh only: sub-meshes roots by type
58 const long Tag_FirstSubMesh = 4;
59 const long Tag_SubMeshOnVertex = 4;
60 const long Tag_SubMeshOnEdge = 5;
61 const long Tag_SubMeshOnWire = 6;
62 const long Tag_SubMeshOnFace = 7;
63 const long Tag_SubMeshOnShell = 8;
64 const long Tag_SubMeshOnSolid = 9;
65 const long Tag_SubMeshOnCompound = 10;
66 const long Tag_LastSubMesh = 10;
67 // Mesh only: group roots by type
68 const long Tag_FirstGroup = 11;
69 const long Tag_NodeGroups = 11;
70 const long Tag_EdgeGroups = 12;
71 const long Tag_FaceGroups = 13;
72 const long Tag_VolumeGroups = 14;
73 const long Tag_0DElementsGroups = 15;
74 const long Tag_BallElementsGroups = 16;
75 const long Tag_LastGroup = 16;
78 * Hypothesis definintion error
82 Hypothesis_Status state;
87 typedef sequence<AlgoStateError> algo_error_array;
90 * Mesh computation error
95 COMPERR_BAD_INPUT_MESH, // wrong mesh on lower submesh
96 COMPERR_STD_EXCEPTION , // some std exception raised
97 COMPERR_OCC_EXCEPTION , // OCC exception raised
98 COMPERR_SLM_EXCEPTION , // SALOME exception raised
99 COMPERR_EXCEPTION , // other exception raised
100 COMPERR_MEMORY_PB , // memory allocation problem
101 COMPERR_ALGO_FAILED , // computation failed
102 COMPERR_BAD_SHAPE , // bad geometry
103 COMPERR_WARNING , // algo reports error but sub-mesh is computed anyway
104 COMPERR_CANCELED // compute canceled
108 short code; // ComputeErrorName or, if negative, algo specific code
109 string comment; // textual problem description
111 short subShapeID; // id of sub-shape of a shape to mesh
112 boolean hasBadMesh; // there are elements preventing computation available for visualization
114 typedef sequence<ComputeError> compute_error_array;
117 interface SMESH_Gen : Engines::EngineComponent, SALOMEDS::Driver
119 //GEOM::GEOM_Gen SetGeomEngine( in string containerLoc );
120 void SetGeomEngine( in GEOM::GEOM_Gen geomcompo );
122 FilterManager CreateFilterManager();
124 SMESH_Pattern GetPattern();
126 Measurements CreateMeasurements();
131 void SetEmbeddedMode( in boolean theMode );
136 boolean IsEmbeddedMode();
139 Set the current study
141 void SetCurrentStudy( in SALOMEDS::Study theStudy );
144 Get the current study
146 SALOMEDS::Study GetCurrentStudy();
149 * Create a hypothesis that can be shared by differents parts of the mesh.
150 * An hypothesis is either:
151 * - a method used to generate or modify a part of the mesh (algorithm).
152 * - a parameter or a law used by an algorithm.
153 * Algorithms are 1D, 2D or 3D.
155 SMESH_Hypothesis CreateHypothesis( in string theHypName,
156 in string theLibName )
157 raises ( SALOME::SALOME_Exception );
160 * Return a hypothesis holding parameter values corresponding either to the mesh
161 * existing on the given geometry or to size of the geometry.
162 * The returned hypothesis may be the one existing in a study and used
163 * to compute the mesh, or a temporary one created just to pass parameter
166 SMESH_Hypothesis GetHypothesisParameterValues( in string theHypName,
167 in string theLibName,
168 in SMESH_Mesh theMesh,
169 in GEOM::GEOM_Object theGeom,
171 raises ( SALOME::SALOME_Exception );
174 * Sets number of segments per diagonal of boundary box of geometry by which
175 * default segment length of appropriate 1D hypotheses is defined
177 void SetBoundaryBoxSegmentation( in long theNbSegments ) raises ( SALOME::SALOME_Exception );
179 * \brief Sets default number of segments per edge
181 void SetDefaultNbSegments( in long theNbSegments) raises ( SALOME::SALOME_Exception );
184 * Set the object name
186 void SetName( in string theObjectIOR,
187 in string theObjectName )
188 raises ( SALOME::SALOME_Exception );
191 * Create a Mesh object, given a geometry shape.
192 * Mesh is created empty (no points, no elements).
193 * Shape is explored via GEOM_Client to create local copies.
194 * of TopoDS_Shapes and bind CORBA references of shape & subshapes
197 SMESH_Mesh CreateMesh( in GEOM::GEOM_Object theObject )
198 raises ( SALOME::SALOME_Exception );
201 * Create an empty mesh object
203 SMESH_Mesh CreateEmptyMesh()
204 raises ( SALOME::SALOME_Exception );
207 * Create Mesh object importing data from given UNV file
208 * (UNV supported version is I-DEAS 10)
210 SMESH_Mesh CreateMeshesFromUNV( in string theFileName )
211 raises ( SALOME::SALOME_Exception );
214 * Create Mesh object(s) importing data from given MED file
216 mesh_array CreateMeshesFromMED( in string theFileName,
217 out SMESH::DriverMED_ReadStatus theStatus )
218 raises ( SALOME::SALOME_Exception );
221 * Create Mesh object(s) importing data from given MED file
223 mesh_array CreateMeshesFromSAUV( in string theFileName,
224 out SMESH::DriverMED_ReadStatus theStatus )
225 raises ( SALOME::SALOME_Exception );
228 * Create Mesh object importing data from given STL file
230 SMESH_Mesh CreateMeshesFromSTL( in string theFileName )
231 raises ( SALOME::SALOME_Exception );
234 * Create Mesh object(s) importing data from given CGNS file
236 mesh_array CreateMeshesFromCGNS( in string theFileName,
237 out SMESH::DriverMED_ReadStatus theStatus )
238 raises ( SALOME::SALOME_Exception );
241 * Create a mesh by copying a part of another mesh
242 * \param meshPart - a part of mesh to copy
243 * \param meshName - a name of the new mesh
244 * \param toCopyGroups - to create in the new mesh groups
245 * the copied elements belongs to
246 * \param toKeepIDs - to preserve IDs of the copied elements or not
248 SMESH_Mesh CopyMesh(in SMESH_IDSource meshPart,
250 in boolean toCopyGroups,
251 in boolean toKeepIDs)
252 raises ( SALOME::SALOME_Exception );
255 * Concatenate the given meshes into one mesh.
256 * Union groups with the same name and type if
257 * theUniteIdenticalGroups flag is true.
258 * Merge coincident nodes and elements if
259 * theMergeNodesAndElements flag is true.
261 SMESH_Mesh Concatenate(in mesh_array theMeshesArray,
262 in boolean theUniteIdenticalGroups,
263 in boolean theMergeNodesAndElements,
264 in double theMergeTolerance)
265 raises ( SALOME::SALOME_Exception );
268 * Concatenate the given meshes into one mesh.
269 * Union groups with the same name and type if
270 * theUniteIdenticalGroups flag is true.
271 * Merge coincident nodes and elements if
272 * theMergeNodesAndElements flag is true.
273 * Create the groups of all elements from initial meshes.
275 SMESH_Mesh ConcatenateWithGroups(in mesh_array theMeshesArray,
276 in boolean theUniteIdenticalGroups,
277 in boolean theMergeNodesAndElements,
278 in double theMergeTolerance)
279 raises ( SALOME::SALOME_Exception );
283 * First, verify list of hypothesis associated with the Sub-shape,
284 * return NOK if hypothesis are not sufficient
286 boolean Compute( in SMESH_Mesh theMesh,
287 in GEOM::GEOM_Object theSubObject )
288 raises ( SALOME::SALOME_Exception );
291 * Cancel a computation.
293 void CancelCompute( in SMESH_Mesh theMesh,
294 in GEOM::GEOM_Object theSubObject );
297 * Return true if hypotheses are defined well
299 boolean IsReadyToCompute( in SMESH_Mesh theMesh,
300 in GEOM::GEOM_Object theSubObject )
301 raises ( SALOME::SALOME_Exception );
304 * Evaluates size of prospective mesh on a shape
306 long_array Evaluate(in SMESH_Mesh theMesh,
307 in GEOM::GEOM_Object theSubObject)
308 raises ( SALOME::SALOME_Exception );
311 * Calculate Mesh as preview till indicated dimension
312 * First, verify list of hypothesis associated with the Sub-shape.
313 * Return mesh preview structure
315 MeshPreviewStruct Precompute( in SMESH_Mesh theMesh,
316 in GEOM::GEOM_Object theSubObject,
317 in Dimension theDimension,
318 inout long_array theShapesId )
319 raises ( SALOME::SALOME_Exception );
322 * Return errors of hypotheses definintion
323 * algo_error_array is empty if everything is OK
325 algo_error_array GetAlgoState( in SMESH_Mesh theMesh,
326 in GEOM::GEOM_Object theSubObject )
327 raises ( SALOME::SALOME_Exception );
330 * Return errors of mesh computation
331 * compute_error_array is empty if everything is OK
333 compute_error_array GetComputeErrors( in SMESH_Mesh theMesh,
334 in GEOM::GEOM_Object theSubObject )
335 raises ( SALOME::SALOME_Exception );
338 * Return mesh elements preventing computation of a sub-shape
340 MeshPreviewStruct GetBadInputElements( in SMESH_Mesh theMesh,
341 in short theSubShapeID )
342 raises ( SALOME::SALOME_Exception );
345 * Return indeces of faces, edges and vertices of given sub-shapes
346 * within theMainObject
348 long_array GetSubShapesId( in GEOM::GEOM_Object theMainObject,
349 in object_array theListOfSubObjects )
350 raises ( SALOME::SALOME_Exception );
353 * Return geometrical object the given element is built on.
354 * The returned geometrical object, if not nil, is either found in the
355 * study or is published by this method with the given name
357 GEOM::GEOM_Object GetGeometryByMeshElement( in SMESH_Mesh theMesh,
358 in long theElementID,
359 in string theGeomName)
360 raises ( SALOME::SALOME_Exception );
363 * Return geometrical object the given element is built on.
364 * The returned geometrical object not published in study by this method.
366 GEOM::GEOM_Object FindGeometryByMeshElement( in SMESH_Mesh theMesh,
367 in long theElementID)
368 raises ( SALOME::SALOME_Exception );
371 * \brief Return id of object, registered in current study context
373 * Can be used to check if the object was created in the same container, as this engine.
375 long GetObjectId(in Object theObject);
378 * \brief Get MED version of the file by its name.
380 boolean GetMEDVersion(in string theFileName, out MED_VERSION theVersion);
383 * \brief Get names of meshes defined in file with the specified name.
385 string_array GetMeshNames(in string theFileName);