.. index:: pair: class; seams::System .. _doxid-classseams_1_1_system: class seams::System =================== .. toctree:: :hidden: Overview ~~~~~~~~ One frame: coordinates, a cell, and the analyses that read them. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include class System: public :ref:`seams::detail::Handle` { public: // construction :ref:`System`(); // methods void :ref:`set_ortho`(std::span xyz, double lx, double ly, double lz); void :ref:`set_ortho`(std::span xyz, std::span origin, std::span lengths, std::span types = {}, std::span ids = {}); void :ref:`set_frame`(std::span xyz, std::span box9, std::span types = {}, std::span ids = {}); std::pair, std::vector> :target:`chill`(double cutoff, int type, int graph, int rule); std::pair, std::vector> :target:`steinhardt`(double cutoff, int order, bool average); void :ref:`read`(std::string_view path, int frame, int type_filter); int :ref:`count`() const; :ref:`Classification` :ref:`chill`(const :ref:`ChillOptions`& options); :ref:`Classification` :ref:`chill_plus`(const :ref:`ChillOptions`& options); :ref:`Steinhardt` :ref:`steinhardt`(const :ref:`SteinhardtOptions`& options); :ref:`Steinhardt` :ref:`ql`(const :ref:`OrderOptions`& options); :ref:`Q4Q6` :ref:`q4q6`(double cutoff, int species = 0); :ref:`Q6Bar` :ref:`q6bar`(const :ref:`Q6BarOptions`& options); :ref:`Neighbours` :ref:`neighbours`(const :ref:`NeighbourOptions`& options); :ref:`ChordlessCycles` :ref:`rings_chordless`(const :ref:`NeighbourOptions`& options, int size); :ref:`Neighbours` :ref:`knn`(const :ref:`KnnOptions`& options); std::vector :ref:`neighbour_degree`(double cutoff, int species = 0); :ref:`Rings` :ref:`rings`(const :ref:`RingOptions`& options); :ref:`Cages` :ref:`cages`(const :ref:`CageOptions`& options); :ref:`SignatureMatch` :ref:`signature_cages`(const :ref:`SignatureOptions`& options); :ref:`Distribution` :ref:`rdf`(const :ref:`DistributionOptions`& options); :ref:`RunningCoordination` :ref:`running_cn`(const :ref:`DistributionOptions`& options); double :ref:`coordination`(const :ref:`DistributionOptions`& options); int :ref:`hbonds`(const :ref:`BondOptions`& options); :ref:`DensityProfile` :ref:`density`(const :ref:`DensityOptions`& options); :ref:`Fingerprint` :ref:`fingerprint`(const :ref:`FingerprintOptions`& options); :ref:`Contacts` :ref:`contact_pairs`(std::string_view spec); :ref:`DomainReport` :ref:`domains`(const :ref:`DomainOptions`& options); :ref:`PrismCensus` :ref:`prisms`(const :ref:`PrismOptions`& options); std::vector :ref:`monolayer`(const :ref:`SheetOptions`& options); std::vector :ref:`site_table`(std::string_view spec); std::vector :ref:`symmetry`(double shell_rmsd); :ref:`Brine` :ref:`brine`(std::span ice, const :ref:`BrineOptions`& options); }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // methods :ref:`Handle`& :ref:`operator=`(const :ref:`Handle`&); :ref:`Handle`& :ref:`operator=`(:ref:`Handle`&& other); :ref:`operator bool`() const; .. _details-classseams_1_1_system: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ 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 :ref:`Steinhardt ` scratch inside the library is process-global, so two frames must not run ``:ref:`steinhardt ```, ``:ref:`ql ```, ``:ref:`q4q6 ```, or ``:ref:`q6bar ``` at the same time. ``:ref:`set_num_threads ``` is also process-global. Construction ------------ .. index:: pair: function; System .. _doxid-classseams_1_1_system_1a8f6a67e67ca298b5dfe9af6483ab62e5: .. ref-code-block:: cpp :class: doxyrest-title-code-block System() Allocate an empty frame. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - Error - with status ``Memory`` when the allocation fails. Methods ------- .. index:: pair: function; set_ortho .. _doxid-classseams_1_1_system_1ad4d74603f143fbac7bdb86497e762627: .. ref-code-block:: cpp :class: doxyrest-title-code-block void set_ortho(std::span xyz, double lx, double ly, double lz) Store points in an orthorhombic cell whose origin is zero. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - 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. .. index:: pair: function; set_ortho .. _doxid-classseams_1_1_system_1a350bd6a7659bf0d77077e81fd97ad966: .. ref-code-block:: cpp :class: doxyrest-title-code-block void set_ortho(std::span xyz, std::span origin, std::span lengths, std::span types = {}, std::span ids = {}) Store points in an orthorhombic cell. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - 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. .. index:: pair: function; set_frame .. _doxid-classseams_1_1_system_1ae61de30cae54c423c079e9b1ec02a972: .. ref-code-block:: cpp :class: doxyrest-title-code-block void set_frame(std::span xyz, std::span box9, std::span types = {}, std::span ids = {}) Store points and a general nine-number cell. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - 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. .. index:: pair: function; read .. _doxid-classseams_1_1_system_1a9d94d3c981d95d18f61b404c5b362a46: .. ref-code-block:: cpp :class: doxyrest-title-code-block void read(std::string_view path, int frame, int type_filter) Read one frame from a trajectory path. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - path - XYZ, CON, chemfiles, or a LAMMPS dump. * - frame - 1-based frame index. * - type_filter - Species to keep. Negative keeps every atom. .. index:: pair: function; count .. _doxid-classseams_1_1_system_1a8c9e0e865138a0eca7d35de5cc9bdd2c: .. ref-code-block:: cpp :class: doxyrest-title-code-block int count() const Number of points in the frame. .. rubric:: Returns: The atom count. An empty frame returns 0. .. index:: pair: function; chill .. _doxid-classseams_1_1_system_1ae4a6555fb25a75db01c122e65f3a2a30: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Classification` chill(const :ref:`ChillOptions`& options) Original CHILL labels and nine population counts. .. index:: pair: function; chill_plus .. _doxid-classseams_1_1_system_1a211926876b948d826f42520fb823b5c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Classification` chill_plus(const :ref:`ChillOptions`& options) CHILL+ labels and nine population counts. .. index:: pair: function; steinhardt .. _doxid-classseams_1_1_system_1aa8841ba03f0a37fe4238bd15e26756b2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Steinhardt` steinhardt(const :ref:`SteinhardtOptions`& options) Local q_l on the cutoff shell. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - options - Cutoff, species, degree, and whether to average. .. index:: pair: function; ql .. _doxid-classseams_1_1_system_1a6327a361caa00807236bb9a6b06baf59: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Steinhardt` ql(const :ref:`OrderOptions`& options) Local q_l on a named graph. .. index:: pair: function; q4q6 .. _doxid-classseams_1_1_system_1a70a06e349cc0b7d0e40548688bdd6c78: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Q4Q6` q4q6(double cutoff, int species = 0) Local q4 and q6 on the cutoff shell. .. index:: pair: function; q6bar .. _doxid-classseams_1_1_system_1a2a2161e5b3ef753e7a30770b5ae8f9ad: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Q6Bar` q6bar(const :ref:`Q6BarOptions`& options) q6-bar, its mean and median, and the ice count above the cut. .. index:: pair: function; neighbours .. _doxid-classseams_1_1_system_1a4d801a1b3769b60e6755996f259524b5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Neighbours` neighbours(const :ref:`NeighbourOptions`& options) Cutoff or mutual neighbour list. .. index:: pair: function; rings_chordless .. _doxid-classseams_1_1_system_1ad15949f9fb3f4b14731ab684a5a9a64d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`ChordlessCycles` rings_chordless(const :ref:`NeighbourOptions`& options, int size) Chordless cycles of one length on a neighbour graph. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - options - :ref:`Graph ` of the cycles. * - size - Cycle length, from 3 through 12. .. rubric:: Returns: :ref:`Neighbours::chordless ` on that graph. .. index:: pair: function; knn .. _doxid-classseams_1_1_system_1acf212e23e209901ccdab1e7db2e8b586: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Neighbours` knn(const :ref:`KnnOptions`& options) k-nearest neighbour list. .. index:: pair: function; neighbour_degree .. _doxid-classseams_1_1_system_1a34e5b40b8af54af8b82683cd18a0b27e: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector neighbour_degree(double cutoff, int species = 0) Degree of each atom on the cutoff graph. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - cutoff - Positive cutoff, Angstrom. * - species - Species filter. Zero keeps every atom. .. index:: pair: function; rings .. _doxid-classseams_1_1_system_1a0b8aec70940ac3656cdc8bdef4b54484: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Rings` rings(const :ref:`RingOptions`& options) Primitive rings up to a maximum size. .. index:: pair: function; cages .. _doxid-classseams_1_1_system_1ab2d09941bd77f2425f36bc10f9412a4d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Cages` cages(const :ref:`CageOptions`& options) Hexagonal and double-diamond cage membership. .. index:: pair: function; signature_cages .. _doxid-classseams_1_1_system_1a2725db4dfd10f187d428636af413c058: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`SignatureMatch` signature_cages(const :ref:`SignatureOptions`& options) Closed cages of one ring census. .. index:: pair: function; rdf .. _doxid-classseams_1_1_system_1a3d082e8faf1bba7d2c8a21b618ff6f29: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Distribution` rdf(const :ref:`DistributionOptions`& options) Partial radial distribution and the cell volume. .. index:: pair: function; running_cn .. _doxid-classseams_1_1_system_1a2aa713e72bbdca8cce25839ebdfd82dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`RunningCoordination` running_cn(const :ref:`DistributionOptions`& options) Running coordination number along the partial RDF. .. index:: pair: function; coordination .. _doxid-classseams_1_1_system_1a8915d6d040203915be8dbc2d1e5b9ec0: .. ref-code-block:: cpp :class: doxyrest-title-code-block double coordination(const :ref:`DistributionOptions`& options) Coordination number integrated to rmax. .. index:: pair: function; hbonds .. _doxid-classseams_1_1_system_1acff446749dbb4303e07bf1effe76619a: .. ref-code-block:: cpp :class: doxyrest-title-code-block int hbonds(const :ref:`BondOptions`& options) Hydrogen-bond count. .. index:: pair: function; density .. _doxid-classseams_1_1_system_1a5f59a8c3c4fed580c66a98e55f11df49: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`DensityProfile` density(const :ref:`DensityOptions`& options) Number density along one cell axis. .. index:: pair: function; fingerprint .. _doxid-classseams_1_1_system_1aa710b592870f05e7333b1b306831231a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Fingerprint` fingerprint(const :ref:`FingerprintOptions`& options) Topological fingerprint of the bonded graph. .. index:: pair: function; contact_pairs .. _doxid-classseams_1_1_system_1a7c4b898b89200fdc381e179ad4e0a0af: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Contacts` contact_pairs(std::string_view spec) Mutual nearest unlike contacts. ``spec`` is site-table text. .. index:: pair: function; domains .. _doxid-classseams_1_1_system_1ac5b0b9b6c2b68f42dafcb9faedf34b45: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`DomainReport` domains(const :ref:`DomainOptions`& options) Largest polar or apolar domain. .. index:: pair: function; prisms .. _doxid-classseams_1_1_system_1a4038d857de37f2df4e790e418c119b7c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`PrismCensus` prisms(const :ref:`PrismOptions`& options) Perfect and imperfect prism counts by ring size. .. index:: pair: function; monolayer .. _doxid-classseams_1_1_system_1ab46ee10bb9b1fe4f0ed2ef97727ac4d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector monolayer(const :ref:`SheetOptions`& options) Primitive-ring histogram of a monolayer. .. rubric:: Returns: ``counts[k]`` is the number of rings of size k. .. index:: pair: function; site_table .. _doxid-classseams_1_1_system_1a8d5f5b1be32204fe8cbb385b08bd5ea5: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector site_table(std::string_view spec) Per-atom site kind. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - spec - Site-table text, for example ``1=waterO``. .. rubric:: Returns: One kind code per atom. .. index:: pair: function; symmetry .. _doxid-classseams_1_1_system_1af7707ba5be76aa88e3f1e8e94210f61c: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector symmetry(double shell_rmsd) Per-atom ice-shell label. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - shell_rmsd - Positive residual ceiling, or a non-positive value for the library ceiling. .. rubric:: Returns: 0 ice Ih, 1 ice Ic, 2 stacking disorder, or -1 when the shell does not match. .. index:: pair: function; brine .. _doxid-classseams_1_1_system_1a9dbdf793c6bb177ea1c4d6289d1177aa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Brine` brine(std::span ice, const :ref:`BrineOptions`& options) Planar ice front from an ice assignment. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ice - Non-zero when the atom is ice. Length must equal ``:ref:`count() ```. * - options - Water species, ion species, bins, and axis.