Skip to content

Commit

Permalink
Update README files and comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
chr1shr committed Sep 28, 2019
1 parent 105f336 commit dfc4cc0
Show file tree
Hide file tree
Showing 76 changed files with 80 additions and 81 deletions.
11 changes: 5 additions & 6 deletions README
@@ -1,14 +1,14 @@
Voro++, a 3D cell-based Voronoi library (http://math.lbl.gov/voro++/)
By Chris H. Rycroft (UC Berkeley / Lawrence Berkeley Laboratory)
By Chris H. Rycroft (Harvard University / Lawrence Berkeley Laboratory)
================================================================
Voro++ is a software library for carrying out three-dimensional computations
of the Voronoi tessellation. A distinguishing feature of the Voro++ library
is that it carries out cell-based calculations, computing the Voronoi cell
for each particle individually, rather than computing the Voronoi
tessellation as a global network of vertices and edges. It is particularly
well-suited for applications that rely on cell-based statistics, where
features of Voronoi cells (eg. volume, centroid, number of faces) can be
used to analyze a system of particles
features of Voronoi cells (e.g. volume, centroid, number of faces) can be
used to analyze a system of particles.

Voro++ comprises of several C++ classes that can be built as a static library
and linked to. A command-line utility is also provided that can analyze text
Expand Down Expand Up @@ -112,16 +112,15 @@ publications:

- Chris H. Rycroft, "Multiscale Modeling in Granular Flow", PhD thesis
submitted to the Massachusetts Institute of Technology, September 2007.
(http://math.berkeley.edu/~chr/publish/phd.html)
(http://seas.harvard.edu/~chr/publish/phd.html)

The first reference contains a one-page overview of the library. The second
reference contains some of the initial images that were made using a very early
version of this code, to track small changes in packing fraction in a large
particle simulation. The third reference discusses the use of 3D Voronoi cells,
and describes the algorithms that were employed in the early version of this
code. Since the publication of the above references, the algorithms in Voro++
have been significantly improved, and a paper specifically devoted to the
current code architecture will be published during 2012.
have been significantly improved.


Copyright Notice
Expand Down
2 changes: 1 addition & 1 deletion examples/basic/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/import.cc
@@ -1,6 +1,6 @@
// File import example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/platonic.cc
@@ -1,6 +1,6 @@
// Platonic solids example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/random_points.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/basic/single_cell.cc
@@ -1,6 +1,6 @@
// Single Voronoi cell example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/custom/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/custom/cell_statistics.cc
@@ -1,6 +1,6 @@
// Simple cell statistics demonstration code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/custom/custom_output.cc
@@ -1,6 +1,6 @@
// Custom output example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/custom/radical.cc
@@ -1,6 +1,6 @@
// Radical Voronoi tessellation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/degenerate/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/degenerate/degenerate.cc
@@ -1,6 +1,6 @@
// Degenerate Voronoi cell example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/degenerate/degenerate2.cc
@@ -1,6 +1,6 @@
// Degenerate vertex example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/box_cut.cc
@@ -1,6 +1,6 @@
// Box cutting example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/cut_region.cc
@@ -1,6 +1,6 @@
// Cell cutting region example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/irregular.cc
@@ -1,6 +1,6 @@
// Irregular packing example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/l_shape.cc
@@ -1,6 +1,6 @@
// Irregular packing example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/extra/superellipsoid.cc
@@ -1,6 +1,6 @@
// Superellipsoid example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/interface/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/interface/find_voro_cell.cc
@@ -1,6 +1,6 @@
// Example code demonstrating find_voronoi_cell function
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/interface/loops.cc
@@ -1,6 +1,6 @@
// Example code demonstrating the loop classes
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/interface/odd_even.cc
@@ -1,6 +1,6 @@
// Odd/even face coloring code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/interface/polygons.cc
@@ -1,6 +1,6 @@
// Direct C++ interface example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/cylinder_inv.cc
@@ -1,6 +1,6 @@
// Cylindrical wall example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/finite_sys.cc
@@ -1,6 +1,6 @@
// Irregular packing example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/ghost_test.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/import_freeman.cc
@@ -1,6 +1,6 @@
// File import example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/import_nguyen.cc
@@ -1,6 +1,6 @@
// File import example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/lloyd_box.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/minkowski.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/neigh_test.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : April 14th 2013

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/r_pts_interface.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/rad_test.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/random_points_10.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/random_points_200.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/single_cell_2d.cc
@@ -1,6 +1,6 @@
// Single Voronoi cell example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/sphere_mesh.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/split_cell.cc
@@ -1,6 +1,6 @@
// Splitting a Voronoi cell example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/tri_mesh.cc
@@ -1,6 +1,6 @@
// Voronoi calculation example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/no_release/voro_lf.cc
@@ -1,6 +1,6 @@
// File import example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/timing/timing_test.cc
@@ -1,6 +1,6 @@
// Timing test example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/walls/Makefile
@@ -1,6 +1,6 @@
# Voro++ makefile
#
# Author : Chris H. Rycroft (LBL / UC Berkeley)
# Author : Chris H. Rycroft (Harvard University / LBL)
# Email : chr@alum.mit.edu
# Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/walls/cylinder.cc
@@ -1,6 +1,6 @@
// Cylindrical wall example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down
2 changes: 1 addition & 1 deletion examples/walls/frustum.cc
@@ -1,6 +1,6 @@
// Frustum example code
//
// Author : Chris H. Rycroft (LBL / UC Berkeley)
// Author : Chris H. Rycroft (Harvard University / LBL)
// Email : chr@alum.mit.edu
// Date : August 30th 2011

Expand Down

0 comments on commit dfc4cc0

Please sign in to comment.