doc/doxygen/tools.dox

   1 /*!
   2 \page tools MEDMEM tools
   3
   4 \section Introduction
   5 On top of the MEDMEM library, MEDMEM comes with a few executables that
   6 are based on the MEDMEM library and that help the user to perform
   7 common operations on MED files :
   8 - conversion to other formats,
   9 - splitting of a %MED file to a parallel %MED file distributed over a
  10 number of subdomains.
  11
  12 \section medsplitter MEDSPLITTERtool
  13
  14 The purpose of  MEDSPLITTER is to split MED files into
  15 a series of other MED files forming a partition of the original MED files. It can either work with serial meshes (1 to n) or distributed meshes (p to n). For serial meshes, it accepts MED files from the 2.1 version onwards. For distributed MED files, it accepts MED files from the 2.3 version onwards.
  16
  17 It can be used either as an executable, \a medsplitter or as a library. The partitioning is made thanks to one of the following library :
  18 - METIS (http://glaros.dtc.umn.edu/gkhome/views/metis/index.html)
  19 - SCOTCH (http://www.labri.fr/perso/pelegrin/scotch/scotch_fr.html)
  20
  21 The arguments to the medsplitter tool can be retrieved by calling :
  22 \code
  23 medsplitter --help
  24 \endcode
  25
  26 For Salome V4.1.0, one gets the following arguments :
  27
  28 \code
  29 Available options:
  30         --help                 : produces this help message
  31         --mesh-only            : do not create the fields contained in the original file(s)
  32         --distributed          : specifies that the input file is distributed
  33         --input-file=<string>  : name of the input MED file
  34         --output-file=<string> : name of the resulting file
  35         --meshname=<string>    : name of the input mesh (not used with --distributed option)
  36         --ndomains=<number>    : number of subdomains in the output file, default is 1
  37         --plain-master         : creates a plain masterfile instead of an XML file
  38         --creates-boundary-faces: creates the necessary faces so that faces joints are created in the output files
  39         --family-splitting       : preserves the family names instead of focusing on the groups
  40 \endcode
  41
  42 \section sauv2med sauv2med tool
  43
  44 The sauv2med tool enable conversion from a Cast3m \a sauv file into a
  45 MED file. It is a python script that encapsulates the read/write
  46 drivers provided by the MEDMEM library.
  47
  48 Calling
  49 \code
  50 sauv2med myfile.med
  51 \endcode
  52 generates a \a sauv file named \a myfile.med.sauv
  53
  54
  55 \section med2sauv med2sauv tool
  56
  57 med2sauv operator is the operator that is inverse of sauv2med. Its
  58 behaviour is symmetrical.
  59
  60 Calling
  61 \code
  62 med2sauv myfile.sauv
  63 \endcode
  64 generates a \a med file named \a myfile.sauv.med
  65
  66 */