branches/dynamic/src/README

   1 Voro++ library source files
   2 ===========================
   3 cell.hh - header file for the voronoicell class and related classes.
   4
   5 cell.cc - implementation file for the voronoicell class and related classes.
   6
   7 cmd_line.cc - source file for creating the command-line utility that makes use
   8 of the library.
   9
  10 config.hh - configuration file for the library, controlling many memory
  11 allocation an tolerance parameters.
  12
  13 container.hh - header file for the container class and related classes.
  14
  15 container.cc - implementation file for the container class and related classes.
  16
  17 Doxyfile - Configuration file for Doxygen, used to automatically generate
  18 documentation based on the source code comments.
  19
  20 wall.hh - header file for the wall types.
  21
  22 wall.cc - implementation file for the wall types.
  23
  24 worklist.hh - header file containing the parameters controlling the worklists.
  25 This file is automatically generated by worklist_gen.pl.
  26
  27 worklist.cc - contains the precompiled worklists of block positions used for
  28 rapid computation in the compute_cell() routine in the container class. This
  29 file is automatically generated by worklist_gen.pl.
  30
  31 worklist_gen.pl - perl script for automatically generating the worklist.hh and
  32 worklist.cc files.
  33
  34 voro++.hh - a single header file that loads all the others.
  35
  36 voro++.cc - a single implementation file that loads all the others and their
  37 headers.