doc/doxygen/meshing.dox

   1 /*!
   2
   3 \page meshing MESHING
   4
   5 \section meshing_overview Overview
   6
   7 This class is a class derived from MESH class that is used
   8 to build a MESH object from scratch.
   9
  10 All verifications are under user responsability : if array values or array
  11 dimensions are wrong, results are impredictable.
  12 All the arrays passed as arguments in the set methods are duplicated in MESHING object.
  13
  14 The creation of a mesh should respect the following sequence :
  15 - setting general information (name, description, coordinate system, ...),
  16 - setting the nodes (number and coordinates),
  17 - setting the connectivity (types, connectivity arrays,...),
  18 - group creations.
  19
  20 The following paragraphs describe the methods that must be called
  21 when creating a mesh. An example illustrates the general procedure.
  22 The specific case of \c MED_POLYGON and \c MED_POLYHEDRA
  23 elements requires some methods that are described in \ref polygon.
  24
  25 \section outline_meshing Outline
  26
  27 The following sections point to various groups of MESHING methods :
  28 - Constructors : \ref MESHING_constructors,
  29 - General information : \ref MESHING_general,
  30 - Setting nodes : \ref MESHING_nodes,
  31 - Connectivity : \ref MESHING_connectivity,
  32 - Groups : \ref MESHING_group.
  33
  34 An example of mesh creation via MESHING is given in :
  35 - C++ :
  36 \include MESHINGexample.cxx
  37 - Python:
  38 \include  MESHINGexample.py
  39
  40 */