seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
Order parameters

CHILL, CHILL+, Steinhardt q_l, and the ice shell label. More...

Functions

SEAMS_API seams_status seams_chill (seams_system *sys, double cutoff, int type, int graph, int rule, int *labels, size_t labels_len, int counts9[9])
 Original CHILL labels, published or OVITO edges.
SEAMS_API seams_status seams_chill_plus (seams_system *sys, double cutoff, int type, int graph, int rule, int *labels, int counts9[9])
 CHILL+ labels, without a buffer length.
SEAMS_API seams_status seams_ql (seams_system *sys, double cutoff, int type, int order_l, int graph, double *ql, size_t ql_len, double *qlbar, size_t qlbar_len)
 Local Steinhardt q_l, and the Lechner-Dellago average on request.
SEAMS_API seams_status seams_q4q6 (seams_system *sys, double cutoff, int type, double *q4, double *q6)
 Local q4 and q6 on the cutoff shell, without buffer lengths.
SEAMS_API seams_status seams_q6bar (seams_system *sys, double cutoff, int type, double ice_cut, double *q6bar, size_t q6bar_len, double *mean, double *median, int *n_ice)
 Lechner-Dellago q6-bar and the ice count above a cut.

Detailed Description

CHILL, CHILL+, Steinhardt q_l, and the ice shell label.

Function Documentation

◆ seams_chill()

SEAMS_API seams_status seams_chill ( seams_system * sys,
double cutoff,
int type,
int graph,
int rule,
int * labels,
size_t labels_len,
int counts9[9] )

Original CHILL labels, published or OVITO edges.

Published CHILL is Moore's four-neighbour rule with inclusive c_ij edges. OVITO mode uses the same thresholds and the open edges. Labels match seams_label.

Parameters
sysFrame handle.
cutoffPositive finite cutoff, Angstrom.
typeSpecies filter. Zero and negative keep every atom.
graphSEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL.
ruleSEAMS_CHILL_PUBLISHED or SEAMS_CHILL_OVITO.
labelsCaller buffer of labels_len ints.
labels_lenMust be at least the frame count.
counts9Nine ints that receive the population of each label, or NULL to skip the histogram.
Returns
SEAMS_OK, or SEAMS_ERR_NULL, SEAMS_ERR_STATE, SEAMS_ERR_RANGE, SEAMS_ERR_ARG, SEAMS_ERR_NOMEM, SEAMS_ERR_INTERNAL.
Handle access
Non-const: writes each atom's CHILL+ label into the stored frame and clears the handle's error slot on entry. Coordinates, cell, types, and ids are not changed.
Ownership
The caller owns labels and counts9.
Thread safety
Exclusive use of sys.
Example
int counts[9];
seams_chill(sys, 3.5, 0, SEAMS_GRAPH_CUTOFF, SEAMS_CHILL_PUBLISHED, labels, n, counts);
SEAMS_API seams_status seams_chill(seams_system *sys, double cutoff, int type, int graph, int rule, int *labels, size_t labels_len, int counts9[9])
Original CHILL labels, published or OVITO edges.
@ SEAMS_CHILL_PUBLISHED
Nguyen and Molinero, four closest neighbours.
Definition seams.h:202
@ SEAMS_GRAPH_CUTOFF
Every neighbour inside the cutoff.
Definition seams.h:208

◆ seams_chill_plus()

SEAMS_API seams_status seams_chill_plus ( seams_system * sys,
double cutoff,
int type,
int graph,
int rule,
int * labels,
int counts9[9] )

CHILL+ labels, without a buffer length.

ABI 1 entry. labels must hold one int per atom in the frame. New callers use seams_chill_plus_n(), which checks the length.

Parameters
sysFrame handle.
cutoffPositive finite cutoff, Angstrom.
typeSpecies filter. Zero and negative keep every atom.
graphSEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL.
ruleSEAMS_CHILL_PUBLISHED or SEAMS_CHILL_OVITO.
labelsCaller buffer of one label per atom.
counts9Nine ints, or NULL.
Returns
Same codes as seams_chill_plus_n().
Handle access
Non-const: writes each atom's CHILL+ label into the stored frame and clears the handle's error slot on entry. Coordinates, cell, types, and ids are not changed.
Ownership
The caller owns labels and counts9.
Thread safety
Exclusive use of sys.
Example
SEAMS_API seams_status seams_chill_plus(seams_system *sys, double cutoff, int type, int graph, int rule, int *labels, int counts9[9])
CHILL+ labels, without a buffer length.

◆ seams_q4q6()

SEAMS_API seams_status seams_q4q6 ( seams_system * sys,
double cutoff,
int type,
double * q4,
double * q6 )

Local q4 and q6 on the cutoff shell, without buffer lengths.

ABI 1 pair. Each non-NULL array has one double per atom. New callers use seams_q4q6_n(), which checks the lengths.

Parameters
sysFrame handle.
cutoffPositive finite cutoff, Angstrom.
typeSpecies filter.
q4Local q4, or NULL.
q6Local q6, or NULL. q4 and q6 may not both be NULL.
Returns
SEAMS_OK, or SEAMS_ERR_NULL, SEAMS_ERR_STATE, SEAMS_ERR_RANGE, SEAMS_ERR_NOMEM, SEAMS_ERR_INTERNAL.
Handle access
Non-const only because the call clears the handle's error slot on entry; it reads the frame and nothing else on the handle. The q_lm work arrays belong to the calling thread, so calls on different handles may run at the same time.
Ownership
The caller owns q4 and q6.
Thread safety
Exclusive use of sys. Any q call on another handle may run beside it.
Example
seams_q4q6(sys, 3.5, 0, q4, q6);
SEAMS_API seams_status seams_q4q6(seams_system *sys, double cutoff, int type, double *q4, double *q6)
Local q4 and q6 on the cutoff shell, without buffer lengths.

◆ seams_q6bar()

SEAMS_API seams_status seams_q6bar ( seams_system * sys,
double cutoff,
int type,
double ice_cut,
double * q6bar,
size_t q6bar_len,
double * mean,
double * median,
int * n_ice )

Lechner-Dellago q6-bar and the ice count above a cut.

The average is the same neighbour mean of q_6m as seams_ql() of order 6 on the cutoff graph. n_ice counts finite values strictly above ice_cut. The nucleation census uses 0.36. mean and median ignore non-finite values. An empty finite set stores 0.

Parameters
sysFrame handle.
cutoffPositive finite cutoff, Angstrom.
typeSpecies filter.
ice_cutFinite threshold on q6-bar.
q6barPer-atom average, or NULL to keep only the summary.
q6bar_lenLength of q6bar. Ignored when q6bar is NULL.
meanReceives the mean, or NULL.
medianReceives the median, or NULL.
n_iceReceives the count above ice_cut, or NULL.
Returns
SEAMS_OK, or SEAMS_ERR_NULL, SEAMS_ERR_STATE, SEAMS_ERR_RANGE, SEAMS_ERR_NOMEM, SEAMS_ERR_INTERNAL. At least one of q6bar, mean, median, and n_ice must be non-NULL.
Handle access
Non-const only because the call clears the handle's error slot on entry; it reads the frame and nothing else on the handle. The q_lm work arrays belong to the calling thread, so calls on different handles may run at the same time.
Ownership
The caller owns q6bar.
Thread safety
Exclusive use of sys. Any q call on another handle may run beside it.
Example
double mean = 0, median = 0;
int n_ice = 0;
seams_q6bar(sys, 3.5, 0, 0.36, NULL, 0, &mean, &median, &n_ice);
SEAMS_API seams_status seams_q6bar(seams_system *sys, double cutoff, int type, double ice_cut, double *q6bar, size_t q6bar_len, double *mean, double *median, int *n_ice)
Lechner-Dellago q6-bar and the ice count above a cut.

◆ seams_ql()

SEAMS_API seams_status seams_ql ( seams_system * sys,
double cutoff,
int type,
int order_l,
int graph,
double * ql,
size_t ql_len,
double * qlbar,
size_t qlbar_len )

Local Steinhardt q_l, and the Lechner-Dellago average on request.

order_l is 3, 4, 6, 8, or 12. Either array may be NULL. A non-NULL array has one double per atom and its length must be at least the frame count. The average is the neighbour mean of q_lm. The cutoff graph reads the cutoff shell. The mutual graph reads the four nearest neighbours inside cutoff + 1.5.

Parameters
sysFrame handle.
cutoffPositive finite cutoff, Angstrom.
typeSpecies filter. Zero and negative keep every atom.
order_lSpherical-harmonic degree.
graphSEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL.
qlLocal q_l, or NULL.
ql_lenLength of ql. Ignored when ql is NULL.
qlbarAveraged q_l, or NULL to skip the average.
qlbar_lenLength of qlbar. Ignored when qlbar is NULL.
Returns
SEAMS_OK, or SEAMS_ERR_NULL, SEAMS_ERR_STATE, SEAMS_ERR_RANGE, SEAMS_ERR_ARG, SEAMS_ERR_NOMEM, SEAMS_ERR_INTERNAL.
Handle access
Non-const only because the call clears the handle's error slot on entry; it reads the frame and nothing else on the handle. The q_lm work arrays belong to the calling thread, so calls on different handles may run at the same time.
Ownership
The caller owns both arrays.
Thread safety
Exclusive use of sys. Any q call on another handle may run beside it.
Example
seams_ql(sys, 3.5, 0, 6, SEAMS_GRAPH_CUTOFF, q6, n, q6bar, n);
SEAMS_API seams_status seams_ql(seams_system *sys, double cutoff, int type, int order_l, int graph, double *ql, size_t ql_len, double *qlbar, size_t qlbar_len)
Local Steinhardt q_l, and the Lechner-Dellago average on request.