doc/doxygen/medmem.dox

   1 /*!
   2 \page medmem MEDMEM library
   3
   4 \section medmem_introduction Introduction
   5 \subsection medmem_rationale Rationale for Med Memory
   6
   7 The Med data exchange model (DEM in English) is the format used in the Salome platform for communicating data between different components. It manipulates objects that describe the meshes underlying scientific computations and the value fields lying on these meshes. This data exchange can be achieved either through files using the Med-file formalism or directly through memory with the Med Memory (\c %MEDMEM) library.
   8
   9 The Med libraries are oganized in multiple layers:
  10 - The MED file layer : C and Fortran API to implement mesh and field persistency.
  11 - The MED Memory level C++ API to create and manipulate mesh and field objects in memory.
  12 - Python API generated using SWIG which wraps the complete C++ API of the MED Memory
  13 - CORBA API to simplify distributed computation inside SALOME (Server Side).
  14 - MED Client classes to simplify and optimize interaction of distant objects within the local solver.
  15
  16 Thanks to Med Memory, any component can access a distant
  17 mesh or field object. Two codes running on
  18 different machines can thus exchange meshes and fields.
  19 These meshes and fields can easily be read/written in a Med file
  20 format, enabling access to the whole Salome suite of tools
  21 (CAD, meshing, Visualization, other components).
  22
  23 \subsection medmem_outline Outline
  24
  25 In this document, we describe the API of the Med Memory library (available in C++ and in Python). This document is intended for developers who are in charge of integrating existing applications in the Salome platform.
  26
  27 As will be seen in section \ref medmem_api, the API consists of very few classes:
  28
  29 - a general MED container : \ref MED_class,
  30 - meshes : \ref mesh ,
  31 - structured meshes : \ref grid ,
  32 - supports and derived classes : \ref support ,
  33 - mesh generation tool : \ref meshing ,
  34 - fields : \ref field ,
  35 - drivers for reading and writing in MED, GIBI and VTK files.
  36
  37 All these are detailed in the following sections. The C++
  38 formalism will be used for the description in these sections.
  39  Python syntax is very similar and is given in appendix \ref medmem_sec_python.
  40
  41 \subsection medmem_naming Naming conventions
  42
  43 The naming conventions are rather straightforward, but the user familiar with the Med-File semantics may find that there are a few noticeable differences (see the following section).
  44
  45 - \b cell entity of dimension equal to the mesh dimension (1, 2 or 3).
  46 - \b component in a field, represents a value that is available for each element of the support (for instance : \f$ T \f$, \f$ v_x \f$, \f$ \sigma_{xy} \f$)).
  47 - \b connectivity \b (descending) connectivity table expressing connectivity of dimension \a d elements in terms of list of dimension \a d-1 elements.
  48 - \b connectivity \b (nodal) connectivity table expressing connectivity of dimension \a d elements in terms of list of nodes.
  49 - \b constituent \b entity entity having a dimension smaller than that of the mesh.
  50 - \b coordinates in a mesh, coordinates can be described by strings giving the names of the coordinates, the units of the coordinates, and the type of coordinates ('MED_CART', 'MED_SPHER' or 'MED_CYL').
  51 - \b description string of characters used to describ an object without giving any access to a query method.
  52 - \b dimension Med Memory discriminates the mesh dimension from the space dimension (a surface shape in 3D will have 2 as a mesh dimension).
  53 - \b driver object attached to a mesh or a field to read (resp. write) data from (resp. to) a Med-file.
  54 - \b edge entity of dimension 1 in a 2D mesh.
  55 - \b element  elementary component of a mesh (0D, 1D, 2D or 3D).
  56 - \b entity category giving information on the dimension of elementary components of meshes : node, edge, face (only in 3D) or cell.
  57 - \b face for 3D meshes, faces are the 2D entities.
  58 - \b family support which is composed of a set of groups, which do not intersect each other, and which gives access to those groups.
  59 - \b field array of integer, integer array, real or real array lying on a support (the dimension of the array of values for each element of the support is called the number of components). A field is uniquely defined by its name, its support, its iteration number and its order number. -1 is the default value of those two numbers.
  60 - \b group support with additional access to parent families.
  61 - \b iteration number] information attached to a field that expresses the number of the time step in the computation (-1 is its default value).
  62 - \b name information attached to a mesh, support or field to name it and access to it.
  63 - \b node entity of dimension 0.
  64 - \b order \b number information attached to a field that expresses the number of an internal iteration inside a time step in the computation (-1 is its default value).
  65 - \b support list of elements of the same entity.
  66 - \b type category of an entity (triangle, segment, quadrangle, tetrahedron, hexahedron, etc...).
  67
  68
  69 \subsection medmem_diff Differences with Med-File concepts
  70 Though the %MEDMEM library can recompute a descending connectivity
  71 from a nodal connectivity, %MEDMEM drivers can only read MED files containing the nodal
  72 connectivities of the entities.
  73 In %MEDMEM, constituent entities are stored as \c MED_FACE
  74 or \c MED_EDGE, whereas in %MED File, they should be stored as \c
  75   MED_MAILLE.
  76
  77 The field notion in %MED File and %MEDMEM is quite different. In %MEDMEM
  78 a field is of course defined by its name, but also by its iteration
  79 number and its order number.
  80 In %MED File a field is only flagged by its name. For instance,
  81 a temperature at times \a t=0.0 s, \a t=1.0 s, \a t=2.0 s will be considered as  a single field in Med File terminology, while it will be considered as three distinct fields in the Med Memory sense.
  82
  83 \section medmem_api Med Memory API
  84
  85 \subsection medmem_conventions Conventions
  86
  87 - In this document, one refers to the main user documentation
  88 \ref RefManualMedMemory where the variable \c $MED_ROOT_DIR (resp.
  89 \c $MED_SRC_DIR) is the Med Memory directory installation (resp. sources
  90 directory).
  91 - All numberings start at one (take care of array index !).
  92 - When one gets a C (resp. C++) type array (resp. STL container) using a \c {get...} method, one should not modify the array. Access is in read only. To modify a such array (resp. STL container) use a \c {set...} method.
  93 - There are many couple of methods that have similar syntaxes (one singular and one
  94 plural). The plural method returns an array and the singular one returns one
  95 particular value in this array (see \c double \c getCoordinate(int i)  and
  96 \c double* \c getCoordinates() for example). Generally, only the plural version
  97 of the methods are documented in this report.
  98 - Difference between local and global number in mesh element connectivity list : when one talks about an
  99 element number, one could see \f$ i^{th} \f$ quadrangle (\f$ i^{th} \f$ in quadrangles array : local numbering) or \f$ j^{th} \f$ element (\f$ j^{th} \f$ in all elements array :
 100 global numbering). These two numberings are equivalent only if one has only one
 101 geometric type.
 102
 103
 104 \subsection namespaces  Namespaces
 105
 106 Med Memory uses two namespaces : \c MEDMEM which is the general
 107 namespace where the main classes are defined and \c MED_EN
 108 which defines enums that can be used by an English-speaking
 109 programer.
 110
 111 \subsection classes Classes
 112 At a basic usage level, the API consists in few classes which are located in
 113 the \c MEDMEM C++ namespace (consult figure \ref fig_UML_light which gives
 114 an UML diagram view of the main Med Memory classes)~:
 115
 116 - \b MED the global container;
 117 - \b MESH the class containing 2D or 3D mesh objects;
 118 - \b SUPPORT the class containing mainly a list of mesh elements;
 119 - \b FIELD the class template containing list of values lying on a particular support.
 120
 121 \anchor fig_UML_light
 122 \image html UML_light.png " UML diagram of basic Med Memory API classes"
 123 \image latex UML_light.eps " UML diagram of basic Med Memory API classes"
 124
 125
 126 The API of those classes is quite sufficient for most of the component
 127 integrations in the Salome platform. The use of the Med Memory libraries may
 128 make easier the code coupling in the Salome framework. With these classes, it
 129 is possible to~:
 130
 131 - read/write meshes and fields from MED-files;
 132 - create fields containing scalar or vectorial values on list of elements
 133 of the mesh;
 134 - communicate these fields between different components;
 135 - read/write such fields.
 136
 137 Note that on the figure \ref fig_UML_light as well as on figure
 138 \ref fig_UML that the
 139 MED container controls the life cycle of all the objects it contains~: its destructor will destroy all the objects it aggregates. On the other hand, the life cycle of mesh, support and field objects are independent. Destroying a support (resp. a field) will have no effect on the mesh (resp. support) which refers to it. But the user has to maintain the link~: a mesh aggregates a support which aggregates a field. If the user has to delete Med Memory objects, the field has to be deleted first, then the support and finally the mesh.
 140
 141 A more advanced usage of the Med Memory is possible through other classes.
 142 Figure \ref fig_UML gives a complete view of the Med Memory API. It includes :
 143
 144 - \b GROUP a class inherited from the SUPPORT class used to create supports linked to mesh groups. It stores restricted list of elements used to set boundary conditions, initial values.
 145 - \b FAMILY which is used to manipulate a certain kind of support which does not intersect each other;
 146 \ b MESHING which builds meshes from scratch, it can be used to transform meshes from a specific format to the MED format or to integrate a mesher within Salome platform (note that class does not add element or node to a mesh);
 147 - \b GRID which enables the user to manipulate specific functions for structured grid.
 148
 149 \anchor fig_UML
 150 \image html UML_small.png "UML diagram of Med Memory API classes"
 151 \image latex UML_small.eps  "UML diagram of Med Memory API classes"
 152
 153
 154 \subsection medmem_enums Enums
 155 A few enums are defined in the \c MED_EN namespace :
 156
 157 - an enum which describes the way node coordinates or field values are stored,
 158   - \c MED_FULL_INTERLACE for arrays such that \f$ x_1,y_1,z_1,x_2,y_2,z_2,\ldots,x_n,y_n,z_n \f$;
 159   - \c MED_NO_INTERLACE for arrays such that \f$ x_1,x_2,\ldots,x_n,y_1,y_2,\ldots,y_n,z_1,z_2,\ldots,z_n \f$;
 160   - \c MED_UNDEFINED_INTERLACE, the undefined interlacing mode.
 161   .
 162 - an enum which describes the type of connectivity
 163   - \c MED_NODAL for nodal connectivity;
 164   - \c MED_DESCENDING for descending connectivity.
 165   .
 166
 167 The user has to be aware of the fact that the Med Memory considers only meshes defined by their nodal connectivity. Nevertheless, the user may, after loading a file in memory, ask to the mesh object to calculate the descending connectivity.
 168
 169 - an enum which contains the different mesh entities, \c medEntityMesh, the entries of which being :
 170  - \c MED_CELL
 171  - \c MED_FACE
 172  - \c MED_EDGE
 173  - \c MED_NODE
 174  - \c MED_ALL_ENTITIES
 175  .
 176
 177 In 3D (resp. 2D), the user has to be aware of the fact that only mesh
 178 entities \c MED_CELL and  \c MED_FACE (resp. \c MED_EDGE) are
 179 considered. In 1D, of course only mesh entities \c MED_CELL+ are considered. Using our naming convention (consult \ref medmem_naming), in $1$ D mesh
 180 only \b node and \b cell are considered. In 2D mesh, only \b node,
 181 \b cell and \b edge are considered. Finally in 3D mesh only
 182 \b node}, \b cell and \b face are considered.
 183
 184 - The \c medGeometryElement enum which defines geometric types. The
 185 available types are linear and quadratic elements (consult
 186 \ref RefManualMedMemory). The entries of this enum are quite
 187 self-explanatory :
 188   - \c MED_NONE
 189   - \c MED_POINT1
 190   - \c MED_SEG2
 191   - \c MED_SEG3
 192   - \c MED_TRIA3
 193   - \c MED_QUAD4
 194   - \c MED_TRIA6
 195   - \c MED_QUAD8
 196   - \c MED_TETRA4
 197   - \c MED_PYRA5
 198   - \c MED_PENTA6
 199   - \c MED_HEXA8
 200   - \c MED_TETRA10
 201   - \c MED_PYRA13
 202   - \c MED_PENTA15
 203   - \c MED_HEXA20
 204   - \c MED_POLYGON
 205   - \c MED_POLYHEDRA
 206   - \c MED_ALL_ELEMENTS
 207   .
 208 The connectivity of all these elements is defined in MED project Web page
 209 http://hammi.extra.cea.fr/static/MED/web_med/logiciels/med-2.3.1/doc/ .
 210
 211
 212 */
 213
 214 /*!
 215 \page paramedmem ParaMEDMEM library
 216
 217
 218 The ParaMEDMEM library is based on several classes that
 219 describe the coupling between two parallel codes.
 220
 221 The classes that make up the API of the library are :
 222 - communication interface : \ref comm_interface,
 223 - definition of processor groups : \ref processor_group,
 224 - Data Exchange Channel(aka DEC, abstract class) : \ref dec, and its implementations :
 225  -  \ref intersectiondec for a \ref InterpKerRemapGlobal based on intersecting elems volume computation,
 226  - NonCoincident DEC for a non-conservative interpolation based on element localization : \ref noncoincidentdec,
 227  - Explicit Coincident DEC for remapping coincident meshes on a one-to-one basis. This class applies to unstructured topologies: \ref explicit_coincident_dec,
 228  - Structured Coincident DEC for remapping coincident meshes on a one-to-one basis. This class applies to structured topologies : \ref structuredcoincidentdec.
 229
 230 */
 231
 232 /*!
 233 \page medmem_install Configuring and Installing MEDMEM from sources
 234
 235 The MEDMEM library can be configured in several manners so that it can run inside or outside the Salome platform. Also, partitioning and parallel functionalities are optional.
 236
 237 The sources of the library are located in the \a MED_SRC directory.
 238 The first step consists in preparing the configuration of the library :
 239 \verbatim
 240 cd ${MED_SRC}
 241 ./build_configure
 242 \endverbatim
 243
 244 This will create a MEDMEM library with link to the SALOME Kernel. If it is desirable to have a standalone version of the library to be used independently from SALOME, use :
 245 \verbatim
 246 cd ${MED_SRC}
 247 ./build_configure --without-kernel
 248 \endverbatim
 249
 250 The library can then be configured :
 251 \verbatim
 252 mkdir ../MED_BUILD
 253 cd ../MED_BUILD
 254 ../MED_SRC/configure --prefix=`pwd`/../MED_INSTALL
 255 \endverbatim
 256
 257 This will configure the library without splitting functionalities. ParaMEDMEM will be compiled if an MPI version has been found.
 258
 259 The following options can be useful to configure MEDMEM :
 260 - \a --enable-splitter=yes will trigger the compilation of the MEDSPLITTER tool,
 261 - \a --with-metis=${METISDIR} will specify a location for the METIS library,
 262 - \a --with-scotch=${SCOTCHDIR} will specify a location for the SCOTCH library,
 263 - \a --with-med2=${MED2DIR} specifies a location for MED-file library,
 264 - \a --with-hdf5=${HDF5DIR} specifies a location for the HDF5 library (must be the same as that used for the MED-file library)
 265 - \a --with-lam=${LAMDIR} specifies an install path for a LAM MPI library,
 266 - \a --with-mpich=${MPICHDIR} specifies an install path for a MPICH-1 library.
 267 */
 268 >>>>>>> 1.1.4.1.2.1