|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Hexagonal and double-diamond cages, signatures, and shell labels. More...
Functions | |
| SEAMS_API seams_status | seams_cages_find (seams_system *sys, double cutoff, int type, int graph, int k, int complete, seams_cage_set **out) |
| Hexagonal and double-diamond cage membership. | |
| SEAMS_API void | seams_cages_destroy (seams_cage_set *cages) |
| Free a cage-membership handle. | |
| SEAMS_API seams_status | seams_cages_counts (const seams_cage_set *cages, int *n_hex, int *n_cubic, int *n_water, int *n_both) |
| Disjoint cage population counts. | |
| SEAMS_API seams_status | seams_cages_labels (const seams_cage_set *cages, int *per_atom, size_t len) |
| Per-atom cage code. | |
| SEAMS_API seams_status | seams_cages_signature (seams_system *sys, double cutoff, int type, int graph, const char *spec, size_t *n_cages, size_t *n_atoms) |
| Count closed cages whose ring census matches a signature. | |
| SEAMS_API seams_status | seams_system_symmetry (seams_system *sys, double shell_rmsd, int *labels, size_t labels_len) |
| Per-atom ice shell label. | |
Hexagonal and double-diamond cages, signatures, and shell labels.
| SEAMS_API seams_status seams_cages_counts | ( | const seams_cage_set * | cages, |
| int * | n_hex, | ||
| int * | n_cubic, | ||
| int * | n_water, | ||
| int * | n_both ) |
Disjoint cage population counts.
The four counts sum to the number of atoms the search kept.
| cages | Cage handle. |
| n_hex | Hexagonal only, or NULL. |
| n_cubic | Double-diamond only, or NULL. |
| n_water | Neither cage, or NULL. |
| n_both | Both cages, or NULL. |
| SEAMS_API void seams_cages_destroy | ( | seams_cage_set * | cages | ) |
Free a cage-membership handle.
| cages | Handle from seams_cages_find() or seams_cages(), or NULL. NULL is ignored. |
| SEAMS_API seams_status seams_cages_find | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| int | k, | ||
| int | complete, | ||
| seams_cage_set ** | out ) |
Hexagonal and double-diamond cage membership.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. The seeded graph uses cutoff + 1.5 as the candidate shell. |
| type | Species filter. |
| graph | SEAMS_GRAPH_CUTOFF, SEAMS_GRAPH_MUTUAL, or SEAMS_GRAPH_SEEDED. |
| k | Neighbour count for the seeded graph. Zero selects 4. |
| complete | Non-zero runs ring-adjacent completion on the seeded labels. Ignored for the cutoff and mutual graphs. |
| out | Receives a new handle. On failure *out is NULL. |
| SEAMS_API seams_status seams_cages_labels | ( | const seams_cage_set * | cages, |
| int * | per_atom, | ||
| size_t | len ) |
Per-atom cage code.
| cages | Cage handle. |
| per_atom | Caller buffer of seams_cage_label values, one per atom in the frame. Atoms the species filter dropped are SEAMS_CAGE_WATER. |
| len | Length of per_atom. Must be at least the frame count stored on the handle. |
| SEAMS_API seams_status seams_cages_signature | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| const char * | spec, | ||
| size_t * | n_cages, | ||
| size_t * | n_atoms ) |
Count closed cages whose ring census matches a signature.
spec is a census such as "512", "51262", or "51264", or the names "hc" and "ddc". n_cages is the number of closed cages. n_atoms is the number of distinct vertices in those cages.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| spec | Signature text. Must be non-NULL. |
| n_cages | Receives the cage count. |
| n_atoms | Receives the vertex count. |
| SEAMS_API seams_status seams_system_symmetry | ( | seams_system * | sys, |
| double | shell_rmsd, | ||
| int * | labels, | ||
| size_t | labels_len ) |
Per-atom ice shell label.
labels[i] is 0 for ice Ih, 1 for ice Ic, 2 for stacking disorder, or -1 when the shell does not match. A non-positive shell_rmsd selects the library ceiling (the scale-free second-shell residual, 0.15).
| sys | Frame handle. |
| shell_rmsd | Positive scale-free residual ceiling, or a non-positive value for the library ceiling. |
| labels | Caller buffer. |
| labels_len | Must be at least the frame count. |