|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
One frame: coordinates, a cell, and the analyses that read them. More...
#include <include/seams.hpp>
Public Member Functions | |
| System () | |
| Allocate an empty frame. | |
| void | set_ortho (std::span< const double > xyz, double lx, double ly, double lz) |
| Store points in an orthorhombic cell whose origin is zero. | |
| void | set_ortho (std::span< const double > xyz, std::span< const double, 3 > origin, std::span< const double, 3 > lengths, std::span< const int > types={}, std::span< const int > ids={}) |
| Store points in an orthorhombic cell. | |
| void | set_frame (std::span< const double > xyz, std::span< const double, 9 > box9, std::span< const int > types={}, std::span< const int > ids={}) |
| Store points and a general nine-number cell. | |
| std::pair< std::vector< int >, std::vector< int > > | chill (double cutoff, int type, int graph, int rule) |
| std::pair< std::vector< double >, std::vector< double > > | steinhardt (double cutoff, int order, bool average) |
| void | read (std::string_view path, int frame, int type_filter) |
| Read one frame from a trajectory path. | |
| int | count () const |
| Number of points in the frame. | |
| Classification | chill (const ChillOptions &options) |
| Original CHILL labels and nine population counts. | |
| Classification | chill_plus (const ChillOptions &options) |
| CHILL+ labels and nine population counts. | |
| Steinhardt | steinhardt (const SteinhardtOptions &options) |
| Local q_l on the cutoff shell. | |
| Steinhardt | ql (const OrderOptions &options) |
| Local q_l on a named graph. | |
| Q4Q6 | q4q6 (double cutoff, int species=0) |
| Local q4 and q6 on the cutoff shell. | |
| Q6Bar | q6bar (const Q6BarOptions &options) |
| q6-bar, its mean and median, and the ice count above the cut. | |
| Neighbours | neighbours (const NeighbourOptions &options) |
| Cutoff or mutual neighbour list. | |
| ChordlessCycles | rings_chordless (const NeighbourOptions &options, int size) |
| Chordless cycles of one length on a neighbour graph. | |
| Neighbours | knn (const KnnOptions &options) |
| k-nearest neighbour list. | |
| std::vector< int > | neighbour_degree (double cutoff, int species=0) |
| Degree of each atom on the cutoff graph. | |
| Rings | rings (const RingOptions &options) |
| Primitive rings up to a maximum size. | |
| Cages | cages (const CageOptions &options) |
| Hexagonal and double-diamond cage membership. | |
| SignatureMatch | signature_cages (const SignatureOptions &options) |
| Closed cages of one ring census. | |
| Distribution | rdf (const DistributionOptions &options) |
| Partial radial distribution and the cell volume. | |
| RunningCoordination | running_cn (const DistributionOptions &options) |
| Running coordination number along the partial RDF. | |
| double | coordination (const DistributionOptions &options) |
| Coordination number integrated to rmax. | |
| int | hbonds (const BondOptions &options) |
| Hydrogen-bond count. | |
| DensityProfile | density (const DensityOptions &options) |
| Number density along one cell axis. | |
| Fingerprint | fingerprint (const FingerprintOptions &options) |
| Topological fingerprint of the bonded graph. | |
| Contacts | contact_pairs (std::string_view spec) |
| Mutual nearest unlike contacts. | |
| DomainReport | domains (const DomainOptions &options) |
| Largest polar or apolar domain. | |
| PrismCensus | prisms (const PrismOptions &options) |
| Perfect and imperfect prism counts by ring size. | |
| std::vector< int > | monolayer (const SheetOptions &options) |
| Primitive-ring histogram of a monolayer. | |
| std::vector< int > | site_table (std::string_view spec) |
| Per-atom site kind. | |
| std::vector< int > | symmetry (double shell_rmsd) |
| Per-atom ice-shell label. | |
| Brine | brine (std::span< const int > ice, const BrineOptions &options) |
| Planar ice front from an ice assignment. | |
| Public Member Functions inherited from seams::detail::Handle< seams_system, seams_system_destroy > | |
| Handle ()=default | |
| Handle & | operator= (const Handle &)=delete |
| ~Handle () | |
| operator bool () const noexcept | |
Additional Inherited Members | |
| Protected Member Functions inherited from seams::detail::Handle< seams_system, seams_system_destroy > | |
| seams_system * | get () const noexcept |
| void | reset () noexcept |
| Protected Attributes inherited from seams::detail::Handle< seams_system, seams_system_destroy > | |
| seams_system * | ptr_ |
One frame: coordinates, a cell, and the analyses that read them.
Move-only. The destructor frees the C handle. Methods that read the frame require exclusive use of this object. The Steinhardt scratch inside the library is process-global, so two frames must not run steinhardt, ql, q4q6, or q6bar at the same time. set_num_threads is also process-global.
|
inline |
Allocate an empty frame.
| Error | with status Memory when the allocation fails. |
Definition at line 945 of file seams.hpp.
|
inlinenodiscard |
Planar ice front from an ice assignment.
| ice | Non-zero when the atom is ice. Length must equal count(). |
| options | Water species, ion species, bins, and axis. |
Definition at line 1332 of file seams.hpp.
|
inlinenodiscard |
Hexagonal and double-diamond cage membership.
Definition at line 1161 of file seams.hpp.
|
inlinenodiscard |
|
inline |
Definition at line 1005 of file seams.hpp.
|
inlinenodiscard |
|
inlinenodiscard |
Mutual nearest unlike contacts.
spec is site-table text.
Definition at line 1265 of file seams.hpp.
|
inlinenodiscard |
Coordination number integrated to rmax.
Definition at line 1219 of file seams.hpp.
|
inlinenodiscard |
|
inlinenodiscard |
Number density along one cell axis.
Definition at line 1237 of file seams.hpp.
|
inlinenodiscard |
Largest polar or apolar domain.
Definition at line 1274 of file seams.hpp.
|
inlinenodiscard |
Topological fingerprint of the bonded graph.
Definition at line 1255 of file seams.hpp.
|
inlinenodiscard |
Hydrogen-bond count.
Definition at line 1228 of file seams.hpp.
|
inlinenodiscard |
k-nearest neighbour list.
Definition at line 1134 of file seams.hpp.
|
inlinenodiscard |
Primitive-ring histogram of a monolayer.
Definition at line 1296 of file seams.hpp.
|
inlinenodiscard |
Degree of each atom on the cutoff graph.
| cutoff | Positive cutoff, Angstrom. |
| species | Species filter. Zero keeps every atom. |
Definition at line 1147 of file seams.hpp.
|
inlinenodiscard |
Cutoff or mutual neighbour list.
Definition at line 1115 of file seams.hpp.
|
inlinenodiscard |
Perfect and imperfect prism counts by ring size.
Definition at line 1284 of file seams.hpp.
|
inlinenodiscard |
Local q4 and q6 on the cutoff shell.
Definition at line 1094 of file seams.hpp.
|
inlinenodiscard |
q6-bar, its mean and median, and the ice count above the cut.
Definition at line 1104 of file seams.hpp.
|
inlinenodiscard |
Local q_l on a named graph.
Definition at line 1079 of file seams.hpp.
|
inlinenodiscard |
Partial radial distribution and the cell volume.
Definition at line 1181 of file seams.hpp.
|
inline |
Read one frame from a trajectory path.
| path | XYZ, CON, chemfiles, or a LAMMPS dump. |
| frame | 1-based frame index. |
| type_filter | Species to keep. Negative keeps every atom. |
Definition at line 1039 of file seams.hpp.
|
inlinenodiscard |
Primitive rings up to a maximum size.
Definition at line 1152 of file seams.hpp.
|
inlinenodiscard |
Chordless cycles of one length on a neighbour graph.
| options | Graph of the cycles. |
| size | Cycle length, from 3 through 12. |
Definition at line 1129 of file seams.hpp.
|
inlinenodiscard |
Running coordination number along the partial RDF.
Definition at line 1201 of file seams.hpp.
|
inline |
Store points and a general nine-number cell.
| xyz | Interleaved coordinates, Angstrom. |
| box9 | ox, oy, oz, lx, ly, lz, xy, xz, yz. |
| types | One species per atom, or empty. |
| ids | One id per atom, or empty. |
Definition at line 993 of file seams.hpp.
|
inline |
Store points in an orthorhombic cell whose origin is zero.
| xyz | Interleaved x, y, z. Length is a multiple of 3. Angstrom. |
| lx | Edge length along x, Angstrom. |
| ly | Edge length along y, Angstrom. |
| lz | Edge length along z, Angstrom. |
Definition at line 958 of file seams.hpp.
|
inline |
Store points in an orthorhombic cell.
| xyz | Interleaved x, y, z. Length is a multiple of 3. Angstrom. |
| origin | Cell origin, Angstrom. |
| lengths | Edge lengths, Angstrom. Each must be positive. |
| types | One species per atom, or an empty span. |
| ids | One id per atom, or an empty span. |
Definition at line 972 of file seams.hpp.
|
inlinenodiscard |
Closed cages of one ring census.
Definition at line 1171 of file seams.hpp.
|
inlinenodiscard |
Per-atom site kind.
| spec | Site-table text, for example 1=waterO. |
Definition at line 1309 of file seams.hpp.
|
inlinenodiscard |
Local q_l on the cutoff shell.
| options | Cutoff, species, degree, and whether to average. |
Definition at line 1064 of file seams.hpp.
|
inline |
Definition at line 1016 of file seams.hpp.
|
inlinenodiscard |
Per-atom ice-shell label.
| shell_rmsd | Positive residual ceiling, or a non-positive value for the library ceiling. |
Definition at line 1321 of file seams.hpp.