netcdf-c/include/netcdf_par.h
Dennis Heimbigner 40cd180957 Fix includes/netcdf_xxx.h files to not include ncexternl.h
re: https://github.com/Unidata/netcdf-c/issues/1502

If you plan to use any of the netcdf_XXX.h files, then it it is assumed
that you first include netcdf.h, followed by any netcdf_XXX.h files
you need. The EXTERNL (and other things) are defined in netcdf.h
so they should be available for use by the netcdf_XXX.h files.

This PR ensures that the above assumption is true.  It also adds
some comments to that effect to the start of the netcdf_xxx.h files.
2019-10-28 10:29:39 -06:00

61 lines
1.6 KiB
C

/*! \file
*
* Main header file for the Parallel C API.
*
* Copyright 2018 University Corporation for Atmospheric
* Research/Unidata. See COPYRIGHT file for more info.
*
* This header file is for the parallel I/O functions of netCDF.
*
* \author Ed Hartnett
*/
/*
* In order to use any of the netcdf_XXX.h files, it is necessary
* to include netcdf.h followed by any netcdf_XXX.h files.
* Various things (like EXTERNL) are defined in netcdf.h
* to make them available for use by the netcdf_XXX.h files.
*/
#ifndef NETCDF_PAR_H
#define NETCDF_PAR_H 1
#include <mpi.h>
#if defined(__cplusplus)
extern "C" {
#endif
/** Use with nc_var_par_access() to set parallel access to independent. */
#define NC_INDEPENDENT 0
/** Use with nc_var_par_access() to set parallel access to collective. */
#define NC_COLLECTIVE 1
/* Create a file and enable parallel I/O. */
EXTERNL int
nc_create_par(const char *path, int cmode, MPI_Comm comm, MPI_Info info,
int *ncidp);
/* Open a file and enable parallel I/O. */
EXTERNL int
nc_open_par(const char *path, int mode, MPI_Comm comm, MPI_Info info,
int *ncidp);
/* Change a variable from independent (the default) to collective
* access. */
EXTERNL int
nc_var_par_access(int ncid, int varid, int par_access);
EXTERNL int
nc_create_par_fortran(const char *path, int cmode, int comm,
int info, int *ncidp);
EXTERNL int
nc_open_par_fortran(const char *path, int mode, int comm,
int info, int *ncidp);
#if defined(__cplusplus)
}
#endif
#endif /* NETCDF_PAR_H */