Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.28 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.28 KB

ForceInCrystal

ForceInCrystal is a software to investigate the behavior of a 2d hexagonal lattice of Brownian particles when one of them is submitted to an external force.

Dependancies

  • Boost for program options and unit testing.
  • SFML for on-the-fly visualization of particles in 2d

Compilation

For compiling the source code, your compiler should support C++14 (both g++ and clang++ do).

The compilation was only tested on Linux. It should in theory also work on Windows and MacOS.

Use of the program and documentation

The command-line arguments to the program are explained when using the --help argument.

The code is documented using Doxygen-compatible comments. One can generate the html and latex documentation using doxygen Doxyfile.

License

This program is free software and is released under GNU GPL. Feel free to contribute to the code!