Program Listing for File t8_netcdf.h

↰ Return to documentation for file (src/t8_netcdf.h)

/*
  This file is part of t8code.
  t8code is a C library to manage a collection (a forest) of multiple
  connected adaptive space-trees of general element classes in parallel.

  Copyright (C) 2015 the developers

  t8code is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  t8code is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with t8code; if not, write to the Free Software Foundation, Inc.,
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/

#ifndef T8_NETCDF_H
#define T8_NETCDF_H

#include <t8.h>

T8_EXTERN_C_BEGIN ();

typedef int64_t t8_nc_int64_t;

typedef int32_t t8_nc_int32_t;

typedef enum t8_netcdf_variable_type {
  T8_NETCDF_INT = 0,
  T8_NETCDF_INT64 = 1,
  T8_NETCDF_DOUBLE = 2
} t8_netcdf_variable_type_t;

typedef struct
{
  const char *variable_name;
  const char *variable_long_name;
  const char *variable_units;
  t8_netcdf_variable_type_t datatype;
  int var_user_dimid;
  sc_array_t *var_user_data;
} t8_netcdf_variable_t;

t8_netcdf_variable_t *
t8_netcdf_create_var (t8_netcdf_variable_type_t var_type, const char *var_name, const char *var_long_name,
                      const char *var_unit, sc_array_t *var_data);

t8_netcdf_variable_t *
t8_netcdf_create_integer_var (const char *var_name, const char *var_long_name, const char *var_unit,
                              sc_array_t *var_data);

t8_netcdf_variable_t *
t8_netcdf_create_double_var (const char *var_name, const char *var_long_name, const char *var_unit,
                             sc_array_t *var_data);

/* Free the allocated NetCDF variable */
void
t8_netcdf_variable_destroy (t8_netcdf_variable_t *var_destroy);

T8_EXTERN_C_END ();

#endif /* T8_NETCDF_H */