branches/dynamic/examples/README

   1 Voro++ example directory
   2 ========================
   3 These directories contain example programs that make use of the Voro++ code,
   4 and they are divided into six sections:
   5
   6 basic - this contains several simple scripts that introduce this basic classes
   7 and carry out simple operations, such as constructing a single cell, or making
   8 a Voronoi tessellation for a small number of a random particles in a box.
   9
  10 extra - this contains miscellaneous additional applications of the library for
  11 non-standard usage.
  12
  13 radical - these programs demonstrate the codes ability to calculate the Voronoi
  14 radical tessellation for a polydisperse packing of particles.
  15
  16 degenerate - these codes demonstrate cases when "degenerate" vertices of order
  17 bigger than 3 are created, when the cutting planes are aligned to existing
  18 vertices within the numerical tolerance.
  19
  20 timing - these programs and scripts can be used to test the performance of the
  21 code under different configurations.
  22
  23 walls - these programs demonstrate the use of wall objects, to calculate the
  24 Voronoi cells in non-standard geometries.