Interface Module¶

The interface module contains functions to measure the interface between sets of points.

InterfaceMeasure¶

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 (`numpy.ndarray`, shape=(\(N_{particles}\), 3), dtype= `numpy.float32`) – one set of particle positions points (`numpy.ndarray`, shape=(\(N_{particles}\), 3), dtype= `numpy.float32`) – other set of particle positions nlist (`freud.locality.NeighborList`) – `freud.locality.NeighborList` object to use to find bonds