Skip to main content

seams_sys/
lib.rs

1/* Copyright (c) d-SEAMS developers */
2/* Generated from include/seams.h by gen_sys.py. Do not edit. */
3#![allow(non_camel_case_types, non_snake_case)]
4
5use std::os::raw::{c_char, c_int, c_void};
6
7pub const SEAMS_OK: c_int = 0;
8pub const SEAMS_ERR_NULL: c_int = 1;
9pub const SEAMS_ERR_RANGE: c_int = 2;
10pub const SEAMS_ERR_BOX: c_int = 3;
11pub const SEAMS_ERR_ARG: c_int = 4;
12pub const SEAMS_ERR_STATE: c_int = 5;
13pub const SEAMS_ERR_NOMEM: c_int = 6;
14pub const SEAMS_ERR_INTERNAL: c_int = 7;
15pub const SEAMS_LABEL_CUBIC: c_int = 0;
16pub const SEAMS_LABEL_HEXAGONAL: c_int = 1;
17pub const SEAMS_LABEL_WATER: c_int = 2;
18pub const SEAMS_LABEL_INTERFACIAL: c_int = 3;
19pub const SEAMS_LABEL_CLATHRATE: c_int = 4;
20pub const SEAMS_LABEL_INTERCLATHRATE: c_int = 5;
21pub const SEAMS_LABEL_UNCLASSIFIED: c_int = 6;
22pub const SEAMS_LABEL_RECUBIC: c_int = 7;
23pub const SEAMS_LABEL_REHEX: c_int = 8;
24pub const SEAMS_RING_UNCLASSIFIED: c_int = 0;
25pub const SEAMS_RING_DDC: c_int = 1;
26pub const SEAMS_RING_HC_BASAL: c_int = 2;
27pub const SEAMS_RING_HC_PRISMATIC: c_int = 3;
28pub const SEAMS_RING_BOTH_BASAL: c_int = 4;
29pub const SEAMS_RING_BOTH_PRISMATIC: c_int = 5;
30pub const SEAMS_RING_PRISM: c_int = 6;
31pub const SEAMS_RING_DEFORMED_PRISM: c_int = 7;
32pub const SEAMS_RING_MIXED_PRISM: c_int = 8;
33pub const SEAMS_RING_PENTAGON: c_int = 9;
34pub const SEAMS_RING_HEXAGON: c_int = 10;
35pub const SEAMS_RING_OTHER: c_int = 11;
36pub const SEAMS_CHILL_PUBLISHED: c_int = 0;
37pub const SEAMS_CHILL_OVITO: c_int = 1;
38pub const SEAMS_GRAPH_CUTOFF: c_int = 0;
39pub const SEAMS_GRAPH_MUTUAL: c_int = 1;
40pub const SEAMS_GRAPH_SEEDED: c_int = 2;
41pub const SEAMS_CAGE_WATER: c_int = 0;
42pub const SEAMS_CAGE_HEX: c_int = 1;
43pub const SEAMS_CAGE_CUBIC: c_int = 2;
44pub const SEAMS_CAGE_BOTH: c_int = 3;
45pub const SEAMS_SITE_UNSPECIFIED: c_int = 0;
46pub const SEAMS_SITE_CATION: c_int = 1;
47pub const SEAMS_SITE_ANION: c_int = 2;
48pub const SEAMS_SITE_TAIL: c_int = 3;
49pub const SEAMS_SITE_DONOR_H: c_int = 4;
50pub const SEAMS_SITE_ACCEPTOR: c_int = 5;
51pub const SEAMS_SITE_POLAR: c_int = 6;
52pub const SEAMS_SITE_APOLAR: c_int = 7;
53pub const SEAMS_SITE_WATER_O: c_int = 8;
54pub const SEAMS_SITE_WATER_H: c_int = 9;
55pub const SEAMS_SITE_SOLVENT: c_int = 10;
56
57#[repr(C)]
58pub struct seams_system {
59    _private: [u8; 0],
60}
61#[repr(C)]
62pub struct seams_neighbours {
63    _private: [u8; 0],
64}
65#[repr(C)]
66pub struct seams_rings {
67    _private: [u8; 0],
68}
69#[repr(C)]
70pub struct seams_cage_set {
71    _private: [u8; 0],
72}
73#[repr(C)]
74pub struct seams_brine {
75    _private: [u8; 0],
76}
77#[repr(C)]
78pub struct seams_topo {
79    _private: [u8; 0],
80}
81
82extern "C" {
83    pub fn seams_abi() -> c_int;
84    pub fn seams_version() -> c_int;
85    pub fn seams_version_major() -> c_int;
86    pub fn seams_version_minor() -> c_int;
87    pub fn seams_version_patch() -> c_int;
88    pub fn seams_version_string() -> *const c_char;
89    pub fn seams_status_string(status: c_int) -> *const c_char;
90    pub fn seams_last_error() -> *const c_char;
91    pub fn seams_handle_error(handle: *const c_void) -> *const c_char;
92    pub fn seams_label_name(label: c_int) -> *const c_char;
93    pub fn seams_ring_symmetry_name(symmetry: c_int) -> *const c_char;
94    pub fn seams_set_num_threads(n: c_int) -> c_int;
95    pub fn seams_get_num_threads() -> c_int;
96    pub fn seams_system_create() -> *mut seams_system;
97    pub fn seams_system_destroy(sys: *mut seams_system);
98    pub fn seams_system_set_atoms(
99        sys: *mut seams_system,
100        xyz: *const f64,
101        n: usize,
102        box9: *const f64,
103        box_len: usize,
104        types: *const c_int,
105        ids: *const c_int,
106    ) -> c_int;
107    pub fn seams_system_set_frame(
108        sys: *mut seams_system,
109        xyz: *const f64,
110        n: c_int,
111        box9: *const f64,
112        types: *const c_int,
113        ids: *const c_int,
114    ) -> c_int;
115    pub fn seams_system_set_ortho(
116        sys: *mut seams_system,
117        xyz: *const f64,
118        n: c_int,
119        ox: f64,
120        oy: f64,
121        oz: f64,
122        lx: f64,
123        ly: f64,
124        lz: f64,
125        types: *const c_int,
126        ids: *const c_int,
127    ) -> c_int;
128    pub fn seams_system_read(
129        sys: *mut seams_system,
130        path: *const c_char,
131        frame: c_int,
132        type_filter: c_int,
133    ) -> c_int;
134    pub fn seams_path_nframes(path: *const c_char, nframes: *mut usize) -> c_int;
135    pub fn seams_system_count(sys: *const seams_system) -> c_int;
136    pub fn seams_neighbours_build(
137        sys: *mut seams_system,
138        cutoff: f64,
139        r#type: c_int,
140        graph: c_int,
141        out: *mut *mut seams_neighbours,
142    ) -> c_int;
143    pub fn seams_neighbours_destroy(nb: *mut seams_neighbours);
144    pub fn seams_neighbours_count(nb: *const seams_neighbours) -> c_int;
145    pub fn seams_neighbours_csr(
146        nb: *const seams_neighbours,
147        offsets: *mut *const c_int,
148        n_offsets: *mut c_int,
149        cols: *mut *const c_int,
150        nnz: *mut c_int,
151    ) -> c_int;
152    pub fn seams_neighbours_copy(
153        nb: *const seams_neighbours,
154        offsets: *mut c_int,
155        offsets_cap: usize,
156        n_offsets: *mut usize,
157        cols: *mut c_int,
158        cols_cap: usize,
159        nnz: *mut usize,
160    ) -> c_int;
161    pub fn seams_chill(
162        sys: *mut seams_system,
163        cutoff: f64,
164        r#type: c_int,
165        graph: c_int,
166        rule: c_int,
167        labels: *mut c_int,
168        labels_len: usize,
169        counts9: *mut c_int,
170    ) -> c_int;
171    pub fn seams_chill_plus(
172        sys: *mut seams_system,
173        cutoff: f64,
174        r#type: c_int,
175        graph: c_int,
176        rule: c_int,
177        labels: *mut c_int,
178        counts9: *mut c_int,
179    ) -> c_int;
180    pub fn seams_ql(
181        sys: *mut seams_system,
182        cutoff: f64,
183        r#type: c_int,
184        order_l: c_int,
185        graph: c_int,
186        ql: *mut f64,
187        ql_len: usize,
188        qlbar: *mut f64,
189        qlbar_len: usize,
190    ) -> c_int;
191    pub fn seams_q4q6(
192        sys: *mut seams_system,
193        cutoff: f64,
194        r#type: c_int,
195        q4: *mut f64,
196        q6: *mut f64,
197    ) -> c_int;
198    pub fn seams_q6bar(
199        sys: *mut seams_system,
200        cutoff: f64,
201        r#type: c_int,
202        ice_cut: f64,
203        q6bar: *mut f64,
204        q6bar_len: usize,
205        mean: *mut f64,
206        median: *mut f64,
207        n_ice: *mut c_int,
208    ) -> c_int;
209    pub fn seams_rings_find(
210        sys: *mut seams_system,
211        cutoff: f64,
212        r#type: c_int,
213        graph: c_int,
214        max_depth: c_int,
215        out: *mut *mut seams_rings,
216    ) -> c_int;
217    pub fn seams_rings_destroy(rings: *mut seams_rings);
218    pub fn seams_rings_count(rings: *const seams_rings) -> c_int;
219    pub fn seams_rings_histogram(
220        rings: *const seams_rings,
221        counts: *mut c_int,
222        counts_len: c_int,
223    ) -> c_int;
224    pub fn seams_rings_labels(
225        rings: *const seams_rings,
226        sizes: *mut c_int,
227        symmetry: *mut c_int,
228    ) -> c_int;
229    pub fn seams_rings_vertices(
230        rings: *const seams_rings,
231        index: c_int,
232        atoms: *mut c_int,
233        cap: usize,
234        n_out: *mut usize,
235    ) -> c_int;
236    pub fn seams_rings_chordless(
237        nb: *const seams_neighbours,
238        size: c_int,
239        rings: *mut c_int,
240        rings_len: usize,
241        n_rings: *mut usize,
242        per_atom: *mut c_int,
243        per_atom_len: usize,
244    ) -> c_int;
245    pub fn seams_rings_fraction(
246        rings: *const seams_rings,
247        size: c_int,
248        fraction: *mut f64,
249    ) -> c_int;
250    pub fn seams_cages_find(
251        sys: *mut seams_system,
252        cutoff: f64,
253        r#type: c_int,
254        graph: c_int,
255        k: c_int,
256        complete: c_int,
257        out: *mut *mut seams_cage_set,
258    ) -> c_int;
259    pub fn seams_cages_destroy(cages: *mut seams_cage_set);
260    pub fn seams_cages_counts(
261        cages: *const seams_cage_set,
262        n_hex: *mut c_int,
263        n_cubic: *mut c_int,
264        n_water: *mut c_int,
265        n_both: *mut c_int,
266    ) -> c_int;
267    pub fn seams_cages_labels(
268        cages: *const seams_cage_set,
269        per_atom: *mut c_int,
270        len: usize,
271    ) -> c_int;
272    pub fn seams_cages_signature(
273        sys: *mut seams_system,
274        cutoff: f64,
275        r#type: c_int,
276        graph: c_int,
277        spec: *const c_char,
278        n_cages: *mut usize,
279        n_atoms: *mut usize,
280    ) -> c_int;
281    pub fn seams_system_symmetry(
282        sys: *mut seams_system,
283        shell_rmsd: f64,
284        labels: *mut c_int,
285        labels_len: usize,
286    ) -> c_int;
287    pub fn seams_brine_analyse(
288        sys: *mut seams_system,
289        ice: *const c_int,
290        n_ice: usize,
291        water_type: c_int,
292        ion_type: c_int,
293        n_bins: c_int,
294        axis: c_int,
295        out: *mut *mut seams_brine,
296    ) -> c_int;
297    pub fn seams_brine_destroy(front: *mut seams_brine);
298    pub fn seams_brine_fronts(
299        front: *const seams_brine,
300        z_enter: *mut f64,
301        z_exit: *mut f64,
302        thickness: *mut f64,
303        found: *mut c_int,
304    ) -> c_int;
305    pub fn seams_brine_rejection(
306        front: *const seams_brine,
307        c_ice: *mut f64,
308        c_liquid: *mut f64,
309        k: *mut f64,
310        defined: *mut c_int,
311    ) -> c_int;
312    pub fn seams_brine_profile(
313        front: *const seams_brine,
314        z_mid: *mut f64,
315        molality: *mut f64,
316        ice_fraction: *mut f64,
317        cap: usize,
318        n_out: *mut usize,
319    ) -> c_int;
320    pub fn seams_brine_pockets(
321        front: *const seams_brine,
322        n_pockets: *mut c_int,
323        reservoir_waters: *mut c_int,
324    ) -> c_int;
325    pub fn seams_cages(
326        sys: *mut seams_system,
327        cutoff: f64,
328        r#type: c_int,
329        graph: c_int,
330        k: c_int,
331        complete: c_int,
332        out: *mut *mut seams_cage_set,
333    ) -> c_int;
334    pub fn seams_signature_cages(
335        sys: *mut seams_system,
336        cutoff: f64,
337        r#type: c_int,
338        graph: c_int,
339        spec: *const c_char,
340        n_cages: *mut usize,
341        n_atoms: *mut usize,
342    ) -> c_int;
343    pub fn seams_signature_cages_edge(
344        sys: *mut seams_system,
345        cutoff: f64,
346        r#type: c_int,
347        graph: c_int,
348        spec: *const c_char,
349        edge: *const c_char,
350        n_cages: *mut usize,
351        n_atoms: *mut usize,
352    ) -> c_int;
353    pub fn seams_steinhardt(
354        sys: *mut seams_system,
355        cutoff: f64,
356        r#type: c_int,
357        order_l: c_int,
358        ql: *mut f64,
359        ql_len: usize,
360        qlbar: *mut f64,
361        qlbar_len: usize,
362    ) -> c_int;
363    pub fn seams_neighbours_knn(
364        sys: *mut seams_system,
365        k: c_int,
366        cutoff: f64,
367        r#type: c_int,
368        mutual: c_int,
369        out: *mut *mut seams_neighbours,
370    ) -> c_int;
371    pub fn seams_rdf(
372        sys: *mut seams_system,
373        rmax: f64,
374        bins: c_int,
375        type_i: c_int,
376        type_j: c_int,
377        r: *mut f64,
378        g: *mut f64,
379        count: *mut c_int,
380        cap: usize,
381        n_out: *mut usize,
382        volume: *mut f64,
383    ) -> c_int;
384    pub fn seams_running_cn(
385        sys: *mut seams_system,
386        rmax: f64,
387        bins: c_int,
388        type_i: c_int,
389        type_j: c_int,
390        r: *mut f64,
391        cn: *mut f64,
392        cap: usize,
393        n_out: *mut usize,
394    ) -> c_int;
395    pub fn seams_coordination(
396        sys: *mut seams_system,
397        rmax: f64,
398        bins: c_int,
399        type_i: c_int,
400        type_j: c_int,
401        cn: *mut f64,
402    ) -> c_int;
403    pub fn seams_hbonds(
404        sys: *mut seams_system,
405        cutoff: f64,
406        oxygen_type: c_int,
407        hydrogen_type: c_int,
408        dist_cutoff: f64,
409        angle_cutoff: f64,
410        n_bonds: *mut c_int,
411    ) -> c_int;
412    pub fn seams_density_axis(
413        sys: *mut seams_system,
414        r#type: c_int,
415        bins: c_int,
416        axis: c_int,
417        z: *mut f64,
418        rho: *mut f64,
419        cap: usize,
420        n_out: *mut usize,
421    ) -> c_int;
422    pub fn seams_fingerprint(
423        sys: *mut seams_system,
424        cutoff: f64,
425        r#type: c_int,
426        k: c_int,
427        graph: c_int,
428        hops: c_int,
429        color_types: c_int,
430        out: *mut *mut seams_topo,
431    ) -> c_int;
432    pub fn seams_fingerprint_destroy(fp: *mut seams_topo);
433    pub fn seams_fingerprint_key(
434        fp: *const seams_topo,
435        buf: *mut c_char,
436        cap: usize,
437        n_out: *mut usize,
438    ) -> c_int;
439    pub fn seams_fingerprint_atom(
440        fp: *const seams_topo,
441        index: c_int,
442        buf: *mut c_char,
443        cap: usize,
444        n_out: *mut usize,
445    ) -> c_int;
446    pub fn seams_fingerprint_rings(
447        fp: *const seams_topo,
448        counts: *mut c_int,
449        counts_len: usize,
450    ) -> c_int;
451    pub fn seams_contact_pairs(
452        sys: *mut seams_system,
453        site_spec: *const c_char,
454        n_pairs: *mut usize,
455        n_cation: *mut c_int,
456        n_anion: *mut c_int,
457    ) -> c_int;
458    pub fn seams_domains(
459        sys: *mut seams_system,
460        cutoff: f64,
461        site_spec: *const c_char,
462        subset: c_int,
463        n_subset: *mut c_int,
464        largest: *mut c_int,
465        percolation: *mut f64,
466    ) -> c_int;
467    pub fn seams_prisms(
468        sys: *mut seams_system,
469        cutoff: f64,
470        r#type: c_int,
471        perfect: *mut c_int,
472        imperfect: *mut c_int,
473        len: usize,
474    ) -> c_int;
475    pub fn seams_monolayer(
476        sys: *mut seams_system,
477        cutoff: f64,
478        r#type: c_int,
479        max_depth: c_int,
480        sheet_area: f64,
481        counts: *mut c_int,
482        counts_len: usize,
483    ) -> c_int;
484    pub fn seams_site_table(
485        sys: *mut seams_system,
486        spec: *const c_char,
487        kinds: *mut c_int,
488        len: usize,
489    ) -> c_int;
490    pub fn seams_last_error_message() -> *const c_char;
491    pub fn seams_system_natoms(sys: *const seams_system, n: *mut usize) -> c_int;
492    pub fn seams_neighbours_nrows(nb: *const seams_neighbours, n: *mut usize) -> c_int;
493    pub fn seams_rings_nrings(rings: *const seams_rings, n: *mut usize) -> c_int;
494    pub fn seams_chill_plus_n(
495        sys: *mut seams_system,
496        cutoff: f64,
497        r#type: c_int,
498        graph: c_int,
499        rule: c_int,
500        labels: *mut c_int,
501        labels_len: usize,
502        counts9: *mut c_int,
503    ) -> c_int;
504    pub fn seams_q4q6_n(
505        sys: *mut seams_system,
506        cutoff: f64,
507        r#type: c_int,
508        q4: *mut f64,
509        q4_len: usize,
510        q6: *mut f64,
511        q6_len: usize,
512    ) -> c_int;
513    pub fn seams_rings_labels_n(
514        rings: *const seams_rings,
515        sizes: *mut c_int,
516        sizes_len: usize,
517        symmetry: *mut c_int,
518        symmetry_len: usize,
519    ) -> c_int;
520    pub fn seams_rings_histogram_n(
521        rings: *const seams_rings,
522        counts: *mut c_int,
523        counts_len: usize,
524    ) -> c_int;
525    pub fn seams_system_set_positions(
526        sys: *mut seams_system,
527        xyz: *const f64,
528        n: usize,
529        box9: *const f64,
530        box_len: usize,
531    ) -> c_int;
532    pub fn seams_system_stage_positions(sys: *mut seams_system, enable: c_int) -> c_int;
533    pub fn seams_system_box(sys: *const seams_system, box9: *mut f64, box_len: usize) -> c_int;
534    pub fn seams_system_positions(sys: *const seams_system, xyz: *mut f64, len: usize) -> c_int;
535    pub fn seams_system_types(sys: *const seams_system, types: *mut c_int, len: usize) -> c_int;
536    pub fn seams_system_ids(sys: *const seams_system, ids: *mut c_int, len: usize) -> c_int;
537}