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
  16 files. It can either work with serial meshes (1 to n) or distributed
  17 meshes (p to n). For serial meshes, it accepts MED files from the 2.1
  18 version onwards. For distributed MED files, it accepts MED files from
  19 the 2.3 version onwards.
  20
  21 There exists a parallel version of MEDSPLITTER, which accepts
  22 distributed MED files only. In contrast to the ordinary MEDSPLITTER
  23 the parallel one distributes several usual MED files composing the
  24 whole model among available processors. After the
  25 partitioning, each processor writes only it's own part of the
  26 distributed MED file. The parallel MEDSPLITTER processes meshes only,
  27 not fields.
  28
  29 It can be used either as an executable, \a medsplitter (or \a
  30 medsplitter_para) or as a library. The partitioning is made thanks to
  31 one of the following library :
  32 - METIS (http://glaros.dtc.umn.edu/gkhome/views/metis/index.html)
  33 - SCOTCH (http://www.labri.fr/perso/pelegrin/scotch/scotch_fr.html)
  34
  35 The arguments to the medsplitter tool can be retrieved by calling :
  36 \code
  37 medsplitter --help
  38 \endcode
  39 or
  40 \code
  41 medsplitter_para --help
  42 \endcode
  43
  44 For Salome V4.1.0, one gets the following arguments (some of them are
  45 unavailable in parallel version):
  46
  47 \code
  48 Available options:
  49         --help                 : produces this help message
  50         --mesh-only            : do not create the fields contained in the original file(s)
  51         --distributed          : specifies that the input file is distributed
  52         --input-file=<string>  : name of the input MED file
  53         --output-file=<string> : name of the resulting file
  54         --meshname=<string>    : name of the input mesh (not used with --distributed option)
  55         --ndomains=<number>    : number of subdomains in the output file, default is 1
  56         --plain-master         : creates a plain masterfile instead of an XML file
  57         --creates-boundary-faces: creates the necessary faces so that faces joints are created in the output files
  58         --family-splitting     : preserves the family names instead of focusing on the groups
  59 \endcode
  60
  61 \section renumber RENUMBER tool
  62
  63 The purpose of RENUMBER is to renumber the cell of a mesh in order to
  64 make numerical computation easier. This tool works with meshes
  65 which contain only one cell type and can renumber it according to two
  66 different methods:
  67 - Reverse Cuthill McKee (with the Boost Graph Library http://www.boost.org/doc/libs/1_40_0/libs/graph/doc/table_of_contents.html)
  68 - Nested Dissection (with the METIS library
  69 http://glaros.dtc.umn.edu/gkhome/views/metis/index.html)
  70
  71 It can be used in this way :
  72 \code
  73 renumber MEDFile_in MeshName Method[BOOST/METIS] MEDFile_out
  74 \endcode
  75
  76 \section sauv2med sauv2med tool
  77
  78 The sauv2med tool enable conversion from a Cast3m \a sauv file into a
  79 MED file. It is a python script that encapsulates the read/write
  80 drivers provided by the MEDMEM library.
  81
  82 Calling
  83 \code
  84 sauv2med myfile.sauv
  85 \endcode
  86 generates a \a med file named \a myfile.sauv.med
  87
  88 \section med2sauv med2sauv tool
  89
  90 med2sauv operator is the operator that is inverse of sauv2med. Its
  91 behaviour is symmetrical.
  92
  93 Calling
  94 \code
  95 med2sauv myfile.med
  96 \endcode
  97 generates a \a sauv file named \a myfile.med.sauv
  98
  99 */