README

   1 Documentation for the MEDMEM library and related tools is given in
   2 $(prefix)/doc/user/html/index.html
   3
   4 I : Major evolution of the Med Memory package between V2.2.x and V3.2.x :
   5 =========================================================================
   6
   7 The Med Memory may be used as a stand alone package with only the C++ and the
   8 python layers (adding --without-kernel at the configure step). In this case
   9 there are no links with the SALOME KERNEL.
  10
  11 In this version,
  12
  13 - mesh defined with polygones/polyhedra mixed with usual types of cells;
  14
  15 - the Med File drivers of the Med Memory support the V2.1 as well as the
  16   V2.2 versions of the Med File layer. The requirement of the Salome platform
  17   is only Med File V2.2, the V2.1 version is emberked in the Med Memory.
  18
  19 - Using the Med file (V2.1 and V2.2) and GIBI drivers; fields laying on a
  20   partial support;
  21
  22 - Fields defined on cells mesh with multiple gauss points,
  23
  24 may be mounted in memory and treated.
  25
  26 With all those new functionalities, most of the Med Memory client codes
  27 based on previous releases of the Med Memory should work; but minor changes
  28 should be done for the get/set field classes methods:
  29
  30 - the getValue() and the setValue(T *) methods take no MED_EN::medModeSwitch
  31   parameter;
  32 - the getValueI (resp. setValueI) should be replaced by getRow(int )
  33   (resp. setRow(int ,T*) if the field is in full interlacing mode (using the
  34   method getInterlacingType() of the class FIELD_). If the field is stored in
  35   no interlacing mode getValueIJ (resp. setValueIJ) should be replaced by
  36   getColumn(int ) (resp. setColumn(int ,T*)).
  37
  38 Intensive debugging was carried throughout the entire Med Memory C++ Layer:
  39
  40   - especially on the major user's C++ classes (such as MED, MESH,
  41     SUPPORT and FIELD);
  42
  43   - the C++ drivers classes on those major classes. Especially the
  44     Med File and the GIBI drivers are read/write ones. The VTK drivers
  45     are only for the writing; and finally the PORFLOW drivers may only
  46     be used for the MESH class in the reading mode.
  47
  48 The Med Client layer of the Med Memory has been tested in a full
  49 Server/Client configuration.
  50
  51 II : MedMemory building and installation :
  52 =========================================
  53
  54 It's very simple :
  55
  56 ./configure --prefix=path_to_your_installation_directory
  57 make
  58 make install
  59
  60 eventually if the user or the installer needs to build an installation of Med
  61 Memory as a stand alone package, he may use the configure option
  62 --without-kernel. By default the full debug options are set:
  63       - compilation using -g option
  64       - Med Memory debugging information history using -D_DEBUG_ option.
  65
  66 The user may get all configure option with :
  67   ./configure --help
  68
  69 The user may set optimization option :
  70   ./configure --enable-production --disable-debug (use compiler flags -O)
  71
  72 In order to avoid most of the problem the user or the installer should first
  73 check the HDF5HOME and the MED2HOME environment variables. This version of
  74 Med Memory with Med File V2.2.2, V2.2.3, as well as V2.3.0 but with the
  75 version of HDF5 V1.6.3. In the installation of Med File you should take care
  76 of the $HDF5HOME environment variable. This warning is especially intended
  77 to the user of The Med Memory in stand alone (without the SALOME KERNEL
  78 component).
  79
  80 III : MedMemory testing :
  81 =========================
  82
  83 After installation of the Med Memory; the user may find a large set of test
  84 files in Med File V2.1, V2.2, GIBI format.
  85
  86 To check the Med Memory installation, in the directory
  87 path_to_your_installation_directory/bin/salome you may find a set of python
  88 scripts and test executable. To ckeck the deep layers (C++, Python) of the Med
  89 Memory, the installer may run:
  90
  91 - testMedMemGeneral.py,
  92 - medMeshing_test.py
  93 - test_profil_MedFieldDriver.py
  94 - testGaussLocalization.py
  95 - med_field_anal.py
  96 - test_MEDMEM_MeshingFlica
  97 - test_MEDMEM_Meshing_poly
  98 - test_MEDMEM_MeshingPoly
  99
 100 To check the upper layer (CORBA, Client), the installer may run in the SALOME
 101 Python console:
 102
 103  - Med_Gen_test.py
 104  - medClient_test.py
 105  - testMedAlliances1.py
 106  - testMedAlliances.py
 107  - testMeshAlliances.py