doc/doxygen/input/medcoupling.dox

   1 /*!
   2 \page medcoupling MEDCoupling
   3
   4 \section MEDCouplingIntro Introduction
   5
   6 \ref medcoupling "MEDCoupling" is a library (\b libmedcoupling.so or \b medcoupling.dll) fully written in C++ and wrapped to be called in Python too.
   7
   8 \ref medcoupling "MEDCoupling" C++ library implements a data structure which is the result of the following tradeoff :
   9
  10 - Compliant with coupling :
  11   - Fields definition defined enough to perform well defined interpolation
  12   - exchangeable through process as well in parallel case in SPMD paradigm ( \ref paramedmem "ParaMEDMEM" ), as in distributed paradigm using CORBA.
  13 - minimize as much as possible the number of prerequisites needed to use it ; So \ref medcoupling "MEDCoupling" only depends on
  14 \ref interpkernel "INTERP_KERNEL library"
  15 - light enough to be agile in order to :
  16    - maximize the amount of algorithms being applied on it
  17    - to ease implementation of clients of \ref medcoupling "MEDCoupling".
  18 - large enough to be used for MED file I/O.
  19 - compliant with VTK visualization DataStructure
  20 - integrate HPC constraints (compact structures, limitation of copies and launching of CPU consuming algorithms only when absolutely needed ).
  21 - compliant with ICOCO API
  22
  23 \ref medcoupling "MEDCoupling" implements a set of algorithms linked to the data structure.
  24
  25 \section MEDCouplingMainConc Main Concepts
  26
  27 Here are listed basic concepts present into \ref medcoupling "MEDCoupling".
  28
  29 For beginners in \ref medcoupling "MEDCoupling" world, it is advisable to read the following concepts in the same order than the underlying list.
  30
  31 - \subpage MEDCouplingArrayPage "DataArrays"
  32 - \subpage MEDCouplingMeshesPage "Meshes"
  33 - \subpage MEDCouplingFieldsPage "Fields"
  34 - \subpage MEDCouplingFieldTemplatesPage "Field templates"
  35 - \subpage MEDCouplingTimeLabelPage "Time labels"
  36
  37 */