Cage

Data Structures

struct  cage::Cage
 This contains a cage, with the constituent rings. More...
 

Enumerations

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

Variables

cageType cage::Cage::type
 
std::vector< int > cage::Cage::rings
 type of the cage : can be DDC or HC More...
 

Detailed Description

Enumeration Type Documentation

◆ cageType

Enumerator
HexC 

The type for a hexagonal cage

DoubleDiaC 

The type for a double-diamond cage

Definition at line 50 of file cage.hpp.

50 { HexC, DoubleDiaC };
@ HexC
Definition: cage.hpp:50
@ DoubleDiaC
Definition: cage.hpp:50

◆ iceType

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 71 of file cage.hpp.

71 { dummy, hc, ddc, mixed, pnc, mixed2 };
@ dummy
Definition: cage.hpp:71
@ pnc
Definition: cage.hpp:71
@ ddc
Definition: cage.hpp:71
@ mixed
Definition: cage.hpp:71
@ hc
Definition: cage.hpp:71
@ mixed2
Definition: cage.hpp:71

Variable Documentation

◆ rings

std::vector<int> cage::Cage::rings

type of the cage : can be DDC or HC

Definition at line 84 of file cage.hpp.

◆ type

cageType cage::Cage::type

Definition at line 83 of file cage.hpp.