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

Functions for topological network criteria cage types. More...

Classes

struct  Cage
 This contains a cage, with the constituent rings. More...
struct  CageShape
 IRA/SOFI result for one cage. More...
struct  EdgeWindow
 Inclusive length window on each face edge, in the coordinate units of the frame. More...
struct  FormerRow
 One network-former atom: coordination, same-species bonds, and the primitive rings that pass through it. More...
struct  FoundCage
 One cage matching a signature, closed or incomplete. More...
struct  Signature
 Ring-size census of a polyhedral cage: size -> number of faces. More...

Enumerations

enum class  cageType { HexC , DoubleDiaC }
enum class  iceType {
  dummy , hc , ddc , mixed ,
  pnc , mixed2
}

Functions

bool nautyAvailable ()
std::string canonicalCertificate (const std::vector< std::vector< int > > &rings)
bool isHexagonalPrism (const std::vector< std::vector< int > > &rings)
bool sameCertificate (const std::vector< std::vector< int > > &a, const std::vector< std::vector< int > > &b)
std::string canonicalCertificateRooted (int n, const std::vector< std::pair< int, int > > &edges, int root)
std::string canonicalCertificateColored (int n, const std::vector< std::pair< int, int > > &edges, const std::vector< int > &colors, int root)
bool isClosedPolyhedron (const std::vector< std::vector< int > > &rings, const std::vector< int > &faces)
 True when every edge of the listed faces is used by exactly two of those faces.
bool isSpherePolyhedron (const std::vector< std::vector< int > > &rings, const std::vector< int > &faces)
 True when the listed faces are closed (isClosedPolyhedron), at least three faces around each of their vertices form a single cycle, and V - E + F = 2.
std::vector< FoundCage > findBySignature (const std::vector< std::vector< int > > &rings, const Signature &signature)
 Face-sharing rings whose size census equals signature and whose edges close.
bool speciesCycleMatches (const std::vector< int > &cycle, const std::vector< int > &pattern)
 True when cycle is pattern rotated or reversed.
std::vector< FoundCage > findBySignature (const std::vector< std::vector< int > > &rings, const Signature &signature, const std::vector< int > &species, const std::vector< std::vector< int > > &patterns)
 As findBySignature.
std::vector< FoundCage > findBySignature (const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList, const Signature &signature)
 As above.
std::vector< FoundCage > findBySignature (const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList, const Signature &signature, const std::vector< int > &atomRank)
 As above, with findHC / findDDC claiming rings in the order of atomRank (ring::positionRank of the frame), so the hc and ddc cages do not depend on the atom labels.
EdgeWindow parseEdgeWindow (std::string_view spec)
 none, off, or false disables the window.
std::string edgeWindowSpec (const EdgeWindow &window)
 none when the window is off, otherwise lo,hi.
std::vector< std::vector< FoundCage > > findBySignatures (const std::vector< std::vector< int > > &rings, const std::vector< std::vector< int > > &nList, const std::vector< Signature > &signatures, const std::vector< int > &atomRank, const std::vector< std::array< double, 3 > > *xyz=nullptr, const std::vector< double > *box=nullptr, const EdgeWindow &window={}, const std::vector< double > *boxLow=nullptr)
 findBySignature for each of signatures, one list per entry.
std::vector< FoundCage > findIncompleteBySignature (const std::vector< std::vector< int > > &rings, const Signature &signature, int minFaces)
 Connected face sets that stay inside the signature budget, have at least minFaces faces, and are not closed.
std::size_t exerciseClosedSeedFilter (const std::vector< std::vector< int > > &rings, const Signature &signature)
 Runs Search with the closed seed filter left on.
std::vector< std::array< double, 3 > > coordsOfVertices (const std::vector< std::array< double, 3 > > &all, const std::vector< int > &vertices)
 Coordinates of vertices only.
CageShape shapeOfVertices (const std::vector< std::array< double, 3 > > &cageXyz)
 Point group of this vertex set.
CageShape overlayVertices (const std::vector< std::array< double, 3 > > &ref, const std::vector< std::array< double, 3 > > &cageXyz)
 Overlay cageXyz on ref.
std::vector< FormerRow > formerRows (const std::vector< std::vector< int > > &nList, const std::vector< std::vector< int > > &rings, const std::vector< int > &species, int formerSpecies)
 formerSpecies < 0 keeps every atom.
bool sameNetwork (const std::vector< FormerRow > &early, const std::vector< FormerRow > &late)
 True when the two tables have the same per-atom species, coordination, homopolar count, and ring-size multiset.

Detailed Description

Functions for topological network criteria cage types.

This namespace contains structs and enums for cage types

Type definitions for atoms, rings and cages. HexC and DoubleDiaC are the TUM ice cages. A Signature names any polyhedron by its ring-size census (sodalite is {4:6, 6:8}); the enumerator in cage_enum.hpp grows face-sharing ring sets that match that census.

Changelog

Enumeration Type Documentation

◆ cageType

enum class cage::cageType
strong
Enumerator
HexC 

The type for a hexagonal cage.

DoubleDiaC 

The type for a double-diamond cage.

Definition at line 60 of file cage.hpp.

60{ HexC, DoubleDiaC };
@ HexC
The type for a hexagonal cage.
Definition cage.hpp:60
@ DoubleDiaC
The type for a double-diamond cage.
Definition cage.hpp:60

◆ iceType

enum class cage::iceType
strong
Enumerator
dummy 

Type for an atom which does not belong to any kind of cage.

hc 

Type for an atom which belongs to an HC.

ddc 

Type for an atom which belongs to a DDC.

mixed 

Type for an atom which is part of a mixed ring, shared by both a DDC and an HC.

pnc 
mixed2 

Definition at line 107 of file cage.hpp.

107{ dummy, hc, ddc, mixed, pnc, mixed2 };
@ mixed
Type for an atom which is part of a mixed ring, shared by both a DDC and an HC.
Definition cage.hpp:107
@ dummy
Type for an atom which does not belong to any kind of cage.
Definition cage.hpp:107
@ hc
Type for an atom which belongs to an HC.
Definition cage.hpp:107
@ ddc
Type for an atom which belongs to a DDC.
Definition cage.hpp:107

Function Documentation

◆ canonicalCertificate()

std::string cage::canonicalCertificate ( const std::vector< std::vector< int > > & rings)

◆ canonicalCertificateColored()

std::string cage::canonicalCertificateColored ( int n,
const std::vector< std::pair< int, int > > & edges,
const std::vector< int > & colors,
int root )

◆ canonicalCertificateRooted()

std::string cage::canonicalCertificateRooted ( int n,
const std::vector< std::pair< int, int > > & edges,
int root )

◆ coordsOfVertices()

std::vector< std::array< double, 3 > > cage::coordsOfVertices ( const std::vector< std::array< double, 3 > > & all,
const std::vector< int > & vertices )

Coordinates of vertices only.

An index past all is skipped.

◆ edgeWindowSpec()

std::string cage::edgeWindowSpec ( const EdgeWindow & window)

none when the window is off, otherwise lo,hi.

◆ exerciseClosedSeedFilter()

std::size_t cage::exerciseClosedSeedFilter ( const std::vector< std::vector< int > > & rings,
const Signature & signature )

Runs Search with the closed seed filter left on.

A ring whose edge sits in fewer than two rings is skipped.

◆ findBySignature() [1/4]

std::vector< FoundCage > cage::findBySignature ( const std::vector< std::vector< int > > & rings,
const Signature & signature )

Face-sharing rings whose size census equals signature and whose edges close.

The input may hold rings of every size; only sizes that appear in the signature take part. Named hc and ddc without a neighbour list use the geometric census (4:6,6:2 and 6:7).

◆ findBySignature() [2/4]

std::vector< FoundCage > cage::findBySignature ( const std::vector< std::vector< int > > & rings,
const Signature & signature,
const std::vector< int > & species,
const std::vector< std::vector< int > > & patterns )

As findBySignature.

A ring is a face only when its species sequence matches one pattern of the same length, up to rotation and reversal. An empty pattern list keeps every ring whose size is in the census. species is one class per atom index. A vertex past the end of species keeps its ring out.

◆ findBySignature() [3/4]

std::vector< FoundCage > cage::findBySignature ( const std::vector< std::vector< int > > & rings,
const std::vector< std::vector< int > > & nList,
const Signature & signature )

As above.

Named hc and ddc call findHC / findDDC on the six-membered rings so the vertex sets match those finders.

◆ findBySignature() [4/4]

std::vector< FoundCage > cage::findBySignature ( const std::vector< std::vector< int > > & rings,
const std::vector< std::vector< int > > & nList,
const Signature & signature,
const std::vector< int > & atomRank )

As above, with findHC / findDDC claiming rings in the order of atomRank (ring::positionRank of the frame), so the hc and ddc cages do not depend on the atom labels.

◆ findBySignatures()

std::vector< std::vector< FoundCage > > cage::findBySignatures ( const std::vector< std::vector< int > > & rings,
const std::vector< std::vector< int > > & nList,
const std::vector< Signature > & signatures,
const std::vector< int > & atomRank,
const std::vector< std::array< double, 3 > > * xyz = nullptr,
const std::vector< double > * box = nullptr,
const EdgeWindow & window = {},
const std::vector< double > * boxLow = nullptr )

findBySignature for each of signatures, one list per entry.

The ring-size censuses share one search, so a face set that fits several of them is grown once; hc and ddc go to findHC / findDDC as in findBySignature. Each list equals findBySignature on its entry. window keeps a face only when every minimum-image edge lies in [lo, hi]. A disabled window, or a null xyz, leaves that test out and the cage bound is the face census. box is the cloud box (three lengths, or lengths plus xy, xz, yz). boxLow is the dump origin; a tilted cell uses it so a wrapped oxygen-oxygen contact is measured on the lattice, not on the orthorhombic bounds.

◆ findIncompleteBySignature()

std::vector< FoundCage > cage::findIncompleteBySignature ( const std::vector< std::vector< int > > & rings,
const Signature & signature,
int minFaces )

Connected face sets that stay inside the signature budget, have at least minFaces faces, and are not closed.

Cups and incomplete cages during hydrate nucleation. Closed polyhedra are omitted. minFaces <= 0 uses max(1, signature.faceCount() / 2). A cup whose every face already belongs to a closed cage is omitted.

◆ formerRows()

std::vector< FormerRow > cage::formerRows ( const std::vector< std::vector< int > > & nList,
const std::vector< std::vector< int > > & rings,
const std::vector< int > & species,
int formerSpecies )

formerSpecies < 0 keeps every atom.

◆ isClosedPolyhedron()

bool cage::isClosedPolyhedron ( const std::vector< std::vector< int > > & rings,
const std::vector< int > & faces )

True when every edge of the listed faces is used by exactly two of those faces.

An empty face list is not closed.

◆ isHexagonalPrism()

bool cage::isHexagonalPrism ( const std::vector< std::vector< int > > & rings)

◆ isSpherePolyhedron()

bool cage::isSpherePolyhedron ( const std::vector< std::vector< int > > & rings,
const std::vector< int > & faces )

True when the listed faces are closed (isClosedPolyhedron), at least three faces around each of their vertices form a single cycle, and V - E + F = 2.

Paired edges alone also admit pinched vertices, two faces that share two edges, and surfaces of higher genus.

◆ nautyAvailable()

bool cage::nautyAvailable ( )

◆ overlayVertices()

CageShape cage::overlayVertices ( const std::vector< std::array< double, 3 > > & ref,
const std::vector< std::array< double, 3 > > & cageXyz )

Overlay cageXyz on ref.

Row counts must agree. Does not see any atom outside the two sets.

◆ parseEdgeWindow()

EdgeWindow cage::parseEdgeWindow ( std::string_view spec)

none, off, or false disables the window.

LO,HI, LO:HI, or LO/HI sets the inclusive bounds. An empty string is the default window. lo is >= 0 and strictly less than hi.

◆ sameCertificate()

bool cage::sameCertificate ( const std::vector< std::vector< int > > & a,
const std::vector< std::vector< int > > & b )

◆ sameNetwork()

bool cage::sameNetwork ( const std::vector< FormerRow > & early,
const std::vector< FormerRow > & late )

True when the two tables have the same per-atom species, coordination, homopolar count, and ring-size multiset.

◆ shapeOfVertices()

CageShape cage::shapeOfVertices ( const std::vector< std::array< double, 3 > > & cageXyz)

Point group of this vertex set.

Does not see any other atom.

◆ speciesCycleMatches()

bool cage::speciesCycleMatches ( const std::vector< int > & cycle,
const std::vector< int > & pattern )

True when cycle is pattern rotated or reversed.