|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Preferred spellings for new callers. More...
Functions | |
| SEAMS_API const char * | seams_last_error_message (void) |
| Thread-local detail of the last failing call on this thread. | |
| SEAMS_API seams_status | seams_system_natoms (const seams_system *sys, size_t *n) |
| Number of points in the frame. | |
| SEAMS_API seams_status | seams_neighbours_nrows (const seams_neighbours *nb, size_t *n) |
| Number of neighbour rows. | |
| SEAMS_API seams_status | seams_rings_nrings (const seams_rings *rings, size_t *n) |
| Number of primitive rings. | |
| SEAMS_API seams_status | seams_chill_plus_n (seams_system *sys, double cutoff, int type, int graph, int rule, int *labels, size_t labels_len, int counts9[9]) |
| CHILL+ labels into a buffer of known length. | |
| SEAMS_API seams_status | seams_q4q6_n (seams_system *sys, double cutoff, int type, double *q4, size_t q4_len, double *q6, size_t q6_len) |
| Local q4 and q6 on the cutoff shell into buffers of known length. | |
| SEAMS_API seams_status | seams_rings_labels_n (const seams_rings *rings, int *sizes, size_t sizes_len, int *symmetry, size_t symmetry_len) |
| Size and symmetry of each ring into buffers of known length. | |
| SEAMS_API seams_status | seams_rings_histogram_n (const seams_rings *rings, int *counts, size_t counts_len) |
| Count primitive rings by size into a buffer of known length. | |
Preferred spellings for new callers.
Each one reports errors through seams_status and takes a size_t length for every caller buffer.
| SEAMS_API seams_status seams_chill_plus_n | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| int | rule, | ||
| int * | labels, | ||
| size_t | labels_len, | ||
| int | counts9[9] ) |
CHILL+ labels into a buffer of known length.
rule selects the q_lm shell. SEAMS_CHILL_PUBLISHED, the default, is Nguyen and Molinero equation 1: the four closest neighbours. SEAMS_CHILL_OVITO is every neighbour inside the cutoff, which is the OVITO Chill+ modifier. Labels match seams_label.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. Zero and negative keep every atom. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| rule | SEAMS_CHILL_PUBLISHED or SEAMS_CHILL_OVITO. |
| labels | Caller buffer of labels_len ints. |
| labels_len | Must be at least the frame count. |
| counts9 | Nine ints that receive the population of each label, or NULL. |
| SEAMS_API const char * seams_last_error_message | ( | void | ) |
Thread-local detail of the last failing call on this thread.
The string is empty after a successful call on this thread. Prefer seams_handle_error() when the failing call had a handle: that copy survives a later call on another handle. seams_last_error() is the ABI 1 spelling and returns the same string.
| SEAMS_API seams_status seams_neighbours_nrows | ( | const seams_neighbours * | nb, |
| size_t * | n ) |
Number of neighbour rows.
| nb | Neighbour handle. |
| n | Receives the row count. |
| SEAMS_API seams_status seams_q4q6_n | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| double * | q4, | ||
| size_t | q4_len, | ||
| double * | q6, | ||
| size_t | q6_len ) |
Local q4 and q6 on the cutoff shell into buffers of known length.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| q4 | Local q4, or NULL. |
| q4_len | Length of q4. Ignored when q4 is NULL. |
| q6 | Local q6, or NULL. q4 and q6 may not both be NULL. |
| q6_len | Length of q6. Ignored when q6 is NULL. |
| SEAMS_API seams_status seams_rings_histogram_n | ( | const seams_rings * | rings, |
| int * | counts, | ||
| size_t | counts_len ) |
Count primitive rings by size into a buffer of known length.
| rings | Ring handle. |
| counts | Caller buffer. counts[k] receives the number of rings of size k. Sizes outside the buffer are ignored. |
| counts_len | Length of counts. Must be positive. |
| SEAMS_API seams_status seams_rings_labels_n | ( | const seams_rings * | rings, |
| int * | sizes, | ||
| size_t | sizes_len, | ||
| int * | symmetry, | ||
| size_t | symmetry_len ) |
Size and symmetry of each ring into buffers of known length.
| rings | Ring handle. |
| sizes | One int per ring, or NULL. |
| sizes_len | Length of sizes. Ignored when sizes is NULL. |
| symmetry | One seams_ring_symmetry code per ring, or NULL. The two pointers may not both be NULL. |
| symmetry_len | Length of symmetry. Ignored when symmetry is NULL. |
| SEAMS_API seams_status seams_rings_nrings | ( | const seams_rings * | rings, |
| size_t * | n ) |
Number of primitive rings.
| rings | Ring handle. |
| n | Receives the ring count. |
| SEAMS_API seams_status seams_system_natoms | ( | const seams_system * | sys, |
| size_t * | n ) |
Number of points in the frame.
| sys | Frame handle. |
| n | Receives the atom count. |