doc/user/doxygen/doxfiles/reference/meshes/meshes.dox

   1
   2 /*!
   3   \page meshes Meshes
   4
   5 <h1>Overview</h1>
   6
   7 Several types of meshes are available in MEDCoupling:
   8
   9 - \subpage MEDCouplingPointSetPage "Point set mesh" (abstract, can not be instantiated)
  10 - \subpage MEDCouplingUMeshPage "Unstructured meshes"
  11 - \subpage MEDCouplingCMeshPage "Cartesian meshes"
  12 - \subpage MEDCouplingExtrudedPage "3D Extruded meshes"
  13
  14 \anchor MEDCouplingMeshes
  15 <h1>Common concept shared by all type of Meshes in MEDCoupling</h1>
  16
  17 A mesh has the following properties :
  18 - a name (a string)
  19 - **a dimension (called mesh dimension) and only one** (it implies that \b all cells constituting
  20 mesh have the same dimension, e.g. no mix between a volumic cube and a flat triangle in the same mesh). This
  21 point matters as it differs from what the MED file format authorizes.
  22 - a space dimension (the space where the coordinates of the points are defined)
  23 - a set of nodes
  24 - a set of cells (whose vertices are in the node set above)
  25
  26 In MEDCoupling library there is no explicit notion of faces nor edges. All cells, be it in 3D, 2D or 1D is
  27 described by a set of point, or by a set of coordinates.
  28
  29 As said above, a mesh has only one dimension, which is often called the "mesh dimension". This notion is different
  30 from the "space dimension", corresponding to the dimension of the space where the nodes are defined.
  31
  32 For example a mesh with a mesh dimension equal to 1 can have \b cells of type
  33 NORM_SEG2 (simple segments). This mesh can however have a space dimension of 3, meaning that we
  34 describe a 3D polygonal line.
  35 Another example: a mesh with a mesh dimension equal
  36 to 2, can have \b cells of type NORM_TRI3 (triangles) and NORM_POLYGON (arbitrary 2D polygons) for example.
  37 It can still have a space dimension of 3, meaning that we describe a planar surface embedded in a 3D space.
  38
  39 The (abstract) class that covers the concept described above is \ref MEDCoupling::MEDCouplingMesh.
  40
  41 <h1>Available (non abstract) mesh types in MEDCoupling</h1>
  42
  43 - \ref MEDCouplingUMeshPage
  44 - \ref MEDCouplingCMeshPage
  45 - \ref MEDCouplingExtrudedPage
  46
  47 */