|
seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
|
Idiomatic C++ for the d-SEAMS C API. More...
#include "seams.h"#include <algorithm>#include <array>#include <cstddef>#include <span>#include <stdexcept>#include <string>#include <string_view>#include <utility>#include <vector>Go to the source code of this file.
Classes | |
| class | seams::Error |
| Failure from the C API, or from a rejected argument. More... | |
| struct | seams::Classification |
| CHILL or CHILL+ labels and the nine population counts. More... | |
| struct | seams::Steinhardt |
| Local Steinhardt parameter, and the average when it was asked for. More... | |
| struct | seams::Q4Q6 |
| Local q4 and q6 on the cutoff shell. More... | |
| struct | seams::Q6Bar |
| Lechner-Dellago q6-bar and the ice count above a cut. More... | |
| struct | seams::Distribution |
| Partial radial distribution. More... | |
| struct | seams::RunningCoordination |
| Running coordination number along a partial RDF. More... | |
| struct | seams::CageCounts |
| Disjoint cage populations. More... | |
| struct | seams::SignatureMatch |
| Closed cages whose ring census matches a signature. More... | |
| struct | seams::Contacts |
| Mutual nearest unlike contacts of a site table. More... | |
| struct | seams::DomainReport |
| Largest polar or apolar domain. More... | |
| struct | seams::PrismCensus |
| Perfect and imperfect prism counts by ring size. More... | |
| struct | seams::DensityProfile |
| Number density along one cell axis. More... | |
| struct | seams::BrineFronts |
| The two planar crossings of an ice slab. More... | |
| struct | seams::Rejection |
| Molal rejection coefficient. More... | |
| struct | seams::BrineProfile |
| Concentration profile along the brine axis. More... | |
| struct | seams::Pockets |
| Brine pockets trapped in the ice. More... | |
| struct | seams::ChillOptions |
| Knobs for CHILL and CHILL+. More... | |
| struct | seams::SteinhardtOptions |
| Knobs for a local Steinhardt parameter on the cutoff shell. More... | |
| struct | seams::OrderOptions |
| Knobs for q_l on a named graph. More... | |
| struct | seams::Q6BarOptions |
| Knobs for the q6-bar ice summary. More... | |
| struct | seams::NeighbourOptions |
| Knobs for a neighbour list. More... | |
| struct | seams::KnnOptions |
| Knobs for a k-nearest neighbour list. More... | |
| struct | seams::RingOptions |
| Knobs for primitive rings. More... | |
| struct | seams::CageOptions |
| Knobs for hexagonal and double-diamond cages. More... | |
| struct | seams::SignatureOptions |
| Knobs for a signature cage census. More... | |
| struct | seams::DistributionOptions |
| Knobs for a partial RDF, its running coordination, or the integral. More... | |
| struct | seams::BondOptions |
| Knobs for a hydrogen-bond count. More... | |
| struct | seams::DensityOptions |
| Knobs for the axial number density. More... | |
| struct | seams::FingerprintOptions |
| Knobs for a topological fingerprint. More... | |
| struct | seams::DomainOptions |
| Knobs for a domain search. More... | |
| struct | seams::PrismOptions |
| Knobs for prism stacks. More... | |
| struct | seams::SheetOptions |
| Knobs for a monolayer ring histogram. More... | |
| struct | seams::BrineOptions |
| Knobs for a planar ice front. More... | |
| class | seams::detail::Handle< T, Destroy > |
| struct | seams::ChordlessCycles |
| Chordless cycles of one length. More... | |
| class | seams::Neighbours |
| Owned neighbour list. More... | |
| class | seams::Rings |
| Owned primitive-ring set. More... | |
| class | seams::Rings::iterator |
| Input iterator. More... | |
| class | seams::Cages |
| Owned hexagonal and double-diamond membership. More... | |
| class | seams::Fingerprint |
| Owned topological fingerprint. More... | |
| class | seams::Brine |
| Owned planar ice-front measurement. More... | |
| class | seams::System |
| One frame: coordinates, a cell, and the analyses that read them. More... | |
Namespaces | |
| namespace | seams |
| namespace | seams::detail |
Enumerations | |
| enum class | seams::Status : int { seams::Status::Ok = SEAMS_OK , seams::Status::Null = SEAMS_ERR_NULL , seams::Status::Range = SEAMS_ERR_RANGE , seams::Status::Cell = SEAMS_ERR_BOX , seams::Status::Argument = SEAMS_ERR_ARG , seams::Status::State = SEAMS_ERR_STATE , seams::Status::Memory = SEAMS_ERR_NOMEM , seams::Status::Internal = SEAMS_ERR_INTERNAL } |
| Status codes. More... | |
| enum class | seams::Graph : int { seams::Graph::Cutoff = SEAMS_GRAPH_CUTOFF , seams::Graph::Mutual = SEAMS_GRAPH_MUTUAL , seams::Graph::Seeded = SEAMS_GRAPH_SEEDED } |
| Neighbour graph. More... | |
| enum class | seams::ChillRule : int { seams::ChillRule::Published = SEAMS_CHILL_PUBLISHED , seams::ChillRule::Ovito = SEAMS_CHILL_OVITO } |
| CHILL+ threshold table. More... | |
| enum class | seams::Label : int { seams::Label::Cubic = SEAMS_LABEL_CUBIC , seams::Label::Hexagonal = SEAMS_LABEL_HEXAGONAL , seams::Label::Water = SEAMS_LABEL_WATER , seams::Label::Interfacial = SEAMS_LABEL_INTERFACIAL , seams::Label::Clathrate = SEAMS_LABEL_CLATHRATE , seams::Label::Interclathrate = SEAMS_LABEL_INTERCLATHRATE , seams::Label::Unclassified = SEAMS_LABEL_UNCLASSIFIED , seams::Label::Recubic = SEAMS_LABEL_RECUBIC , seams::Label::Rehex = SEAMS_LABEL_REHEX } |
| CHILL and CHILL+ atom label. More... | |
| enum class | seams::RingSymmetry : int { seams::RingSymmetry::Unclassified = SEAMS_RING_UNCLASSIFIED , seams::RingSymmetry::Ddc = SEAMS_RING_DDC , seams::RingSymmetry::HcBasal = SEAMS_RING_HC_BASAL , seams::RingSymmetry::HcPrismatic = SEAMS_RING_HC_PRISMATIC , seams::RingSymmetry::BothBasal = SEAMS_RING_BOTH_BASAL , seams::RingSymmetry::BothPrismatic = SEAMS_RING_BOTH_PRISMATIC , seams::RingSymmetry::Prism = SEAMS_RING_PRISM , seams::RingSymmetry::DeformedPrism = SEAMS_RING_DEFORMED_PRISM , seams::RingSymmetry::MixedPrism = SEAMS_RING_MIXED_PRISM , seams::RingSymmetry::Pentagon = SEAMS_RING_PENTAGON , seams::RingSymmetry::Hexagon = SEAMS_RING_HEXAGON , seams::RingSymmetry::Other = SEAMS_RING_OTHER } |
| Primitive-ring symmetry class. More... | |
| enum class | seams::CageLabel : int { seams::CageLabel::Water = SEAMS_CAGE_WATER , seams::CageLabel::Hex = SEAMS_CAGE_HEX , seams::CageLabel::Cubic = SEAMS_CAGE_CUBIC , seams::CageLabel::Both = SEAMS_CAGE_BOTH } |
| Per-atom cage membership. More... | |
| enum class | seams::SiteKind : int { seams::SiteKind::Unspecified = SEAMS_SITE_UNSPECIFIED , seams::SiteKind::Cation = SEAMS_SITE_CATION , seams::SiteKind::Anion = SEAMS_SITE_ANION , seams::SiteKind::Tail = SEAMS_SITE_TAIL , seams::SiteKind::DonorH = SEAMS_SITE_DONOR_H , seams::SiteKind::Acceptor = SEAMS_SITE_ACCEPTOR , seams::SiteKind::Polar = SEAMS_SITE_POLAR , seams::SiteKind::Apolar = SEAMS_SITE_APOLAR , seams::SiteKind::WaterO = SEAMS_SITE_WATER_O , seams::SiteKind::WaterH = SEAMS_SITE_WATER_H , seams::SiteKind::Solvent = SEAMS_SITE_SOLVENT } |
| Site-table kind. More... | |
| enum class | seams::Axis : int { seams::Axis::X = 0 , seams::Axis::Y = 1 , seams::Axis::Z = 2 } |
| Cell axis. More... | |
| enum class | seams::DomainSubset : int { seams::DomainSubset::Apolar = 0 , seams::DomainSubset::Polar = 1 } |
| Domain subset. More... | |
Functions | |
| void | seams::detail::check (int status, const void *handle) |
| template<class Call> | |
| std::string | seams::detail::copy_text (Call call, const void *handle) |
| std::string | seams::version () |
| Library version text, for example 2.14.0. | |
| int | seams::abi () |
| ABI number compiled into this library. | |
| void | seams::set_num_threads (int n) |
| Set the OpenMP width for the next call. | |
| int | seams::num_threads () |
| OpenMP width the next call will use. | |
| std::size_t | seams::nframes (std::string_view path) |
| Count frames in a trajectory path. | |
| std::string_view | seams::label_name (Label label) |
| Short name of a CHILL+ label. | |
| std::string_view | seams::ring_symmetry_name (RingSymmetry symmetry) |
| Short name of a ring-symmetry code. | |
Idiomatic C++ for the d-SEAMS C API.
One header, no library of its own. It includes seams.h and links libseams. Handles are move-only and free themselves. A status other than success throws seams::Error, and the message is seams_handle_error. Coordinates and cutoffs are Angstrom. A cell is nine LAMMPS numbers: origin, edge lengths, then the tilts xy, xz, yz.
Analyses with several knobs take an options aggregate. Results come back as values, std::vector, or std::string. The caller does not pass output buffers.
Definition in file seams.hpp.