.. meta::
:keywords: maillage, champ, manipulation, med, dĂŠveloppement
:author: Guillaume Boulant
.. include:: medcalc-definitions.rst
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Module MED: Guide de dĂŠveloppement du composant MEDCalc
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Le composant logiciel MEDCalc est un ĂŠlĂŠment du module MED. Il fournit
une interface utilisateur pour la manipulation de maillages et de
champs, composĂŠe d'une interface texte (TUI) et d'une interface
graphique (GUI). L'interface graphique constitue l'interface graphique
du module MED.
Ce document est la documentation technique du composant MEDCalc. Il
fournit les instructions Ă suivre pour installer le composant en vue
d'un travail de dĂŠveloppement, puis dĂŠcrit les ĂŠlĂŠments de conception.
.. contents:: Sommaire
:local:
:backlinks: none
Mise en place de l'espace de dĂŠveloppement
==========================================
Gestion de configuration du composant MEDCalc
-------------------------------------------
Le composant logiciel MEDCalc est un package du module SALOME MED,
hĂŠbergĂŠ dans l'espace source au niveau du sous-rĂŠpertoire
`src/MEDCalc`. La gestion des fichiers sources est donc intĂŠgrĂŠe dans le
module SALOME MED.
Organisation des sources du composant MEDCalc
-------------------------------------------
Le rĂŠpertoire source `src/MEDCalc` distingue les sous-rĂŠpertoires
suivants:
* cmp: package containing the SALOME components
* tui: package containing the python user interface
* gui: package containing the graphical user interface (the GUI part
of the MED module)
* res: resources files associated to the MEDCalc package (icons, config
files, data files, ...)
* exe: additional executable programs that can be launched from the
MEDCalc framework
Construction du composant MEDCalc
-------------------------------
IntĂŠgrĂŠ Ă la construction du module MED. Le composant MEDCalc dĂŠpend de
MEDCoupling et MEDLoader uniquement.
ExĂŠcution des tests unitaires du composant MEDCalc
------------------------------------------------
Les tests unitaires peuvent ĂŞtre exĂŠcutĂŠs au moyen de scripts python
lancĂŠs depuis une session shell SALOME. Dans un nouveau shell, taper::
$ ./appli/runSession
[NS=mars:2810]$ python appli/bin/salome/med/test_medcalc_components.py
L'exĂŠcution imprime un rapport dĂŠtaillant le rĂŠsultat pour chaque
fonction de test::
test_Calculator_applyFunc (__main__.MyTestSuite) ... ok
test_Calculator_basics (__main__.MyTestSuite) ... ok
test_MEDDataManager_getFieldListInFieldseries (__main__.MyTestSuite) ... ok
test_MEDDataManager_getFieldseriesListOnMesh (__main__.MyTestSuite) ... ok
test_MEDDataManager_getMesh (__main__.MyTestSuite) ... ok
test_MEDDataManager_getMeshList (__main__.MyTestSuite) ... ok
test_loadDatasource (__main__.MyTestSuite) ... ok
test_getDataManager (__main__.MyTestSuite) ... ok
test_getFieldHandlerList (__main__.MyTestSuite) ... ok
test_getFieldRepresentation (__main__.MyTestSuite) ... ok
test_markAsPersistent (__main__.MyTestSuite) ... ok
test_saveFields (__main__.MyTestSuite) ... ok
test_updateFieldMetadata (__main__.MyTestSuite) ... ok
Les scripts de test sont installĂŠs dans le rĂŠpertoire ``bin/med``. On trouve:
* ``test_medcalc_components.py``: test les composants SALOME dĂŠveloppĂŠs pour
la manipulation de champs (``MEDDataManager`` et ``MEDCalculator``).
* ``test_xmed_fieldOperations.py``: test des operations de champs telles
qu'elles sont mises en oeuvre depuis l'interface textuelle.
* ``test_xmed_uiEventListener.py``: test du système de notification
d'Êvènements des composants vers la partie gui du module MED.
* ``test_xmed_visualisation.py``: test du système de visualisation
des champs tel que pilotĂŠ depuis le module MED.
Architecture du module XMED
===========================
Le module MED pour la manipulation de champs est composĂŠ de:
* une bibliothèque de fonctions pour le traitement de donnÊes sur des
maillages et des champs conformes au modèle MED (package
MEDCoupling, MEDLoader et REMAPPER);
* une interface graphique pour la mise en oeuvre des cas standard de
manipulation de champs;
* une ensemble d'outils pour intervenir sur des fichiers au format
MED.
Une bibliothèque de fonctions pour le traitement de donnÊes
-----------------------------------------------------------
La figure ci-dessous montre la structure des paquets logiciels qui
constituent la bibliothèque:
.. image:: images/medlayers.png
:align: center
Elle comprend en particulier les paquets suivants:
* MEDCoupling: qui dĂŠcrit les structures de donnĂŠes pour porter les
maillages et les champs
* MEDLoader: qui fournit les fonctions de persistence sous forme de
fichiers au format MED (lecture et ĂŠcriture).
* REMAPPER:
Il est important de noter que MEDCoupling n'a aucune dĂŠpendance
logicielle autre que la bibliothèque C++ standard. Ceci permet
d'envisager son implantation dans un code de calcul ou un outil de
traitement sans tirer l'ensemble prĂŠ-requis de SALOME.
Une interface graphique pour l'exĂŠcution des cas standard
---------------------------------------------------------
Un ensemble d'outils pour le traitement de fichiers
---------------------------------------------------
Description des composants
==========================
MEDDataManager - Le gestionnaire des donnĂŠes de session
-------------------------------------------------------
Le composant MEDDataManager s'occupe de fournir les donnĂŠes MED sur
demande des interfaces clientes, en particulier pour module de
pilotage fieldproxy.py. Ces donnĂŠes peuvent avoir plusieurs sources,
en gĂŠnĂŠral elle proviennent d'un fichier au format med contenant des
champs dĂŠfinis sur des maillages. Les donnĂŠes sont identifiĂŠes Ă la
lecture des mĂŠtadonnĂŠes de description dans le fichiers med, puis les
valeurs des champs et les maillages support sont chargĂŠs au besoin.
Le chargement des mĂŠtadonnĂŠes de description se fait par la mĂŠthode::
loadDatasource(const char \*filepath)
ElĂŠments d'implĂŠmentation
=========================
Ecrire un service CORBA qui retourne une sequence de FieldHandler:
.. code-block:: cpp
MEDCALC::FieldHandlerList * MyFunction(...) {
vector<MEDCALC::FieldHandler*> fieldHandlerList;
...
fieldHandlerList.push_back(fieldHandler);
// Map the resulting list to a CORBA sequence for return:
MEDCALC::FieldHandlerList_var fieldHandlerSeq = new MEDCALC::FieldHandlerList();
int nbFieldHandler = fieldHandlerList.size();
fieldHandlerSeq->length(nbFieldHandler);
for (int i=0; i<nbFieldHandler; i++) {
fieldHandlerSeq[i] = *fieldHandlerList[i];
}
return fieldHandlerSeq._retn();
}
Ecrire un service CORBA qui retourne une structure CORBA:
.. code-block:: cpp
MEDCALC::FieldHandler * fieldHandler = new ...
_fieldHandlerMap[fieldHandler->id] = fieldHandler;
// >>> WARNING: CORBA struct specification indicates that the
// assignement acts as a desctructor for the structure that is
// pointed to. The values of the fields are copy first in the new
// structure that receives the assignement and finally the initial
// structure is destroyed. In the present case, WE WANT to keep
// the initial fieldHandler in the map. We must then make a deep
// copy of the structure found in the map and return the copy. The
// CORBA struct specification indicates that a deep copy can be
// done using the copy constructor. <<<
return new MEDCALC::FieldHandler(*fieldHandler);
ANNEXE A: Bug en cours
======================
TO FIX:
* la composition d'opĂŠrations n'est pas possible (ex: 2*f1+f2) car
2*f1 est indiquĂŠ comme non compatible (il semble qu'il n'ai pas la
reference correcte vers le maillage).
* le script de test test_medoperation.py plante si le module xmed n'a
pas ĂŠtĂŠ chargĂŠ avec des donnĂŠes chargĂŠes.
ANNEXE B: TraçabilitÊ avec le module XMED
=========================================
Le module SALOME de nom XMED est l'espace de dĂŠveloppement initial du
composant logiciel MEDCalc, intĂŠgrĂŠ aujourd'hui au module MED. Cette
annexe est la notice technique de ce module, qui reste disponible mais
qui n'est plus maintenu.
Gestion de configuration du module XMED
---------------------------------------
Les sources du module (rĂŠpertoire ``xmed``) sont archivĂŠs en dĂŠpĂ´t de
configuration dans une base git du projet NEPAL. Ils peuvent ĂŞtre
rĂŠcupĂŠrĂŠs au moyen de la commande::
$ git clone git@cli70rw.der.edf.fr:xom/xmed.git
Cette commande installe un rĂŠpertoire ``xmed`` contenant l'ensemble
des sources du module XMED.
Le module XMED a pour prĂŠ-requis logiciel la plateforme SALOME:
* SALOME version 6.1.3 (au moins) Ă tĂŠlĂŠcharger Ă l'URL
http://pal.der.edf.fr/pal/projets/pal/releases/V6_1_3
* On peut ĂŠgalement utiliser une version dĂŠrivĂŠe comme SALOME-MECA 2010.1
* Installer la plate-forme choisie selon les instructions fournies.
Le module XMED utilise Êgalement une bibliothèque interne au projet
NEPAL, appelĂŠe XSALOME, et qui fournit une extension aux fonctions de
SALOME pour un usage de dĂŠveloppement (XSALOME signifie eXtension
SALOME). Les sources de cette bibliothèque doivent être rÊcupÊrÊs au
moyen de la commande::
$ git clone git@cli70rw.der.edf.fr:xom/xsalome.git
Cette commande installe un rĂŠpertoire ``xsalome`` contenant l'ensemble
des sources de la bibliothèque XSALOME.
.. note:: La bibliothèque XSALOME n'est pas un module SALOME mais une
simple bibliothèque de fonctions qui complète ou rend plus facile
d'utilisation les fonctions de SALOME. Elle NE DOIT EN AUCUN CAS
ĂŞtre intĂŠgrĂŠe Ă d'autres projets que les projets internes NEPAL ou
MAILLAGE. Il s'agit en effet d'une bibliothèque de transition qui
hĂŠberge des dĂŠveloppements destinĂŠs Ă ĂŞtre reversĂŠs dans la
plate-forme SALOME. Le contenu et les interfaces de XSALOME ne peut
donc ĂŞtre garanti sur le long terme.
Installation et lancement de l'application
------------------------------------------
L'installation suppose qu'une version 6.1.3 de SALOME (ou plus) est
disponible et que le shell de travail est ĂŠtendu avec l'environnement
de SALOME. En gĂŠnĂŠral, par des commandes de la forme::
$ . /where/is/salome/prerequis.sh
$ . /where/is/salome/envSalome.sh
La compilation des modules xsalome et xmed suit le standard SALOME. La
bibliothèque xsalome est un prÊrequis à la compilation de xmed. Pour
cela, la variable d'environnement XSALOME_DIR doit ĂŞtre spĂŠcifiĂŠe pour
la configuration de la procĂŠdure de reconstruction de xmed::
$ export XSALOME_DIR=<xsalome_installdir>
AprĂŠs l'installation de xmed, il est possible de gĂŠnĂŠrer
automatiquement une application SALOME prĂŞte Ă l'emploi pour la
manipulation de champs::
$ <xmed_installdir>/bin/salome/xmed/appligen/appligen.sh
Cette commande gĂŠnĂŠre un rĂŠpertoire ``appli`` Ă l'emplacement oĂš elle
est exĂŠcutĂŠe. Il reste Ă lancer l'application SALOME au moyen de la
commande::
$ ./appli/runAppli -k