doc/doxygen/doxfiles/tools.dox

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