Interface Module¶
Overview
Measures the interface between two sets of points. |
Details
The freud.interface
module contains functions to measure the interface
between sets of points.
Interface Measure¶
-
class
freud.interface.
InterfaceMeasure
(box, r_cut)¶ Measures the interface between two sets of points.
Module author: Matthew Spellings <mspells@umich.edu>
Module author: Bradley Dice <bdice@bradleydice.com>
- Parameters
box (
freud.box.Box
) – Simulation box.r_cut (float) – Distance to search for particle neighbors.
- Variables
ref_point_count (int) – Number of particles from
ref_points
on the interface.ref_point_ids (
np.ndarray
) – The particle IDs fromref_points
.point_count (int) – Number of particles from
points
on the interface.point_ids (
np.ndarray
) – The particle IDs frompoints
.
-
compute
¶ Compute the particles at the interface between the two given sets of points.
- Parameters
ref_points ((\(N_{particles}\), 3)
numpy.ndarray
) – One set of particle positions.points ((\(N_{particles}\), 3)
numpy.ndarray
) – Other set of particle positions.nlist (
freud.locality.NeighborList
, optional) – Neighborlist to use to find bonds (Default value = None).
-
property
point_count
¶
-
property
point_ids
¶
-
property
ref_point_count
¶
-
property
ref_point_ids
¶