Skip to content

Commit d4393f8

Browse files
authored
Update README.md
Minor fixes to the readme.
1 parent 87179f7 commit d4393f8

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ between an energetic ion and a target material. This includes reflection,
1313
implantation, and transmission of the incident ion, as well as sputtering
1414
and displacement damage of the target. Generally, [BCA] codes can be
1515
valid for incident ion energies between approximately ~1 eV/nucleon
16-
to <1 GeV/nucleon. Improvements to RustBCA have been shown to expand the
17-
regime of validity for some quantities even lower than 1 eV/nucleon.
16+
to <1 GeV/nucleon. Improvements to RustBCA have expanded the regime
17+
of validity for some quantities, such as reflection coefficients, below
18+
1 eV/nucleon.
1819

1920
Check out the `RustBCA` [Wiki] for detailed information, installation
2021
instructions, use cases, examples, and more. See the RustBCA paper at the
@@ -28,6 +29,7 @@ Selected citations of RustBCA as of 5/24/23:
2829
* [hPIC2: A hardware-accelerated, hybrid particle-in-cell code for dynamic plasma-material interactions](https://doi.org/10.1016/j.cpc.2022.108569), LT Meredith et al. (2023)
2930
* [Global sensitivity analysis of a coupled multiphysics model to predict surface evolution in fusion plasma–surface interactions](https://doi.org/10.1016/j.commatsci.2023.112229), P. Robbe et al. (2023)
3031
* [Modeling the effect of nitrogen recycling on the erosion and leakage of tungsten impurities from the SAS-VW divertor in DIII-D during nitrogen gas injection](https://doi.org/10.1016/j.nme.2022.101254), MS Parsons et al. (2023)
32+
* [Enabling attractive-repulsive potentials in binary-collision-approximation monte-carlo codes for ion-surface interactions](https://doi.org/10.1088/2053-1591/ad1262), J Drobny and D Curreli (2023)
3133

3234
## Getting started
3335

@@ -116,8 +118,8 @@ The following features are implemented in `RustBCA`:
116118
* the Kr-C, ZBL, Lenz-Jensen, and Moliere universal, screened-Coulomb potentials.
117119
* the Lennard-Jones 12-6 and Morse attractive-repulsive potentials.
118120
* Solving the distance-of-closest-approach problem is achieved using:
119-
* the Newton-Raphson method for simple root-finding,
120-
* or, for attractive-repulsive potentials, an Adaptive Chebyshev Proxy Rootfinder with Automatic Subdivision algorithm and a Polynomial root-finding algorithm are provided through the [rcpr] crate.
121+
* the Newton-Raphson method for purely repulsive potentials,
122+
* or, for attractive-repulsive potentials, an Adaptive Chebyshev Proxy Rootfinder with Automatic Subdivision algorithm and a polynomial root-finding algorithm are provided through [rcpr].
121123
* Multiple interaction potentials can be used in a single simulation for any number of potentials/species.
122124
* For example, the He-W interaction can be specified using a Lennard-Jones 12-6 potential, while the W-W interaction can be defined using a Kr-C potential.
123125
* The scattering integral can be calculated using:
@@ -154,7 +156,7 @@ Windows, MacOS, and Linux systems.
154156
#### Optional Dependencies
155157

156158
* [HDF5] libraries
157-
* [rcpr], a CPR and polynomial rootfinder, required for using attractive-repulsive interaction potentials such as Lennard-Jones or Morse. It may require additional software (see below).
159+
* [rcpr], a CPR and polynomial rootfinder, required for using attractive-repulsive interaction potentials such as Lennard-Jones or Morse.
158160
* For manipulating input files and running associated scripts, the following are required:
159161
* [Python] 3.6+
160162
* The [Python] libraries: `numpy`, `matplotlib`, `toml` (must build from source), `shapely`, and `scipy`.

0 commit comments

Comments
 (0)