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

Status codes, label codes, and opaque handles. More...

Typedefs

typedef enum seams_status seams_status
 Status codes.
typedef enum seams_label seams_label
 CHILL and CHILL+ atom labels.
typedef enum seams_ring_symmetry seams_ring_symmetry
 Ring topology.
typedef enum seams_chill_rule seams_chill_rule
 CHILL+ definition.
typedef enum seams_graph seams_graph
 Neighbour graph.
typedef enum seams_cage_label seams_cage_label
 Per-atom cage membership from the hexagonal and double-diamond search.
typedef enum seams_site_kind seams_site_kind
 Site kind.
typedef struct seams_system seams_system
 One frame.
typedef struct seams_neighbours seams_neighbours
 One neighbour list.
typedef struct seams_rings seams_rings
 One primitive-ring set.
typedef struct seams_cage_set seams_cage_set
 Hexagonal and double-diamond membership.
typedef struct seams_brine seams_brine
 One planar ice/brine front measurement.
typedef struct seams_topo seams_topo
 Topological fingerprint of one bonded frame.

Enumerations

enum  seams_status {
  SEAMS_OK = 0 , SEAMS_ERR_NULL = 1 , SEAMS_ERR_RANGE = 2 , SEAMS_ERR_BOX = 3 ,
  SEAMS_ERR_ARG = 4 , SEAMS_ERR_STATE = 5 , SEAMS_ERR_NOMEM = 6 , SEAMS_ERR_INTERNAL = 7
}
 Status codes. More...
enum  seams_label {
  SEAMS_LABEL_CUBIC = 0 , SEAMS_LABEL_HEXAGONAL = 1 , SEAMS_LABEL_WATER = 2 , SEAMS_LABEL_INTERFACIAL = 3 ,
  SEAMS_LABEL_CLATHRATE = 4 , SEAMS_LABEL_INTERCLATHRATE = 5 , SEAMS_LABEL_UNCLASSIFIED = 6 , SEAMS_LABEL_RECUBIC = 7 ,
  SEAMS_LABEL_REHEX = 8
}
 CHILL and CHILL+ atom labels. More...
enum  seams_ring_symmetry {
  SEAMS_RING_UNCLASSIFIED = 0 , SEAMS_RING_DDC = 1 , SEAMS_RING_HC_BASAL = 2 , SEAMS_RING_HC_PRISMATIC = 3 ,
  SEAMS_RING_BOTH_BASAL = 4 , SEAMS_RING_BOTH_PRISMATIC = 5 , SEAMS_RING_PRISM = 6 , SEAMS_RING_DEFORMED_PRISM = 7 ,
  SEAMS_RING_MIXED_PRISM = 8 , SEAMS_RING_PENTAGON = 9 , SEAMS_RING_HEXAGON = 10 , SEAMS_RING_OTHER = 11
}
 Ring topology. More...
enum  seams_chill_rule { SEAMS_CHILL_PUBLISHED = 0 , SEAMS_CHILL_OVITO = 1 }
 CHILL+ definition. More...
enum  seams_graph { SEAMS_GRAPH_CUTOFF = 0 , SEAMS_GRAPH_MUTUAL = 1 , SEAMS_GRAPH_SEEDED = 2 }
 Neighbour graph. More...
enum  seams_cage_label { SEAMS_CAGE_WATER = 0 , SEAMS_CAGE_HEX = 1 , SEAMS_CAGE_CUBIC = 2 , SEAMS_CAGE_BOTH = 3 }
 Per-atom cage membership from the hexagonal and double-diamond search. More...
enum  seams_site_kind {
  SEAMS_SITE_UNSPECIFIED = 0 , SEAMS_SITE_CATION = 1 , SEAMS_SITE_ANION = 2 , SEAMS_SITE_TAIL = 3 ,
  SEAMS_SITE_DONOR_H = 4 , SEAMS_SITE_ACCEPTOR = 5 , SEAMS_SITE_POLAR = 6 , SEAMS_SITE_APOLAR = 7 ,
  SEAMS_SITE_WATER_O = 8 , SEAMS_SITE_WATER_H = 9 , SEAMS_SITE_SOLVENT = 10
}
 Site kind. More...

Detailed Description

Status codes, label codes, and opaque handles.

Typedef Documentation

◆ seams_brine

typedef struct seams_brine seams_brine

One planar ice/brine front measurement.

Free with seams_brine_destroy().

Definition at line 249 of file seams.h.

◆ seams_cage_label

Per-atom cage membership from the hexagonal and double-diamond search.

The four codes are disjoint.

◆ seams_cage_set

Hexagonal and double-diamond membership.

Free with seams_cages_destroy().

Definition at line 247 of file seams.h.

◆ seams_chill_rule

CHILL+ definition.

PUBLISHED averages q_lm over the four closest neighbours (Nguyen and Molinero, equation 1) and uses inclusive edges. OVITO averages q_lm over every neighbour inside the cutoff, the Chill+ modifier's 3.5 A shell, with that modifier's open edges.

◆ seams_graph

typedef enum seams_graph seams_graph

Neighbour graph.

Seeded is a cage graph: mutual seeds, union completions.

◆ seams_label

typedef enum seams_label seams_label

CHILL and CHILL+ atom labels.

Matches molSys::atom_state_type.

◆ seams_neighbours

One neighbour list.

Free with seams_neighbours_destroy().

Definition at line 243 of file seams.h.

◆ seams_ring_symmetry

Ring topology.

Size classes are used when a six-ring is not a cage face.

◆ seams_rings

typedef struct seams_rings seams_rings

One primitive-ring set.

Free with seams_rings_destroy().

Definition at line 245 of file seams.h.

◆ seams_site_kind

Site kind.

Values match the engine's site table.

◆ seams_status

typedef enum seams_status seams_status

Status codes.

Zero is success.

◆ seams_system

typedef struct seams_system seams_system

One frame.

Create with seams_system_create(), free with seams_system_destroy().

Definition at line 241 of file seams.h.

◆ seams_topo

typedef struct seams_topo seams_topo

Topological fingerprint of one bonded frame.

Free with seams_fingerprint_destroy().

Definition at line 251 of file seams.h.

Enumeration Type Documentation

◆ seams_cage_label

Per-atom cage membership from the hexagonal and double-diamond search.

The four codes are disjoint.

Enumerator
SEAMS_CAGE_WATER 

In neither cage.

SEAMS_CAGE_HEX 

Hexagonal cage only.

SEAMS_CAGE_CUBIC 

Double-diamond cage only.

SEAMS_CAGE_BOTH 

Both cages.

Definition at line 218 of file seams.h.

218 {
219 SEAMS_CAGE_WATER = 0,
220 SEAMS_CAGE_HEX = 1,
221 SEAMS_CAGE_CUBIC = 2,
222 SEAMS_CAGE_BOTH = 3
seams_cage_label
Per-atom cage membership from the hexagonal and double-diamond search.
Definition seams.h:218
@ SEAMS_CAGE_CUBIC
Double-diamond cage only.
Definition seams.h:221
@ SEAMS_CAGE_HEX
Hexagonal cage only.
Definition seams.h:220
@ SEAMS_CAGE_WATER
In neither cage.
Definition seams.h:219
@ SEAMS_CAGE_BOTH
Both cages.
Definition seams.h:222

◆ seams_chill_rule

CHILL+ definition.

PUBLISHED averages q_lm over the four closest neighbours (Nguyen and Molinero, equation 1) and uses inclusive edges. OVITO averages q_lm over every neighbour inside the cutoff, the Chill+ modifier's 3.5 A shell, with that modifier's open edges.

Enumerator
SEAMS_CHILL_PUBLISHED 

Nguyen and Molinero, four closest neighbours.

SEAMS_CHILL_OVITO 

OVITO Chill+ modifier, every neighbour in the cutoff.

Definition at line 201 of file seams.h.

201 {
seams_chill_rule
CHILL+ definition.
Definition seams.h:201
@ SEAMS_CHILL_OVITO
OVITO Chill+ modifier, every neighbour in the cutoff.
Definition seams.h:203
@ SEAMS_CHILL_PUBLISHED
Nguyen and Molinero, four closest neighbours.
Definition seams.h:202

◆ seams_graph

Neighbour graph.

Seeded is a cage graph: mutual seeds, union completions.

Enumerator
SEAMS_GRAPH_CUTOFF 

Every neighbour inside the cutoff.

SEAMS_GRAPH_MUTUAL 

Mutual four nearest inside cutoff + 1.5.

SEAMS_GRAPH_SEEDED 

Mutual seeds with union completions, for cages only.

Definition at line 207 of file seams.h.

207 {
seams_graph
Neighbour graph.
Definition seams.h:207
@ SEAMS_GRAPH_CUTOFF
Every neighbour inside the cutoff.
Definition seams.h:208
@ SEAMS_GRAPH_SEEDED
Mutual seeds with union completions, for cages only.
Definition seams.h:210
@ SEAMS_GRAPH_MUTUAL
Mutual four nearest inside cutoff + 1.5.
Definition seams.h:209

◆ seams_label

CHILL and CHILL+ atom labels.

Matches molSys::atom_state_type.

Enumerator
SEAMS_LABEL_CUBIC 

Cubic ice (Ic).

SEAMS_LABEL_HEXAGONAL 

Hexagonal ice (Ih).

SEAMS_LABEL_WATER 

Liquid water.

SEAMS_LABEL_INTERFACIAL 

Interfacial ice.

SEAMS_LABEL_CLATHRATE 

Clathrate.

SEAMS_LABEL_INTERCLATHRATE 

Interfacial clathrate.

SEAMS_LABEL_UNCLASSIFIED 

Not classified, or dropped by the species filter.

SEAMS_LABEL_RECUBIC 

Cubic after reclassification.

SEAMS_LABEL_REHEX 

Hexagonal after reclassification.

Definition at line 165 of file seams.h.

165 {
seams_label
CHILL and CHILL+ atom labels.
Definition seams.h:165
@ SEAMS_LABEL_INTERCLATHRATE
Interfacial clathrate.
Definition seams.h:171
@ SEAMS_LABEL_UNCLASSIFIED
Not classified, or dropped by the species filter.
Definition seams.h:172
@ SEAMS_LABEL_INTERFACIAL
Interfacial ice.
Definition seams.h:169
@ SEAMS_LABEL_WATER
Liquid water.
Definition seams.h:168
@ SEAMS_LABEL_RECUBIC
Cubic after reclassification.
Definition seams.h:173
@ SEAMS_LABEL_CUBIC
Cubic ice (Ic).
Definition seams.h:166
@ SEAMS_LABEL_HEXAGONAL
Hexagonal ice (Ih).
Definition seams.h:167
@ SEAMS_LABEL_REHEX
Hexagonal after reclassification.
Definition seams.h:174
@ SEAMS_LABEL_CLATHRATE
Clathrate.
Definition seams.h:170

◆ seams_ring_symmetry

Ring topology.

Size classes are used when a six-ring is not a cage face.

Enumerator
SEAMS_RING_UNCLASSIFIED 

No topology assigned.

SEAMS_RING_DDC 

Face of a double-diamond cage.

SEAMS_RING_HC_BASAL 

Basal face of a hexagonal cage.

SEAMS_RING_HC_PRISMATIC 

Prismatic face of a hexagonal cage.

SEAMS_RING_BOTH_BASAL 

Shared by both cage kinds, basal.

SEAMS_RING_BOTH_PRISMATIC 

Shared by both cage kinds, prismatic.

SEAMS_RING_PRISM 

Face of a perfect prism.

SEAMS_RING_DEFORMED_PRISM 

Face of a deformed prism.

SEAMS_RING_MIXED_PRISM 

Face of a mixed prism.

SEAMS_RING_PENTAGON 

Five-ring outside any cage.

SEAMS_RING_HEXAGON 

Six-ring outside any cage.

SEAMS_RING_OTHER 

Any other size outside any cage.

Definition at line 178 of file seams.h.

178 {
180 SEAMS_RING_DDC = 1,
185 SEAMS_RING_PRISM = 6,
189 SEAMS_RING_HEXAGON = 10,
190 SEAMS_RING_OTHER = 11
seams_ring_symmetry
Ring topology.
Definition seams.h:178
@ SEAMS_RING_HEXAGON
Six-ring outside any cage.
Definition seams.h:189
@ SEAMS_RING_UNCLASSIFIED
No topology assigned.
Definition seams.h:179
@ SEAMS_RING_HC_PRISMATIC
Prismatic face of a hexagonal cage.
Definition seams.h:182
@ SEAMS_RING_MIXED_PRISM
Face of a mixed prism.
Definition seams.h:187
@ SEAMS_RING_DEFORMED_PRISM
Face of a deformed prism.
Definition seams.h:186
@ SEAMS_RING_BOTH_PRISMATIC
Shared by both cage kinds, prismatic.
Definition seams.h:184
@ SEAMS_RING_PENTAGON
Five-ring outside any cage.
Definition seams.h:188
@ SEAMS_RING_BOTH_BASAL
Shared by both cage kinds, basal.
Definition seams.h:183
@ SEAMS_RING_PRISM
Face of a perfect prism.
Definition seams.h:185
@ SEAMS_RING_HC_BASAL
Basal face of a hexagonal cage.
Definition seams.h:181
@ SEAMS_RING_OTHER
Any other size outside any cage.
Definition seams.h:190
@ SEAMS_RING_DDC
Face of a double-diamond cage.
Definition seams.h:180

◆ seams_site_kind

Site kind.

Values match the engine's site table.

Enumerator
SEAMS_SITE_UNSPECIFIED 

Not named in the site table.

SEAMS_SITE_CATION 

Cation head.

SEAMS_SITE_ANION 

Anion.

SEAMS_SITE_TAIL 

Alkyl tail.

SEAMS_SITE_DONOR_H 

Hydrogen-bond donor hydrogen.

SEAMS_SITE_ACCEPTOR 

Hydrogen-bond acceptor.

SEAMS_SITE_POLAR 

Other polar site.

SEAMS_SITE_APOLAR 

Other apolar site.

SEAMS_SITE_WATER_O 

Water oxygen.

SEAMS_SITE_WATER_H 

Water hydrogen.

SEAMS_SITE_SOLVENT 

Other solvent.

Definition at line 226 of file seams.h.

226 {
229 SEAMS_SITE_ANION = 2,
230 SEAMS_SITE_TAIL = 3,
233 SEAMS_SITE_POLAR = 6,
seams_site_kind
Site kind.
Definition seams.h:226
@ SEAMS_SITE_WATER_H
Water hydrogen.
Definition seams.h:236
@ SEAMS_SITE_WATER_O
Water oxygen.
Definition seams.h:235
@ SEAMS_SITE_CATION
Cation head.
Definition seams.h:228
@ SEAMS_SITE_DONOR_H
Hydrogen-bond donor hydrogen.
Definition seams.h:231
@ SEAMS_SITE_ACCEPTOR
Hydrogen-bond acceptor.
Definition seams.h:232
@ SEAMS_SITE_TAIL
Alkyl tail.
Definition seams.h:230
@ SEAMS_SITE_APOLAR
Other apolar site.
Definition seams.h:234
@ SEAMS_SITE_SOLVENT
Other solvent.
Definition seams.h:237
@ SEAMS_SITE_ANION
Anion.
Definition seams.h:229
@ SEAMS_SITE_UNSPECIFIED
Not named in the site table.
Definition seams.h:227
@ SEAMS_SITE_POLAR
Other polar site.
Definition seams.h:233

◆ seams_status

Status codes.

Zero is success.

Enumerator
SEAMS_OK 

The call succeeded.

SEAMS_ERR_NULL 

A required pointer is null.

SEAMS_ERR_RANGE 

A number or a buffer length is outside the accepted range.

SEAMS_ERR_BOX 

The cell is missing, non-finite, or has no volume.

SEAMS_ERR_ARG 

A caller argument is the wrong shape, or a coordinate is not finite.

SEAMS_ERR_STATE 

The handle has no frame yet.

SEAMS_ERR_NOMEM 

An allocation failed.

SEAMS_ERR_INTERNAL 

The library hit an internal failure.

Definition at line 153 of file seams.h.

153 {
154 SEAMS_OK = 0,
155 SEAMS_ERR_NULL = 1,
156 SEAMS_ERR_RANGE = 2,
157 SEAMS_ERR_BOX = 3,
158 SEAMS_ERR_ARG = 4,
159 SEAMS_ERR_STATE = 5,
160 SEAMS_ERR_NOMEM = 6,
seams_status
Status codes.
Definition seams.h:153
@ SEAMS_ERR_RANGE
A number or a buffer length is outside the accepted range.
Definition seams.h:156
@ SEAMS_ERR_NOMEM
An allocation failed.
Definition seams.h:160
@ SEAMS_ERR_NULL
A required pointer is null.
Definition seams.h:155
@ SEAMS_ERR_STATE
The handle has no frame yet.
Definition seams.h:159
@ SEAMS_ERR_BOX
The cell is missing, non-finite, or has no volume.
Definition seams.h:157
@ SEAMS_ERR_INTERNAL
The library hit an internal failure.
Definition seams.h:161
@ SEAMS_ERR_ARG
A caller argument is the wrong shape, or a coordinate is not finite.
Definition seams.h:158
@ SEAMS_OK
The call succeeded.
Definition seams.h:154