vlsvrs 1.0.0

VLSV reader with C and Python bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

#pragma once
#include "stddef.h"

/*
WARNING
The ownership of the pointers returned is passed to the c callsite
So it is the user's responsibillity to free the pointers!!!
*/

typedef struct {
  size_t nx;
  size_t ny;
  size_t nz;
  size_t nc;
  double xmin;
  double ymin;
  double zmin;
  double xmax;
  double ymax;
  double zmax;
  void *data;
  size_t datasize;  
} VLSVRS_GenericGrid;

typedef struct {
  size_t nx;
  size_t ny;
  size_t nz;
  size_t nc;
  double xmin;
  double ymin;
  double zmin;
  double xmax;
  double ymax;
  double zmax;
  float *data;
} VLSVRS_Grid32;

typedef struct {
  size_t nx;
  size_t ny;
  size_t nz;
  size_t nc;
  double xmin;
  double ymin;
  double zmin;
  double xmax;
  double ymax;
  double zmax;
  double *data;
} VLSVRS_Grid64;

extern "C"{
  VLSVRS_GenericGrid read_var(const char *fname, const char *varname, int op);
  VLSVRS_Grid32 read_var_32(const char *fname, const char *varname, int op);
  VLSVRS_Grid32 read_vector_var_32(const char *fname, const char *varname,
                                   size_t component);
  VLSVRS_Grid64 read_vector_var_64(const char *fname, const char *varname,
                                   size_t component);
  VLSVRS_Grid32 read_var_zoom_32(const char *fname, const char *varname, int op,
                                 double scale_factor);
  VLSVRS_Grid64 read_var_zoom_64(const char *fname, const char *varname, int op,
                                 double scale_factor);
  VLSVRS_Grid64 read_var_64(const char *fname, const char *varname, int op);
  VLSVRS_GenericGrid read_vdf(const char *fname, const char *pop, size_t cid);
  VLSVRS_Grid32 read_vdf_32(const char *fname, const char *pop, size_t cid);
  VLSVRS_Grid64 read_vdf_64(const char *fname, const char *pop, size_t cid);
  void read_vdf_into_32(const char *fname, const char *pop, size_t cid,
                        VLSVRS_Grid32 *target);
  void read_vdf_into_64(const char *fname, const char *pop, size_t cid,
                        VLSVRS_Grid64 *target);
  double read_scalar_parameter(const char *fname, const char *parameter);
  size_t get_wid(const char *fname, const char *pop);
}
#ifdef VLSVRS_STRIP_PREFIX
#define VLSVRS_Grid32 Grid32
#define VLSVRS_Grid64 Grid64
#endif