doc/doxygen/grid.dox

   1 /*!
   2 \page grid GRID
   3 \section GRIDgeneral General Information
   4
   5 The GRID class represents structured meshes in the MEDMEM library.
   6 The GRID class inherits mesh common information from GMESH class,
   7 in particular, reading and writing from files (c.f. \ref MESH_io), general information
   8 access (c.f. \ref MESH_general),
   9 access to families and other supports (c.f. \ref MESH_families). However, because of the particular nature of structured meshes,
  10 there exist methods to access information related to the axes of the grid.
  11
  12 The numbering of the cells and nodes in a grid starts at one and
  13 the inner loop is that of the first axis, the outer loop being the one
  14 of the last axis (c.f. figure \ref fig_grid_connectivity} ).
  15
  16 \image html grid_example.png "Example for structured mesh connectivity. The numbering is automatically defined from the two input verctors X and Y."
  17
  18 \section grid_outline Outline
  19
  20 Constructors are defined in \ref GRID_constructors, methods related to
  21 axes are defined in \ref GRID_axes, while connectivity methods are
  22 given in \ref GRID_connectivity. A structured mesh can be obtained from
  23 a GRID using MEDMEM::GRID::convertInMESH() method.
  24 */