C++¶
include/seams.hpp is the native C++ API: move-only handles in namespace seams, with results returned by value. C++ is the narrative for that header. This page lists the public types and methods, and the seams.h functions each method calls.
Native API¶
Generated from the sources named below. A name on this page is a public call in that language.
seams::BondOptions¶
struct BondOptions
Knobs for a hydrogen-bond count.
seams::Brine¶
class Brine : public detail::Handle<seams_brine, seams_brine_destroy>
Owned planar ice-front measurement.
seams::Brine::fronts¶
[[nodiscard]] BrineFronts fronts() const
seams::Brine::pockets¶
[[nodiscard]] Pockets pockets() const
seams::Brine::profile¶
[[nodiscard]] BrineProfile profile() const
seams::Brine::rejection¶
[[nodiscard]] Rejection rejection() const
seams::BrineFronts¶
struct BrineFronts
The two planar crossings of an ice slab.
seams::BrineOptions¶
struct BrineOptions
Knobs for a planar ice front.
seams::BrineProfile¶
struct BrineProfile
Concentration profile along the brine axis.
seams::CageCounts¶
struct CageCounts
Disjoint cage populations.
seams::CageOptions¶
struct CageOptions
Knobs for hexagonal and double-diamond cages.
seams::Cages¶
class Cages : public detail::Handle<seams_cage_set, seams_cages_destroy>
Owned hexagonal and double-diamond membership.
seams::Cages::counts¶
[[nodiscard]] CageCounts counts() const
Disjoint population counts.
seams::Cages::labels¶
[[nodiscard]] std::vector<int> labels(std::size_t n_atoms) const
One cage code per atom.
seams::ChillOptions¶
struct ChillOptions
Knobs for CHILL and CHILL+.
seams::ChordlessCycles¶
struct ChordlessCycles
Chordless cycles of one length.
seams::ChordlessCycles::count¶
[[nodiscard]] std::size_t count() const
seams::ChordlessCycles::cycle¶
[[nodiscard]] std::vector<int> cycle(std::size_t index) const
seams::Classification¶
struct Classification
CHILL or CHILL+ labels and the nine population counts.
seams::Contacts¶
struct Contacts
Mutual nearest unlike contacts of a site table.
seams::DensityOptions¶
struct DensityOptions
Knobs for the axial number density.
seams::DensityProfile¶
struct DensityProfile
Number density along one cell axis.
seams::Distribution¶
struct Distribution
Partial radial distribution.
seams::DistributionOptions¶
struct DistributionOptions
Knobs for a partial RDF, its running coordination, or the integral.
seams::DomainOptions¶
struct DomainOptions
Knobs for a domain search.
seams::DomainReport¶
struct DomainReport
Largest polar or apolar domain.
seams::Error¶
class Error : public std::runtime_error
Failure from the C API, or from a rejected argument.
seams::Error::Error¶
Error(int status, std::string message) : std::runtime_error(std::move(message)), code_(status)
Build an error from a status and a message.
seams::Error::code¶
[[nodiscard]] int code() const noexcept
Status integer. Same values as `seams_status`.
seams::Error::status¶
[[nodiscard]] Status status() const noexcept
Status as the `Status` enumeration when the code is known.
seams::Fingerprint¶
class Fingerprint : public detail::Handle<seams_topo, seams_fingerprint_destroy>
Owned topological fingerprint.
seams::Fingerprint::atom¶
[[nodiscard]] std::string atom(int index) const
Local key of one atom.
seams::Fingerprint::key¶
[[nodiscard]] std::string key() const
Frame fingerprint text.
seams::Fingerprint::rings¶
[[nodiscard]] std::vector<int> rings() const
Primitive-ring census stored on the fingerprint.
seams::FingerprintOptions¶
struct FingerprintOptions
Knobs for a topological fingerprint.
seams::KnnOptions¶
struct KnnOptions
Knobs for a k-nearest neighbour list.
seams::NeighbourOptions¶
struct NeighbourOptions
Knobs for a neighbour list.
seams::Neighbours¶
class Neighbours : public detail::Handle<seams_neighbours, seams_neighbours_destroy>
Owned neighbour list.
seams::Neighbours::chordless¶
[[nodiscard]] ChordlessCycles chordless(int size) const
Chordless cycles of one length on this graph.
seams::Neighbours::degrees¶
[[nodiscard]] std::vector<int> degrees() const
Degree of each atom.
seams::Neighbours::nnz¶
[[nodiscard]] std::size_t nnz() const
Number of neighbour pairs, omitting self.
seams::Neighbours::pairs¶
[[nodiscard]] std::vector<std::pair<int, int>> pairs() const
Directed pairs `(atom, neighbour)`.
seams::OrderOptions¶
struct OrderOptions
Knobs for q_l on a named graph.
seams::Pockets¶
struct Pockets
Brine pockets trapped in the ice.
seams::PrismCensus¶
struct PrismCensus
Perfect and imperfect prism counts by ring size.
seams::PrismOptions¶
struct PrismOptions
Knobs for prism stacks.
seams::Q4Q6¶
struct Q4Q6
Local q4 and q6 on the cutoff shell.
seams::Q6Bar¶
struct Q6Bar
Lechner-Dellago q6-bar and the ice count above a cut.
seams::Q6BarOptions¶
struct Q6BarOptions
Knobs for the q6-bar ice summary.
seams::Rejection¶
struct Rejection
Molal rejection coefficient.
seams::RingOptions¶
struct RingOptions
Knobs for primitive rings.
seams::Rings¶
class Rings : public detail::Handle<seams_rings, seams_rings_destroy>
Owned primitive-ring set.
seams::Rings::fraction¶
[[nodiscard]] double fraction(int ring_size) const
Fraction of atoms that sit on a ring of one size.
seams::Rings::histogram¶
[[nodiscard]] std::vector<int> histogram(int up_to) const
Histogram of ring size.
seams::Rings::iterator¶
iterator(const Rings *owner, int index) : owner_(owner), index_(index)
seams::Rings::size¶
[[nodiscard]] int size() const
Number of primitive rings.
seams::Rings::vertices¶
[[nodiscard]] std::vector<int> vertices(int index) const
Atom indices of one ring.
seams::RunningCoordination¶
struct RunningCoordination
Running coordination number along a partial RDF.
seams::SheetOptions¶
struct SheetOptions
Knobs for a monolayer ring histogram.
seams::SignatureMatch¶
struct SignatureMatch
Closed cages whose ring census matches a signature.
seams::SignatureOptions¶
struct SignatureOptions
Knobs for a signature cage census.
seams::Steinhardt¶
struct Steinhardt
Local Steinhardt parameter, and the average when it was asked for.
seams::SteinhardtOptions¶
struct SteinhardtOptions
Knobs for a local Steinhardt parameter on the cutoff shell.
seams::System¶
class System : public detail::Handle<seams_system, seams_system_destroy>
One frame: coordinates, a cell, and the analyses that read them.
seams::System::System¶
System() : detail::Handle<seams_system, seams_system_destroy>(seams_system_create())
Allocate an empty frame.
seams::System::brine¶
[[nodiscard]] Brine brine(std::span<const int> ice, const BrineOptions &options)
Planar ice front from an ice assignment.
seams::System::cages¶
[[nodiscard]] Cages cages(const CageOptions &options)
seams::System::chill¶
std::pair<std::vector<int>, std::vector<int>> chill(double cutoff, int type, int graph, int rule)
seams::System::chill_plus¶
[[nodiscard]] Classification chill_plus(const ChillOptions &options)
seams::System::contact_pairs¶
[[nodiscard]] Contacts contact_pairs(std::string_view spec)
seams::System::coordination¶
[[nodiscard]] double coordination(const DistributionOptions &options)
seams::System::count¶
[[nodiscard]] int count() const
Number of points in the frame.
seams::System::density¶
[[nodiscard]] DensityProfile density(const DensityOptions &options)
seams::System::domains¶
[[nodiscard]] DomainReport domains(const DomainOptions &options)
seams::System::fingerprint¶
[[nodiscard]] Fingerprint fingerprint(const FingerprintOptions &options)
seams::System::hbonds¶
[[nodiscard]] int hbonds(const BondOptions &options)
seams::System::knn¶
[[nodiscard]] Neighbours knn(const KnnOptions &options)
seams::System::monolayer¶
[[nodiscard]] std::vector<int> monolayer(const SheetOptions &options)
Primitive-ring histogram of a monolayer.
seams::System::neighbour_degree¶
[[nodiscard]] std::vector<int> neighbour_degree(double cutoff, int species = 0)
Degree of each atom on the cutoff graph.
seams::System::neighbours¶
[[nodiscard]] Neighbours neighbours(const NeighbourOptions &options)
seams::System::prisms¶
[[nodiscard]] PrismCensus prisms(const PrismOptions &options)
seams::System::q4q6¶
[[nodiscard]] Q4Q6 q4q6(double cutoff, int species = 0)
seams::System::q6bar¶
[[nodiscard]] Q6Bar q6bar(const Q6BarOptions &options)
seams::System::ql¶
[[nodiscard]] Steinhardt ql(const OrderOptions &options)
seams::System::rdf¶
[[nodiscard]] Distribution rdf(const DistributionOptions &options)
seams::System::read¶
void read(std::string_view path, int frame, int type_filter)
Read one frame from a trajectory path.
seams::System::rings¶
[[nodiscard]] Rings rings(const RingOptions &options)
seams::System::rings_chordless¶
[[nodiscard]] ChordlessCycles rings_chordless(const NeighbourOptions &options, int size)
Chordless cycles of one length on a neighbour graph.
seams::System::running_cn¶
[[nodiscard]] RunningCoordination running_cn(const DistributionOptions &options)
seams::System::set_ortho¶
void set_ortho(std::span<const double> xyz, double lx, double ly, double lz)
Store points in an orthorhombic cell whose origin is zero.
seams::System::signature_cages¶
[[nodiscard]] SignatureMatch signature_cages(const SignatureOptions &options)
seams::System::site_table¶
[[nodiscard]] std::vector<int> site_table(std::string_view spec)
Per-atom site kind.
seams::System::steinhardt¶
std::pair<std::vector<double>, std::vector<double>> steinhardt(double cutoff, int order, bool average)
seams::System::symmetry¶
[[nodiscard]] std::vector<int> symmetry(double shell_rmsd)
Per-atom ice-shell label.
seams::abi¶
[[nodiscard]] inline int abi()
ABI number compiled into this library.
seams::check¶
inline void check(int status, const void *handle) { if (status == SEAMS_OK)
seams::label_name¶
[[nodiscard]] inline std::string_view label_name(Label label)
Short name of a CHILL+ label.
seams::nframes¶
[[nodiscard]] inline std::size_t nframes(std::string_view path)
Count frames in a trajectory path.
seams::num_threads¶
[[nodiscard]] inline int num_threads()
OpenMP width the next call will use.
seams::ring_symmetry_name¶
[[nodiscard]] inline std::string_view ring_symmetry_name(RingSymmetry symmetry)
Short name of a ring-symmetry code.
seams::set_num_threads¶
inline void set_num_threads(int n)
Set the OpenMP width for the next call.
seams::version¶
[[nodiscard]] inline std::string version()
Library version text, for example `2.14.0`.
C API¶
Each native call and the seams.h or seams_lang.h function it uses. The C column is the stable ABI.
Native |
C |
|---|---|
|
no direct C call |
|
|
|
|
|
|
|
|
|
|
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
|
|
|
|
|
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
|
|
|
|
|
|
|
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
|
|
|
|
|
|
|
|
|
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
|
|
|
|
|
|
no direct C call |
|
|
|
|
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
no direct C call |
|
|
|
no direct C call |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
no direct C call |
|
|
|
|
|
|
|
|
|
|
|
no direct C call |
|
|
|
|
|
|
|
|
|
|
|
|