C++ Version of CERN's BLonD code

NOT Stable - Under heavy development

• cmake version >= 3.0.2 install
• gcc version >= 4.8.0 install
• FFTW3 Library install

1. clone the code into a directory (lets call it BLonD++/)

   git clone --branch=master --recursive https://github.com/kiliakis/BLonD-minimal-cpp.git BLonD++    

2. run the commands

   cd BLonD++
   mkdir build  
   cd build 
   cmake --help .. # to see avaliable options
   cmake .. # use opptions like cmake -DUSE_FFTW_OMP=True .. for the multithreaded version on Linux
   cmake --build ..

3. The executables should be ready!

4. Developer's Notes:

• By default, the Release version of the code is compiled. You can build a debug version with cmake -DCMAKE_BUILD_TYPE=Debug ..

• FFTW3 Library
  If you are using a Linux distribution, you can install FFTW3 simply by running the install-linux.sh script as:

  cd BLonD++
  sh install-linux.sh

  If this doesn't work, then you should try the following set of commands:

  wget http://www.fftw.org/fftw-3.3.4.tar.gz
  tar -xzvf fftw-3.3.4.tar.gz
  cd fftw-3.3.4
  ./configure  
  make 
  make install #you may need sudo access for this step, if you don't have it then try ./configure --prefix=/path/to/install

  Note that if you want to use the multi-threaded version of this library you must configure as ./configure --enable-openmp.

The following definitions, found in file include/configuration.h, can be commented / uncommented to alter simulation's configuration:

#define TIMING
#define PRINT_RESULTS

Note that a re-compile is needed every time a change is made.

The following optional command line arguments can be specified in order to specify some basic simulation parameters:

• -m , --threads=<num> : Number of OpenMP threads that will be used in the simulation (default: 1)
• -p , --particles=<num> : Number of macro particles that will be simulated (default: 10k)
• -t , --turns=<num> : Number of simulation turns (default: 10k)
• -s , --slices=<num> : Number of slices that will be used to generate the beam's histogram (default: 100)

Example: ./testcase -t 1000 -p2000
Or type: ./testcase -h for more

Once you have successfully compiled the code you can run the tests:

cd BLonD++/build
ctest -VV

Then you can generate unit-test documentation:

cd BLonD++/build
lcov --capture --directory .. --output-file coverage.info
genhtml coverage.info --output-directory html

• Repository: https://gitlab.cern.ch/dquartul/BLonD
• Documentation: http://blond-documentation.web.cern.ch/
• Project website: http://blond.web.cern.ch

• Alexandre Lasheen (alexandre.lasheen (at) cern.ch)
• Juan Esteban Muller (juan.fem (at) cern.ch)
• Danilo Quartullo (danilo.quartullo (at) cern.ch)
• Helga Timko (Helga.Timko (at) cern.ch)
• Konstantinos Iliakis (konstantinos.iliakis (at) cern.ch)

Dear all contributors, you are kindly requested to format your code using astyle format options found [here] (https://root.cern.ch/coding-conventions#Astyle).