-// Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE
//
// Copyright (C) 2003-2007 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.
+// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
#include "SALOME_Exception.idl"
#include "SALOME_GenericObj.idl"
#include "GEOM_Gen.idl"
-#include "MED.idl"
module SMESH
{
double_array coords;
long_array indexes;
};
+ typedef sequence<log_block> log_array;
struct PointStruct { double x;
- double y;
- double z; } ;
+ double y;
+ double z; } ;
typedef sequence<PointStruct> nodes_array;
- struct DirStruct { PointStruct PS ; } ; // analog to Occ Direction
+ struct DirStruct { PointStruct PS ; } ; // analog to OCCT gp_Vec
struct AxisStruct { double x;
- double y;
- double z;
- double vx;
- double vy;
- double vz; } ;
-
+ double y;
+ double z;
+ double vx;
+ double vy;
+ double vz; } ;
/*!
* Node location on a shape
*/
FACE,
VOLUME,
ELEM0D,
- BALL
+ BALL,
+ NB_ELEMENT_TYPES
};
typedef sequence<ElementType> array_of_ElementType ;
/*!
- * Enumeration for element geometry type, like in SMDS
+ * Enumeration for element geometry type, like SMDSAbs_GeometryType in SMDSAbs_ElementType.hxx
*/
enum GeometryType
{
ORDER_QUADRATIC /*! entities of 2nd order */
};
-
/*!
* Enumeration of entity type used in mesh info array,
* it should be synchronised with enum SMDSAbs_EntityType
Entity_Last
};
-
/*!
* Enumeration for hypothesis status (used by AddHypothesis() and RemoveHypothesis() methods)
*/
HYP_BAD_DIM, // bad dimension
HYP_BAD_SUBSHAPE, // shape is neither the main one, nor its sub-shape, nor a group
HYP_BAD_GEOMETRY, // geometry mismatches algorithm's expectation
- HYP_NEED_SHAPE // algorithm can work on shape only
+ HYP_NEED_SHAPE, // algorithm can work on shape only
+ HYP_INCOMPAT_HYPS // several additional hypotheses are incompatible one with other
};
/*!
- * Enumeration for DriverMED read status (used by ImportMEDFile() method)
+ * Enumeration for mesh read status (used by SMESH_Gen::CreateMeshesFrom*() methods)
*/
enum DriverMED_ReadStatus // in the order of severity
{
DRS_OK,
- DRS_EMPTY, // a MED file contains no mesh with the given name
+ DRS_EMPTY, // a 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
};
/*!
- * Enumeration for DriverMED (used by Perform() method)
+ * Enumeration for ExportToMED*()
*/
- enum MED_VERSION // in the order of severity
+ enum MED_VERSION
{
MED_V2_1,
MED_V2_2
};
- typedef sequence<log_block> log_array;
-
+ /*!
+ * \brief A structure containing information about MED file
+ */
+ struct MedFileInfo
+ {
+ string fileName; //!< name of file
+ long fileSize; //!< size of file
+ long major, minor, release; //!< MED file version
+ };
/*!
* Auxilary flags for advanced extrusion.
interface SMESH_Mesh;
- interface SMESH_IDSource
+ interface SMESH_IDSource : SALOME::GenericObj
{
/*!
* Returns a sequence of all element IDs
long_array GetIDs();
/*!
- * Returns statistic of mesh elements
- * @return array of number enityties by index of EntityType
+ * Returns number of mesh elements of each \a EntityType
+ * @return array of number of elements per \a EntityType
*/
long_array GetMeshInfo();
+ /*!
+ * Returns number of mesh elements of each \a ElementType
+ * @return array of number of elements per \a ElementType
+ */
+ long_array GetNbElementsByType();
+
/*!
* Returns types of elements it contains.
* It's empty if the SMESH_IDSource contains no IDs
* Create a group
*/
SMESH_Group CreateGroup( in ElementType elem_type,
- in string name )
+ in string name )
raises (SALOME::SALOME_Exception);
/*!
raises (SALOME::SALOME_Exception);
/*!
- * Add hypothesis to the mesh, under a particular Sub-shape
+ * Add hypothesis to the mesh, under a particular sub-shape
* (or the main shape itself)
- * The Add method is only used to prepare the build of the mesh and store
+ * This 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.
+ * Actual job of meshing the shape is done by SMESH_Gen::Compute()
* @params
- * - aSubShape : sub-shape obtained by a shape explode in GEOM
+ * - aSubObject : sub-shape obtained by a shape explode in GEOM
* (or main shape)
- * - anHyp : hypothesis object
+ * - anHyp : an hypothesis object
* @return
- * - OK if the hypothesis is compatible with the sub-shape
- * (and all previous hypothesis on the sub-shape)
- * - NOK if the hypothesis is not compatible with the sub-shape
- * (or one previous hypothesis on the sub-shape)
- * raises exception if hypothesis has not been created
+ * - An enum item explaining what's up
+ * - anErrorText: an optional textual description of a problem (if any)
*/
Hypothesis_Status AddHypothesis(in GEOM::GEOM_Object aSubObject,
- in SMESH_Hypothesis anHyp)
+ in SMESH_Hypothesis anHyp,
+ out string anErrorText)
raises (SALOME::SALOME_Exception);
/*!
* Remove an hypothesis previouly added with AddHypothesis.
*/
Hypothesis_Status RemoveHypothesis(in GEOM::GEOM_Object aSubObject,
- in SMESH_Hypothesis anHyp)
+ in SMESH_Hypothesis anHyp)
raises (SALOME::SALOME_Exception);
/*!
boolean HasDuplicatedGroupNamesMED();
/*!
- * Export Mesh to different MED Formats
+ * Export Mesh to a MED Format file
* @params
* - file : name of the MED file
* - 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.
- * - version : define the version of format of MED file, that will be created
+ * the groups Group_On_All_Nodes, Group_On_All_Faces, ... ;
+ * the typical use is auto_groups=false.
+ * - version : defines the version of format of MED file, that will be created
* - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
+ * - autoDimension : if @c true, a space dimension of a MED mesh can be either
+ * - 1D if all mesh nodes lie on OX coordinate axis, or
+ * - 2D if all mesh nodes lie on XOY coordinate plane, or
+ * - 3D in the rest cases.
+ * If @a autoDimension is @c false, the space dimension is always 3.
*/
void ExportToMEDX( in string file,
in boolean auto_groups,
in MED_VERSION version,
- in boolean overwrite ) raises (SALOME::SALOME_Exception);
+ in boolean overwrite,
+ in boolean autoDimension) raises (SALOME::SALOME_Exception);
/*!
- * Export a part of Mesh into a MED file
+ * Export a [part of] Mesh into a MED file
* @params
* - meshPart : a part of mesh to store
* - file : name of the MED file
* - version : define the version of format of MED file, that will be created
* - overwrite : boolean parameter for overwriting/not overwriting the file, if it exists
- */
- void ExportPartToMED( in SMESH_IDSource meshPart,
- in string file,
- in boolean auto_groups,
- in MED_VERSION version,
- in boolean overwrite ) raises (SALOME::SALOME_Exception);
-
- /*!
- * Export Mesh to different MED Formats
+ * - autoDimension : if @c True, a space dimension for export is defined by mesh
+ * configuration; for example a planar mesh lying on XOY plane
+ * will be exported as a mesh in 2D space.
+ * If @a autoDimension == @c False, the space dimension is 3.
+ * - fields : list of GEOM fields defined on the shape to mesh.
+ * - geomAssocFields : each character of this string means a need to export a
+ * corresponding field; correspondence between fields and characters is following:
+ * - 'v' stands for _vertices_ field;
+ * - 'e' stands for _edges_ field;
+ * - 'f' stands for _faces_ field;
+ * - 's' stands for _solids_ field.
+ */
+ void ExportPartToMED( in SMESH_IDSource meshPart,
+ in string file,
+ in boolean auto_groups,
+ in MED_VERSION version,
+ in boolean overwrite,
+ in boolean autoDimension,
+ in GEOM::ListOfFields fields,
+ in string geomAssocFields ) raises (SALOME::SALOME_Exception);
+
+ /*!
+ * Export Mesh to a MED Format file
* Works, just the same as ExportToMEDX, with overwrite parameter equal to true.
* The method is kept in order to support old functionality
*/
void ExportPartToSTL( in SMESH_IDSource meshPart,
in string file,
in boolean isascii ) raises (SALOME::SALOME_Exception);
-
/*!
- * Get MED Mesh
+ * Return computation progress [0.,1]
*/
- SALOME_MED::MESH GetMEDMesh()
- raises (SALOME::SALOME_Exception);
+ double GetComputeProgress();
/*!
* Get informations about mesh contents
EntityType GetElementGeomType( in long id )
raises (SALOME::SALOME_Exception);
+ GeometryType GetElementShape( in long id )
+ raises (SALOME::SALOME_Exception);
+
long_array GetSubMeshElementsId(in long ShapeID)
raises (SALOME::SALOME_Exception);
* Methods to set meshing order of submeshes
*/
+ /*!
+ * \brief Return \c true if a meshing order not yet set for a concurrent sub-mesh
+ */
+ boolean IsUnorderedSubMesh(in long submeshID);
+
/*!
* \brief Return submesh objects list in meshing order
*/
*/
long_array GetElemFaceNodes(in long elemId, in short faceIndex);
+ /*!
+ * Returns three components of normal of given mesh face (or an empty array in KO case)
+ */
+ double_array GetFaceNormal(in long faceId, in boolean normalized);
+
/*!
* Returns an element based on all given nodes.
*/
double_array BaryCenter(in long id);
/*! Gets information about imported MED file */
- SALOME_MED::MedFileInfo GetMEDFileInfo();
+ MedFileInfo GetMEDFileInfo();
/*!
* Sets list of notebook variables used for Mesh operations separated by ":" symbol
* Get the internal Id
*/
long GetId();
-
- /*!
- * Get MED subMesh
- */
- SALOME_MED::FAMILY GetFamily()
- raises (SALOME::SALOME_Exception);
};
};
