gtool_file.h File Reference

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>

Include dependency graph for gtool_file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	datainfo_t

Macros
#define	File_HSHORT   16
#define	File_HMID   64
#define	File_HLONG   256
#define	File_REAL4   0
#define	File_REAL8   1
#define	File_INTEGER2   2
#define	File_INTEGER4   3
#define	File_INTEGER8   4
#define	File_FREAD   0
#define	File_FWRITE   1
#define	File_FAPPEND   2
#define	ERROR_CODE   -1
#define	SUCCESS_CODE   0
#define	ALREADY_CLOSED_CODE   1
#define	ALREADY_EXISTED_CODE   2
#define	MAX_RANK   10

Functions
typedef	float (real32_t)
typedef	double (real64_t)
int32_t	file_open (int32_t *fid, char *fname, int32_t mode)
int32_t	file_set_option (int32_t fid, char *filetype, char *key, char *val)
int32_t	file_get_datainfo (datainfo_t *dinfo, int32_t fid, char *varname, int32_t step, int32_t suppress)
int32_t	file_read_data (void *var, datainfo_t *dinfo, int32_t precision)
int32_t	file_get_global_attribute_text (int32_t fid, char *key, char *value, int32_t len)
int32_t	file_get_global_attribute_int (int32_t fid, char *key, int32_t *value, size_t len)
int32_t	file_get_global_attribute_float (int32_t fid, char *key, float *value, size_t len)
int32_t	file_get_global_attribute_double (int32_t fid, char *key, double *value, size_t len)
int32_t	file_set_global_attribute_text (int32_t fid, char *key, char *value)
int32_t	file_set_global_attribute_int (int32_t fid, char *key, int32_t *value, size_t len)
int32_t	file_set_global_attribute_float (int32_t fid, char *key, float *value, size_t len)
int32_t	file_set_global_attribute_double (int32_t fid, char *key, double *value, size_t len)
int32_t	file_set_tunits (int32_t fid, char *time_units)
int32_t	file_set_tattr (int32_t fid, char *vname, char *key, char *val)
int32_t	file_put_axis (int32_t fid, char *name, char *desc, char *units, char *dim_name, int32_t dtype, void *val, int32_t size, int32_t precision)
int32_t	file_def_axis (int32_t fid, char *name, char *desc, char *units, char *dim_name, int32_t dtype, int32_t dim_size)
int32_t	file_write_axis (int32_t fid, char *name, void *val, int32_t precision)
int32_t	file_put_associated_coordinates (int32_t fid, char *name, char *desc, char *units, char **dim_names, int32_t ndims, int32_t dtype, void *val, int32_t precision)
int32_t	file_def_associated_coordinates (int32_t fid, char *name, char *desc, char *units, char **dim_names, int32_t ndims, int32_t dtype)
int32_t	file_write_associated_coordinates (int32_t fid, char *name, void *val, int32_t precision)
int32_t	file_add_variable (int32_t *vid, int32_t fid, char *varname, char *desc, char *units, char **dims, int32_t ndims, int32_t dtype, real64_t tint, int32_t tavg)
int32_t	file_write_data (int32_t fid, int32_t vid, void *var, real64_t t_start, real64_t t_end, int32_t precision)
int32_t	file_write_var (int32_t vid, void *var, real64_t t_start, real64_t t_end, int32_t precision)
int32_t	file_enddef (int32_t fid)
int32_t	file_close (int32_t fid)

Macro Definition Documentation

File_HSHORT

#define File_HSHORT   16

Definition at line 11 of file gtool_file.h.

Referenced by file_set_option_(), file_set_tattr_(), file_write_associated_coordinates_(), and file_write_axis_().

File_HMID

#define File_HMID   64

Definition at line 12 of file gtool_file.h.

Referenced by file_set_option_(), and file_set_tunits_().

File_HLONG

#define File_HLONG   256

Definition at line 13 of file gtool_file.h.

Referenced by file_set_tattr_().

File_REAL4

#define File_REAL4   0

Definition at line 16 of file gtool_file.h.

File_REAL8

#define File_REAL8   1

Definition at line 17 of file gtool_file.h.

File_INTEGER2

#define File_INTEGER2   2

Definition at line 18 of file gtool_file.h.

File_INTEGER4

#define File_INTEGER4   3

Definition at line 19 of file gtool_file.h.

File_INTEGER8

#define File_INTEGER8   4

Definition at line 20 of file gtool_file.h.

File_FREAD

#define File_FREAD   0

Definition at line 23 of file gtool_file.h.

File_FWRITE

#define File_FWRITE   1

Definition at line 24 of file gtool_file.h.

File_FAPPEND

#define File_FAPPEND   2

Definition at line 25 of file gtool_file.h.

ERROR_CODE

#define ERROR_CODE   -1

Definition at line 28 of file gtool_file.h.

Referenced by file_set_option().

SUCCESS_CODE

#define SUCCESS_CODE   0

Definition at line 29 of file gtool_file.h.

Referenced by file_enddef(), file_set_option(), file_set_tattr(), and file_set_tunits().

ALREADY_CLOSED_CODE

#define ALREADY_CLOSED_CODE   1

Definition at line 30 of file gtool_file.h.

Referenced by file_close(), file_enddef(), file_set_option(), file_set_tattr(), file_write_associated_coordinates(), file_write_axis(), file_write_data(), and file_write_var().

ALREADY_EXISTED_CODE

#define ALREADY_EXISTED_CODE   2

Definition at line 31 of file gtool_file.h.

Referenced by file_set_tattr().

MAX_RANK

#define MAX_RANK   10

Definition at line 34 of file gtool_file.h.

Function Documentation

float()

typedef float

(

real32_t

)

Referenced by scale_atmos_phy_ae_kajino13::aerosol_nucleation(), scale_atmos_phy_ae_kajino13::atmos_phy_ae_kajino13_setup(), and scale_atmos_phy_rd_mm5sw::swpara().

Here is the caller graph for this function:

double()

typedef double

(

real64_t

)

file_open()

int32_t file_open	(	int32_t *	fid,
		char *	fname,
		int32_t	mode
	)

Definition at line 97 of file gtool_netcdf.c.

Referenced by gtool_file::filemakefname().

{
  int ncid;
  int len;
  char _fname[File_HLONG+4];

  if ( nfile >= FILE_MAX ) {
    fprintf(stderr, "exceed max number of file limit\n");
    return ERROR_CODE;
  }

  len = strlen(fname);
  strcpy(_fname, fname);
  if (fname[len-3] != '.' || fname[len-2] != 'n' || fname[len-1] != 'c' )
    strcat(_fname, ".nc");

  switch ( mode ) {
  case File_FREAD:
    CHECK_ERROR( nc_open(_fname, NC_NOWRITE, &ncid) );
    break;
  case File_FWRITE:
#ifdef NETCDF3
    CHECK_ERROR( nc_create(_fname, NC_CLOBBER, &ncid) );
#else
    CHECK_ERROR( nc_create(_fname, NC_CLOBBER|NC_NETCDF4, &ncid) );
#endif
    break;
  case File_FAPPEND:
    CHECK_ERROR( nc_open(_fname, NC_WRITE, &ncid) );
    break;
  default:
    fprintf(stderr, "invalid mode type\n");
    return ERROR_CODE;
  }

  files[nfile] = (fileinfo_t*) malloc(sizeof(fileinfo_t));
  files[nfile]->ncid = ncid;
  files[nfile]->deflate_level = DEFAULT_DEFLATE_LEVEL;
#ifdef NETCDF3
  files[nfile]->defmode = 1;
#endif
  *fid = nfile;
  nfile++;

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_option()

int32_t file_set_option	(	int32_t	fid,
		char *	filetype,
		char *	key,
		char *	val
	)

Definition at line 146 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, fileinfo_t::deflate_level, ERROR_CODE, and SUCCESS_CODE.

Referenced by gtool_file::filesetoption().

{
  if ( strcmp(filetype, "netcdf") != 0 ) return SUCCESS_CODE;

  if ( strcmp(key, "deflate_level") == 0 ) {
    if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
    files[fid]->deflate_level = atoi(val);
    return SUCCESS_CODE;
  } else {
    return ERROR_CODE;
  }
}

Here is the caller graph for this function:

file_get_datainfo()

int32_t file_get_datainfo	(	datainfo_t *	dinfo,
		int32_t	fid,
		char *	varname,
		int32_t	step,
		int32_t	suppress
	)

Definition at line 162 of file gtool_netcdf.c.

Referenced by gtool_file::filegetalldatainfo(), gtool_file::filegetdatainfo(), and gtool_file::filegetshape().

{
  int ncid, varid;
  nc_type xtype;
  int rank;
  int dimids[MAX_RANK], tdim, uldims[NC_MAX_DIMS];
  char name[File_HSHORT+1];
  size_t size;
  size_t idx[2];
  int i, n;

  ERROR_SUPPRESS = suppress;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;
  CHECK_ERROR( nc_inq_varid(ncid, varname, &varid) );

  // fid
  dinfo->fid = fid;
  // varname
  strcpy(dinfo->varname, varname);
  // description
  CHECK_ERROR( nc_get_att_text(ncid, varid, "long_name", dinfo->description) );
  // units
  CHECK_ERROR( nc_get_att_text(ncid, varid, "units", dinfo->units) );
  // datatype
  CHECK_ERROR( nc_inq_vartype(ncid, varid, &xtype) );
  NCTYPE2TYPE(xtype, dinfo->datatype);
  // rank
  CHECK_ERROR( nc_inq_varndims(ncid, varid, &rank) );
  CHECK_ERROR( nc_inq_vardimid(ncid, varid, dimids) );
#ifdef NETCDF3
  CHECK_ERROR( nc_inq_unlimdim(ncid, uldims) );
  n = 1;
#else
  CHECK_ERROR( nc_inq_unlimdims(ncid, &n, uldims) );
#endif
  tdim = -1;
  for ( i=0; i<n; i++ ) {
    if ( uldims[i] == dimids[0] ) {
      tdim = uldims[i];
      break;
    }
  }
  if (rank > MAX_RANK) {
    fprintf(stderr, "rank exceeds limit: %d\n", rank);
    return ERROR_CODE;
  }
  dinfo->rank = tdim >= 0 ? rank -1 : rank; // do not count time dimension
  // dim_name and dim_size
  for (i=0; i<dinfo->rank; i++) {
    // note: C and Fortran orders are opposit
    CHECK_ERROR( nc_inq_dim(ncid, dimids[rank-i-1], name, &size) );
    strncpy(dinfo->dim_name+i*File_HSHORT, name, File_HSHORT);
    dinfo->dim_size[i] = size;
  }

  dinfo->step = step;
  if ( tdim >= 0 ) {
    // time_end
    CHECK_ERROR( nc_inq_dimname(ncid, tdim, name) );
    CHECK_ERROR( nc_inq_varid(ncid, name, &varid) );
    idx[0] = step - 1;
    CHECK_ERROR( nc_get_var1_double(ncid, varid, idx, &(dinfo->time_end)) );
    // time_start
    strcat(name, "_bnds");
    CHECK_ERROR( nc_inq_varid(ncid, name, &varid) );
    idx[1] = 0;
    CHECK_ERROR( nc_get_var1_double(ncid, varid, idx, &(dinfo->time_start)) );
    // units
    CHECK_ERROR( nc_get_att_text(ncid, varid, "units", dinfo->time_units) );
  } else {
  }

  ERROR_SUPPRESS = 0;

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_read_data()

int32_t file_read_data	(	void *	var,
		datainfo_t *	dinfo,
		int32_t	precision
	)

Definition at line 245 of file gtool_netcdf.c.

Referenced by gtool_file::filegetalldatainfo().

{
  int ncid, varid;
  int rank;
  size_t *start, *count;
  int i;
  int status;

  if ( files[dinfo->fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[dinfo->fid]->ncid;
  CHECK_ERROR( nc_inq_varid(ncid, dinfo->varname, &varid) );

  CHECK_ERROR( nc_inq_varndims(ncid, varid, &rank) );
  start = (size_t*) malloc(sizeof(size_t)*rank);
  count = (size_t*) malloc(sizeof(size_t)*rank);
  for (i=0; i<dinfo->rank; i++) {
    // note: C and Fortran orders are opposit
    start[rank -i-1] = 0;
    count[rank -i-1] = dinfo->dim_size[i];
  }
  if (rank > dinfo->rank) { // have time dimension
    start[0] = dinfo->step - 1;
    count[0] = 1;
  }
  switch ( precision ) {
  case 8:
    status = nc_get_vara_double(ncid, varid, start, count, (double*)var);
    free(start);
    free(count);
    CHECK_ERROR(status);
    break;
  case 4:
    status = nc_get_vara_float(ncid, varid, start, count, (float*)var);
    free(start);
    free(count);
    CHECK_ERROR(status);
    break;
  default:
    free(start);
    free(count);
    fprintf(stderr, "unsuppoted data precision: %d\n", precision );
    return ERROR_CODE;
  }

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_get_global_attribute_text()

int32_t file_get_global_attribute_text	(	int32_t	fid,
		char *	key,
		char *	value,
		int32_t	len
	)

Definition at line 294 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;
  size_t l;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_attlen(ncid, NC_GLOBAL, key, &l) );
  if ( len < l+1 ) return ERROR_CODE;

  CHECK_ERROR( nc_get_att_text(ncid, NC_GLOBAL, key, value) );
  value[l] = '\0';

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_get_global_attribute_int()

int32_t file_get_global_attribute_int	(	int32_t	fid,
		char *	key,
		int32_t *	value,
		size_t	len
	)

Referenced by gtool_file::filecreate().

Here is the caller graph for this function:

file_get_global_attribute_float()

int32_t file_get_global_attribute_float	(	int32_t	fid,
		char *	key,
		float *	value,
		size_t	len
	)

Definition at line 332 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;
  size_t l;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_attlen(ncid, NC_GLOBAL, key, &l) );
  if ( len < l ) return ERROR_CODE;
  CHECK_ERROR( nc_get_att_float(ncid, NC_GLOBAL, key, value) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_get_global_attribute_double()

int32_t file_get_global_attribute_double	(	int32_t	fid,
		char *	key,
		double *	value,
		size_t	len
	)

Definition at line 350 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;
  size_t l;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_attlen(ncid, NC_GLOBAL, key, &l) );
  if ( len < l ) return ERROR_CODE;
  CHECK_ERROR( nc_get_att_double(ncid, NC_GLOBAL, key, value) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_global_attribute_text()

int32_t file_set_global_attribute_text	(	int32_t	fid,
		char *	key,
		char *	value
	)

Definition at line 368 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  CHECK_ERROR( nc_put_att_text(ncid, NC_GLOBAL, key, strlen(value), value) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_global_attribute_int()

int32_t file_set_global_attribute_int	(	int32_t	fid,
		char *	key,
		int32_t *	value,
		size_t	len
	)

Referenced by gtool_file::filecreate().

Here is the caller graph for this function:

file_set_global_attribute_float()

int32_t file_set_global_attribute_float	(	int32_t	fid,
		char *	key,
		float *	value,
		size_t	len
	)

Definition at line 411 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  CHECK_ERROR( nc_put_att_float(ncid, NC_GLOBAL, key, NC_FLOAT, len, value) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_global_attribute_double()

int32_t file_set_global_attribute_double	(	int32_t	fid,
		char *	key,
		double *	value,
		size_t	len
	)

Definition at line 433 of file gtool_netcdf.c.

Referenced by gtool_file::filecreate().

{
  int ncid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  CHECK_ERROR( nc_put_att_double(ncid, NC_GLOBAL, key, NC_DOUBLE, len, value) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_tunits()

int32_t file_set_tunits	(	int32_t	fid,
		char *	time_units
	)

Definition at line 455 of file gtool_netcdf.c.

References SUCCESS_CODE.

Referenced by gtool_file::filecreate().

{
  strcpy(files[fid]->time_units, time_units);

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_set_tattr()

int32_t file_set_tattr	(	int32_t	fid,
		char *	vname,
		char *	key,
		char *	val
	)

Definition at line 463 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, ALREADY_EXISTED_CODE, CHECK_ERROR, fileinfo_t::ncid, and SUCCESS_CODE.

Referenced by gtool_file::filesettattr().

{
  int ncid;
  int varid;
  int attid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_varid(ncid, vname, &varid) );

  if ( nc_inq_attid(ncid, varid, key, &attid) == NC_NOERR ) // check if existed
    return ALREADY_EXISTED_CODE;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  CHECK_ERROR( nc_put_att_text(ncid, varid, key, strlen(val), val) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_put_axis()

int32_t file_put_axis	(	int32_t	fid,
		char *	name,
		char *	desc,
		char *	units,
		char *	dim_name,
		int32_t	dtype,
		void *	val,
		int32_t	size,
		int32_t	precision
	)

Definition at line 492 of file gtool_netcdf.c.

Referenced by gtool_file::fileopen().

{
  int ncid, dimid, varid;
  nc_type xtype = -1;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  if ( nc_inq_varid(ncid, name, &varid) == NC_NOERR ) // check if existed
    return ALREADY_EXISTED_CODE;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  if ( nc_inq_dimid(ncid, dim_name, &dimid) != NC_NOERR ) // check if existed
    CHECK_ERROR( nc_def_dim(ncid, dim_name, size, &dimid) );

  TYPE2NCTYPE(dtype, xtype);
  CHECK_ERROR( nc_def_var(ncid, name, xtype, 1, &dimid, &varid) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "long_name", strlen(desc), desc) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "units", strlen(units), units) );

#ifdef NETCDF3
  CHECK_ERROR( nc_enddef(ncid) );
  files[fid]->defmode = 0;
#endif

  switch ( precision ) {
  case 8:
    CHECK_ERROR( nc_put_var_double(ncid, varid, (double*)val) );
    break;
  case 4:
    CHECK_ERROR( nc_put_var_float(ncid, varid, (float*)val) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_def_axis()

int32_t file_def_axis	(	int32_t	fid,
		char *	name,
		char *	desc,
		char *	units,
		char *	dim_name,
		int32_t	dtype,
		int32_t	dim_size
	)

Definition at line 546 of file gtool_netcdf.c.

Referenced by gtool_file::filedefaxis().

{
  int ncid, dimid, varid;
  nc_type xtype = -1;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  if ( nc_inq_varid(ncid, name, &varid) == NC_NOERR ) // check if existed
    return ALREADY_EXISTED_CODE;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  if ( nc_inq_dimid(ncid, dim_name, &dimid) != NC_NOERR ) // check if existed
    CHECK_ERROR( nc_def_dim(ncid, dim_name, dim_size, &dimid) );

  TYPE2NCTYPE(dtype, xtype);
  CHECK_ERROR( nc_def_var(ncid, name, xtype, 1, &dimid, &varid) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "long_name", strlen(desc), desc) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "units", strlen(units), units) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_write_axis()

int32_t file_write_axis	(	int32_t	fid,
		char *	name,
		void *	val,
		int32_t	precision
	)

Definition at line 581 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, CHECK_ERROR, and fileinfo_t::ncid.

Referenced by gtool_file::filedefaxis().

{
  int ncid, varid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_varid(ncid, name, &varid) )

#ifdef NETCDF3
  if (files[fid]->defmode == 1) {
    CHECK_ERROR( nc_enddef(ncid) );
    files[fid]->defmode = 0;
  }
#endif

  switch ( precision ) {
  case 8:
    CHECK_ERROR( nc_put_var_double(ncid, varid, (double*)val) );
    break;
  case 4:
    CHECK_ERROR( nc_put_var_float(ncid, varid, (float*)val) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_put_associated_coordinates()

int32_t file_put_associated_coordinates	(	int32_t	fid,
		char *	name,
		char *	desc,
		char *	units,
		char **	dim_names,
		int32_t	ndims,
		int32_t	dtype,
		void *	val,
		int32_t	precision
	)

Definition at line 615 of file gtool_netcdf.c.

Referenced by gtool_file::filedefaxis().

{
  int ncid, *dimids, varid;
  nc_type xtype = -1;
  int i;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  if ( nc_inq_varid(ncid, name, &varid) == NC_NOERR ) // check if existed
    return ALREADY_EXISTED_CODE;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  dimids = malloc(sizeof(int)*ndims);
  for (i=0; i<ndims; i++)
    CHECK_ERROR( nc_inq_dimid(ncid, dim_names[i], dimids+ndims-i-1) );

  TYPE2NCTYPE(dtype, xtype);

  CHECK_ERROR( nc_def_var(ncid, name, xtype, ndims, dimids, &varid) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "long_name", strlen(desc), desc) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "units", strlen(units), units) );
  free(dimids);

#ifdef NETCDF3
  CHECK_ERROR( nc_enddef(ncid) );
  files[fid]->defmode = 0;
#endif

  switch ( precision ) {
  case 8:
    CHECK_ERROR( nc_put_var_double(ncid, varid, (double*)val) );
    break;
  case 4:
    CHECK_ERROR( nc_put_var_float(ncid, varid, (float*)val) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_def_associated_coordinates()

int32_t file_def_associated_coordinates	(	int32_t	fid,
		char *	name,
		char *	desc,
		char *	units,
		char **	dim_names,
		int32_t	ndims,
		int32_t	dtype
	)

Definition at line 673 of file gtool_netcdf.c.

Referenced by gtool_file::filedefassociatedcoordinates().

{
  int ncid, *dimids, varid;
  nc_type xtype = -1;
  int i;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  if ( nc_inq_varid(ncid, name, &varid) == NC_NOERR ) // check if existed
    return ALREADY_EXISTED_CODE;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  dimids = malloc(sizeof(int)*ndims);
  for (i=0; i<ndims; i++)
    CHECK_ERROR( nc_inq_dimid(ncid, dim_names[i], dimids+ndims-i-1) );

  TYPE2NCTYPE(dtype, xtype);

  CHECK_ERROR( nc_def_var(ncid, name, xtype, ndims, dimids, &varid) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "long_name", strlen(desc), desc) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "units", strlen(units), units) );
  free(dimids);

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_write_associated_coordinates()

int32_t file_write_associated_coordinates	(	int32_t	fid,
		char *	name,
		void *	val,
		int32_t	precision
	)

Definition at line 712 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, CHECK_ERROR, and fileinfo_t::ncid.

Referenced by gtool_file::filedefassociatedcoordinates().

{
  int ncid, varid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  CHECK_ERROR( nc_inq_varid(ncid, name, &varid) );

#ifdef NETCDF3
  if (files[fid]->defmode == 1) {
    CHECK_ERROR( nc_enddef(ncid) );
    files[fid]->defmode = 0;
  }
#endif

  switch ( precision ) {
  case 8:
    CHECK_ERROR( nc_put_var_double(ncid, varid, (double*)val) );
    break;
  case 4:
    CHECK_ERROR( nc_put_var_float(ncid, varid, (float*)val) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_add_variable()

int32_t file_add_variable	(	int32_t *	vid,
		int32_t	fid,
		char *	varname,
		char *	desc,
		char *	units,
		char **	dims,
		int32_t	ndims,
		int32_t	dtype,
		real64_t	tint,
		int32_t	tavg
	)

Definition at line 746 of file gtool_netcdf.c.

Referenced by gtool_file::filedefassociatedcoordinates(), and gtool_file::filedefinevariable().

{
  int ncid, varid, acid, *acdimids;
  int dimids[NC_MAX_DIMS], dimid;
  char tname[File_HSHORT+1];
  int tdimid, tvarid;
  nc_type xtype = -1;
  char buf[File_HMID+1];
  int i, j, k, n, m;
  int nndims;
  size_t size;
  double rmiss = RMISS;
  char coord[File_HMID+1];
  int has_assoc;
  int new;

  if ( nvar >= VAR_MAX ) {
    fprintf(stderr, "exceed max number of variable limit\n");
    return ERROR_CODE;
  }

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  vars[nvar] = (varinfo_t*) malloc(sizeof(varinfo_t));
  vars[nvar]->ncid  = ncid;
  vars[nvar]->t = NULL;
  vars[nvar]->start = NULL;
  vars[nvar]->count = NULL;

#ifdef NETCDF3
  if (files[fid]->defmode == 0) {
    CHECK_ERROR( nc_redef(ncid) );
    files[fid]->defmode = 1;
  }
#endif

  // get time variable
  if ( tint > 0.0 ) {
    for ( i=0; i<nt; i++ ) {
      if ( tdims[i] != NULL && // still opened
           tdims[i]->ncid == ncid && // same file
           tdims[i]->tint == tint ) { // same time interval
        vars[nvar]->t = tdims[i];
        break;
      }
    }
    if ( vars[nvar]->t == NULL ) {
      tdims[nt] = (tdim_t*) malloc(sizeof(tdim_t));
      tdims[nt]->ncid = ncid;
      tdims[nt]->count = -1;
      tdims[nt]->tint = tint;
      // generate name
      if ( nt == 0 )
        strcpy(tname, "time");
      else
        sprintf(tname, "time%d", nt);
      strcpy(tdims[nt]->name, tname);
      // define time dimension and variable
      CHECK_ERROR( nc_def_dim(ncid, tname, 0, &tdimid) );
      tdims[nt]->dimid = tdimid;
      CHECK_ERROR( nc_def_var(ncid, tname, NC_DOUBLE, 1, &tdimid, &tvarid) );
      tdims[nt]->varid = tvarid;
      strcpy(buf, "time");
      CHECK_ERROR( nc_put_att_text(ncid, tvarid, "long_name", strlen(buf), buf) );
      CHECK_ERROR( nc_put_att_text(ncid, tvarid, "units", strlen(files[fid]->time_units), files[fid]->time_units) );
      // define boundary variable
      if ( nc_inq_dimid(ncid, "nv", &(dimids[1])) != NC_NOERR ) // first called
        CHECK_ERROR( nc_def_dim(ncid, "nv", 2, &(dimids[1])) ); // number of vertices
      sprintf(buf, "%s_bnds", tname);
      CHECK_ERROR( nc_put_att_text(ncid, tvarid, "bounds", strlen(buf), buf) );
      dimids[0] = tdimid;
      CHECK_ERROR( nc_def_var(ncid, buf, NC_DOUBLE, 2, dimids, &tvarid) );
      tdims[nt]->bndsid = tvarid;
      CHECK_ERROR( nc_put_att_text(ncid, tvarid, "units", strlen(files[fid]->time_units), files[fid]->time_units) );

      vars[nvar]->t = tdims[nt];
      nt++;
    }
  }

  // get dimension IDs
  // note: C and Fortran order are opposit
  n = ndims;
  if ( tint > 0.0 ) { // add time dimension
    dimids[0] = vars[nvar]->t->dimid;
    ndims++;
  }
  for (i=ndims-n; i<ndims; i++) dimids[i] = -1;

  has_assoc = 0;
  nndims = 0;
  for (i=0; i<n; i++) {
    //printf("%d %s\n", i, dims[i]);
    if ( nc_inq_dimid(ncid, dims[i], &dimid) == NC_NOERR ) {
      //printf("not assoc\n");
      new = 1;
      for (k=0; k<nndims; k++) {
        if (dimid == dimids[k]) {
          new = 0;
          break;
        }
      }
      if (new) {
        dimids[ndims-(++nndims)] = dimid;
      }
    } else {
      //printf("assoc\n");
      CHECK_ERROR( nc_inq_varid(ncid, dims[i], &acid) );
      CHECK_ERROR( nc_inq_varndims(ncid, acid, &m) );
      acdimids = (int*) malloc((sizeof(int)*m));
      CHECK_ERROR( nc_inq_vardimid(ncid, acid, acdimids) );
      for (j=m-1; j>=0; j--) {
        new = 1;
        for (k=0; k<ndims; k++) {
          if (acdimids[j] == dimids[k]) {
            new = 0;
            break;
          }
        }
        if (new) {
          if ( nndims >= ndims ) {
            fprintf(stderr, "Error: invalid associated coordinates\n");
            return ERROR_CODE;
          }
          dimids[ndims-(++nndims)] = acdimids[j];
          //nc_inq_dimname(ncid, acdimids[j], tname);
          //printf("add %s\n", tname);
        }
      }
      free(acdimids);
      has_assoc = 1;
    }
  }
  if (nndims != n) {
    fprintf(stderr, "Error: invalid associated coordinates: %d %d\n", ndims, nndims);
    return ERROR_CODE;
  }

  TYPE2NCTYPE(dtype, xtype);
  CHECK_ERROR( nc_def_var(ncid, varname, xtype, ndims, dimids, &varid) );

  // put variable attribute
  CHECK_ERROR( nc_put_att_text(ncid, varid, "long_name", strlen(desc), desc) );
  CHECK_ERROR( nc_put_att_text(ncid, varid, "units", strlen(units), units) );
  CHECK_ERROR( nc_put_att_double(ncid, varid, _FillValue, xtype, 1, &rmiss) );
  CHECK_ERROR( nc_put_att_double(ncid, varid, "missing_value", xtype, 1, &rmiss) );
  if ( has_assoc ) {
    strcpy(coord, dims[0]);
    for(i=1; i<n; i++) {
      if (strlen(coord)+strlen(dims[i])+1 < File_HMID) {
        strcat(coord, " ");
        strcat(coord, dims[i]);
      }
    }
    if ( ndims > n && strlen(coord)+6 < File_HMID) {
      strcat(coord, " ");
      strcat(coord, vars[nvar]->t->name);
    }
    CHECK_ERROR( nc_put_att_text(ncid, varid, "coordinates", strlen(coord), coord) );
  }


  if ( tavg ) {
    sprintf(buf, "%s: mean", vars[nvar]->t->name);
    CHECK_ERROR( nc_put_att_text(ncid, varid, "cell_methods", strlen(buf), buf) );
  }

  // set start and count
  vars[nvar]->start = (size_t*) malloc(sizeof(size_t)*ndims);
  vars[nvar]->count = (size_t*) malloc(sizeof(size_t)*ndims);
  for ( i=0; i<ndims; i++ ) {
    CHECK_ERROR( nc_inq_dimlen(ncid, dimids[i], &size) );
    vars[nvar]->count[i] = size;
    vars[nvar]->start[i] = 0;
  }
  if ( tint > 0.0 ) vars[nvar]->count[0] = 1;

#ifndef NETCDF3
  // set chunk size and deflate level
  if ( files[fid]->deflate_level > 0 ) {
    CHECK_ERROR( nc_def_var_chunking(ncid, varid, NC_CHUNKED, vars[nvar]->count) );
    CHECK_ERROR( nc_def_var_deflate(ncid, varid, 0, 1, files[fid]->deflate_level) );
  }
#endif

  vars[nvar]->varid = varid;
  *vid = nvar;
  nvar++;

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_write_data()

int32_t file_write_data	(	int32_t	fid,
		int32_t	vid,
		void *	var,
		real64_t	t_start,
		real64_t	t_end,
		int32_t	precision
	)

Definition at line 948 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, CHECK_ERROR, tdim_t::count, varinfo_t::count, varinfo_t::ncid, varinfo_t::start, tdim_t::t, varinfo_t::t, TEPS, and varinfo_t::varid.

Referenced by file_write_data_(), and gtool_file::filegetalldatainfo().

{
  int ncid, varid;

  if ( vars[vid] == NULL ) return ALREADY_CLOSED_CODE;

  ncid = vars[vid]->ncid;

#ifdef NETCDF3
  if (files[fid]->defmode == 1) {
    CHECK_ERROR( nc_enddef(ncid) );
    files[fid]->defmode = 0;
  }
#endif

  varid = vars[vid]->varid;
  if ( vars[vid]->t != NULL ) { // have time dimension
    if ( vars[vid]->t->count < 0 ||  // first time
         t_end > vars[vid]->t->t + TEPS ) { // time goes next step
      vars[vid]->t->count += 1;
      vars[vid]->t->t = t_end;
      size_t index[2];
      index[0] = vars[vid]->t->count;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->varid, index, &t_end) );
      index[1] = 0;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->bndsid, index, &t_start) );
      index[1] = 1;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->bndsid, index, &t_end) );
      vars[vid]->start[0] = vars[vid]->t->count;
    } else {
      size_t nt = vars[vid]->t->count + 1;
      double t[nt];
      size_t s[1];
      int flag, n;
      s[0] = 0;
      CHECK_ERROR( nc_get_vara_double(ncid, vars[vid]->t->varid, s, &nt, t) );
      flag = 1;
      for(n=nt-1;n>=0;n--) {
        if ( fabs(t[n]-t_end) < TEPS ) {
          vars[vid]->start[0] = n;
          flag = 0;
          break;
        }
      }
      if ( flag ) {
        fprintf(stderr, "cannot find time: %f\n", t_end);
        fprintf(stderr, "  time count is : %d, last time is: %f, diff is: %e\n", vars[vid]->t->count < 0, vars[vid]->t->t, vars[vid]->t->t-t_end);
        fprintf(stderr, "  time is: ");
        for (n=0;n<nt;n++) fprintf(stderr, "%f, ", t[n]);
        fprintf(stderr, "\n");
        return ERROR_CODE;
      }
    }
  }

  switch (precision) {
  case 8:
    CHECK_ERROR( nc_put_vara_double(ncid, varid, vars[vid]->start, vars[vid]->count, (double*)var) );
    break;
  case 4:
    CHECK_ERROR( nc_put_vara_float(ncid, varid, vars[vid]->start, vars[vid]->count, (float*)var) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  CHECK_ERROR( nc_sync(ncid) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_write_var()

int32_t file_write_var	(	int32_t	vid,
		void *	var,
		real64_t	t_start,
		real64_t	t_end,
		int32_t	precision
	)

Definition at line 1042 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, CHECK_ERROR, tdim_t::count, varinfo_t::count, varinfo_t::ncid, varinfo_t::start, tdim_t::t, varinfo_t::t, TEPS, and varinfo_t::varid.

Referenced by file_write_var_(), and gtool_file::filegetalldatainfo().

{
  int ncid, varid;

  if ( vars[vid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = vars[vid]->ncid;
  varid = vars[vid]->varid;
  if ( vars[vid]->t != NULL ) { // have time dimension
    if ( vars[vid]->t->count < 0 ||  // first time
         t_end > vars[vid]->t->t + TEPS ) { // time goes next step
      vars[vid]->t->count += 1;
      vars[vid]->t->t = t_end;
      size_t index[2];
      index[0] = vars[vid]->t->count;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->varid, index, &t_end) );
      index[1] = 0;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->bndsid, index, &t_start) );
      index[1] = 1;
      CHECK_ERROR( nc_put_var1_double(ncid, vars[vid]->t->bndsid, index, &t_end) );
      vars[vid]->start[0] = vars[vid]->t->count;
    } else {
      size_t nt = vars[vid]->t->count + 1;
      double t[nt];
      size_t s[1];
      int flag, n;
      s[0] = 0;
      CHECK_ERROR( nc_get_vara_double(ncid, vars[vid]->t->varid, s, &nt, t) );
      flag = 1;
      for(n=nt-1;n>=0;n--) {
        if ( fabs(t[n]-t_end) < TEPS ) {
          vars[vid]->start[0] = n;
          flag = 0;
          break;
        }
      }
      if ( flag ) {
        fprintf(stderr, "cannot find time: %f\n", t_end);
        fprintf(stderr, "  time count is : %d, last time is: %f, diff is: %e\n", vars[vid]->t->count < 0, vars[vid]->t->t, vars[vid]->t->t-t_end);
        fprintf(stderr, "  time is: ");
        for (n=0;n<nt;n++) fprintf(stderr, "%f, ", t[n]);
        fprintf(stderr, "\n");
        return ERROR_CODE;
      }
    }
  }

  switch (precision) {
  case 8:
    CHECK_ERROR( nc_put_vara_double(ncid, varid, vars[vid]->start, vars[vid]->count, (double*)var) );
    break;
  case 4:
    CHECK_ERROR( nc_put_vara_float(ncid, varid, vars[vid]->start, vars[vid]->count, (float*)var) );
    break;
  default:
    fprintf(stderr, "unsuppoted data precision: %d\n", precision);
    return ERROR_CODE;
  }

  CHECK_ERROR( nc_sync(ncid) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_enddef()

int32_t file_enddef

(

int32_t

fid

)

Definition at line 1025 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, CHECK_ERROR, fileinfo_t::ncid, and SUCCESS_CODE.

Referenced by file_enddef_(), and gtool_file::fileenddef().

{
  int ncid;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

#ifdef NETCDF3
  if (files[fid]->defmode == 1) {
    CHECK_ERROR( nc_enddef(ncid) );
    files[fid]->defmode = 0;
  }
#endif

  return SUCCESS_CODE;
}

Here is the caller graph for this function:

file_close()

int32_t file_close

(

int32_t

fid

)

Definition at line 1109 of file gtool_netcdf.c.

References ALREADY_CLOSED_CODE, and fileinfo_t::ncid.

Referenced by file_close_(), and gtool_file::fileclose().

{
  int ncid;
  int i;

  if ( files[fid] == NULL ) return ALREADY_CLOSED_CODE;
  ncid = files[fid]->ncid;

  free( files[fid] );
  files[fid] = NULL;

  for (i=0; i<nvar; i++) {
    if ( vars[i] != NULL && vars[i]->ncid == ncid ) {
      free( vars[i]->start );
      free( vars[i]->count );
      free( vars[i] );
      vars[i] = NULL;
    }
  }

  for (i=0; i<nt; i++) {
    if ( tdims[i] != NULL && tdims[i]->ncid == ncid ) {
      free( tdims[i] );
      tdims[i] = NULL;
    }
  }

  CHECK_ERROR( nc_close(ncid) );

  return SUCCESS_CODE;
}

Here is the caller graph for this function: