cage.hpp
Go to the documentation of this file.
Code
1//-----------------------------------------------------------------------------------
2// d-SEAMS - Deferred Structural Elucidation Analysis for Molecular Simulations
3//
4// Copyright (c) 2018--present d-SEAMS core team
5//
6// This program is free software: you can redistribute it and/or modify
7// it under the terms of the MIT License as published by
8// the Open Source Initiative.
9//
10// A copy of the MIT License is included in the LICENSE file of this repository.
11// You should have received a copy of the MIT License along with this program.
12// If not, see <https://opensource.org/licenses/MIT>.
13//-----------------------------------------------------------------------------------
14
15#ifndef __CAGE_H_
16#define __CAGE_H_
17#include <vector>
18
40// Namespace for cages
41namespace cage {
42
43// Type of a cage (a group of rings)
54enum class cageType { HexC, DoubleDiaC };
55
56// Type of ice for a particular atom. Dummy means that the atom is unclassified
57// and is most probably water
75enum class iceType { dummy, hc, ddc, mixed, pnc, mixed2 };
76
77// Each DDC has one equatorial ring and 6 peripheral rings
78// Each HC has two basal planes and 3 prismatic planes
86struct Cage {
88 std::vector<int> rings;
89};
90
91} // namespace cage
92
93#endif // __CAGE_H_
cageType
Definition cage.hpp:54
std::vector< int > rings
type of the cage : can be DDC or HC
Definition cage.hpp:88
iceType
Definition cage.hpp:75
cageType type
Definition cage.hpp:87
Functions for topological network criteria cage types. This namespace contains structs and enums for ...
Definition cage.hpp:41
This contains a cage, with the constituent rings.
Definition cage.hpp:86