Skip to content

Commit 9c2f939

Browse files
authored
Updates to readme
Add a line about the library functions to the top of the readme; clarify that the GeV limit is an upper bound by change of notation; elaborate on library functions in feature list.
1 parent faff3fe commit 9c2f939

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
`RustBCA` is a general-purpose, high-performance code for simulating
44
ion-material interactions using the binary collision approximation ([BCA]),
5-
written in [Rust]!
5+
written in [Rust]! RustBCA consists of a standalone code and libraries for
6+
including ion-material interactions in C/C++, Python, and Fortran codes.
67

78
By discretizing the collision cascade into a sequence of binary collisions,
89
[BCA] codes can accurately and efficiently model the prompt interaction
910
between an energetic ion and a target material.
1011
This includes reflection, implantation, and transmission of the incident ion,
1112
as well as sputtering and displacement damage of the target.
1213
Generally, [BCA] codes are valid for incident ion energies between approximately
13-
~1 eV/nucleon to ~1 GeV/nucleon.
14+
~1 eV/nucleon to <1 GeV/nucleon.
1415

1516
Check out the `RustBCA` [Wiki] for detailed information, installation
1617
instructions, use cases, examples, and more. See the RustBCA paper at the
@@ -77,7 +78,7 @@ The following features are implemented in `rustBCA`:
7778
* local (Oen-Robinson),
7879
* nonlocal (Lindhard-Scharff),
7980
* and equipartition forms.
80-
* Biersack-Varelas interpolation is also included for electronic stopping up to ~1 GeV/nucleon.
81+
* Biersack-Varelas interpolation is also included for electronic stopping up to ~1 GeV/nucleon. Note that high energy physics beyond electronic stopping are not included.
8182
* Optionally, the Biersack-Haggmark treatment of high-energy free-flight paths between collisions can be included to greatly speed up high-energy simulations (i.e., by neglecting very small angle scattering).
8283
* A wide range of interaction potentials are provided, including:
8384
* the Kr-C, ZBL, Lenz-Jensen, and Moliere universal, screened-Coulomb potentials.
@@ -100,6 +101,7 @@ The following features are implemented in `rustBCA`:
100101
* full trajectory tracking for both the incident ions and target atoms,
101102
* and many other parameters such as position of origin of sputtered particles and energy loss along trajectories.
102103
* Optionally, the code can produce energy-angle and implantation distributions when built with the `--features distributions` flag and disable space-intensive particle list output with `--features no_list_output`.
104+
* Library functions for modeling ion reflection, implantation, and sputtering in C++/C, Python, and Fortran codes.
103105

104106
## Installation
105107

0 commit comments

Comments
 (0)