;fname: snbvPkg-README.txt

Support for using the Subspring Network Breakable Voronoi model is provided in
the snbvPkg9.N package that works with PFC2D/3D version 9 (where N is the
package subversion number).

CAPABILITIES
  Create 2D and 3D SNBV materials and perform laboratory testing
  (direct-tension and triaxial/biaxial in 3D/2D). Response monitoring includes
  material visualization, grain-size and material-property distributions,
  stress-strain curves, damage (interface and grain breaks) tracking and
  visualization as well as test-result extraction.

PACKAGE LAYOUT
  The SNBV package is provided as a single directory, named snbvPkg9.N, where
  N is the package version number (in
  ExampleProjects\snbvSrc\snbvPkg-VERSION.txt). The package layout is in
  snbvPkgContents.txt. A public modifications list is in
  snbvPkg-publicMods.txt. Documentation is in the Documentation directory.
  Example projects are in the ExampleProjects{2D,3D} directories, each of
  which contains the FISH source code in its snbvSrc directory.

  The file-naming convention is as follows. The file extensions are p{2,3}prj,
  p{2,3}dvr, p{2,3}dat, and fis to denote a PFC2D/3D project file, 2D/3D
  driver file (performs operations to drive the simulation), 2D/3D data file
  (sets input parameters - should be the only type of file that a user of the
  package needs to modify), and FISH file (FISH functions for both 2D and 3D),
  respectively.

DOCUMENTATION (see snbvPkgContents.txt)

EXAMPLE PROJECTS
  The following projects are provided.
    LabTests3D {Create 3D material, and perform lab tests upon it}
    LabTests2D {Create 2D material, and perform lab tests upon it}

  Each project is contained within a directory. The simulations are launched
  by opening the PFC{2,3}D project therein and calling the file
  doAll.p{2,3}dvr. The code will shut down upon completion.

  When working with the package, one should copy and rename a directory, set
  model parameters, and run the project therein. A parameter study can be
  performed by running the project ExampleProjects{2,3}D-RUN.p{2,3}prj (and
  modifying the file ExampleProjects{2,3}D-RUN.p{2,3}prj). This will launch a
  separate instance of PFC{2,3}D within each directory and call its
  doAll.p{2,3}dvr.

Good luck, and have fun.

;EOF: snbvPkg-README.txt