Interface Module¶
Overview
freud.interface.InterfaceMeasure |
Measures the interface between two sets of points. |
Details
The interface module contains functions to measure the interface between sets of points.
-
class
freud.interface.InterfaceMeasure(box, r_cut)¶ Measures the interface between two sets of points.
Module author: Matthew Spellings <mspells@umich.edu>
Parameters: - box (
freud.box.Box) – Simulation box. - r_cut (float) – Distance to search for particle neighbors.
-
compute(self, ref_points, points, nlist=None)¶ Compute and return the number of 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).
- ref_points ((\(N_{particles}\), 3)
- box (