.. index:: pair: namespace; iface .. _doxid-namespaceiface: namespace iface =============== .. toctree:: :hidden: enum_iface_Cause.rst enum_iface_Kind.rst struct_iface_Bin.rst struct_iface_BootstrapInterval.rst struct_iface_Front.rst struct_iface_Growth.rst struct_iface_GrowthFrame.rst struct_iface_Profile.rst struct_iface_Study.rst struct_iface_WillardChandler.rst Overview ~~~~~~~~ .. ref-code-block:: cpp :class: doxyrest-overview-code-block namespace iface { // enums enum :ref:`Cause`; enum :ref:`Kind`; // structs struct :ref:`Bin`; struct :ref:`BootstrapInterval`; struct :ref:`Front`; struct :ref:`Growth`; struct :ref:`GrowthFrame`; struct :ref:`Profile`; struct :ref:`Study`; struct :ref:`WillardChandler`; // global functions :ref:`Study` :ref:`studyCloud`(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> cloud, double cutoff = 3.5, double binWidth = 1.0, bool census = true); :ref:`Study` :target:`studyDump`(const std::string& path, int frame, double cutoff = 3.5, double binWidth = 1.0, bool census = true); std::string :target:`formatStudy`(const :ref:`Study`& study, const std::string& tag); double :ref:`slope`(const std::vector& x, const std::vector& y); :ref:`Growth` :ref:`studyTrajectory`(const std::string& path, double dumpEveryPs, double cutoff = 3.5); std::string :target:`formatGrowth`(const :ref:`Growth`& growth); std::string :ref:`formatQ6Growth`(const std::string& path, double dumpEveryPs, double cutoff = 3.5); :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> :ref:`nanotube`(int ring, int stacks, double bond = 2.75); :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> :target:`honeycombSheet`(int nx, int ny, int layers, double bond = 2.75); double :ref:`gaussianStepWidth`(double xi); :ref:`BootstrapInterval` :ref:`bootstrapMean`(const std::vector& samples, int nDraw, std::uint64_t seed); :ref:`BootstrapInterval` :ref:`pairedDifference`(const std::vector& a, const std::vector& b, int nDraw, std::uint64_t seed); :ref:`WillardChandler` :ref:`willardChandler`(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> cloud, double xi = 2.4); std::string :target:`formatWillardChandler`(const :ref:`WillardChandler`& surface); } // namespace iface .. _details-namespaceiface: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Global Functions ---------------- .. index:: pair: function; studyCloud .. _doxid-namespaceiface_1ae766328e3e793278b61ae939e2cc2dfe: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Study` studyCloud(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> cloud, double cutoff = 3.5, double binWidth = 1.0, bool census = true) Both rules, the ring census, and the interface or nucleus profile. Cutoff and bond thresholds stay at the published values. census false skips rings, sheets, diamond, CNA, q6 and the template. The CHILL+ labels and the thickness profile are unchanged. .. index:: pair: function; slope .. _doxid-namespaceiface_1a7615303594a4624586db8fc7dad682d0: .. ref-code-block:: cpp :class: doxyrest-title-code-block double slope(const std::vector& x, const std::vector& y) Ordinary least squares slope. Empty or a single point returns 0. .. index:: pair: function; studyTrajectory .. _doxid-namespaceiface_1a4c169525df7e2f69700c7116bf18b707: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`Growth` studyTrajectory(const std::string& path, double dumpEveryPs, double cutoff = 3.5) Every frame of a dump. time of frame i is (i - 1) \* dumpEveryPs. .. index:: pair: function; formatQ6Growth .. _doxid-namespaceiface_1acc0c4800681d1d5d1397be73a0cf9f77: .. ref-code-block:: cpp :class: doxyrest-title-code-block std::string formatQ6Growth(const std::string& path, double dumpEveryPs, double cutoff = 3.5) Lechner-Dellago q6 on the 3.5 A shell, the counting rule in Espinosa, Navarro, Sanz, Valeriani and Vega, J. Chem. Phys. 145, 211922 (2016), page 211922-3. The threshold is not fitted. The report is the fraction of molecules at or above each listed q6bar and local q6, plus the frame-1 histogram of the ice core and the liquid core. .. index:: pair: function; nanotube .. _doxid-namespaceiface_1a3fa4d8c0d6ee39ffdbbfdfaa4c64b0f4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> nanotube(int ring, int stacks, double bond = 2.75) Ideal oxygen frameworks at a nearest-neighbour distance of ``:ref:`bond ```. The box is orthorhombic and large enough that a 3.5 A shell does not see a lateral image. .. index:: pair: function; gaussianStepWidth .. _doxid-namespaceiface_1ac3554da1361c67160b4d59db9e1034e1: .. ref-code-block:: cpp :class: doxyrest-title-code-block double gaussianStepWidth(double xi) 10-90 width of a step smoothed by a Gaussian of standard deviation xi. The profile is the normal cdf, so the width is 2 \* 1.2815515655446004 \* xi. .. index:: pair: function; bootstrapMean .. _doxid-namespaceiface_1a0665e3f3b47a112af0e9543fd68f0d95: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`BootstrapInterval` bootstrapMean(const std::vector& samples, int nDraw, std::uint64_t seed) Percentile bootstrap of the mean. nDraw samples with replacement. .. index:: pair: function; pairedDifference .. _doxid-namespaceiface_1a88cfd68ef2f533bc67e97ecb489f975d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`BootstrapInterval` pairedDifference(const std::vector& a, const std::vector& b, int nDraw, std::uint64_t seed) Mean of a[i] - b[i], resampled by shared index. .. index:: pair: function; willardChandler .. _doxid-namespaceiface_1a05f59884d0d3896c70075a635609406e: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`WillardChandler` willardChandler(:ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> cloud, double xi = 2.4) Instantaneous interface of Willard and Chandler, J. Phys. Chem. B 114, 1954 (2010). xi is their Gaussian width. The surface is the set of rays from the crystal center of mass on which the coarse density crosses the midpoint of the core and the outer liquid.