grid.h 5.12 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
#ifndef _GRID_H
#define _GRID_H

4
#include "cdi.h"
5
#include <stdbool.h>
6

Uwe Schulzweida's avatar
Uwe Schulzweida committed
7
typedef unsigned char mask_t;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
8

9
10
11
12
13
typedef struct grid_t grid_t;

struct gridVirtTable
{
  void (*destroy)(grid_t *gridptr);
Thomas Jahns's avatar
Thomas Jahns committed
14
15
16
  grid_t *(*copy)(grid_t *gridptr);
  void (*copyScalarFields)(grid_t *gridptrOrig, grid_t *gridptrDup);
  void (*copyArrayFields)(grid_t *gridptrOrig, grid_t *gridptrDup);
17
18
19
20
21
22
23
24
25
26
27
28
29
  void (*defXVals)(grid_t *gridptr, const double *xvals);
  void (*defYVals)(grid_t *gridptr, const double *yvals);
  void (*defMask)(grid_t *gridptr, const int *mask);
  void (*defMaskGME)(grid_t *gridptr, const int *mask);
  void (*defXBounds)(grid_t *gridptr, const double *xbounds);
  void (*defYBounds)(grid_t *gridptr, const double *ybounds);
  void (*defArea)(grid_t *gridptr, const double *area);
  double (*inqXVal)(grid_t *gridptr, int index);
  double (*inqYVal)(grid_t *gridptr, int index);
  int (*inqXVals)(grid_t *gridptr, double *xvals);
  int (*inqYVals)(grid_t *gridptr, double *yvals);
  const double *(*inqXValsPtr)(grid_t *gridptr);
  const double *(*inqYValsPtr)(grid_t *gridptr);
30
  /* return if for both grids, all xval and all yval are equal */
31
  bool (*compareXYFull)(grid_t *gridRef, grid_t *gridTest);
32
33
  /* return if for both grids, x[0], y[0], x[size-1] and y[size-1] are
   * respectively equal */
34
  bool (*compareXYAO)(grid_t *gridRef, grid_t *gridTest);
35
  void (*inqArea)(grid_t *gridptr, double *area);
36
  const double *(*inqAreaPtr)(grid_t *gridptr);
Thomas Jahns's avatar
Thomas Jahns committed
37
  int (*hasArea)(grid_t *gridptr);
38
39
40
41
42
43
44
45
  int (*inqMask)(grid_t *gridptr, int *mask);
  int (*inqMaskGME)(grid_t *gridptr, int *mask_gme);
  int (*inqXBounds)(grid_t *gridptr, double *xbounds);
  int (*inqYBounds)(grid_t *gridptr, double *ybounds);
  const double *(*inqXBoundsPtr)(grid_t *gridptr);
  const double *(*inqYBoundsPtr)(grid_t *gridptr);
};

46
47
struct gridaxis_t {
  char    name[CDI_MAX_NAME];
48
  char    longname[CDI_MAX_NAME];
49
  char    units[CDI_MAX_NAME];
50
  char    dimname[CDI_MAX_NAME];
51
  const char *stdname;
52
  int     size;                  // number of values
53
  double *vals;
54
  double *bounds;
55
56
};

57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Lambert Conformal Conic
struct grid_lcc_t {
  double  originLon;
  double  originLat;
  double  lonParY;
  double  lat1;
  double  lat2;
  double  xinc;
  double  yinc;
  int     projflag;
  int     scanflag;
  short   defined;
};

71
72
73
74
75
76
77
// Lambert Conformal Conic 2
struct grid_lcc2_t {
  double  lon_0;
  double  lat_0;
  double  lat_1;
  double  lat_2;
  double  a;
78
  short   defined;
79
80
};

81
82
83
84
85
86
87
88
// Lambert Azimuthal Equal Area
struct grid_laea_t {
  double  lon_0;
  double  lat_0;
  double  a;
  short   defined;
};

89
90
91
92
93
// GME Grid
struct grid_gme_t {
  int     nd, ni, ni2, ni3;       /* parameter for GRID_GME         */
};

94
struct grid_t {
Uwe Schulzweida's avatar
Uwe Schulzweida committed
95
96
97
  int     self;
  int     type;                   /* grid type                      */
  int     prec;                   /* grid precision                 */
98
  int     proj;                   /* grid projection                */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
99
100
  mask_t *mask;
  mask_t *mask_gme;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
101
102
103
104
  double *area;
  double  xfirst, yfirst;
  double  xlast, ylast;
  double  xinc, yinc;
105
  struct grid_lcc_t  lcc;
106
  struct grid_lcc2_t lcc2;
107
  struct grid_laea_t laea;
108
  struct grid_gme_t  gme;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
109
  double  xpole, ypole, angle;    /* rotated north pole             */
110
111
112
113
  short   isCyclic;               /* TRUE for global cyclic grids   */
  short   isRotated;              /* TRUE for rotated grids         */
  short   xdef;                   /* 0: undefined 1:xvals 2:x0+xinc */
  short   ydef;                   /* 0: undefined 1:yvals 2:y0+yinc */
114
  int     number, position;       /* parameter for GRID_REFERENCE   */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
115
116
  int     trunc;                  /* parameter for GRID_SPECTEAL    */
  int     nvertex;
117
118
  char   *reference;
  unsigned char uuid[CDI_UUID_SIZE]; /* uuid for grid reference        */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
119
120
121
  int    *rowlon;
  int     nrowlon;
  int     size;
122
  int     np;                     /* number of parallels between a pole and the equator */
123
124
  bool    lcomplex;
  bool    hasdims;
125
  char    vdimname[CDI_MAX_NAME];
Uwe Schulzweida's avatar
Uwe Schulzweida committed
126
  char   *name;
127
128
  struct gridaxis_t x;
  struct gridaxis_t y;
129
130
131
  const struct gridVirtTable *vtable;
  void *extraData;
};
Uwe Schulzweida's avatar
Uwe Schulzweida committed
132
133


Uwe Schulzweida's avatar
Uwe Schulzweida committed
134
void grid_init(grid_t *gridptr);
135
136
void
cdiGridTypeInit(grid_t *gridptr, int gridtype, int size);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
137
void grid_free(grid_t *gridptr);
138
grid_t *gridID2Ptr(int gridID);
139
extern const struct gridVirtTable cdiGridVtable;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
140

Thomas Jahns's avatar
Thomas Jahns committed
141
unsigned cdiGridCount(void);
142

Uwe Schulzweida's avatar
Uwe Schulzweida committed
143
144
145
const double *gridInqXvalsPtr(int gridID);
const double *gridInqYvalsPtr(int gridID);

146
147
const double *gridInqXboundsPtr(int gridID);
const double *gridInqYboundsPtr(int gridID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
148
149
const double *gridInqAreaPtr(int gridID);

150
151
152
const char *gridInqXnamePtr(int gridID);
const char *gridInqYnamePtr(int gridID);

153
154
const char *gridInqReferencePtr(int gridID);

155
int gridGenerate(const grid_t *grid);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
156

Thomas Jahns's avatar
Thomas Jahns committed
157
void cdiGridGetIndexList(unsigned, int * );
Uwe Schulzweida's avatar
Uwe Schulzweida committed
158

159
160
void
gridUnpack(char * unpackBuffer, int unpackBufferSize,
161
           int * unpackBufferPos, int originNamespace, void *context,
162
163
           int force_id);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
164
struct addIfNewRes
165
166
167
168
169
{
  int Id;
  int isNew;
};

Uwe Schulzweida's avatar
Uwe Schulzweida committed
170
struct addIfNewRes cdiVlistAddGridIfNew(int vlistID, grid_t *grid, int mode);
171

Uwe Schulzweida's avatar
Uwe Schulzweida committed
172
#endif
173
174
175
176
177
178
179
180
181
/*
 * Local Variables:
 * c-file-style: "Java"
 * c-basic-offset: 2
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */