Commit 7e2ed91d authored by Sam Schoenholz's avatar Sam Schoenholz
Browse files

Changed radii -> diameter in harmonic energy docs.

parent f240e6c7
......@@ -59,7 +59,7 @@ def soft_sphere(dr, sigma=1, epsilon=1, alpha=2, **unused_kwargs):
Args:
dr: An ndarray of shape [n, m] of pairwise distances between particles.
sigma: Particle radii. Should either be a floating point scalar or an
sigma: Particle diameter. Should either be a floating point scalar or an
ndarray whose shape is [n, m].
epsilon: Interaction energy scale. Should either be a floating point scalar
or an ndarray whose shape is [n, m].
......@@ -199,8 +199,8 @@ def multiplicative_isotropic_cutoff(fn, r_onset, r_cutoff):
Args:
fn: A function that takes an ndarray of distances of shape [n, m] as well
as varargs.
r_onset: A float specifying the onset radius of deformation.
r_cutoff: A float specifying the cutoff radius.
r_onset: A float specifying the distance marking the onset of deformation.
r_cutoff: A float specifying the cutoff distance.
Returns:
A new function with the same signature as fn, with the properties outlined
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment