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

Bare-bones structs used throughout the architecture. More...

Classes

struct  Result
 This contains the bond classifier of enum class type bond_type, and the bond correlation factor. More...
struct  Point
 This contains per-particle information. More...
struct  PointCloud
 This contains a collection of points; contains information for a particular frame. More...

Concepts

concept  CoordinateScalar

Enumerations

enum class  bond_type { staggered , eclipsed , out_of_range }
enum class  atom_state_type {
  cubic , hexagonal , water , interfacial ,
  clathrate , interClathrate , unclassified , reCubic ,
  reHex
}

Functions

std::unordered_map< int, int > createIDMolIDmap (molSys::PointCloud< molSys::Point< double >, double > &yCloud)
std::unordered_multimap< int, int > createMolIDAtomIDMultiMap (molSys::PointCloud< molSys::Point< double >, double > &yCloud)
std::vector< std::vector< int > > hAtomMolList (molSys::PointCloud< molSys::Point< double >, double > &hCloud, molSys::PointCloud< molSys::Point< double >, double > &oCloud)
int searchMolList (const std::vector< std::vector< int > > &molList, int molIDtoFind)
molSys::PointCloud< molSys::Point< double >, double > clearPointCloud (molSys::PointCloud< molSys::Point< double >, double > &yCloud)
 //! Function for clearing vectors in PointCloud after multiple usage

Detailed Description

Bare-bones structs used throughout the architecture.

@detials This namespace defines Point and PointCloud structs, alongwith other basic functions and enums.

PointCloud is a struct that contains the information of a collection of Point structs, at every frame. Point contains the coordinates and types of each point, along with information about whether the particular particle is within a slice or not.

Changelog

Enumeration Type Documentation

◆ atom_state_type

enum class molSys::atom_state_type
strong
Enumerator
cubic 

Ic, or particle type signifying Cubic Ice.

hexagonal 

Ih, or particle type signifying Hexagonal Ice.

water 

Liquid/amorphous phase.

interfacial 

Interfacial ice: ice-like molecules which do not fulfill the strict criteria of the Ic or Ih phases.

clathrate 

Clathrate ice phase.

interClathrate 

Interfacial clathrate ice phase.

unclassified 

Not classified into any other category.

reCubic 

Reclassified as cubic ice, according to the \(q_6\) order parameter.

reHex 

Reclassified as hexagonal ice, according to the \(q_6\) order parameter.

Definition at line 107 of file mol_sys.hpp.

107 {
108 cubic,
109 hexagonal,
110 water,
112 clathrate,
115 reCubic,
116 reHex
117};
@ hexagonal
Ih, or particle type signifying Hexagonal Ice.
Definition mol_sys.hpp:109
@ reCubic
Reclassified as cubic ice, according to the order parameter.
Definition mol_sys.hpp:115
@ interfacial
Interfacial ice: ice-like molecules which do not fulfill the strict criteria of the Ic or Ih phases.
Definition mol_sys.hpp:111
@ cubic
Ic, or particle type signifying Cubic Ice.
Definition mol_sys.hpp:108
@ interClathrate
Interfacial clathrate ice phase.
Definition mol_sys.hpp:113
@ water
Liquid/amorphous phase.
Definition mol_sys.hpp:110
@ reHex
Reclassified as hexagonal ice, according to the order parameter.
Definition mol_sys.hpp:116
@ clathrate
Clathrate ice phase.
Definition mol_sys.hpp:112
@ unclassified
Not classified into any other category.
Definition mol_sys.hpp:114

◆ bond_type

enum class molSys::bond_type
strong
Enumerator
staggered 

The bond is a staggered bond, according to the \(a(i,j)\) or \(c(i,j)\) value.

eclipsed 

The bond is an eclipsed bond.

out_of_range 

The bond cannot be classified as either staggered or eclipsed.

Definition at line 69 of file mol_sys.hpp.

@ eclipsed
The bond is an eclipsed bond.
Definition mol_sys.hpp:69
@ out_of_range
The bond cannot be classified as either staggered or eclipsed.
Definition mol_sys.hpp:69
@ staggered
The bond is a staggered bond, according to the or value.
Definition mol_sys.hpp:69

Function Documentation

◆ clearPointCloud()

molSys::PointCloud< molSys::Point< double >, double > molSys::clearPointCloud ( molSys::PointCloud< molSys::Point< double >, double > & yCloud)

//! Function for clearing vectors in PointCloud after multiple usage

◆ createIDMolIDmap()

std::unordered_map< int, int > molSys::createIDMolIDmap ( molSys::PointCloud< molSys::Point< double >, double > & yCloud)

Creates an unordered map, with the atomIDs as keys and molecular IDs as the values

◆ createMolIDAtomIDMultiMap()

std::unordered_multimap< int, int > molSys::createMolIDAtomIDMultiMap ( molSys::PointCloud< molSys::Point< double >, double > & yCloud)

Creates an multimap with molecule IDs of the atoms as the keys and the atom IDs as the values. More than one atom can have the same molecule ID

◆ hAtomMolList()

std::vector< std::vector< int > > molSys::hAtomMolList ( molSys::PointCloud< molSys::Point< double >, double > & hCloud,
molSys::PointCloud< molSys::Point< double >, double > & oCloud )

Returns a vector of vectors, which contains the molIDs in the first column, and the hydrogen atom indices (not atom IDs) in the row

◆ searchMolList()

int molSys::searchMolList ( const std::vector< std::vector< int > > & molList,
int molIDtoFind )
nodiscard

This function searches a vector of vectors molList, for a particular molecular ID, and returns the index in molList