Merge pull request #274 from lcpp-org/readme_fix

Fix readme

Author: drobnyjt

README.md

@@ -60,20 +60,19 @@ For those eager to get started with the standalone code, try running one of the
 the plots located on the [Wiki], these may require some optional
 [Python] packages (`matplotlib`, `numpy`, `scipy`, `shapely`, and `toml`).
 
-### H trajectories and collision cascades in a boron nitride dust grain
-
+### H trajectories and collision cascades in boron nitride
 First, run the example using:
 
 ```bash
-cargo run --release examples/boron_nitride.toml
+cargo run --release 0D examples/boron_nitride_0D.toml
 ```
 
 Afterwords, fire up your favourite [Python] interpreter
 (e.g., [IPython]) and execute:
 
 ```python
 from scripts.rustbca import *
-do_trajectory_plot("boron_dust_grain_")
+do_trajectory_plot("boron_nitride_")
 ```
 
 ### He implantation into a layered TiO<sub>2</sub>/Al/Si target

examples/boron_nitride_0D.toml

@@ -4,22 +4,24 @@ name = "boron_nitride_"
 weak_collision_order = 0
 num_threads = 4
 track_displacements = true
+track_trajectories = true
+track_recoil_trajectories = true
 
 [material_parameters]
 energy_unit = "EV"
 mass_unit = "AMU"
 Eb = [ 0.0, 0.0,]
 Es = [ 5.76, 0.0,]
 Ed = [25.0, 25.0]
-Ec = [ 1.0, 1.0,]
+Ec = [ 5.0, 5.0,]
 Z = [ 5, 7,]
 m = [ 10.811, 14,]
 
 [particle_parameters]
 length_unit = "MICRON"
 energy_unit = "EV"
 mass_unit = "AMU"
-N = [ 10000 ]
+N = [ 10 ] # Number of computational ions low for plotting trajectories
 m = [ 1.008 ]
 Z = [ 1 ]
 E = [ 1000.0 ]

examples/boron_nitride_wire_homogeneous.toml

@@ -1,4 +1,4 @@
-#Use with 0D geometry option only
+#Use with HOMOGENEOUS2D geometry option only
 [options]
 name = "boron_nitride_h_"
 weak_collision_order = 0

src/input.rs

@@ -172,11 +172,6 @@ fn one_u64() -> u64 {
     1
 }
 
-///This helper function is a workaround to issue #368 in serde
-fn three() -> usize {
-    3
-}
-
 fn zero_usize() -> usize{
     0
 }