// Copyright : CEA/DEN/DMSS/LGLS
// $Header$
/*!
-This file contains the main IDL difinitions of the %MED component in %SALOME application.
+This file contains the main IDL definitions of the %MED component in %SALOME application.
*/
#ifndef MED_IDL
#define MED_IDL
/*!
\defgroup MED SALOME MED component
+
+ This component is dedicated to the mounting in memory of a .med file. some
+ services of that component store CORBA objects (MED, MESH, FIELD) in the
+ study and/or give a direct access to those objects.
*/
#include "SALOME_Exception.idl"
interface SUPPORT;
/*!
-This enumeration contains a set of elements difining the type of geometrical elements which constitue
+This enumeration contains a set of elements defining the type of geometrical elements which constitue
a %Mesh.
*/
typedef long medGeometryElement;
/*!
-This enumeration contains a set of elements difining the structural elements (entities) which constitue
+This enumeration contains a set of elements defining the structural elements (entities) which constitue
a %Mesh.
*/
typedef long medEntityMesh;
const medEntityMesh MED_ALL_ENTITIES = 4;
/*!
-This enumeration contains a set of mode to store data in an array.
-For example an array of coordinates in 3D tow storage may be considered:
- - X1,Y1,Z1,X2,Y2,...,Zn if MED_FULL_INTERLACE
- - X1,X2,...Xn,Y1,Y2,...Zn if MED_NO_INTERLACE
+This enumeration contains a set of modes to store data in an array.
+For example an array of coordinates in 3D; tow storage may be considered:
+
+ - X1,Y1,Z1,X2,Y2,Z2,...,Xn,Yn,Zn if MED_FULL_INTERLACE
+ - X1,X2,...,Xn,Y1,Y2,...,Yn,Z1,Z2,...,Zn if MED_NO_INTERLACE
*/
typedef long medModeSwitch;
const medModeSwitch MED_FULL_INTERLACE = 0;
const medDriverTypes NO_DRIVER = 2;
/*!
- An array of <VAR>medGeometryElement</VAR>
+ An array of %medGeometryElement
*/
typedef sequence<medGeometryElement> medGeometryElement_array;
raises (SALOME::SALOME_Exception);
/*!
- Returns the <VAR>SUPPORT<VAR> containing the boundary elements
+ Returns the %SUPPORT containing the boundary elements
of the mesh.
*/
raises (SALOME::SALOME_Exception);
/*!
- Returns the <VAR>SUPPORT<VAR> containing the boundary elements
+ Returns the %SUPPORT containing the boundary elements
of the support mySupport3D.
*/
SUPPORT getSkin(in SUPPORT mySupport3D ) raises (SALOME::SALOME_Exception);
// ------------
/*!
- Returns the number of different <VAR>medGeometryElement</VAR> types existing
+ Returns the number of defferent %medGeometryElement types existing
in the specified entity.
\note
raises (SALOME::SALOME_Exception);
/*!
- Returns an array of all <VAR>medGeometryElement</VAR> types existing
+ Returns an array of all %medGeometryElement types existing
in the mesh.
\note
raises (SALOME::SALOME_Exception);
/*!
- Returns the number of elements of type <VAR>medGeometryElement</VAR>.
+ Returns the number of elements of type %medGeometryElement.
Note :
- Implemented for MED_ALL_ELEMENTS
Give, in full or no interlace mode (for nodal connectivity),
descending or nodal connectivity.
- You must give a <VAR>medEntityMesh</VAR> (ie:MED_EDGE) and a
- <VAR>medGeometryElement</VAR> (ie:MED_SEG3).
+ You must give a %medEntityMesh (ie:MED_EDGE) and a
+ %medGeometryElement (ie:MED_SEG3).
*/
SALOME_MED::long_array getConnectivity(in medModeSwitch typeSwitch,
in medConnectivity mode,
MESH getMesh() raises (SALOME::SALOME_Exception);
/*!
- Returns the type of <VAR>medEntityMesh</VAR> used by the support.
+ Returns the type of %medEntityMesh used by the support.
\note
A support deals only with one entity's type
boolean isOnAllElements() raises (SALOME::SALOME_Exception);
/*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method
+ If the method %isOnAllElements() returns False, this method
returns the number of elements in the support.
Example : number of MED_TRIA3 or MED_ALL_ELEMETNS elements
in entity of support.
\note
- If %SUPPORT is defined on MED_NODE, use MED_NONE <VAR>medGeometryElement</VAR> type.
+ If %SUPPORT is defined on MED_NODE, use MED_NONE %medGeometryElement
+ type.
*/
long getNumberOfElements(in medGeometryElement geomElement)
raises (SALOME::SALOME_Exception);
long getNumberOfTypes() raises (SALOME::SALOME_Exception);
/*!
- If isOnAllElements is False, returns an array of <VAR>medGeometryElement</VAR>
+ If isOnAllElements is False, returns an array of %medGeometryElement
types used by the support.
- <VAR>medEntityMesh</VAR> is given by getEntity.
+ %medEntityMesh is given by getEntity.
*/
medGeometryElement_array getTypes() raises (SALOME::SALOME_Exception);
/*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method returns an array which
- contains all numbers of given <VAR>medGeometryElement</VAR>.
+ If the method %isOnAllElements() returns False, this method returns an array which
+ contains all numbers of given %medGeometryElement.
Numbering is global, ie numbers are bounded by 1 and
MESH::getNumberOfElement(entity,MED_ALL_ELEMENTS) and not by 1 and
MESH::getNumberOfElement(entity,geomElement).
\note
- If %SUPPORT is defined on MED_NODE, use MED_NONE <VAR>medGeometryElement</VAR> type.
+ If %SUPPORT is defined on MED_NODE, use MED_NONE %medGeometryElement type.
*/
SALOME_MED::long_array getNumber(in medGeometryElement geomElement)
raises (SALOME::SALOME_Exception);
/*!
- If the method <VAR>isOnAllElements</VAR> returns False, this method returns the index
+ If the method %isOnAllElements() returns False, this method returns the index
of element number.
Use it with getNumber(MED_ALL_ELEMENTS).
\note
- See the method <VAR>getConnectivityIndex</VAR> for more details.
+ See the method %getConnectivityIndex for more details.
*/
SALOME_MED::long_array getNumberIndex()
raises (SALOME::SALOME_Exception);
/*!
- Returns the number of Gauss points for this <VAR>medGeometryElement</VAR>.
+ Returns the number of Gauss points for this %medGeometryElement.
\note
- Not defined if %SUPPORT is on MED_NODE.
- - Not defined for MED_ALL_ELEMENTS <VAR>medGeometryElement</VAR> type.
+ - Not defined for MED_ALL_ELEMENTS %medGeometryElement type.
*/
long getNumberOfGaussPoint(in medGeometryElement geomElement)
raises (SALOME::SALOME_Exception);
*/
string getComponentUnit(in long i) raises (SALOME::SALOME_Exception);
-
+ /*!
+ Returns the iteration number.
+ */
long getIterationNumber() raises (SALOME::SALOME_Exception);
/*!
{
interface MED_Gen : Engines::Component, SALOMEDS::Driver
{
- SALOME_MED::MESH readMeshInFile(in string fileName,
- in string studyName,
- in string meshName )
- raises (SALOME::SALOME_Exception);
- SALOME_MED::FIELD readFieldInFile(in string fileName,
- in string studyName,
- in string fieldName,
- in long ordre,
- in long iter )
- raises (SALOME::SALOME_Exception);
- SALOME_MED::MED readStructFile(in string fileName,
- in string studyName )
- raises (SALOME::SALOME_Exception);
-
- void readStructFileWithFieldType(in string fileName,
- in string studyName )
- raises (SALOME::SALOME_Exception);
+ /*!
+ it returns a Corba pointer %MESH on the mesh stored in the .med file
+ <VAR>fileName</VAR> with the name <VAR>meshName</VAR>; and it pushes it
+ in the study named <VAR>studyName</VAR>.
+ */
+ SALOME_MED::MESH readMeshInFile(in string fileName, in string studyName,
+ in string meshName)
+ raises(SALOME::SALOME_Exception);
+
+ /*!
+ it returns a Corba pointer %FIELD on the field instance with the order
+ <VAR>ordre</VAR> at the iteration <VAR>iter</VAR>, stored in the .med
+ file <VAR>fileName</VAR> with the name <VAR>fieldName</VAR>; and it
+ pushes it in the study named <VAR>studyName</VAR>.
+ */
+ SALOME_MED::FIELD readFieldInFile(in string fileName, in string studyName,
+ in string fieldName, in long ordre,
+ in long iter)
+ raises (SALOME::SALOME_Exception);
+
+ /*!
+ it returns a Corba pointer on the %MED object regrouping all objects
+ (%MESH and %FIELD) stored in the file <VAR>fileName</VAR>; and it pushes
+ all those objects in the study named <VAR>studyName</VAR>. All instances
+ of the fields are stored without their type.
+ */
+ SALOME_MED::MED readStructFile(in string fileName,
+ in string studyName)
+ raises (SALOME::SALOME_Exception);
+
+ /*!
+ It pushes all Corba pointers (%MED, %MESH, %FIELD) in the study named
+ <VAR>studyName</VAR>. The %MED object regroups all objects
+ (%MESH and %FIELD) stored in the file <VAR>fileName</VAR> and all
+ instances of the fields are stored with their own type.
+ */
+ void readStructFileWithFieldType(in string fileName,
+ in string studyName)
+ raises (SALOME::SALOME_Exception);
};
};
