smesh/idl/SMESH_Mesh.idl

709 lines
21 KiB
Plaintext
Raw Normal View History

2003-07-10 21:09:38 +06:00
// Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
//
//
//
// File : SMESH_Mesh.idl
// Author : Paul RASCLE, EDF
// $Header$
2003-05-19 19:18:36 +06:00
#ifndef _SMESH_MESH_IDL_
#define _SMESH_MESH_IDL_
#include "SALOME_Exception.idl"
2004-06-18 14:34:31 +06:00
#include "SALOME_GenericObj.idl"
module GEOM
{
2004-12-01 15:48:31 +05:00
interface GEOM_Object;
2004-06-18 14:34:31 +06:00
};
module SALOME_MED
{
interface MESH;
interface FAMILY;
};
2003-05-19 19:18:36 +06:00
module SMESH
{
2004-06-18 14:34:31 +06:00
interface SMESH_Hypothesis;
typedef sequence<SMESH_Hypothesis> ListOfHypothesis;
2003-05-19 19:18:36 +06:00
typedef sequence<double> double_array ;
typedef sequence<long> long_array ;
typedef sequence<string> string_array ;
2004-12-01 15:48:31 +05:00
typedef sequence<long_array> array_of_long_array ;
2003-05-19 19:18:36 +06:00
enum log_command
{
ADD_NODE,
ADD_EDGE,
ADD_TRIANGLE,
ADD_QUADRANGLE,
ADD_POLYGON,
2003-05-19 19:18:36 +06:00
ADD_TETRAHEDRON,
ADD_PYRAMID,
ADD_PRISM,
ADD_HEXAHEDRON,
ADD_POLYHEDRON,
2003-05-19 19:18:36 +06:00
REMOVE_NODE,
2004-12-01 15:48:31 +05:00
REMOVE_ELEMENT,
MOVE_NODE,
CHANGE_ELEMENT_NODES,
CHANGE_POLYHEDRON_NODES,
2004-12-01 15:48:31 +05:00
RENUMBER
2003-05-19 19:18:36 +06:00
};
struct log_block
{
long commandType;
long number;
double_array coords;
long_array indexes;
};
2004-06-18 14:34:31 +06:00
2004-12-01 15:48:31 +05:00
struct PointStruct { double x;
double y;
double z; } ;
struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
struct AxisStruct { double x;
double y;
double z;
double vx;
double vy;
double vz; } ;
2004-06-18 14:34:31 +06:00
/*!
* Enumeration for element type, like in SMDS
*/
enum ElementType
{
ALL,
NODE,
EDGE,
FACE,
VOLUME
};
/*!
* Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
*/
enum Hypothesis_Status // in the order of severity
{
HYP_OK,
HYP_MISSING, // algo misses a hypothesis
HYP_CONCURENT, // several applicable hypotheses
HYP_BAD_PARAMETER,// hypothesis has a bad parameter value
HYP_UNKNOWN_FATAL,// --- all statuses below should be considered as fatal
// for Add/RemoveHypothesis operations
HYP_INCOMPATIBLE, // hypothesis does not fit algo
HYP_NOTCONFORM, // not conform mesh is produced appling a hypothesis
HYP_ALREADY_EXIST,// such hypothesis already exist
HYP_BAD_DIM // bad dimension
};
2003-05-19 19:18:36 +06:00
2004-06-18 14:34:31 +06:00
/*!
* Enumeration for DriverMED read status (used by ImportMEDFile() method)
*/
enum DriverMED_ReadStatus // in the order of severity
{
DRS_OK,
DRS_EMPTY, // a MED file contains no mesh with the given name
DRS_WARN_RENUMBER, // a MED file has overlapped ranges of element numbers,
// so the numbers from the file are ignored
DRS_WARN_SKIP_ELEM, // some elements were skipped due to incorrect file data
DRS_FAIL // general failure (exception etc.)
};
2005-01-20 11:25:54 +05:00
/*!
* Enumeration for DriverMED (used by Perform() method)
*/
enum MED_VERSION // in the order of severity
{
MED_V2_1,
MED_V2_2
};
2003-05-19 19:18:36 +06:00
typedef sequence<log_block> log_array;
2004-12-01 15:48:31 +05:00
interface SMESH_IDSource
{
/*!
* Returns a sequence of all element IDs
*/
long_array GetIDs();
};
interface SMESH_GroupBase;
2004-06-18 14:34:31 +06:00
interface SMESH_Group;
2004-12-01 15:48:31 +05:00
interface SMESH_GroupOnGeom;
2003-05-19 19:18:36 +06:00
interface SMESH_subMesh;
interface SMESH_MeshEditor;
2004-12-01 15:48:31 +05:00
interface SMESH_Mesh : SALOME::GenericObj, SMESH_IDSource
2003-05-19 19:18:36 +06:00
{
/*!
* Associate a Shape to a Mesh created with NewEmpty
*/
2004-12-01 15:48:31 +05:00
// boolean SetMesh(in GEOM::GEOM_Object anObject)
2003-05-19 19:18:36 +06:00
// raises (SALOME::SALOME_Exception);
/*!
* Get the subMesh object associated to a subShape. The subMesh object
* gives access to nodes and elements IDs.
* SubMesh will be used instead of SubShape in a next idl version to
* adress a specific subMesh...
*/
2004-12-01 15:48:31 +05:00
SMESH_subMesh GetSubMesh(in GEOM::GEOM_Object aSubObject, in string name)
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
/*!
* Create a subMesh without reference to a subShape
*/
// SMESH_subMesh NewEmpty()
// raises (SALOME::SALOME_Exception);
2004-12-01 15:48:31 +05:00
/*!
* Get geom shape to mesh. A result may be nil
*/
GEOM::GEOM_Object GetShapeToMesh()
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
/*!
* Remove a submesh
*/
void RemoveSubMesh(in SMESH_subMesh aSubMesh)
raises (SALOME::SALOME_Exception);
/*!
* Create a group
*/
SMESH_Group CreateGroup( in ElementType elem_type,
in string name )
raises (SALOME::SALOME_Exception);
2004-12-01 15:48:31 +05:00
/*!
* Create a group from geometry group
*/
SMESH_GroupOnGeom CreateGroupFromGEOM( in ElementType elem_type,
in string name,
in GEOM::GEOM_Object theGeomObject )
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
/*!
* Remove a group
*/
2004-12-01 15:48:31 +05:00
void RemoveGroup(in SMESH_GroupBase aGroup)
2004-06-18 14:34:31 +06:00
raises (SALOME::SALOME_Exception);
2004-12-01 15:48:31 +05:00
/*!
* Remove group with its contents
*/
void RemoveGroupWithContents( in SMESH_GroupBase aGroup )
raises (SALOME::SALOME_Exception);
/*!
* Union of two groups
* New group is created. All mesh elements that are
* present in initial groups are added to the new one
*/
SMESH_Group UnionGroups (in SMESH_GroupBase aGroup1,
in SMESH_GroupBase aGroup2,
in string name )
raises (SALOME::SALOME_Exception);
/*!
* Intersection of two groups
* New group is created. All mesh elements that are
* present in both initial groups are added to the new one.
*/
SMESH_Group IntersectGroups (in SMESH_GroupBase aGroup1,
in SMESH_GroupBase aGroup2,
in string name )
raises (SALOME::SALOME_Exception);
/*!
* Cut of two groups
* New group is created. All mesh elements that are present in
* main group but do not present in tool group are added to the new one
*/
SMESH_Group CutGroups (in SMESH_GroupBase aMainGroup,
in SMESH_GroupBase aToolGroup,
in string name )
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
/*!
* Add hypothesis to the mesh, under a particular subShape
* (or the main shape itself)
* The Add method is only used to prepare the build of the mesh and store
* the algorithms and associated parameters.
* Actual job of mesh the shape is done by MESH_Gen.
* @params
* - aSubShape : subShape obtained by a shape explode in GEOM
* (or main shape)
* - anHyp : hypothesis object
* @return
* - OK if the hypothesis is compatible with the subShape
* (and all previous hypothesis on the subShape)
* - NOK if the hypothesis is not compatible with the subShape
* (or one previous hypothesis on the subShape)
* raises exception if hypothesis has not been created
*/
2004-12-01 15:48:31 +05:00
Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
2004-06-18 14:34:31 +06:00
in SMESH_Hypothesis anHyp)
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
// boolean AddHypothesis(in SMESH_subMesh aSubMesh, in SMESH_Hypothesis anHyp)
// raises (SALOME::SALOME_Exception);
/*!
* Remove an hypothesis previouly added with AddHypothesis.
*/
2004-12-01 15:48:31 +05:00
Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
2004-06-18 14:34:31 +06:00
in SMESH_Hypothesis anHyp)
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
// boolean RemoveHypothesis(in SMESH_subMesh aSubMesh,
// in SMESH_Hypothesis anHyp)
// raises (SALOME::SALOME_Exception);
/*!
* Get the list of hypothesis added on a subShape
*/
2004-12-01 15:48:31 +05:00
ListOfHypothesis GetHypothesisList(in GEOM::GEOM_Object aSubObject)
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
// ListOfHypothesis GetHypothesisList(in SMESH_subMesh aSubMesh)
// raises (SALOME::SALOME_Exception);
/*!
* Get the log of nodes and elements added or removed since previous
* clear of the log.
* @params
* - clearAfterGet : log is emptied after Get (safe if concurrents access)
*/
// string_array GetLog(in boolean clearAfterGet)
// raises (SALOME::SALOME_Exception);
log_array GetLog(in boolean clearAfterGet)
raises (SALOME::SALOME_Exception);
/*!
* Clear the log of nodes and elements added or removed since previous
* clear. Must be used immediately after GetLog if clearAfterGet is false.
*/
void ClearLog()
raises (SALOME::SALOME_Exception);
/*!
* Get the internal Id
*/
long GetId();
/*!
* Get the study Id
*/
long GetStudyId();
SMESH_MeshEditor GetMeshEditor()
raises (SALOME::SALOME_Exception);
/*!
* Export Mesh to different MED Formats
* @params
* - auto_groups : boolean parameter for creating/not creating
* the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
* the typical use is auto_groups=false.
* - theVersion : define the version of format of MED file, that will be created
2003-05-19 19:18:36 +06:00
*/
2005-01-20 11:25:54 +05:00
void ExportToMED( in string file, in boolean auto_groups, in MED_VERSION theVersion )
2004-06-18 14:34:31 +06:00
raises (SALOME::SALOME_Exception);
/*!
* Export Mesh to MED_V2_1 MED format
* Works, just the same as ExportToMED, with MED_VERSION parameter equal to MED_V2_1.
* The method is kept in order to support old functionality
*/
2004-06-18 14:34:31 +06:00
void ExportMED( in string file, in boolean auto_groups )
raises (SALOME::SALOME_Exception);
2005-01-20 11:25:54 +05:00
/*!
* Export Mesh to DAT, UNV and STL Formats
*/
void ExportDAT( in string file )
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
void ExportUNV( in string file )
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
2004-12-01 15:48:31 +05:00
void ExportSTL( in string file, in boolean isascii )
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
/*!
* Get MED Mesh
*/
SALOME_MED::MESH GetMEDMesh()
raises (SALOME::SALOME_Exception);
long NbNodes()
raises (SALOME::SALOME_Exception);
2005-01-20 11:25:54 +05:00
long NbElements()
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
long NbEdges()
raises (SALOME::SALOME_Exception);
long NbFaces()
raises (SALOME::SALOME_Exception);
long NbTriangles()
raises (SALOME::SALOME_Exception);
long NbQuadrangles()
raises (SALOME::SALOME_Exception);
long NbPolygons()
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
long NbVolumes()
raises (SALOME::SALOME_Exception);
long NbTetras()
raises (SALOME::SALOME_Exception);
long NbHexas()
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
long NbPyramids()
raises (SALOME::SALOME_Exception);
long NbPrisms()
raises (SALOME::SALOME_Exception);
long NbPolyhedrons()
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
long NbSubMesh()
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
2005-01-20 11:25:54 +05:00
long_array GetElementsId()
raises (SALOME::SALOME_Exception);
long_array GetElementsByType( in ElementType theType )
raises (SALOME::SALOME_Exception);
long_array GetNodesId()
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
string Dump();
2003-05-19 19:18:36 +06:00
};
2004-12-01 15:48:31 +05:00
interface SMESH_subMesh : SALOME::GenericObj, SMESH_IDSource
2003-05-19 19:18:36 +06:00
{
/*!
*
*/
long GetNumberOfElements()
raises (SALOME::SALOME_Exception);
/*!
*
*/
2004-12-01 15:48:31 +05:00
long GetNumberOfNodes( in boolean all )
2003-05-19 19:18:36 +06:00
raises (SALOME::SALOME_Exception);
/*!
*
*/
long_array GetElementsId()
raises (SALOME::SALOME_Exception);
2004-06-18 14:34:31 +06:00
/*!
*
*/
long_array GetElementsByType( in ElementType theType )
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
/*!
*
*/
long_array GetNodesId()
raises (SALOME::SALOME_Exception);
2004-12-01 15:48:31 +05:00
/*!
* Get geom shape the submesh is dedicated to
*/
GEOM::GEOM_Object GetSubShape()
raises (SALOME::SALOME_Exception);
2003-05-19 19:18:36 +06:00
/*!
* Get SMESH_Mesh which stores nodes coordinates & elements definition
*/
SMESH_Mesh GetFather()
raises (SALOME::SALOME_Exception);
/*!
* Get the internal Id
*/
long GetId();
/*!
* Get MED subMesh
*/
SALOME_MED::FAMILY GetFamily()
raises (SALOME::SALOME_Exception);
};
/*!
2004-12-01 15:48:31 +05:00
* This interface makes modifications on the Mesh - removing elements and nodes etc.
*/
interface NumericalFunctor;
2003-05-19 19:18:36 +06:00
interface SMESH_MeshEditor {
2004-12-01 15:48:31 +05:00
boolean RemoveElements(in long_array IDsOfElements);
2003-05-19 19:18:36 +06:00
2004-12-01 15:48:31 +05:00
boolean RemoveNodes(in long_array IDsOfNodes);
2003-05-19 19:18:36 +06:00
2004-12-01 15:48:31 +05:00
boolean AddNode(in double x, in double y, in double z);
2003-05-19 19:18:36 +06:00
2004-12-01 15:48:31 +05:00
boolean AddEdge(in long_array IDsOfNodes);
2003-05-19 19:18:36 +06:00
2004-12-01 15:48:31 +05:00
boolean AddFace(in long_array IDsOfNodes);
boolean AddVolume(in long_array IDsOfNodes);
//boolean AddPolygonalFace (in long_array IdsOfNodes);
/*!
* Create volume of many faces, giving nodes for each face.
* \param IdsOfNodes List of node IDs for volume creation face by face.
* \param Quantities List of integer values, Quantities[i]
* gives quantity of nodes in face number i.
*/
boolean AddPolyhedralVolume (in long_array IdsOfNodes,
in long_array Quantities);
/*!
* Create volume of many faces, giving IDs of existing faces.
* \param IdsOfFaces List of face IDs for volume creation.
* \note The created volume will refer only to nodes
* of the given faces, not to the faces itself.
*/
boolean AddPolyhedralVolumeByFaces (in long_array IdsOfFaces);
2004-12-01 15:48:31 +05:00
boolean MoveNode(in long NodeID, in double x, in double y, in double z);
boolean InverseDiag(in long NodeID1, in long NodeID2);
boolean DeleteDiag(in long NodeID1, in long NodeID2);
boolean Reorient(in long_array IDsOfElements);
boolean ReorientObject(in SMESH_IDSource theObject);
boolean TriToQuad(in long_array IDsOfElements,
in NumericalFunctor Criterion,
in double MaxAngle);
boolean TriToQuadObject(in SMESH_IDSource theObject,
in NumericalFunctor Criterion,
in double MaxAngle);
boolean QuadToTri(in long_array IDsOfElements,
in NumericalFunctor Criterion);
boolean SplitQuad(in long_array IDsOfElements,
in boolean Diag13);
boolean SplitQuadObject(in SMESH_IDSource theObject,
in boolean Diag13);
enum Smooth_Method { LAPLACIAN_SMOOTH, CENTROIDAL_SMOOTH };
boolean Smooth(in long_array IDsOfElements,
in long_array IDsOfFixedNodes,
in long MaxNbOfIterations,
in double MaxAspectRatio,
in Smooth_Method Method);
boolean SmoothObject(in SMESH_IDSource theObject,
in long_array IDsOfFixedNodes,
in long MaxNbOfIterations,
in double MaxAspectRatio,
in Smooth_Method Method);
boolean SmoothParametric(in long_array IDsOfElements,
in long_array IDsOfFixedNodes,
in long MaxNbOfIterations,
in double MaxAspectRatio,
in Smooth_Method Method);
boolean SmoothParametricObject(in SMESH_IDSource theObject,
in long_array IDsOfFixedNodes,
in long MaxNbOfIterations,
in double MaxAspectRatio,
in Smooth_Method Method);
2004-12-01 15:48:31 +05:00
void RenumberNodes();
void RenumberElements();
void RotationSweep(in long_array IDsOfElements,
in AxisStruct Axix,
in double AngleInRadians,
in long NbOfSteps,
in double Tolerance);
void RotationSweepObject(in SMESH_IDSource theObject,
in AxisStruct Axix,
in double AngleInRadians,
in long NbOfSteps,
in double Tolerance);
void ExtrusionSweep(in long_array IDsOfElements,
in DirStruct StepVector,
in long NbOfSteps);
void ExtrusionSweepObject(in SMESH_IDSource theObject,
in DirStruct StepVector,
in long NbOfSteps);
void ExtrusionSweepObject1D(in SMESH_IDSource theObject,
in DirStruct StepVector,
in long NbOfSteps);
void ExtrusionSweepObject2D(in SMESH_IDSource theObject,
in DirStruct StepVector,
in long NbOfSteps);
enum Extrusion_Error {
EXTR_OK,
EXTR_NO_ELEMENTS,
EXTR_PATH_NOT_EDGE,
EXTR_BAD_PATH_SHAPE,
EXTR_BAD_STARTING_NODE,
EXTR_BAD_ANGLES_NUMBER,
EXTR_CANT_GET_TANGENT
};
Extrusion_Error ExtrusionAlongPath(in long_array IDsOfElements,
in SMESH_Mesh PathMesh,
in GEOM::GEOM_Object PathShape,
in long NodeStart,
in boolean HasAngles,
in double_array Angles,
in boolean HasRefPoint,
in PointStruct RefPoint);
Extrusion_Error ExtrusionAlongPathObject(in SMESH_IDSource theObject,
in SMESH_Mesh PathMesh,
in GEOM::GEOM_Object PathShape,
in long NodeStart,
in boolean HasAngles,
in double_array Angles,
in boolean HasRefPoint,
in PointStruct RefPoint);
2005-01-20 11:25:54 +05:00
2004-12-01 15:48:31 +05:00
enum MirrorType { POINT, AXIS, PLANE };
void Mirror (in long_array IDsOfElements,
in AxisStruct Mirror,
in MirrorType theMirrorType,
in boolean Copy);
void MirrorObject (in SMESH_IDSource theObject,
in AxisStruct Mirror,
in MirrorType theMirrorType,
in boolean Copy);
void Translate (in long_array IDsOfElements,
in DirStruct Vector,
in boolean Copy);
void TranslateObject (in SMESH_IDSource theObject,
in DirStruct Vector,
in boolean Copy);
void Rotate (in long_array IDsOfElements,
in AxisStruct Axis,
in double AngleInRadians,
in boolean Copy);
void RotateObject (in SMESH_IDSource theObject,
in AxisStruct Axis,
in double AngleInRadians,
in boolean Copy);
void FindCoincidentNodes (in double Tolerance,
out array_of_long_array GroupsOfNodes);
void MergeNodes (in array_of_long_array GroupsOfNodes);
void MergeEqualElements();
enum Sew_Error {
SEW_OK,
SEW_BORDER1_NOT_FOUND,
SEW_BORDER2_NOT_FOUND,
SEW_BOTH_BORDERS_NOT_FOUND,
SEW_BAD_SIDE_NODES,
SEW_VOLUMES_TO_SPLIT,
// for SewSideElements() only:
SEW_DIFF_NB_OF_ELEMENTS,
SEW_TOPO_DIFF_SETS_OF_ELEMENTS,
SEW_BAD_SIDE1_NODES,
SEW_BAD_SIDE2_NODES
};
Sew_Error SewFreeBorders (in long FirstNodeID1,
in long SecondNodeID1,
in long LastNodeID1,
in long FirstNodeID2,
in long SecondNodeID2,
in long LastNodeID2,
in boolean CreatePolygons,
in boolean CreatePolyedrs);
2004-12-01 15:48:31 +05:00
Sew_Error SewConformFreeBorders (in long FirstNodeID1,
in long SecondNodeID1,
in long LastNodeID1,
in long FirstNodeID2,
in long SecondNodeID2);
Sew_Error SewBorderToSide (in long FirstNodeIDOnFreeBorder,
in long SecondNodeIDOnFreeBorder,
in long LastNodeIDOnFreeBorder,
in long FirstNodeIDOnSide,
in long LastNodeIDOnSide,
in boolean CreatePolygons,
in boolean CreatePolyedrs);
2004-12-01 15:48:31 +05:00
Sew_Error SewSideElements (in long_array IDsOfSide1Elements,
in long_array IDsOfSide2Elements,
in long NodeID1OfSide1ToMerge,
in long NodeID1OfSide2ToMerge,
in long NodeID2OfSide1ToMerge,
in long NodeID2OfSide2ToMerge);
2003-05-19 19:18:36 +06:00
};
};
#endif