doc/doxygen/doxfiles/intro.dox

   1 /*!
   2
   3 \mainpage Introduction
   4
   5 Simulation studies require the manipulation of meshes and fields for data
   6 pre-processing, in calculation schemes (including chaining and coupling
   7 of codes), or even for results post-processing.
   8
   9 Corresponding computer codes can be viewed as software components accessing
  10 input meshes and fields (with specific constraints) along with parameters
  11 (datasets), and producing result meshes and fields. Each code presents by
  12 construction the specificities of its discipline.
  13
  14 The MED module aims at pooling operations on meshes and fields, facilitating
  15 their use by various codes involved in a simulation process. This includes
  16 making codes communicate while preserving as much as possible the integrity of
  17 their content.
  18
  19 To fulfill its objective, the MED module includes:
  20 - Handling meshes and fields to satisfy code input requirements.
  21 - Extraction of field information to post-process computation results of
  22 a code.
  23 - Projections and serialization to exchange meshes and fields between codes.
  24
  25 In addition, the MED module offers several interfacing levels; users can thus
  26 benefit from an interaction level adapted to their codes.
  27
  28 Main services offered by MEDCoupling are:
  29 - Manipulation of fields and their support mesh, serialized with MED format.
  30 - Operations on scalars, vectors, and second order tensors.
  31 - 1D/2D/3D interpolation on nodes, cells, Gauss points and nodes by element.
  32
  33 MEDCoupling thus considers:
  34 - Data dimension.
  35 - Nature of information on fields, as well as conservation laws.
  36 - Field profiles and mesh connectivity.
  37
  38
  39 \image html projectionHQ_600.png
  40 <br />
  41
  42 \section contents Contents
  43 This document is organized as follows:
  44 - Recall of some basic \ref glossary about mesh and field manipulation.
  45 - \ref library to manipulate meshes and fields that conform
  46   to the MED data model. This library can be used in C++ programs as
  47   in python script for data processing on meshes and fields.
  48 - Technical presentation of \ref medcoupling that describes DataStructures
  49 used for cross process exchange of meshes and fields.
  50 - Technical presentation of \ref medloader that provides I/O functions to the
  51 MED file format.
  52 - \ref interptools, from theory to practice using MEDCoupling.
  53 - Summary of  \ref functionalities "available functionalities".
  54   \if ENABLE_EXAMPLES
  55 - \ref medcouplingpyexamples and tutorials.
  56   \endif
  57 - \ref gui that exhibits some useful functions of the library for a graphical
  58 manipulation of data in standard use cases.
  59 - \ref tools based on MEDLoader that can be used to process MED data files
  60 (conversion tools and splitting tools).
  61   \if ENABLE_EXAMPLES
  62 - \ref medcouplingcppexamples for advanced users.
  63   \endif
  64
  65
  66 \section install Installation
  67 The install procedure of the %MED SALOME module can handle a variety of configurations
  68 to suit the needs of its user. Instructions for configuring and
  69 installing the module can be found in \ref paramedmem_install.
  70
  71
  72 \section references References
  73 Here follows a list of useful references :
  74
  75 -# \anchor RefManualMedFile Reference Manual for Med File, V. Lefebvre,  E. Fayolle, Projet PAL: D&eacute;finition du mod&egrave;le d'&eacute;change de donn&eacute;es MED V2.2,  Note technique EDF/SINETICS, HI-26-03-012/A, https://hammi.extra.cea.fr/static/MED/web_med/index.html
  76 -# VTK home page: \c http://public.kitware.com/VTK
  77 -# Med File Data Model : V. Lefebvre,  E. Fayolle, D&eacute;finition du mod&egrave;le d'&eacute;change de donn&eacute;es MED v2.2, https://hammi.extra.cea.fr/static/MED/web_med/pdf/NOTE_HI_26_03_012_A.pdf
  78 -# Jeffrey Grandy, Conservative remapping and region overlays by intersecting arbitrary polyhedra, Journal of Computational Physics, vol 148, 433-466 (1999)
  79 -# F. Preparata and M. Shamos Computational Geometry. Springer-Verlag, New York, 1985
  80
  81 */