.. index:: pair: namespace; water .. _doxid-namespacewater: namespace water =============== .. toctree:: :hidden: enum_water_MolMode.rst struct_water_IonReport.rst struct_water_IonSite.rst struct_water_Request.rst struct_water_Selection.rst Overview ~~~~~~~~ Water-oxygen selection for a mixed frame. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block namespace water { // enums enum :ref:`MolMode`; // structs struct :ref:`IonReport`; struct :ref:`IonSite`; struct :ref:`Request`; struct :ref:`Selection`; // global functions bool :target:`hasMultiAtomMolecule`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud); :ref:`Selection` :target:`selectOxygens`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, const :ref:`Request`& request); :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> :target:`subsetCloud`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, const :ref:`Selection`& selection); :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> :ref:`keepHistoricalOxygen`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud); std::vector<:ref:`IonSite`> :target:`collectIons`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud, const :ref:`Selection`& selection); :ref:`IonReport` :ref:`ionFront`(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& oxygen, const std::vector<:ref:`IonSite`>& ions); bool :target:`iceLabel`(:ref:`molSys::atom_state_type` label); } // namespace water .. _details-namespacewater: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Water-oxygen selection for a mixed frame. Neighbours, CHILL, CHILL+, rings and cages run on the oxygen atoms. Ions and hydrogens stay out of that graph. A requested type or molecule that is not in the frame is an error, as is a selection that keeps nothing. The messages are the strings the tests match. Global Functions ---------------- .. index:: pair: function; keepHistoricalOxygen .. _doxid-namespacewater_1a96d8a115335adeddf742b5009a4f3798: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double> keepHistoricalOxygen(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& cloud) Historical dump guess: type 2 when any atom has it, otherwise type 1. A miss leaves an empty cloud and keeps the box. .. index:: pair: function; ionFront .. _doxid-namespacewater_1a39efb9161b577ad0caf0a174d06d4799: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`IonReport` ionFront(const :ref:`molSys::PointCloud`<:ref:`molSys::Point`, double>& oxygen, const std::vector<:ref:`IonSite`>& ions) oxygen is the labeled water subset. front is the nearest ice oxygen, in the box units, or -1 when no ion sits next to ice.