trunk/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 walls - these programs demonstrate the use of wall objects, to calculate the
  11 Voronoi cells in non-standard geometries.
  12
  13 custom - these programs demonstrate how to customize the output of the library
  14 to contain a variety of different statistics about the computed Voronoi cells.
  15 The radical tessellation for a polydisperse packing of particles is also
  16 demonstrated.
  17
  18 interface - these programs demonstrate features of the library's C++ interface.
  19
  20 extra - this contains miscellaneous additional applications of the library for
  21 non-standard usage. It also includes an example of using a wall object to
  22 approximately deal with a case of an irregular boundary.
  23
  24 degenerate - these codes demonstrate cases when "degenerate" vertices of order
  25 bigger than 3 are created, when the cutting planes are aligned to existing
  26 vertices within the numerical tolerance.
  27
  28 timing - these programs and scripts can be used to test the performance of the
  29 code under different configurations.