.. index:: pair: namespace; nucleation .. _doxid-namespacenucleation: namespace nucleation ==================== .. toctree:: :hidden: enum_nucleation_CommittorFate.rst struct_nucleation_Ascent.rst struct_nucleation_CommittorCall.rst struct_nucleation_FrameRecord.rst struct_nucleation_GrowBasin.rst struct_nucleation_HalfRise.rst struct_nucleation_Lead.rst struct_nucleation_Shift.rst Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block namespace nucleation { // enums enum :ref:`CommittorFate`; // structs struct :ref:`Ascent`; struct :ref:`CommittorCall`; struct :ref:`FrameRecord`; struct :ref:`GrowBasin`; struct :ref:`HalfRise`; struct :ref:`Lead`; struct :ref:`Shift`; // global variables double :ref:`kCutoffA` = 3.5; int :ref:`kRingDepth` = 7; double :ref:`kQ6BarIceCut` = 0.36; double :ref:`kQ6SolidCutoffA` = 3.2; double :target:`kQ6SolidCut` = 0.5; // global functions std::vector :ref:`q6DotScore`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, const std::vector& offsets, const std::vector& cols); :ref:`FrameRecord` :ref:`analyzeFrame`(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, double cutoff, int ringDepth, int typeI, double q6Cut, int frame); double :ref:`stackFraction`(int cubic, int hexagonal); :ref:`Ascent` :target:`finalAscent`(const std::vector& series); :ref:`GrowBasin` :target:`growBasin`(const std::vector& series); :ref:`CommittorCall` :target:`committorOf`(const std::vector& series, int molecules); :ref:`HalfRise` :target:`halfRise`(const std::vector& series); :ref:`Lead` :ref:`ringLead`(const std::vector& ringFraction, const std::vector& iceFraction); :ref:`Shift` :ref:`definitionShift`(int sizeA, int frameA, int sizeB, int frameB); } // namespace nucleation .. _details-namespacenucleation: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Variables ---------------- .. index:: pair: variable; kCutoffA .. _doxid-namespacenucleation_1a3bc244ef7bf44479500a58d1387a0373: .. ref-code-block:: cpp :class: doxyrest-title-code-block double kCutoffA = 3.5 Published CHILL+ cutoff. Not a fitted parameter. .. index:: pair: variable; kRingDepth .. _doxid-namespacenucleation_1a64fc5d22d7f2818a0d819ee1a947f087: .. ref-code-block:: cpp :class: doxyrest-title-code-block int kRingDepth = 7 Primitive rings through this size. Depth 7 is the adjacency-row search. .. index:: pair: variable; kQ6BarIceCut .. _doxid-namespacenucleation_1af2f1477e5e5f99cbe98f4ab5b95091ae: .. ref-code-block:: cpp :class: doxyrest-title-code-block double kQ6BarIceCut = 0.36 Lechner-Dellago :math:`\bar{q}_6` above this value is an ice-like environment. Set from the gap between a perfect mW Ic crystal and a liquid reference, not from the nucleation trajectory. .. index:: pair: variable; kQ6SolidCutoffA .. _doxid-namespacenucleation_1ae22c8a1c01ef593e140430321e5e0408: .. ref-code-block:: cpp :class: doxyrest-title-code-block double kQ6SolidCutoffA = 3.2 q6 solid criterion of ten Wolde, Ruiz-Montero and Frenkel, J. Chem. Phys. 104, 9932 (1996), in the mW form of Haji-Akbari and Debenedetti, PNAS 112(34) (2015), doi:10.1073/pnas.1509267112, SI Table S1: neighbours within 3.2 A (the first minimum of the mW g(r)), and a molecule is solid when the mean over its neighbours of the normalised q6(i).q6\*(j) exceeds 0.5. The solid cluster is the largest component of solid molecules on the same 3.2 A graph. The Reinhardt chain exclusion is not applied. Global Functions ---------------- .. index:: pair: function; q6DotScore .. _doxid-namespacenucleation_1a047d583af8b7c503376f262d63dc9ade: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::vector q6DotScore(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, const std::vector& offsets, const std::vector& cols) Per-molecule ten Wolde q6 score: the mean over neighbours within cutoff of ``Re q6(i).q6*(j) / (|q6(i)| |q6(j)|)``. A molecule without neighbours scores 0. The box is orthorhombic. .. index:: pair: function; analyzeFrame .. _doxid-namespacenucleation_1a64e04b196b84bc47a828f2875823e5b8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`FrameRecord` analyzeFrame(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, double cutoff, int ringDepth, int typeI, double q6Cut, int frame) Label one frame. Leaves iceType as the published CHILL+ label. typeI selects the molecules passed to q6-bar. q6Cut is the ice cut on :math:`\bar{q}_6`. .. index:: pair: function; stackFraction .. _doxid-namespacenucleation_1a536f149502c3e4e03088aa2287700cb2: .. ref-code-block:: cpp :class: doxyrest-title-code-block double stackFraction(int cubic, int hexagonal) Cubic / (cubic + hexagonal). Quiet NaN when the denominator is 0. .. index:: pair: function; ringLead .. _doxid-namespacenucleation_1a24db8d7542dd5836a3e8026d591accd9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Lead` ringLead(const std::vector& ringFraction, const std::vector& iceFraction) Ring signal is n6 / (n5 + n6). Ice signal is the ice-like count divided by the molecule count. Both are intensive. .. index:: pair: function; definitionShift .. _doxid-namespacenucleation_1a607b48d72ffc919887fa6243d2eb4e9d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Shift` definitionShift(int sizeA, int frameA, int sizeB, int frameB) How far definition b moves the onset size and the onset frame relative to definition a. dSize = b.size - a.size at each onset.