Interface Module

Overview

freud.interface.Interface

Measures the interface between two sets of points.

Details

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

class freud.interface.Interface

Bases: _PairCompute

Measures the interface between two sets of points.

compute(system, query_points, neighbors=None)

Compute the particles at the interface between two sets of points.

Parameters:

• system – Any object that is a valid argument to freud.locality.NeighborQuery.from_system.

• query_points ((\(N_{query\_points}\), 3) numpy.ndarray, optional) – Second set of points (in addition to the system points) to calculate the interface.

• neighbors (freud.locality.NeighborList or dict, optional) – Either a NeighborList of neighbor pairs to use in the calculation, or a dictionary of query arguments (Default value: None).

property default_query_args

No default query arguments.

property point_count

Number of particles from points on the interface.

Type:

int

property point_ids

The particle IDs from points.

Type:

np.ndarray

property query_point_count

Number of particles from query_points on the interface.

Type:

int

property query_point_ids

The particle IDs from query_points.

Type:

np.ndarray