enum ring::strucType

Overview

#include <ring.hpp>
 
enum strucType {
    unclassified,
    DDC,
    HCbasal,
    HCprismatic,
    bothBasal,
    bothPrismatic,
    Prism,
    deformedPrism,
    mixedPrismRing,
};

Detailed Documentation

Enum Values

unclassified

The ring is unclassified, which may be either water or a deformed type which cannot be classified by the criteria.

DDC

The ring belongs to a double-diamond cage (DDC).

HCbasal

The ring belongs only to a hexagonal cage (HC).

Specifically, the ring is purely a basal ring of an HC.

HCprismatic

The ring belongs only to a hexagonal cage (HC); specifically the ring is purely a prismatic ring of an HC.

It is not shared by a DDC.

bothBasal

The ring belongs to both a DDC and HC.

It is a ‘mixed’ ring. The ring is also one of the basal rings of the HC of which it is part. A mixed ring must be a peripheral ring of the DDC of which it is part by definition.

bothPrismatic

The ring belongs to both a DDC and HC and is, thus, a ‘mixed’ ring.

The ring is also one of the prismatic rings of the HC of which it is part. A mixed ring must be a peripheral ring of the DDC of which it is part by definition (can never be an equatorial ring of a DDC and also be part of an HC).

Prism

The ring belongs to a prism block, classified according to the prism identification scheme.