|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Aliases, k-nearest lists, RDF, hydrogen bonds, density, fingerprints, sites. More...
Functions | |
| SEAMS_API seams_status | seams_cages (seams_system *sys, double cutoff, int type, int graph, int k, int complete, seams_cage_set **out) |
| Hexagonal and double-diamond cages. | |
| SEAMS_API seams_status | seams_signature_cages (seams_system *sys, double cutoff, int type, int graph, const char *spec, size_t *n_cages, size_t *n_atoms) |
| Closed cages of one ring census. | |
| SEAMS_API seams_status | seams_signature_cages_edge (seams_system *sys, double cutoff, int type, int graph, const char *spec, const char *edge, size_t *n_cages, size_t *n_atoms) |
| Closed cages of one ring census with an explicit face-edge window. | |
| SEAMS_API seams_status | seams_steinhardt (seams_system *sys, double cutoff, int type, int order_l, double *ql, size_t ql_len, double *qlbar, size_t qlbar_len) |
| Local Steinhardt q_l on the cutoff shell, and the average on request. | |
| SEAMS_API seams_status | seams_neighbours_knn (seams_system *sys, int k, double cutoff, int type, int mutual, seams_neighbours **out) |
| k-nearest neighbour list. | |
| SEAMS_API seams_status | seams_rdf (seams_system *sys, double rmax, int bins, int type_i, int type_j, double *r, double *g, int *count, size_t cap, size_t *n_out, double *volume) |
| Partial radial distribution. | |
| SEAMS_API seams_status | seams_running_cn (seams_system *sys, double rmax, int bins, int type_i, int type_j, double *r, double *cn, size_t cap, size_t *n_out) |
| Running coordination number along the partial RDF. | |
| SEAMS_API seams_status | seams_coordination (seams_system *sys, double rmax, int bins, int type_i, int type_j, double *cn) |
| Coordination number integrated to rmax. | |
| SEAMS_API seams_status | seams_hbonds (seams_system *sys, double cutoff, int oxygen_type, int hydrogen_type, double dist_cutoff, double angle_cutoff, int *n_bonds) |
| Hydrogen-bond count on one frame. | |
| SEAMS_API seams_status | seams_density_axis (seams_system *sys, int type, int bins, int axis, double *z, double *rho, size_t cap, size_t *n_out) |
| Number density along one cell axis. | |
| SEAMS_API seams_status | seams_fingerprint (seams_system *sys, double cutoff, int type, int k, int graph, int hops, int color_types, seams_topo **out) |
| Topological fingerprint of the bonded graph. | |
| SEAMS_API void | seams_fingerprint_destroy (seams_topo *fp) |
| Free a fingerprint. | |
| SEAMS_API seams_status | seams_fingerprint_key (const seams_topo *fp, char *buf, size_t cap, size_t *n_out) |
| Frame key text. | |
| SEAMS_API seams_status | seams_fingerprint_atom (const seams_topo *fp, int index, char *buf, size_t cap, size_t *n_out) |
| Local key of one atom. | |
| SEAMS_API seams_status | seams_fingerprint_rings (const seams_topo *fp, int *counts, size_t counts_len) |
| Primitive-ring census stored on the fingerprint. | |
| SEAMS_API seams_status | seams_contact_pairs (seams_system *sys, const char *site_spec, size_t *n_pairs, int *n_cation, int *n_anion) |
| Mutual nearest unlike contacts of a site table. | |
| SEAMS_API seams_status | seams_domains (seams_system *sys, double cutoff, const char *site_spec, int subset, int *n_subset, int *largest, double *percolation) |
| Largest domain of a polar or apolar site subset. | |
| SEAMS_API seams_status | seams_prisms (seams_system *sys, double cutoff, int type, int *perfect, int *imperfect, size_t len) |
| Perfect and imperfect prism counts by ring size. | |
| SEAMS_API seams_status | seams_monolayer (seams_system *sys, double cutoff, int type, int max_depth, double sheet_area, int *counts, size_t counts_len) |
| Primitive-ring histogram of a monolayer. | |
| SEAMS_API seams_status | seams_site_table (seams_system *sys, const char *spec, int *kinds, size_t len) |
| Per-atom site kind from a site-table spec. | |
Aliases, k-nearest lists, RDF, hydrogen bonds, density, fingerprints, sites.
| SEAMS_API seams_status seams_cages | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| int | k, | ||
| int | complete, | ||
| seams_cage_set ** | out ) |
Hexagonal and double-diamond cages.
Same search as seams_cages_find().
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| 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 seeded labels. |
| out | Receives a seams_cage_set. On failure *out is NULL. |
| SEAMS_API seams_status seams_contact_pairs | ( | seams_system * | sys, |
| const char * | site_spec, | ||
| size_t * | n_pairs, | ||
| int * | n_cation, | ||
| int * | n_anion ) |
Mutual nearest unlike contacts of a site table.
Cation and anion counts are molecules in the ion cloud.
| sys | Frame handle. |
| site_spec | Text such as "1=cationHead,2=anion". Must be non-NULL. |
| n_pairs | Receives the contact count, or NULL. |
| n_cation | Receives the cation molecule count, or NULL. |
| n_anion | Receives the anion molecule count, or NULL. At least one of the three outputs must be non-NULL. |
| SEAMS_API seams_status seams_coordination | ( | seams_system * | sys, |
| double | rmax, | ||
| int | bins, | ||
| int | type_i, | ||
| int | type_j, | ||
| double * | cn ) |
Coordination number integrated to rmax.
| sys | Frame handle. |
| rmax | Positive finite outer radius, Angstrom. |
| bins | Bin count. Zero selects about rmax / 0.1. |
| type_i | Central species, as in seams_rdf(). |
| type_j | Counted species, as in seams_rdf(). |
| cn | Receives the coordination number. |
| SEAMS_API seams_status seams_density_axis | ( | seams_system * | sys, |
| int | type, | ||
| int | bins, | ||
| int | axis, | ||
| double * | z, | ||
| double * | rho, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Number density along one cell axis.
z is Angstrom. rho is number density, atoms per cubic Angstrom.
| sys | Frame handle. |
| type | Species filter. Zero keeps every atom. |
| bins | Bin count. Zero selects about one bin per 0.1 Angstrom. |
| axis | 0, 1, or 2. |
| z | Bin centers, or NULL to query. |
| rho | Density per bin, or NULL to query. |
| cap | Capacity of each non-NULL column. |
| n_out | Receives the bin count. |
| SEAMS_API seams_status seams_domains | ( | seams_system * | sys, |
| double | cutoff, | ||
| const char * | site_spec, | ||
| int | subset, | ||
| int * | n_subset, | ||
| int * | largest, | ||
| double * | percolation ) |
Largest domain of a polar or apolar site subset.
| sys | Frame handle. |
| cutoff | Positive finite cluster cutoff, Angstrom. |
| site_spec | Site table text. Must be non-NULL. |
| subset | 0 is apolar, 1 is polar. |
| n_subset | Receives the number of sites in the subset, or NULL. |
| largest | Receives the size of the largest domain, or NULL. |
| percolation | Receives the largest domain size over the subset size, or NULL. At least one output must be non-NULL. |
| SEAMS_API seams_status seams_fingerprint | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | k, | ||
| int | graph, | ||
| int | hops, | ||
| int | color_types, | ||
| seams_topo ** | out ) |
Topological fingerprint of the bonded graph.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| k | Neighbour count for the mutual graph. Zero selects 4. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| hops | Neighbourhood depth. Zero selects 2. |
| color_types | Non-zero colors vertices by LAMMPS type. |
| out | Receives a seams_topo. On failure *out is NULL. |
| SEAMS_API seams_status seams_fingerprint_atom | ( | const seams_topo * | fp, |
| int | index, | ||
| char * | buf, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Local key of one atom.
Same buffer rule as seams_fingerprint_key().
| fp | Fingerprint handle. |
| index | Atom index in the frame. |
| buf | Caller buffer of cap bytes, or NULL to query. |
| cap | Capacity of buf, including the terminating NUL. |
| n_out | Receives the key length without the terminating NUL. |
| SEAMS_API void seams_fingerprint_destroy | ( | seams_topo * | fp | ) |
Free a fingerprint.
| fp | Handle from seams_fingerprint(), or NULL. NULL is ignored. |
| SEAMS_API seams_status seams_fingerprint_key | ( | const seams_topo * | fp, |
| char * | buf, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Frame key text.
| fp | Fingerprint handle. |
| buf | Caller buffer of cap bytes, or NULL to query. |
| cap | Capacity of buf, including the terminating NUL. |
| n_out | Receives the key length without the terminating NUL. |
| SEAMS_API seams_status seams_fingerprint_rings | ( | const seams_topo * | fp, |
| int * | counts, | ||
| size_t | counts_len ) |
Primitive-ring census stored on the fingerprint.
| fp | Fingerprint handle. |
| counts | Caller buffer. counts[k] receives the number of rings of size k. Sizes past the buffer are dropped. |
| counts_len | Length of counts. Must be positive. |
| SEAMS_API seams_status seams_hbonds | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | oxygen_type, | ||
| int | hydrogen_type, | ||
| double | dist_cutoff, | ||
| double | angle_cutoff, | ||
| int * | n_bonds ) |
Hydrogen-bond count on one frame.
| sys | Frame handle. |
| cutoff | Positive finite donor-acceptor cutoff, Angstrom. |
| oxygen_type | Heavy-atom species. Zero keeps every atom that is not hydrogen_type. |
| hydrogen_type | Positive hydrogen species. |
| dist_cutoff | Acceptor-H distance, Angstrom. |
| angle_cutoff | O-O-H angle, degrees. |
| n_bonds | Receives the number of hydrogen bonds. |
| SEAMS_API seams_status seams_monolayer | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | max_depth, | ||
| double | sheet_area, | ||
| int * | counts, | ||
| size_t | counts_len ) |
Primitive-ring histogram of a monolayer.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| max_depth | Largest ring size, at least 3. |
| sheet_area | Sheet area, square Angstrom. Must be positive. |
| counts | counts[k] is the number of rings of size k. |
| counts_len | Must be at least max_depth + 1. |
| SEAMS_API seams_status seams_neighbours_knn | ( | seams_system * | sys, |
| int | k, | ||
| double | cutoff, | ||
| int | type, | ||
| int | mutual, | ||
| seams_neighbours ** | out ) |
k-nearest neighbour list.
| sys | Frame handle. |
| k | Positive neighbour count. |
| cutoff | Nominal positive cutoff, Angstrom. Candidates are taken inside cutoff + 1.5. |
| type | Species filter. Zero and negative keep every atom. |
| mutual | Non-zero keeps the mutual graph. Zero keeps the one-way k-nearest graph. |
| out | Receives a neighbour handle. On failure *out is NULL. |
| SEAMS_API seams_status seams_prisms | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int * | perfect, | ||
| int * | imperfect, | ||
| size_t | len ) |
Perfect and imperfect prism counts by ring size.
Rings come from the mutual four-nearest graph inside cutoff + 1.5.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| perfect | Caller buffer. perfect[k] receives the perfect k-prisms. |
| imperfect | Caller buffer. imperfect[k] receives the deformed k-prisms. |
| len | Length of each buffer. At least 7, so that sizes 3 through 6 are filled. |
| SEAMS_API seams_status seams_rdf | ( | seams_system * | sys, |
| double | rmax, | ||
| int | bins, | ||
| int | type_i, | ||
| int | type_j, | ||
| double * | r, | ||
| double * | g, | ||
| int * | count, | ||
| size_t | cap, | ||
| size_t * | n_out, | ||
| double * | volume ) |
Partial radial distribution.
r is Angstrom. g is dimensionless. volume is cubic Angstrom.
| sys | Frame handle. |
| rmax | Positive finite outer radius, Angstrom. |
| bins | Bin count. Zero selects about rmax / 0.1. |
| type_i | First species. Zero and negative keep every atom of a single-species frame, or every atom as one species otherwise. |
| type_j | Second species. Zero and negative reuse the type_i species. |
| r | Bin centers, or NULL to query. |
| g | g(r) per bin, or NULL to query. |
| count | Pair count per bin, or NULL to query. |
| cap | Capacity of each non-NULL column. |
| n_out | Receives the bin count. |
| volume | Receives the cell volume, or NULL. |
| SEAMS_API seams_status seams_running_cn | ( | seams_system * | sys, |
| double | rmax, | ||
| int | bins, | ||
| int | type_i, | ||
| int | type_j, | ||
| double * | r, | ||
| double * | cn, | ||
| size_t | cap, | ||
| size_t * | n_out ) |
Running coordination number along the partial RDF.
| sys | Frame handle. |
| rmax | Positive finite outer radius, Angstrom. |
| bins | Bin count. Zero selects about rmax / 0.1. |
| type_i | Central species, as in seams_rdf(). |
| type_j | Counted species, as in seams_rdf(). |
| r | Bin centers, Angstrom, or NULL to query. |
| cn | Running coordination number, or NULL to query. |
| cap | Capacity of each non-NULL column. |
| n_out | Receives the bin count. |
| SEAMS_API seams_status seams_signature_cages | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| const char * | spec, | ||
| size_t * | n_cages, | ||
| size_t * | n_atoms ) |
Closed cages of one ring census.
Same search as seams_cages_signature().
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| spec | Signature text such as "512" or "hc". Must be non-NULL. |
| n_cages | Receives the cage count. |
| n_atoms | Receives the vertex count. |
| SEAMS_API seams_status seams_signature_cages_edge | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | graph, | ||
| const char * | spec, | ||
| const char * | edge, | ||
| size_t * | n_cages, | ||
| size_t * | n_atoms ) |
Closed cages of one ring census with an explicit face-edge window.
Same search as seams_signature_cages(). edge NULL or "" keeps the default window 2.65,3.15 in the coordinate units of the file. "none" leaves the cage bound to the face census.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| graph | SEAMS_GRAPH_CUTOFF or SEAMS_GRAPH_MUTUAL. |
| spec | Signature text such as "512" or "hc". Must be non-NULL. |
| edge | Face-edge window, or NULL. "none" turns the window off. |
| n_cages | Receives the cage count. |
| n_atoms | Receives the vertex count. |
| SEAMS_API seams_status seams_site_table | ( | seams_system * | sys, |
| const char * | spec, | ||
| int * | kinds, | ||
| size_t | len ) |
Per-atom site kind from a site-table spec.
| sys | Frame handle. |
| spec | Site table text such as "1=cationHead,2=anion". Must be non-NULL. |
| kinds | One seams_site_kind per atom. |
| len | Length of kinds. Must be at least the frame count. |
| SEAMS_API seams_status seams_steinhardt | ( | seams_system * | sys, |
| double | cutoff, | ||
| int | type, | ||
| int | order_l, | ||
| double * | ql, | ||
| size_t | ql_len, | ||
| double * | qlbar, | ||
| size_t | qlbar_len ) |
Local Steinhardt q_l on the cutoff shell, and the average on request.
This is seams_ql() with the cutoff graph.
| sys | Frame handle. |
| cutoff | Positive finite cutoff, Angstrom. |
| type | Species filter. |
| order_l | 3, 4, 6, 8, or 12. |
| ql | Local q_l, or NULL. |
| ql_len | Length of ql. Ignored when ql is NULL. |
| qlbar | Averaged q_l, or NULL to skip the Lechner-Dellago average. |
| qlbar_len | Length of qlbar. Ignored when qlbar is NULL. |