doc/tutorial/medloader_basicAPI1_fr.rst

   1
   2 Lecture, écriture d'un fichier MED grâce à l'API basique de MEDLoader
   3 ---------------------------------------------------------------------
   4
   5 L'API basique de MEDLoader est contenue dans la classe ``MEDLoader``.
   6 Toutes les méthodes de cette classe sont *statiques* (elles ne dépendent pas d'une instance particulière de la
   7 classe), leurs noms commencent par une majuscule.
   8 L'ensemble des lectures/écritures sont exécutées à chaque appel de méthode et aucun état interne à la classe n'est
   9 enregistré.
  10
  11 Objectif
  12 ~~~~~~~~
  13
  14 Ecrire un maillage et un champ à partir de rien, les relire et comparer les résultats.
  15
  16 Points abordés: en utilisant l'API basique de ``MEDLoader``
  17
  18 * Ecrire un fichier
  19 * Lire un fichier
  20
  21 Début d'implémentation
  22 ~~~~~~~~~~~~~~~~~~~~~~
  23
  24 Cet exercice repose comme tous les autres sur le language de script Python. On charge
  25 le module Python ``medcoupling``.::
  26
  27         import medcoupling as mc
  28
  29 Lecture, écriture d'un maillage
  30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  31
  32 Tout d'abord créons un maillage ``targetMesh`` composé de plusieurs types géométriques. ::
  33
  34         targetCoords = [-0.3,-0.3, 0.2,-0.3, 0.7,-0.3, -0.3,0.2, 0.2,0.2, 0.7,0.2, -0.3,0.7, 0.2,0.7, 0.7,0.7 ]
  35         targetConn = [0,3,4,1, 1,4,2, 4,5,2, 6,7,4,3, 7,8,5,4]
  36         targetMesh = mc.MEDCouplingUMesh("MyMesh",2)
  37         targetMesh.allocateCells(5)
  38         targetMesh.insertNextCell(mc.NORM_TRI3,3,targetConn[4:7])
  39         targetMesh.insertNextCell(mc.NORM_TRI3,3,targetConn[7:10])
  40         targetMesh.insertNextCell(mc.NORM_QUAD4,4,targetConn[0:4])
  41         targetMesh.insertNextCell(mc.NORM_QUAD4,4,targetConn[10:14])
  42         targetMesh.insertNextCell(mc.NORM_QUAD4,4,targetConn[14:18])
  43         myCoords = mc.DataArrayDouble(targetCoords,9,2)
  44         myCoords.setInfoOnComponents(["X [km]","YY [mm]"])
  45         targetMesh.setCoords(myCoords)
  46
  47 .. note:: Le maillage ``targetMesh`` est ordonné par type géométrique.
  48
  49 Le maillage peut alors directement être écrit ... ::
  50
  51         mc.WriteUMesh("TargetMesh.med",targetMesh,True)  # True means 'from scratch'
  52
  53 ... et relu. ::
  54
  55         meshRead = mc.ReadUMeshFromFile("TargetMesh.med",targetMesh.getName(),0)
  56         print("Is the read mesh equal to 'targetMesh' ?", meshRead.isEqual(targetMesh,1e-12))
  57
  58 Lire/Ecrire un champ sur un pas de temps
  59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  60
  61 Nous créons maintenant un champ de vecteurs ``f`` aux cellules (P0) avec ``targetMesh`` comme support.
  62 Ce champ correspond par exemple au temps physique 5.6, repéré par l'itération 7 et la sous-itération 8.
  63 Nous en profitons pour rappeler
  64 que dans les champs MEDCoupling, le temps physique est donné pour information seulement, le stockage et la plupart des
  65 fonctions de l'API se basent sur les deux derniers entiers. ::
  66
  67         f = mc.MEDCouplingFieldDouble.New(mc.ON_CELLS, mc.ONE_TIME)
  68         f.setTime(5.6,7,8)                              # Declare the timestep associated to the field
  69         f.setArray(targetMesh.computeCellCenterOfMass())
  70         f.setMesh(targetMesh)
  71         f.setName("AFieldName")
  72         mc.WriteField("MyFirstField.med",f,True)
  73
  74 Question subsidiaire : à quoi correspond le champ ainsi créé ?
  75
  76 .. note:: Le maillage **et** le champ sont écrits d'un seul coup dans le fichier "MyFirstField.med".
  77
  78 Nous relisons ensuite MyFirstField.med : ::
  79
  80         f2 = mc.ReadFieldCell("MyFirstField.med", f.getMesh().getName(), 0, f.getName(), 7, 8)
  81         print("Is the read field identical to 'f' ?", f2.isEqual(f,1e-12,1e-12))
  82
  83 .. note:: Lors de la lecture du champ, on doit donc connaître: son nom, le nom de sa mesh de support
  84         et le pas de temps voulu. Des fonctions du type ``MEDFileFields.getFieldsNames()`` ou encore
  85         ``MEDFileMeshes.getMeshesNames()`` aident à cela.
  86
  87 .. note:: Le nom ``ReadFieldCell()`` rappelle que le champ doit être lu aux cellules. Souvenez-vous que suivant la
  88         norme MED fichier, un même champ peut avoir une partie de ses données stockées aux cellules, mais aussi
  89         simultanément aux noeuds, aux points de Gauss, etc ... même si ce genre de mélange exotique n'est généralement
  90         pas conseillé.
  91
  92 Lire/Ecrire un champ sur plusieurs pas de temps
  93 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94
  95 Ici contrairement au cas précédent, nous écrivons en plusieurs fois dans le *même* fichier MED.
  96 Ecrivons tout d'abord le maillage. ::
  97
  98         mc.WriteUMesh("MySecondField.med",f.getMesh(),True)
  99
 100 Ensuite, nous écrivons seulement les informations relatives au champ (principalement son tableau de valeurs en fait
 101 ). ::
 102
 103         mc.WriteFieldUsingAlreadyWrittenMesh("MySecondField.med",f)   # mesh is not re-written
 104
 105 Nous rajoutons ensuite un second pas de temps sur le *même* maillage. ::
 106
 107         f2 = f.clone(True)         # 'True' means that we need a deep copy
 108         f2.getArray()[:] = 2.0
 109         f2.setTime(7.8,9,10)
 110         mc.WriteFieldUsingAlreadyWrittenMesh("MySecondField.med",f2)
 111
 112 Maintenant le fichier "MySecondField.med" contient le maillage et un champ à deux pas de temps porté par ce maillage.
 113
 114 Nous pouvons relire tout cela avec des méthodes similaires à ce qui a été vu précédemment : ::
 115
 116         f3 = mc.ReadFieldCell("MySecondField.med",f.getMesh().getName(),0,f.getName(),7,8)
 117         print("Is the field read in file equals to 'f' ?", f.isEqual(f3,1e-12,1e-12))
 118         f4 = mc.ReadFieldCell("MySecondField.med",f.getMesh().getName(),0,f.getName(),9,10)
 119         print("Is the field read in file equals to 'f2' ?", f2.isEqual(f4,1e-12,1e-12))
 120
 121 Solution
 122 ~~~~~~~~
 123
 124 :ref:`python_testMEDLoaderBasicAPI1_solution`