seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
site.hpp File Reference

Per-atom site chemistry, separate from CHILL ice labels. More...

#include <mol_sys.hpp>
#include <array>
#include <string_view>
#include <unordered_map>
#include <vector>

Go to the source code of this file.

Classes

struct  site::Table
struct  site::IonEnvironment
struct  site::GuestOccupancy
 Guests read against enumerated cages. More...
struct  site::InsideTrace
struct  site::IceClusterIons
 Connected components of ice atoms on the water graph, and the ion count per component: each ion is assigned to the cluster of the nearest ice atom within cutoff. More...

Namespaces

namespace  site

Enumerations

enum class  site::Kind {
  site::unspecified , site::cationHead , site::anion , site::tail ,
  site::donorH , site::acceptor , site::polar , site::apolar ,
  site::waterO , site::waterH , site::solvent
}
enum class  site::Family {
  site::waterIce , site::ionicLiquid , site::moltenSalt , site::des ,
  site::electrolyte , site::confinedIL , site::confinedWater , site::networkFormer
}
enum class  site::IonState { site::liquid = 0 , site::front = 1 , site::ice = 2 }
 Ions read against a per-atom ice assignment. More...

Functions

std::vector< int > site::indicesOf (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const Table &table, Kind kind)
int site::lammpsTypeOfKind (const Table &table, Kind kind)
molSys::PointCloud< molSys::Point< double >, double > site::ionCloud (const molSys::PointCloud< molSys::Point< double >, double > &src, const Table &table)
Table site::parseSiteSpec (std::string_view spec)
IonEnvironment site::ionEnvironment (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< bool > &iceFlag, const std::vector< int > &ionIndices, const std::vector< int > &waterTypes, double cutoff)
 iceFlag is indexed like yCloud.pts.
IonEnvironment site::ionEnvironment (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< bool > &iceFlag, const std::vector< int > &ionIndices, int waterType, double cutoff)
 waterType 0 accepts every non-ion. Any other value is that one type.
std::vector< int > site::shellRingCensus (const std::vector< std::vector< int > > &rings, const std::vector< int > &shell, int maxRingSize)
 Rings of the water network that pass through a first shell: the census by size of every ring with at least one vertex in shell.
std::vector< std::vector< int > > site::cappedRings (const std::vector< std::vector< int > > &rings, const std::vector< int > &shell, int maxRingSize)
 Capped rings: the water-only primitive rings of rings (the ring network of the water graph, ions not vertices) of at most maxRingSize members, every member of which lies in shell.
std::vector< std::vector< int > > site::brokenRings (const std::vector< std::vector< int > > &nList, const std::vector< int > &shell, int maxRingSize)
 Broken rings: the primitive rings, of at most maxRingSize members, of the water graph nList (by index, leading self entry, ions not bonded) plus one virtual ion vertex bonded to every water of shell, that contain the ion.
GuestOccupancy site::guestOccupancy (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< std::vector< int > > &cages, const std::vector< int > &guestIndices, double radius)
 cages are vertex index lists into yCloud.pts; radius in the cloud's length unit (half the cage diameter, about 4 A for a 5^12 cage).
std::array< double, 3 > site::periodicCentroid (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< int > &atoms)
 Periodic centroid of a set of atoms: every atom is unwrapped to its minimum image about the first, and the mean is taken there.
const std::vector< std::array< double, 3 > > & site::insideRayDirections ()
 The fixed, ordered unit directions the inside test casts rays along.
InsideTrace site::pointInFacesTrace (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< std::vector< int > > &rings, const std::vector< int > &faces, const std::array< double, 3 > &guest, const std::array< double, 3 > *center=nullptr)
 The inside predicate for one cage.
bool site::pointInFaces (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< std::vector< int > > &rings, const std::vector< int > &faces, const std::array< double, 3 > &guest, const std::array< double, 3 > *center=nullptr)
GuestOccupancy site::guestOccupancyInside (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &cageFaces, const std::vector< int > &guestIndices)
 Occupancy by the inside predicate (pointInFaces) on every cage.
IceClusterIons site::iceClusterIonCensus (const molSys::PointCloud< molSys::Point< double >, double > &yCloud, const std::vector< bool > &ice, const std::vector< std::vector< int > > &nListByIndex, const std::vector< int > &ionIndices, double cutoff)

Variables

constexpr double site::kInsideRelTol = 1e-9
 Relative tolerance of the inside test, in units of the largest distance from c_F to a cage vertex.

Detailed Description

Per-atom site chemistry, separate from CHILL ice labels.

LAMMPS type IDs are not chemistry. A Table maps type (and optional atom-ID override) to Kind. Family is an input, not an inference. Table::of does not write polar or apolar back onto the table; indicesOf applies those two derived unions.

Definition in file site.hpp.