diff --git a/docs/_c_a_mexample.html b/docs/_c_a_mexample.html deleted file mode 100644 index b9f00626885..00000000000 --- a/docs/_c_a_mexample.html +++ /dev/null @@ -1,115 +0,0 @@ - - -
- - - - -
- PIO
- 2.4.2
-
- |
-
CAM references PIO through both interface routines (which call PIO routines) and PIO routines proper. The interface routines control much of the setting up of PIO output and input, whereas the actual output and input is accomplished through direct PIO calls. The PIO routines are located in models/utils/pio. A description of the PIO package along with usage information may be found in the main PIO documentation. We will first describe the interface and then cover the direct calls.
-The CAM interface to PIO consists of the pio_utils module, which is the file models/atm/cam/src/utils/pio_utils.F90.
-Init_pio_subsystem is the first routine called. It is called from cam_init and initializes PIO in CAM. Init_pio_subsystem calls read_namelist_pio, which calls set_pio_parameters. The main parameters set includes the IO mode (netcdf vs pnetcdf), number of IO tasks, and IO stride.
-Cam_pio_createfile and cam_pio_openfile create and open a PIO file, respectively. Cam_pio_createfile is called from cam_write_restart, h_define (called from wshist, which is called from write_restart_history), and atm_write_srfrest_mct.
-Cam_pio_openfile is called from setup_initial (called from cam_initial), cam_read_restart, read_restart_history, atm_read_srfrest_mct, and wrapup (called from cam_run4).
-Clean_iodesc_list, called from startup_initialconds and cam_read_restart, cleans the list of IO descriptors.
-Get_phys_decomp and get_dyn_decomp create decompositions for physics and dynamics variables, respectively. Get_decomp is an interface to those routines.
-Get_phys_decomp is directly called from infld_real_2d, infld_real_3d, infld_real_3dncol; read_restart_physics, write_restart_physics; and pbuf_read_restart, pbuf_write_restart.
-Get_dyn_decomp is directly called from infld_real_2d and infld_real_3d.
-Get_decomp is called from read_restart_history and dump_field (called from wshist, which is called from write_restart_history). We see that the only time the get_decomp interface is called is when dealing with history variables (where each variable contains a description telling whether it relates to dynamics or physics).
-Get_phys_decomp and get_dyn_decomp have an optional column (or column_in) argument, which is used when defining history variables over a range of columns rather than the whole domain.
-Whenever a decomposition is created, a description of that decomposition is stored in a list. When a new variable is catalogued, that list is searched to see if that needed decomposition already exists. The routine performing that search is find_iodesc (called from get_phys_decomp and get_dyn_decomp). This capability is supported only when the range of history output is the whole domain.
-Get_phys_decomp calls get_phys_ldof (or get_column_ldof), and get_dyn_decomp calls get_dyn_ldof (or get_column_ldof). These routines do the bulk of the work in constructing the IO decompositions. Get_column_ldof is called when the history output is restricted to a subset of the domain.
-Virtually all the calls to PIO routines reference the pio module, located in pio.F90. Many of the variables contained in the pio module are referenced as well. This section of the documentation focuses on these calls and surrounding environs and discusses data types only peripherally.
-Write_restart_history (in control/cam_history.F90) controls the writing of a history file. Wshist writes the main variables that are on history tapes. Pio_put_var is used to write header information, and subroutine dump_field writes the main history variables, using primarily PIO_write_darray. Additional variables are then written using PIO_put_var. (Recall that PIO_write_darray isused to write distributed arrays.)
-Read_restart_history (in control/cam_history.F90) controls the reading of a history file. Individual parameters are first read using pio_get_var. History variables are then read in using PIO_read_darray (which reads distributed arrays).
-Cam_write_restart (in control/cam_restart.F90) controls the writing of a restart dump. The calling chain includes write_restart_hycoef (which writes the pressure coefficients), write_restart_dynamics, write_restart_physics, and write_restart_history. Write_restart_coef is in hycoef.F90 and uses PIO_put_var calls. Write_restart_dynamics is in restart_dynamics.F90 (in the dynamics subdirectory relevant to the active dynamical core) and issues primarily PIO_write_darray calls. Write_restart_physics is in physics/cam/restart_physics.F90. It calls a number of restart routines relating to chemistry and aerosols, such as pbuf_write_restart (in physics/cam/phys_buffer.F90), chem_write_restart (in chemistry/mozart), and write_prescribed_?????_restart (where ????? = ozone, ghg, aero, volcaero), located in chemistry/utils/prescribed_?????.F90. Pbuf_write_restart calls the relevant decomposition routine followed by PIO_write_darray. Chem_write_restart calls write_?????_restart (where ????? = tracer_cnst, tracer_srcs, linoz_data, spedata), located in chemistry/mozart/?????.F90. These routines typically use PIO_put_var. Write_restart_history is in cam_history.F90 and uses PIO_put_var.
-Cam_read_restart (in control/cam_restart.F90) controls the reading of a restart dump. The calling chain corresponds to that for cam_write_restart, and includes read_restart_hycoef, read_restart_dynamics, read_restart_physics, and read_restart_history. Typical routines called are pio_get_var and PIO_read_darray.
-Cam_init (in control/cam_comp.F90) calls cam_initial and phys_init. Cam_initial, which is located in the relevant dynamics subdirectory, calls initial_conds, located in control/startup_initialconds. Initial_conds calls read_inidat, which is located in the relevant dynamics subdirectory. Read_inidat calls infld, located in control/ncdio_atm.F90. Infld calls the relevant decomposition routine followed by PIO_read_darray.
-Phys_init is located in physics/cam/phys_grid.F90 and calls a number of initialization routines. An important one is phys_inidat, which makes several calls to infld.
-
- PIO
- 2.4.2
-
- |
-
▼Npio_types | |
Cdecompmap_t | |
Cfile_desc_t | File descriptor returned by PIO_openfile or PIO_createfile (see pio_types) |
Cio_desc_t | An io descriptor handle that is generated in PIO_initdecomp (see pio_types) |
Ciosystem_desc_t | A defined PIO system descriptor created by PIO_init (see pio_types) |
Cpio_rearr_comm_fc_opt_t | |
Cpio_rearr_opt_t | |
Cvar_desc_t | A variable descriptor returned from PIO_def_var (see pio_types) |
▼Npiodarray | |
CPIOc_read_darray | |
CPIOc_write_darray_multi | |
▼Npioexample | |
Cpioexampleclass | A class to hold example code and data |
▼Npionfget_mod | |
CPIOc_get_var_double | |
CPIOc_get_var_float | |
CPIOc_get_var_int | |
CPIOc_get_vara_double | |
CPIOc_get_vara_float | |
CPIOc_get_vara_int | |
CPIOc_get_vara_text | |
▼Npionfput_mod | |
CPIOc_put_vara_double | |
CPIOc_put_vara_float | |
CPIOc_put_vara_int | |
CPIOc_put_vara_text | |
Cfile_desc_t | File descriptor structure |
Cio_desc_t | IO descriptor structure |
Cio_region | IO region structure |
Ciosystem_desc_t | IO system descriptor structure |
Crearr_comm_fc_opt | Rearranger comm flow control options |
Crearr_opt | Rearranger options |
Cvar_desc_t | Variable description structure |
Cwmulti_buffer | The multi buffer holds data from one or more variables |
- PIO
- 2.4.2
-
- |
-
This is a list of all user interface routines:
-Also see: http://www.unidata.ucar.edu/software/netcdf/docs/
-
- PIO
- 2.4.2
-
- |
-
This document describes the code style to be used when contributing to the PIO library.
-Consistency of style allows bugs to be spotted more quickly and contributes to code quality.
-The C library compiles under GNU gcc without warnings. No code will be merged with the C library which causes warnings during compile.
-We cannot remove or change a function in the public C API. We can add to it, carefully.
-Consider: C is a terse language.
-Put braces on their own line, avoiding their use if possible.
-Put this in your .emacs file:
--(setq c-default-style "linux" - c-basic-offset 4) -
The tab key (used anywhere on the line) will indent a line correctly. M-x indent-region will indent a selected region of code.
-M-x untabify will convert all the tabs in a file to spaces.
-All code is subject to review.
- -Pull requests will be focused on one issue.
- -Pull requests may not be submitted until all tests pass.
- -All non-trivial pull requests are associated with a github issue. The issue is where discussion of requirements and implementation details can be worked out.
- -Pull requests will be left up on github for about a day. Request more time if you need it and are actively reviewing the code. (Note that pull request can also be reviewed after they are merged, if you miss one).
- -Jim will identify key stakeholders in changed code and ensure they accept code changes.
- -Reviewers are open-minded and ready to accept improvements to the library.
- -Reviewers will make comments on the pull request. All comments must be resolved.
- -If chages are dictated, they happen on the branch, so code reviewers can see the updated code.
- -The pull request is only merged when all programmers agree that all issues have been resolved.
- -Programmers begin work on a feature or fix by branching from develop.
- -When a branch is ready, it is submitted to code review.
- -When code review is complete, and the changes are approved, the PR is merged into the develop branch.
- -Mutliple merges into the develop branch may take place between test cycles. (???)
- -The develop branch is tested automatically by Jenkins.
- -The develop branch is tested periodically by CDash (every ~6 hours).
- -After all jenkins and Cdash builds complete successfully, with all tests passing, and no warnings, the PR is merged into master by the integrator.
- -Multiple PRs may be merged to master between test cycles. (???)
- -The branch is then deleted by whomever merged it to master.
- -The master branch is then tested on Jenkins.
- -The master branch is tested on CDash. Any test failures and the merge to master will be rolled back.
- --/** - @ingroup PIOc_inq_attname - The PIO-C interface for the NetCDF function nc_inq_attname.
This routine is called collectively by all tasks in the communicator - ios.union_comm. For more information on the underlying NetCDF commmand - please read about this function in the NetCDF documentation at: - http://www.unidata.ucar.edu/software/netcdf/docs/group__attributes.html
@param ncid the ncid of the open file, obtained from - PIOc_openfile() or PIOc_createfile(). - @param varid the variable ID. - @param attnum the attribute ID. - @return PIO_NOERR for success, error code otherwise. See PIOc_Set_File_Error_Handling - */ -int PIOc_inq_attname(int ncid, int varid, int attnum, char *name) -{ - iosystem_desc_t *ios; /* Pointer to io system information. */ - file_desc_t *file; /* Pointer to file information. */ - int ierr = PIO_NOERR; /* Return code from function calls. */ - int mpierr = MPI_SUCCESS, mpierr2; /* Return code from MPI function codes. */
LOG((1, "PIOc_inq_attname ncid = %d varid = %d attnum = %d", ncid, varid, - attnum));
/* Find the info about this file. */ - if (!(file = pio_get_file_from_id(ncid))) - return PIO_EBADID; - ios = file->iosystem;
/* If async is in use, and this is not an IO task, bcast the parameters. */ - if (ios->async_interface) - { - if (!ios->ioproc) - { - int msg = PIO_MSG_INQ_ATTNAME; - char name_present = name ? true : false;
if(ios->compmaster) - mpierr = MPI_Send(&msg, 1,MPI_INT, ios->ioroot, 1, ios->union_comm);
if (!mpierr) - mpierr = MPI_Bcast(&ncid, 1, MPI_INT, ios->compmaster, ios->intercomm); - if (!mpierr) - mpierr = MPI_Bcast(&varid, 1, MPI_INT, ios->compmaster, ios->intercomm); - if (!mpierr) - mpierr = MPI_Bcast(&attnum, 1, MPI_INT, ios->compmaster, ios->intercomm); - if (!mpierr) - mpierr = MPI_Bcast(&name_present, 1, MPI_CHAR, ios->compmaster, ios->intercomm); - }
/* Handle MPI errors. */ - if ((mpierr2 = MPI_Bcast(&mpierr, 1, MPI_INT, ios->comproot, ios->my_comm))) - check_mpi(file, mpierr2, __FILE__, __LINE__); - if (mpierr) - return check_mpi(file, mpierr, __FILE__, __LINE__); - }
/* If this is an IO task, then call the netCDF function. */ - if (ios->ioproc) - { -#ifdef _PNETCDF - if (file->iotype == PIO_IOTYPE_PNETCDF) - ierr = ncmpi_inq_attname(file->fh, varid, attnum, name); -#endif /* _PNETCDF */ -#ifdef _NETCDF - if (file->iotype != PIO_IOTYPE_PNETCDF && file->do_io) - ierr = nc_inq_attname(file->fh, varid, attnum, name); -#endif /* _NETCDF */ - LOG((2, "PIOc_inq_attname netcdf call returned %d", ierr)); - }
/* Broadcast and check the return code. */ - if ((mpierr = MPI_Bcast(&ierr, 1, MPI_INT, ios->ioroot, ios->my_comm))) - { - check_mpi(file, mpierr, __FILE__, __LINE__); - return PIO_EIO; - } - check_netcdf(file, ierr, __FILE__, __LINE__);
/* Broadcast results to all tasks. Ignore NULL parameters. */ - if (!ierr) - if (name) - { - int namelen = strlen(name); - if ((mpierr = MPI_Bcast(&namelen, 1, MPI_INT, ios->ioroot, ios->my_comm))) - check_mpi(file, mpierr, __FILE__, __LINE__); - if ((mpierr = MPI_Bcast((void *)name, namelen + 1, MPI_CHAR, ios->ioroot, - ios->my_comm))) - check_mpi(file, mpierr, __FILE__, __LINE__); - }
return ierr; -} -
For style issues not already covered in this document, see this style guide.
-Last updated: 05-16-2016
-
- PIO
- 2.4.2
-
- |
-
One of the biggest challenges to working with PIO is setting up the call to PIO_initdecomp. The user must properly describe how the data within each MPI tasks memory should be placed or retrieved from disk. PIO provides two methods to rearrange data from compute tasks to IO tasks. The first method, called box rearrangement is the only one provided in PIO1. The second called subset rearrangement is introduced in PIO2.
-In this method data is rearranged from compute to IO tasks such that the arrangement of data on the IO tasks optimizes the call from the IO tasks to the underlying (NetCDF) IO library. In this case each compute task will transfer data to one or more IO tasks.
-In this method each IO task is associated with a unique subset of compute tasks so that each compute task will transfer data to one and only one IO task. Since this technique does not guarantee that data on the IO node represents a contiguous block of data on the file it may require multiple calls to the underlying (NetCDF) IO library.
-As an example suppose we have a global two dimensional grid of size 4x5 decomposed over 5 tasks. We represent the two dimensional grid in terms of offset from the initial element ie
- 0 1 2 3 - 4 5 6 7 - 8 9 10 11 - 12 13 14 15 - 16 17 18 19 -
Now suppose this data is distributed over the compute tasks as follows:
-0: { 0 4 8 12 } -1: { 16 1 5 9 } -2: { 13 17 2 6 } -3: { 10 14 18 3 } -4: { 7 11 15 19 } -
If we have 2 io tasks the Box rearranger would give:
-0: { 0 1 2 3 4 5 6 7 8 9 } -1: { 10 11 12 13 14 15 16 17 18 19 } -
While the subset rearranger would give:
-0: { 0 1 4 5 8 9 12 16 } -1: { 2 3 6 7 10 11 13 14 15 17 18 19 } -
Note that while the box rearranger gives a data layout which is well balanced and well suited for the underlying io library, it had to communicate with every compute task to do so. On the other hand the subset rearranger communicated with only a portion of the compute tasks but requires more work on the part of the underlying io library to complete the operation.
-Also note if every task is an IO task then the box rearranger will need to do an alltoall communication, while the subset rearranger does none. In fact using the subset rearranger with every compute task an IO task provides a measure of what you might expect the performance of the underlying IO library to be if it were used without PIO.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
-Files | |
file | pio.F90 |
User interface Module for PIO, this is the only file a user program should 'use'. | |
file | pio_kinds.F90 |
basic data types | |
file | pio_support.F90 |
internal code for compiler workarounds, aborts and debug functions | |
file | pio_types.F90 |
Derived datatypes and constants for PIO Fortran API. | |
file | piodarray.f90 |
Read and write routines for decomposed data. | |
file | piolib_mod.f90 |
Initialization Routines for PIO. | |
file | pionfatt_mod_2.f90 |
NetCDF attribute interface to PIO. | |
file | pionfget_mod_2.f90 |
Read Routines for non-decomposed NetCDF data. | |
file | pionfput_mod.f90 |
Write routines for non-decomposed NetCDF data. | |
- PIO
- 2.4.2
-
- |
-
-Files | |
file | examplePio.f90 |
A simple Fortran example for the ParallelIO Library. | |
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
-Files | |
file | example1.c |
A simple C example for the ParallelIO Library. | |
file | example2.c |
A simple C example for the ParallelIO Library. | |
file | examplePio.c |
A simple C example for the ParallelIO Library. | |
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
-Files | |
file | pio.h [code] |
Public headers for the PIO C interface. | |
file | pio_darray.c |
Public functions that read and write distributed arrays in PIO. | |
file | pio_file.c |
PIO File Handling. | |
file | pio_get_nc.c |
PIO functions to get data. | |
file | pio_nc.c |
PIO interfaces to NetCDF support functions. | |
file | pio_nc4.c |
Functions to wrap netCDF-4 functions for PIO. | |
file | pio_put_nc.c |
PIO functions to write data. | |
file | pioc.c |
Some initialization and support functions. | |
file | pioc_support.c |
Support functions for the PIO library. | |
- PIO
- 2.4.2
-
- |
-
By default, PIO handles errors internally by printing a string describing the error and then calling mpi_abort. Application developers can change this behaivior with a call to PIO_seterrorhandling
-call pio_seterrorhandling(File, PIO_BCAST_ERROR) - ierr = pio_inq_varid(File, 'U', uid) - call pio_seterrorhandling(File, PIO_INTERNAL_ERROR) - if(ierr/= PIO_NOERR) then - write(stderr,*) 'Variable U not found on input file, setting to 0' - U=0 - else - ... - endif -
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
-
- PIO
- 2.4.2
-
- |
-
The PIO library examples can be found under the examples subdirectory. They are built with the make test or make check build target.
-The C examples are in the examples/c subdirectory.
-The Fortran examples are in the examples/f03 subdirectory.
-PIO has been implemented in several geophysical component models, including the Community Atmosphere Model (CAM), the Community Land Model (CLM), the Parallel Ocean Program (POP), the Community Ice CodE (CICE), and coupler for used by CCSM4.0 (CPL7). We also provide several simpler example code as well as a test code that is suitable for regression testing and benchmarking.
- -
- PIO
- 2.4.2
-
- |
-
A simple C example for the ParallelIO Library. -More...
-#include "config.h"
#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <mpi.h>
#include <pio.h>
-Macros | |
#define | NUM_NETCDF_FLAVORS 4 |
The number of possible output netCDF output flavors available to the ParallelIO library. More... | |
#define | NDIM 1 |
The number of dimensions in the example data. More... | |
#define | DIM_LEN 16 |
The length of our sample data. More... | |
#define | DIM_NAME "x" |
The name of the dimension in the netCDF output file. More... | |
#define | VAR_NAME "foo" |
The name of the variable in the netCDF output file. More... | |
#define | ERR_BAD 1001 |
Return code when netCDF output file does not match expectations. More... | |
#define | START_DATA_VAL 42 |
The meaning of life, the universe, and everything. More... | |
#define | MPIERR(e) |
Handle MPI errors. More... | |
#define | ERR(e) |
Handle non-MPI errors by finalizing the MPI library and exiting with an exit code. More... | |
-Functions | |
int | check_file (int ntasks, char *filename) |
Check the output file. More... | |
int | main (int argc, char *argv[]) |
Main execution of code. More... | |
-Variables | |
char | err_buffer [MPI_MAX_ERROR_STRING] |
Global err buffer for MPI. More... | |
int | resultlen |
This is the length of the most recent MPI error message, stored int the global error string. More... | |
A simple C example for the ParallelIO Library.
-This example creates a netCDF output file with one dimension and one variable. It first writes, then reads the sample file using the ParallelIO library.
-This example can be run in parallel for 1, 2, 4, 8, or 16 processors.
-#define DIM_LEN 16 | -
The length of our sample data.
-There will be a total of 16 integers in our data, and responsibilty for writing and reading them will be spread between all the processors used to run this example.
- -#define DIM_NAME "x" | -
The name of the dimension in the netCDF output file.
- -#define ERR | -( | -- | e | ) | -- |
Handle non-MPI errors by finalizing the MPI library and exiting with an exit code.
- -#define ERR_BAD 1001 | -
Return code when netCDF output file does not match expectations.
- -#define MPIERR | -( | -- | e | ) | -- |
Handle MPI errors.
-This should only be used with MPI library function calls.
- -#define NDIM 1 | -
The number of dimensions in the example data.
-In this simple example, we are using one-dimensional data.
- -#define NUM_NETCDF_FLAVORS 4 | -
The number of possible output netCDF output flavors available to the ParallelIO library.
- -#define START_DATA_VAL 42 | -
The meaning of life, the universe, and everything.
- -#define VAR_NAME "foo" | -
The name of the variable in the netCDF output file.
- -int check_file | -( | -int | -ntasks, | -
- | - | char * | -filename | -
- | ) | -- |
Check the output file.
-Use netCDF to check that the output is as expected.
-ntasks | The number of processors running the example. |
filename | The name of the example file to check. |
< File ID from netCDF.
-< Number of dimensions.
-< Number of variables.
-< Number of global attributes.
-< ID of unlimited dimension.
-< Length of the dimension.
-< Number of variable attributes.
-< NetCDF data type of this variable.
-< Return code for function calls.
-< Dimension ids for this variable.
-< Name of the dimension.
-< Name of the variable.
-< Zero-based index to start read.
-< Number of elements to read.
-< Buffer to read in data.
-< Data values we expect to find.
- -int main | -( | -int | -argc, | -
- | - | char * | -argv[] | -
- | ) | -- |
Main execution of code.
-Executes the functions to:
The example can be run from the command line (on system that support it) like this:
-mpiexec -n 4 ./examplePio -
The sample file created by this program is a small netCDF file. It has the following contents (as shown by ncdump) for a 4-processor run:
--netcdf examplePio_c { -dimensions: -x = 16 ; -variables: -int foo(x) ; -data:
foo = 42, 42, 42, 42, 43, 43, 43, 43, 44, 44, 44, 44, 45, 45, 45, 45 ; -} -
[in] | argc | argument count (should be zero) |
[in] | argv | argument array (should be NULL) |
examplePioClass* | Pointer to self. |
Set to non-zero to get output to stdout.
-Zero-based rank of processor.
-Number of processors involved in current execution.
-Different output flavors. The example file is written (and then read) four times. The first two flavors, parallel-netcdf, and netCDF serial, both produce a netCDF classic format file (but with different libraries). The last two produce netCDF4/HDF5 format files, written with and without using netCDF-4 parallel I/O.
-Number of processors that will do IO. In this example we will do IO from all processors.
-Stride in the mpi rank between io tasks. Always 1 in this example.
-Zero based rank of first processor to be used for I/O.
-The dimension ID.
-Array index per processing unit. This is the number of elements of the data array that will be handled by each processor. In this example there are 16 data elements. If the example is run on 4 processors, then arrIdxPerPe will be 4.
-The ID for the parallel I/O system. It is set by PIOc_Init_Intracomm(). It references an internal structure containing the general IO subsystem data and MPI structure. It is passed to PIOc_finalize() to free associated resources, after all I/O, but before MPI_Finalize is called.
-The ncid of the netCDF file created in this example.
-The ID of the netCDF varable in the example file.
-The I/O description ID as passed back by PIOc_InitDecomp() and freed in PIOc_freedecomp().
-A buffer for sample data. The size of this array will vary depending on how many processors are involved in the execution of the example code. It's length will be the same as elements_per_pe.
-A 1-D array which holds the decomposition mapping for this example. The size of this array will vary depending on how many processors are involved in the execution of the example code. It's length will be the same as elements_per_pe.
-Test filename.
-The number of netCDF flavors available in this build.
-Used for command line processing.
-Return value.
- -char err_buffer[MPI_MAX_ERROR_STRING] | -
Global err buffer for MPI.
-When there is an MPI error, this buffer is used to store the error message that is associated with the MPI error.
- -int resultlen | -
This is the length of the most recent MPI error message, stored int the global error string.
- -
- PIO
- 2.4.2
-
- |
-
A simple C example for the ParallelIO Library. -More...
-#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <mpi.h>
#include <pio.h>
#include <math.h>
-Macros | |
#define | NUM_NETCDF_FLAVORS 4 |
The number of possible output netCDF output flavors available to the ParallelIO library. More... | |
#define | NDIM 3 |
The number of dimensions in the example data. More... | |
#define | NUM_TIMESTEPS 6 |
The number of timesteps of data to write. More... | |
#define | VAR_NAME "foo" |
The name of the variable in the netCDF output file. More... | |
#define | ERR_BAD 1001 |
Return code when netCDF output file does not match expectations. More... | |
#define | START_DATA_VAL 42 |
The meaning of life, the universe, and everything. More... | |
#define | MPIERR(e) |
Handle MPI errors. More... | |
#define | ERR(e) |
Handle non-MPI errors by finalizing the MPI library and exiting with an exit code. More... | |
#define | NUM_EVENTS 10 |
Number of MPE events. More... | |
#define | X_DIM_LEN 20 |
The length of our sample data along each dimension. More... | |
-#define | Y_DIM_LEN 30 |
#define | ERR_FILE 1 |
Some error codes for when things go wrong. More... | |
-#define | ERR_DUMB 2 |
-#define | ERR_ARG 3 |
-#define | ERR_MPI 4 |
-#define | ERR_MPITYPE 5 |
-#define | ERR_LOGGING 6 |
-#define | ERR_UPDATE 7 |
-#define | ERR_CALC 8 |
-#define | ERR_COUNT 9 |
-#define | ERR_WRITE 10 |
-#define | ERR_SWAP 11 |
-#define | ERR_INIT 12 |
-Functions | |
int | init_logging (int my_rank, int event_num[][NUM_EVENTS]) |
This will set up the MPE logging event numbers. More... | |
int | check_file (int ntasks, char *filename) |
Check the output file. More... | |
int | calculate_value (int my_rank, int timestep, float *datap) |
Calculate sample data. More... | |
int | main (int argc, char *argv[]) |
Main execution of code. More... | |
-Variables | |
char | err_buffer [MPI_MAX_ERROR_STRING] |
Global err buffer for MPI. More... | |
int | resultlen |
This is the length of the most recent MPI error message, stored int the global error string. More... | |
char | dim_name [NDIM][PIO_MAX_NAME+1] = {"timestep", "x", "y"} |
The dimension names. More... | |
int | dim_len [NDIM] = {NC_UNLIMITED, X_DIM_LEN, Y_DIM_LEN} |
Length of the dimensions in the sample data. More... | |
PIO_Offset | chunksize [NDIM] = {2, X_DIM_LEN/2, Y_DIM_LEN/2} |
Length of chunksizes to use in netCDF-4 files. More... | |
A simple C example for the ParallelIO Library.
-This example creates a netCDF output file with one 3D variable. One of the dimensions will be unlimited. The example first writes the sample file using the ParallelIO library, then reads it with the plain old netCDF library to check that it is correct.
-This example can be run in parallel for 1, 2, 4, 8, or 16 processors.
-This example uses the MPE performace profiling library, if it is present on the build machine. After the program is run, MPE will produce a file called example2.clog2. In order to see the nice graphs, execute the commands:
--clog2ToSlog2 example2.clog2 -jumpshot example2.slog2 -
#define ERR | -( | -- | e | ) | -- |
Handle non-MPI errors by finalizing the MPI library and exiting with an exit code.
- -#define ERR_BAD 1001 | -
Return code when netCDF output file does not match expectations.
- -#define ERR_FILE 1 | -
Some error codes for when things go wrong.
- -#define MPIERR | -( | -- | e | ) | -- |
Handle MPI errors.
-This should only be used with MPI library function calls.
- -#define NDIM 3 | -
The number of dimensions in the example data.
-In this example, we are using three-dimensional data.
- -#define NUM_EVENTS 10 | -
Number of MPE events.
-The start and stop of each event will be tracked, and graphed. This value is used outside of HAVE_MPE ifdefs.
- -#define NUM_NETCDF_FLAVORS 4 | -
The number of possible output netCDF output flavors available to the ParallelIO library.
- -#define NUM_TIMESTEPS 6 | -
The number of timesteps of data to write.
- -#define START_DATA_VAL 42 | -
The meaning of life, the universe, and everything.
- -#define VAR_NAME "foo" | -
The name of the variable in the netCDF output file.
- -#define X_DIM_LEN 20 | -
The length of our sample data along each dimension.
-There will be a total of 16 integers in each timestep of our data, and responsibilty for writing and reading them will be spread between all the processors used to run this example.
- -int calculate_value | -( | -int | -my_rank, | -
- | - | int | -timestep, | -
- | - | float * | -datap | -
- | ) | -- |
Calculate sample data.
-This function is deliberately slow in order to take up some time calculating.
my_rank | the rank of the processor running the code. |
timestep | the timestep. |
datap | pointer where we should write datum. |
int check_file | -( | -int | -ntasks, | -
- | - | char * | -filename | -
- | ) | -- |
Check the output file.
-Use netCDF to check that the output is as expected.
-ntasks | The number of processors running the example. |
filename | The name of the example file to check. |
< File ID from netCDF.
-< Number of dimensions.
-< Number of variables.
-< Number of global attributes.
-< ID of unlimited dimension.
-< Length of the dimension.
-< Number of variable attributes.
-< NetCDF data type of this variable.
-< Return code for function calls.
-< Dimension ids for this variable.
-< Name of the dimension.
-< Name of the variable.
-< Zero-based index to start read.
-< Number of elements to read.
-< Buffer to read in data.
-< Data values we expect to find.
- -int init_logging | -( | -int | -my_rank, | -
- | - | int | -event_num[][NUM_EVENTS] | -
- | ) | -- |
This will set up the MPE logging event numbers.
-my_rank | the rank of the processor running the code. |
event_num | array of MPE event numbers. |
int main | -( | -int | -argc, | -
- | - | char * | -argv[] | -
- | ) | -- |
Main execution of code.
-Executes the functions to:
The example can be run from the command line (on system that support it) like this:
-mpiexec -n 4 ./examplePio -
The sample file created by this program is a small netCDF file. It has the following contents (as shown by ncdump) for a 4-processor run:
--netcdf examplePio_c { -dimensions: -x = 16 ; -variables: -int foo(x) ; -data:
foo = 42, 42, 42, 42, 43, 43, 43, 43, 44, 44, 44, 44, 45, 45, 45, 45 ; -} -
[in] | argc | argument count (should be zero) |
[in] | argv | argument array (should be NULL) |
examplePioClass* | Pointer to self. |
Set to non-zero to get output to stdout.
-Zero-based rank of processor.
-Number of processors involved in current execution.
-Different output flavors. The example file is written (and then read) four times. The first two flavors, parallel-netcdf, and netCDF serial, both produce a netCDF classic format file (but with different libraries). The last two produce netCDF4/HDF5 format files, written with and without using netCDF-4 parallel I/O.
-Names for the output files. Two of them (pnetcdf and classic) will be in classic netCDF format, the others (serial4 and parallel4) will be in netCDF-4/HDF5 format. All four can be read by the netCDF library, and all will contain the same contents.
-Number of processors that will do IO. In this example we will do IO from all processors.
-Stride in the mpi rank between io tasks. Always 1 in this example.
-Number of the aggregator? Always 0 in this example.
-Zero based rank of first processor to be used for I/O.
-Specifies the flavor of netCDF output format.
-The dimension IDs.
-Array index per processing unit. This is the number of elements of the data array that will be handled by each processor. In this example there are 16 data elements. If the example is run on 4 processors, then arrIdxPerPe will be 4.
-The ID for the parallel I/O system. It is set by PIOc_Init_Intracomm(). It references an internal structure containing the general IO subsystem data and MPI structure. It is passed to PIOc_finalize() to free associated resources, after all I/O, but before MPI_Finalize is called.
-The ncid of the netCDF file created in this example.
-The ID of the netCDF varable in the example file.
-The I/O description ID as passed back by PIOc_InitDecomp() and freed in PIOc_freedecomp().
-A buffer for sample data. The size of this array will vary depending on how many processors are involved in the execution of the example code. It's length will be the same as elements_per_pe.
-A buffer for reading data back from the file. The size of this array will vary depending on how many processors are involved in the execution of the example code. It's length will be the same as elements_per_pe.
-A 1-D array which holds the decomposition mapping for this example. The size of this array will vary depending on how many processors are involved in the execution of the example code. It's length will be the same as elements_per_pe.
-Needed for command line processing.
- -PIO_Offset chunksize[NDIM] = {2, X_DIM_LEN/2, Y_DIM_LEN/2} | -
Length of chunksizes to use in netCDF-4 files.
- -Length of the dimensions in the sample data.
- -char dim_name[NDIM][PIO_MAX_NAME+1] = {"timestep", "x", "y"} | -
The dimension names.
- -char err_buffer[MPI_MAX_ERROR_STRING] | -
Global err buffer for MPI.
-When there is an MPI error, this buffer is used to store the error message that is associated with the MPI error.
- -int resultlen | -
This is the length of the most recent MPI error message, stored int the global error string.
- -
- PIO
- 2.4.2
-
- |
-
A simple C example for the ParallelIO Library. -More...
-#include "config.h"
#include <getopt.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <mpi.h>
#include <pio.h>
-Typedefs | |
typedef struct examplePioClass | examplePioClass |
Holds code and data for this example. More... | |
-Functions | |
struct examplePioClass * | epc_init (struct examplePioClass *this) |
Initialize libraries, create sample data. More... | |
struct examplePioClass * | epc_createDecomp (struct examplePioClass *this) |
Create the decomposition. More... | |
struct examplePioClass * | epc_createFile (struct examplePioClass *this) |
Create the netCDF file. More... | |
struct examplePioClass * | epc_defineVar (struct examplePioClass *this) |
Define netCDF metadata. More... | |
struct examplePioClass * | epc_writeVar (struct examplePioClass *this) |
Write the sample data to the file. More... | |
struct examplePioClass * | epc_readVar (struct examplePioClass *this) |
Read the example data from the file. More... | |
struct examplePioClass * | epc_closeFile (struct examplePioClass *this) |
Closes the netCDF file. More... | |
struct examplePioClass * | epc_cleanUp (struct examplePioClass *this) |
Clean up allocated resources. More... | |
struct examplePioClass * | epc_errorHandler (struct examplePioClass *this, const char *errMsg, const int retVal) |
Error handling function. More... | |
struct examplePioClass * | epc_new (int verbose) |
Create an examplePioClass object. More... | |
int | main (int argc, char *argv[]) |
Main execution of code. More... | |
A simple C example for the ParallelIO Library.
-This example creates a netCDF output file with one dimension and one variable. It first writes, then reads the sample file using the ParallelIO library.
-This example can be run in parallel for 1, 2, 4, 8, or 16 processors.
-typedef struct examplePioClass examplePioClass | -
Holds code and data for this example.
-This struct stores pointers to the functions used in the example, and all the data values needed to run the example code.
- -struct examplePioClass* epc_cleanUp | -( | -struct examplePioClass * | -this | ) | -- |
Clean up allocated resources.
-This function frees the memory used in this example. It calls the ParallelIO library function PIOc_freedecomp() to free decomposition resources. Then calles PIOc_finalize() and MPI_finalize() to free library resources.
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_closeFile | -( | -struct examplePioClass * | -this | ) | -- |
Closes the netCDF file.
-Uses the PIOc_closefile() function to close the netCDF sample file written by this example.
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_createDecomp | -( | -struct examplePioClass * | -this | ) | -- |
Create the decomposition.
-This function is called as part of the creation of a sample data file for this example.
-Uses PIOc_InitDecomp() to initalize the decomposition for this example. The arguments are:
The decomposition mapping array (called compdof, in this example code), contains a 1 based array of offsets into the array record on file. For this example, the compdof array will have the following sizes and values, depending on number of processors used.
-For one processor the decomposition array looks like this (note that the array is 1-based):
--rank: 0 length: 16 [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16] -
For two processors, the decomposition array looks like this on each processor:
--rank: 0 length: 8 [1, 2, 3, 4, 5, 6, 7, 8] -rank: 1 length: 8 [9, 10, 11, 12, 13, 14, 15, 16] -
For four processors, the decomposition arrays are:
--rank: 0 length: 4 [1, 2, 3, 4] -rank: 1 length: 4 [5, 6, 7, 8] -rank: 2 length: 4 [9, 10, 11, 12] -rank: 3 length: 4 [13, 14, 15, 16] -
[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_createFile | -( | -struct examplePioClass * | -this | ) | -- |
Create the netCDF file.
-This function is called as part of the creation of a sample data file for this example.
-Uses the function PIOc_createfile() to create the netCDF output file. The format of the file is created in accordance with the iotype member variable, which specifies one of the following values:
-The PIOc_createfile() function has the following parameters:
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_defineVar | -( | -struct examplePioClass * | -this | ) | -- |
Define netCDF metadata.
-This function is called as part of the creation of a sample data file for this example.
-It defines a dimension and a one-dimensional variable in the netCDF file using functions PIOc_def_dim() and PIOc_def_var(). It then calls PIOc_enddef() to end the define mode of the file.
-All of the functions take the pioFileDesc returned by PIOc_createfile(). This is the ncid of the netCDF file.
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_errorHandler | -( | -struct examplePioClass * | -this, | -
- | - | const char * | -errMsg, | -
- | - | const int | -retVal | -
- | ) | -- |
Error handling function.
-On error, process with rank zero will print error message, the netCDF file will be closed with PIOc_closefile(), and MPI_Abort is called to end the example execution on all processes.
-[in] | this | Pointer to self. |
[in] | errMsg | an error message |
[in] | retVal | the non-zero return value that indicated an error |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_init | -( | -struct examplePioClass * | -this | ) | -- |
Initialize libraries, create sample data.
-This function is called as part of the creation of a sample data file for this example.
-Ths funtion initializes MPI and the ParallelIO libraries. It sets up the ParallelIO library communicator. It also allocates memory for data used in this example, and assigns sample values to the data array that will be written.
-The ParallelIO communicator is set up with a call to PIOc_Init_Intracomm(). This call takes the following parameters:
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_new | -( | -int | -verbose | ) | -- |
Create an examplePioClass object.
-This function allocates memory for the struct that contains the code and data for this example. Then pointers are to the functions used in the example.
-[in] | verbose | Non-zero for output to stdout. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_readVar | -( | -struct examplePioClass * | -this | ) | -- |
Read the example data from the file.
-This function is called as part of the creation of a sample data file for this example.
-This function reads the data that has been written to the sample data file. The data are read with the PIOc_read_darray() function.
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
struct examplePioClass* epc_writeVar | -( | -struct examplePioClass * | -this | ) | -- |
Write the sample data to the file.
-This function is called as part of the creation of a sample data file for this example.
-The data are written with the PIOc_write_darray() function. After the write is complete, ensure the file is synced for all processes after the write.
-[in] | this | Pointer to self. |
examplePioClass* | Pointer to self. |
int main | -( | -int | -argc, | -
- | - | char * | -argv[] | -
- | ) | -- |
Main execution of code.
-Executes the functions to:
The example can be run from the command line (on system that support it) like this:
-mpiexec -n 4 ./examplePio -
The sample file created by this program is a small netCDF file. It has the following contents (as shown by ncdump) for a 4-processor run:
--netcdf examplePio_c { -dimensions: - x = 16 ; -variables: - int foo(x) ; -data:
foo = 42, 42, 42, 42, 43, 43, 43, 43, 44, 44, 44, 44, 45, 45, 45, 45 ; -} -
[in] | argc | argument count (should be zero) |
[in] | argv | argument array (should be NULL) |
examplePioClass* | Pointer to self. |
- PIO
- 2.4.2
-
- |
-
A simple Fortran example for the ParallelIO Library. -More...
--Data Types | |
type | pioexample::pioexampleclass |
A class to hold example code and data. More... | |
-Functions/Subroutines | |
subroutine | pioexample::init (this) |
Initialize MPI, ParallelIO, and example data. More... | |
program | main |
Main execution of example code. More... | |
A simple Fortran example for the ParallelIO Library.
-subroutine pioexample::init | -( | -class(pioexampleclass), intent(inout) | -this | ) | -- |
Initialize MPI, ParallelIO, and example data.
-Initialize the MPI and ParallelIO libraries. Also allocate memory to write and read the sample data to the netCDF file.
- -program main | -( | -) | -- |
Main execution of example code.
-This is an example program for the ParallelIO library.
-This program creates a netCDF output file with the ParallelIO library, then writes and reads some data to and from the file.
-This example does the following:
-
- PIO
- 2.4.2
-
- |
-
Here is a list of frequently asked questions and their answers.
The PIO Library distribution contains tests for PIO. They are run my 'make check'. The tests use mpiexec to run tests on 4, 8, or 16 processors.
- -
- PIO
- 2.4.2
-
- |
-
example1.c | A simple C example for the ParallelIO Library |
example2.c | A simple C example for the ParallelIO Library |
examplePio.c | A simple C example for the ParallelIO Library |
examplePio.f90 | A simple Fortran example for the ParallelIO Library |
pio.F90 | User interface Module for PIO, this is the only file a user program should 'use' |
pio.h | Public headers for the PIO C interface |
pio_darray.c | Public functions that read and write distributed arrays in PIO |
pio_file.c | PIO File Handling |
pio_get_nc.c | PIO functions to get data |
pio_kinds.F90 | Basic data types |
pio_nc.c | PIO interfaces to NetCDF support functions |
pio_nc4.c | Functions to wrap netCDF-4 functions for PIO |
pio_put_nc.c | PIO functions to write data |
pio_support.F90 | Internal code for compiler workarounds, aborts and debug functions |
pio_types.F90 | Derived datatypes and constants for PIO Fortran API |
pioc.c | Some initialization and support functions |
pioc_support.c | Support functions for the PIO library |
piodarray.f90 | Read and write routines for decomposed data |
piolib_mod.f90 | Initialization Routines for PIO |
pionfatt_mod_2.f90 | NetCDF attribute interface to PIO |
pionfget_mod_2.f90 | Read Routines for non-decomposed NetCDF data |
pionfput_mod.f90 | Write routines for non-decomposed NetCDF data |
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This page explains how to interpret the graphs that are generated by doxygen.
-Consider the following example:
This will result in the following graph:
-The boxes in the above graph have the following meaning:
-The arrows have the following meaning:
-
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
subroutine | piolib_mod::advanceframe (file, vardesc) |
advances the record dimension of a variable in a netcdf format file or the block address in a binary file More... | |
subroutine piolib_mod::advanceframe | -( | -type(file_desc_t), intent(in) | -file, | -
- | - | type(var_desc_t), intent(inout) | -vardesc | -
- | ) | -- |
advances the record dimension of a variable in a netcdf format file or the block address in a binary file
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
subroutine | piolib_mod::closefile (file) |
close a disk file More... | |
subroutine piolib_mod::closefile | -( | -type(file_desc_t) | -file | ) | -- |
close a disk file
-file | File descriptor structure. This structure holds information associated with each open file |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
int | PIOc_createfile_int (int iosysid, int *ncidp, int *iotype, const char *filename, int mode) |
Create a new file using pio. More... | |
integer function | piolib_mod::createfile (iosystem, file, iotype, fname, amode_in) |
Create a NetCDF or PNetCDF file using PIO. More... | |
integer function piolib_mod::createfile | -( | -type (iosystem_desc_t), intent(inout), target | -iosystem, | -
- | - | type (file_desc_t), intent(out) | -file, | -
- | - | integer, intent(in) | -iotype, | -
- | - | character(len=*), intent(in) | -fname, | -
- | - | integer, intent(in), optional | -amode_in | -
- | ) | -- |
Create a NetCDF or PNetCDF file using PIO.
-Input parameters are read on comp task 0 and ignored elsewhere
iosystem | : A defined pio system descriptor created by a call to PIO_init (see PIO_types) |
file | : The returned file descriptor |
iotype | : An integer parameter which controls the iotype.
|
fname | : The name of the file to open |
amode_in | : The NetCDF creation mode flag. the following flags are available: (1) zero value or NC_NOWRITE is default and opens the file with read-only access. (2) NC_WRITE for read-write access. (3) NC_SHARE is used for NetCDF classic, and dangerous with this application. (4) NC_WRITE|NC_SHARE |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
int PIOc_createfile_int | -( | -int | -iosysid, | -
- | - | int * | -ncidp, | -
- | - | int * | -iotype, | -
- | - | const char * | -filename, | -
- | - | int | -mode | -
- | ) | -- |
Create a new file using pio.
-This is an internal function that is called by both PIOc_create() and PIOc_createfile(). Input parameters are read on comp task 0 and ignored elsewhere.
-iosysid | A defined pio system ID, obtained from PIOc_Init_Intracomm() or PIOc_InitAsync(). |
ncidp | A pointer that gets the ncid of the newly created file. |
iotype | A pointer to a pio output format. Must be one of PIO_IOTYPE_PNETCDF, PIO_IOTYPE_NETCDF, PIO_IOTYPE_NETCDF4C, or PIO_IOTYPE_NETCDF4P. |
filename | The filename to create. |
mode | The netcdf mode for the create operation. |
- PIO
- 2.4.2
-
- |
-
A set of functions to define dimensions and their attributes in NetCDF files. -More...
--Functions/Subroutines | |
integer function | pio_nf::def_dim_int_desc (File, name, len, dimid) |
Defines the netcdf dimension. More... | |
integer function | pio_nf::def_dim_int_id (ncid, name, len, dimid) |
Defines the netcdf dimension. More... | |
integer function | pio_nf::def_dim_desc (File, name, len, dimid) |
Defines the netcdf dimension. More... | |
integer function | pio_nf::def_dim_id (ncid, name, len, dimid) |
Defines the netcdf dimension. More... | |
A set of functions to define dimensions and their attributes in NetCDF files.
-integer function pio_nf::def_dim_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(pio_offset_kind), intent(in) | -len, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Defines the netcdf dimension.
- -integer function pio_nf::def_dim_id | -( | -integer, intent(in) | -ncid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(pio_offset_kind), intent(in) | -len, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Defines the netcdf dimension.
- -integer function pio_nf::def_dim_int_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(in) | -len, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Defines the netcdf dimension.
-File | File descriptor structure. This structure holds information associated with each open file |
name | : The name of the dimension to define |
len | : The size of the dimension |
dimid | : The dimension identifier |
integer function pio_nf::def_dim_int_id | -( | -integer, intent(in) | -ncid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(in) | -len, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Defines the netcdf dimension.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::def_var_0d_desc (File, name, type, vardesc) |
Defines a netcdf variable. More... | |
-integer function | pio_nf::def_var_0d_id (ncid, name, type, varid) |
Defines a netcdf variable. | |
integer function | pio_nf::def_var_md_desc (File, name, type, dimids, vardesc) |
Defines the a netcdf variable. More... | |
-integer function | pio_nf::def_var_md_id (ncid, name, type, dimids, varid) |
Defines a netcdf variable. | |
integer function pio_nf::def_var_0d_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(in) | -type, | -
- | - | type (var_desc_t), intent(inout) | -vardesc | -
- | ) | -- |
Defines a netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
name | : The name of the variable to define |
type | : The type of variable |
vardesc | Variable description structure. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::def_var_md_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(in) | -type, | -
- | - | integer, dimension(:), intent(in) | -dimids, | -
- | - | type (var_desc_t), intent(inout) | -vardesc | -
- | ) | -- |
Defines the a netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
name | : The name of the variable to define |
type | : The type of variable |
dimids | : The dimension identifier returned by PIO_def_dim |
vardesc | Variable description structure. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::enddef_desc (File) |
Exits netcdf define mode. More... | |
integer function | pio_nf::enddef_id (ncid) |
Wrapper for the C function PIOc_enddef . More... | |
integer function pio_nf::enddef_desc | -( | -type (file_desc_t), intent(inout) | -File | ) | -- |
Exits netcdf define mode.
-File | File descriptor structure. This structure holds information associated with each open file |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::enddef_id | -( | -integer, intent(in) | -ncid | ) | -- |
Wrapper for the C function PIOc_enddef .
- -
- PIO
- 2.4.2
-
- |
-
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
-
- PIO
- 2.4.2
-
- |
-
Shuts down and cleans up any memory associated with the pio library. -More...
--Functions/Subroutines | |
subroutine | piolib_mod::finalize (iosystem, ierr) |
finalizes the pio subsystem. More... | |
Shuts down and cleans up any memory associated with the pio library.
-subroutine piolib_mod::finalize | -( | -type (iosystem_desc_t), intent(inout) | -iosystem, | -
- | - | integer(i4), intent(out) | -ierr | -
- | ) | -- |
finalizes the pio subsystem.
-This is a collective call which expects the following parameters
iosystem | : IO descriptor structure. This structure defines the mapping for a given variable between compute and IO decomposition. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
free memory associated with a io descriptor -More...
--Functions/Subroutines | |
subroutine | piolib_mod::freedecomp_ios (ios, iodesc) |
free all allocated storage associated with this decomposition More... | |
subroutine | piolib_mod::freedecomp_file (file, iodesc) |
free all allocated storage associated with this decomposition More... | |
free memory associated with a io descriptor
-subroutine piolib_mod::freedecomp_file | -( | -type (file_desc_t) | -file, | -
- | - | type (io_desc_t) | -iodesc | -
- | ) | -- |
free all allocated storage associated with this decomposition
-file | File descriptor structure. This structure holds information associated with each open file |
iodesc | : IO descriptor structure. This structure defines the mapping for a given variable between compute and IO decomposition. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
subroutine piolib_mod::freedecomp_ios | -( | -type (iosystem_desc_t) | -ios, | -
- | - | type (io_desc_t) | -iodesc | -
- | ) | -- |
free all allocated storage associated with this decomposition
-ios | : a defined pio system descriptor created by call to PIO_init (see PIO_types) |
iodesc | IO descriptor structure. This structure defines the mapping for a given variable between compute and IO decomposition. |
- PIO
- 2.4.2
-
- |
-
Reads an netcdf attribute from a file. -More...
--Functions/Subroutines | |
integer function | pionfatt_mod::get_att_desc_text (File, varDesc, name, values) |
Reads an netcdf attribute from a file. More... | |
integer function | pionfatt_mod::get_att_desc_1d_int (File, varDesc, name, values) |
Reads an netcdf attribute from a file. More... | |
integer function | pionfatt_mod::get_att_id_int (ncid, varid, name, values) |
Reads an netcdf attribute from a file. More... | |
integer function | pionfatt_mod::get_att_1d_real (File, varid, name, values) |
Reads an netcdf attribute from a file. More... | |
integer function | pionfatt_mod::get_att_1d_int (File, varid, name, values) |
Reads an netcdf attribute from a file. More... | |
integer function | pionfatt_mod::get_att_1d_double (File, varid, name, values) |
Reads an netcdf attribute from a file. More... | |
Reads an netcdf attribute from a file.
-integer function pionfatt_mod::get_att_1d_double | -( | -type (file_desc_t), intent(in), target | -File, | -
- | - | integer(i4), intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r8), dimension(:), intent(out) | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::get_att_1d_int | -( | -type (file_desc_t), intent(in), target | -File, | -
- | - | integer(i4), intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(i4), dimension(:), intent(out) | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::get_att_1d_real | -( | -type (file_desc_t), intent(in), target | -File, | -
- | - | integer(i4), intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r4), dimension(:), intent(out) | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::get_att_desc_1d_int | -( | -type (file_desc_t), intent(inout), target | -File, | -
- | - | type (var_desc_t), intent(in) | -varDesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(i4), dimension(:), intent(out) | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varDesc | Variable description structure. |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::get_att_desc_text | -( | -type (file_desc_t), intent(inout), target | -File, | -
- | - | type (var_desc_t), intent(in) | -varDesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | character(len=*), intent(out) | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varDesc | Variable description structure. |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::get_att_id_int | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(i4), intent(out), target | -values | -
- | ) | -- |
Reads an netcdf attribute from a file.
-ncid | : The netcdf file ID |
varid | : The netcdf variable identifier |
name | : name of the attribute to get |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function, public | piolib_mod::pio_get_local_array_size (iodesc) |
This function returns the expected local size of an array associated with iodesc. More... | |
integer function, public piolib_mod::pio_get_local_array_size | -( | -type(io_desc_t), intent(in) | -iodesc | ) | -- |
This function returns the expected local size of an array associated with iodesc.
-iodesc | IO descriptor structure. This structure defines the mapping for a given variable between compute and IO decomposition. |
- PIO
- 2.4.2
-
- |
-
Reads non-decomposed data from a NetCDF file. -More...
--Functions/Subroutines | |
integer function | pionfget_mod::get_var1_text (File, varid, index, ival) |
Reads non-decomposed fields from a NetCDF file. More... | |
integer function | pionfget_mod::get_var1_vdesc_text (File, vardesc, index, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_1d_int (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_2d_int (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_3d_int (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_4d_int (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_5d_int (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_1d_real (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_2d_real (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_3d_real (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_4d_real (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_5d_real (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_1d_double (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_2d_double (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_3d_double (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_4d_double (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_5d_double (File, varid, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_1d_text (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_2d_text (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_3d_text (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_4d_text (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_5d_text (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_1d_real (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_2d_real (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_3d_real (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_4d_real (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_5d_real (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_1d_double (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_2d_double (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_3d_double (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_4d_double (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_5d_double (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_1d_int (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_2d_int (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_3d_int (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_4d_int (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_vara_vdesc_5d_int (File, vardesc, start, count, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_var_0d_text (File, varid, ival) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfget_mod::get_var_vdesc_0d_text (File, vardesc, ival) |
Writes an netcdf attribute to a file. More... | |
Reads non-decomposed data from a NetCDF file.
-The get_var interface is provided as a simplified interface to read variables from a NetCDF format file. The variable is read on the root IO task and broadcast in its entirety to all tasks.
-integer function pionfget_mod::get_var1_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | character(len=*), intent(out) | -ival | -
- | ) | -- |
Reads non-decomposed fields from a NetCDF file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
index | : a multidimensional index that specifies which value to get |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_var1_vdesc_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | character(len=*), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
index | : a multidimensional index that specifies which value to get |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_var_0d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_var_vdesc_0d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_1d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_1d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_1d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_2d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_2d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_2d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_3d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_3d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_3d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_4d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_4d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_4d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_5d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_5d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_5d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
varid | : The netcdf variable identifier |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_1d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_1d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_1d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_1d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_2d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_2d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_2d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_2d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_3d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_3d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_3d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_3d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_4d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_4d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_4d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_4d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_5d_double | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_5d_int | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_5d_real | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
integer function pionfget_mod::get_vara_vdesc_5d_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:,:), intent(out) | -ival | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | file_desc_t |
vardesc | var_desc_t |
start | : A vector of size_t integers specifying the index in the variable where the first of the data values will be read. The indices are relative to 0, so for example, the first data value of a variable would have index (0, 0, ... , 0). The length of start must be the same as the number of dimensions of the specified variable. The elements of start correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first index would correspond to the starting record number for reading the data values. |
count | : A vector of size_t integers specifying the edge lengths along each dimension of the block of data values to be read. To read a single value, for example, specify count as (1, 1, ... , 1). The length of count is the number of dimensions of the specified variable. The elements of count correspond, in order, to the variable's dimensions. Hence, if the variable is a record variable, the first element of count corresponds to a count of the number of records to read. Note: setting any element of the count array to zero causes the function to exit without error, and without doing anything. |
ival | : The value for the netcdf metadata |
ierr | error return codes |
- PIO
- 2.4.2
-
- |
-
returns the actual number of IO-tasks used. -More...
--Functions/Subroutines | |
subroutine | piolib_mod::getnumiotasks (iosystem, numiotasks) |
This returns the number of IO-tasks that PIO is using. More... | |
returns the actual number of IO-tasks used.
-PIO will reset the total number of IO-tasks if certain conditions are meet
-subroutine piolib_mod::getnumiotasks | -( | -type (iosystem_desc_t), intent(in) | -iosystem, | -
- | - | integer(i4), intent(out) | -numiotasks | -
- | ) | -- |
This returns the number of IO-tasks that PIO is using.
-iosystem | : a defined pio system descriptor, see PIO_types |
numiotasks | : the number of IO-tasks |
- PIO
- 2.4.2
-
- |
-
initializes the pio subsystem -More...
--Functions/Subroutines | |
subroutine | piolib_mod::init_intracom (comp_rank, comp_comm, num_iotasks, num_aggregator, stride, rearr, iosystem, base, rearr_opts) |
initialize the pio subsystem. More... | |
subroutine | piolib_mod::init_intercom (component_count, peer_comm, comp_comms, io_comm, iosystem) |
Initialize the pio subsystem. More... | |
initializes the pio subsystem
-subroutine piolib_mod::init_intercom | -( | -integer, intent(in) | -component_count, | -
- | - | integer, intent(in) | -peer_comm, | -
- | - | integer, dimension(component_count), intent(in) | -comp_comms, | -
- | - | integer, intent(in) | -io_comm, | -
- | - | type (iosystem_desc_t), dimension(component_count), intent(out) | -iosystem | -
- | ) | -- |
Initialize the pio subsystem.
-This is a collective call. Input parameters are read on comp_rank=0 values on other tasks are ignored. This variation of PIO_init sets up a distinct set of tasks to handle IO, these tasks do not return from this call. Instead they go to an internal loop and wait to receive further instructions from the computational tasks
component_count | The number of computational components to associate with this IO component |
peer_comm | The communicator from which all other communicator arguments are derived |
comp_comms | The computational communicator for each of the computational components |
io_comm | The io communicator |
iosystem | a derived type which can be used in subsequent pio operations (defined in PIO_types). |
subroutine piolib_mod::init_intracom | -( | -integer(i4), intent(in) | -comp_rank, | -
- | - | integer(i4), intent(in) | -comp_comm, | -
- | - | integer(i4), intent(in) | -num_iotasks, | -
- | - | integer(i4), intent(in) | -num_aggregator, | -
- | - | integer(i4), intent(in) | -stride, | -
- | - | integer(i4), intent(in) | -rearr, | -
- | - | type (iosystem_desc_t), intent(out) | -iosystem, | -
- | - | integer(i4), intent(in), optional | -base, | -
- | - | type (pio_rearr_opt_t), intent(in), optional | -rearr_opts | -
- | ) | -- |
initialize the pio subsystem.
-This is a collective call. Input parameters are read on comp_rank=0 values on other tasks are ignored. This variation of PIO_init locates the IO tasks on a subset of the compute tasks.
comp_rank | mpi rank of each participating task, |
comp_comm | the mpi communicator which defines the collective. |
num_iotasks | the number of iotasks to define. |
num_aggregator | the mpi aggregator count |
stride | the stride in the mpi rank between io tasks. |
rearr | The three choices to control rearrangement are:
|
iosystem | a derived type which can be used in subsequent pio operations (defined in PIO_types). |
base | optional argument can be used to offset the first io task - default base is task 1. |
rearr_opts | the rearranger options. |
- PIO
- 2.4.2
-
- |
-
PIO_initdecomp is an overload interface the models decomposition to pio. -More...
--Functions/Subroutines | |
subroutine | piolib_mod::pio_initdecomp_bc (iosystem, basepiotype, dims, compstart, compcount, iodesc) |
Implements the block-cyclic decomposition for PIO_initdecomp. More... | |
subroutine | piolib_mod::initdecomp_2dof_bin_i4 (iosystem, basepiotype, dims, lenblocks, compdof, iodofr, iodofw, iodesc) |
A deprecated interface to the PIO_initdecomp method. More... | |
subroutine | piolib_mod::initdecomp_1dof_bin_i8 (iosystem, basepiotype, dims, lenblocks, compdof, iodofr, iodesc) |
A deprecated interface to the PIO_initdecomp method. More... | |
subroutine | piolib_mod::initdecomp_2dof_nf_i4 (iosystem, basepiotype, dims, lenblocks, compdof, iodofr, iodofw, start, count, iodesc) |
A deprecated interface to the PIO_initdecomp method. More... | |
subroutine | piolib_mod::initdecomp_1dof_nf_i4 (iosystem, basepiotype, dims, lenblocks, compdof, iodof, start, count, iodesc) |
A deprecated interface to the PIO_initdecomp method. More... | |
subroutine | piolib_mod::pio_initdecomp_dof_i4 (iosystem, basepiotype, dims, compdof, iodesc, rearr, iostart, iocount) |
Implements the degrees of freedom decomposition for PIO_initdecomp (previous name: initdecomp_1dof_nf_box) More... | |
PIO_initdecomp is an overload interface the models decomposition to pio.
-initdecomp_1dof_bin_i8, initdecomp_1dof_nf_i4, initdecomp_2dof_bin_i4, and initdecomp_2dof_nf_i4 are all depreciated, but supported for backwards compatibility.
-subroutine piolib_mod::initdecomp_1dof_bin_i8 | -( | -type (iosystem_desc_t), intent(in) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer(i4), intent(in) | -lenblocks, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -compdof, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -iodofr, | -
- | - | type (io_desc_t), intent(inout) | -iodesc | -
- | ) | -- |
A deprecated interface to the PIO_initdecomp method.
- -iosystem | : a defined pio system descriptor, see PIO_types |
basepiotype | : the type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | : an array of the global length of each dimesion of the variable(s) |
lenblocks | : |
compdof | : mapping of the storage order of the variable to its memory order |
iodofr | : |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
subroutine piolib_mod::initdecomp_1dof_nf_i4 | -( | -type (iosystem_desc_t), intent(in) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer (i4), intent(in) | -lenblocks, | -
- | - | integer (i4), dimension(:), intent(in) | -compdof, | -
- | - | integer (i4), dimension(:), intent(in) | -iodof, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -start, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -count, | -
- | - | type (io_desc_t), intent(inout) | -iodesc | -
- | ) | -- |
A deprecated interface to the PIO_initdecomp method.
- -iosystem | : a defined PIO system descriptor, see pio_types |
basepiotype | : The type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | : an array of the global length of each dimesion of the variable(s) |
lenblocks | : |
compdof | : mapping of the storage order of the variable to its memory order |
iodof | : |
start | : |
count | : |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
subroutine piolib_mod::initdecomp_2dof_bin_i4 | -( | -type (iosystem_desc_t), intent(in) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer (i4), intent(in) | -lenblocks, | -
- | - | integer (i4), dimension(:), intent(in) | -compdof, | -
- | - | integer (i4), dimension(:), intent(in) | -iodofr, | -
- | - | integer (i4), dimension(:), intent(in) | -iodofw, | -
- | - | type (io_desc_t), intent(inout) | -iodesc | -
- | ) | -- |
A deprecated interface to the PIO_initdecomp method.
- -iosystem | : a defined pio system descriptor, see PIO_types |
basepiotype | : the type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | : an array of the global length of each dimesion of the variable(s) |
lenblocks | : |
compdof | : mapping of the storage order of the variable to its memory order |
iodofr | : |
iodofw | : |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
subroutine piolib_mod::initdecomp_2dof_nf_i4 | -( | -type (iosystem_desc_t), intent(in) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer (i4), intent(in) | -lenblocks, | -
- | - | integer (i4), dimension(:), intent(in) | -compdof, | -
- | - | integer (i4), dimension(:), intent(in) | -iodofr, | -
- | - | integer (i4), dimension(:), intent(in) | -iodofw, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -start, | -
- | - | integer(pio_offset_kind), dimension(:), intent(in) | -count, | -
- | - | type (io_desc_t), intent(inout) | -iodesc | -
- | ) | -- |
A deprecated interface to the PIO_initdecomp method.
- -iosystem | : a defined pio system descriptor, see PIO_types |
basepiotype | : the type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | : an array of the global length of each dimesion of the variable(s) |
lenblocks | : |
compdof | : mapping of the storage order of the variable to its memory order |
iodofr | : |
iodofw | : |
start | : used with count to give a block description of the shape of the data |
count | : |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
subroutine piolib_mod::pio_initdecomp_bc | -( | -type (iosystem_desc_t), intent(inout) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer (kind=pio_offset_kind), dimension(:) | -compstart, | -
- | - | integer (kind=pio_offset_kind), dimension(:) | -compcount, | -
- | - | type (io_desc_t), intent(out) | -iodesc | -
- | ) | -- |
Implements the block-cyclic decomposition for PIO_initdecomp.
-This provides the ability to describe a computational decomposition in PIO that has a block-cyclic form. That is something that can be described using start and count arrays. Optional parameters for this subroutine allows for the specification of io decomposition using iostart and iocount arrays. If iostart and iocount arrays are not specified by the user, and rearrangement is turned on then PIO will calculate a suitable IO decomposition
iosystem | IO system descriptor structure. This structure contains the general IO subsystem data and MPI structure |
basepiotype | The type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | An array of the global length of each dimesion of the variable(s) |
compstart | The start index into the block-cyclic computational decomposition |
compcount | The count for the block-cyclic computational decomposition |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
subroutine piolib_mod::pio_initdecomp_dof_i4 | -( | -type (iosystem_desc_t), intent(inout) | -iosystem, | -
- | - | integer(i4), intent(in) | -basepiotype, | -
- | - | integer(i4), dimension(:), intent(in) | -dims, | -
- | - | integer(i4), dimension(:), intent(in) | -compdof, | -
- | - | type (io_desc_t), intent(inout) | -iodesc, | -
- | - | integer, optional, target | -rearr, | -
- | - | integer (pio_offset_kind), dimension(:), optional | -iostart, | -
- | - | integer (pio_offset_kind), dimension(:), optional | -iocount | -
- | ) | -- |
Implements the degrees of freedom decomposition for PIO_initdecomp (previous name: initdecomp_1dof_nf_box)
-This provides the ability to describe a computational decomposition in PIO using degrees of freedom method. This is a decomposition that can not be easily described using a start and count method. Optional parameters for this subroutine allows for the specififcation of io decomposition using iostart and iocount arrays. If iostart and iocount arrays are not specified by the user, and rearrangement is turned on then PIO will calculate an suitable IO decomposition. Note that this subroutine was previously called initdecomp_1dof_nf_box
iosystem | IO system descriptor structure. This structure contains the general IO subsystem data and MPI structure |
basepiotype | The type of variable(s) associated with this iodesc. The base types supported by PIO are:
|
dims | An array of the global length of each dimesion of the variable(s) |
compdof | Mapping of the storage order for the computational decomposition to its memory order |
iodesc | The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). |
rearr | rearranger |
iostart | The start index for the block-cyclic io decomposition |
iocount | The count for the block-cyclic io decomposition |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_att_desc (File, vardesc, name, xtype, len) |
Gets information about attributes. More... | |
-integer function | pio_nf::inq_att_vid (File, varid, name, xtype, len) |
Gets information about attributes. | |
-integer function | pio_nf::inq_att_id (ncid, varid, name, xtype, len) |
Gets information about attributes. | |
integer function pio_nf::inq_att_desc | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(out), optional | -xtype, | -
- | - | integer(pio_offset_kind), intent(out), optional | -len | -
- | ) | -- |
Gets information about attributes.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
name | : Name of the attribute |
xtype | : The type of attribute |
len | : The length of the attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_attlen_desc (File, vardesc, name, len) |
Gets the attribute length. More... | |
-integer function | pio_nf::inq_attlen_vid (File, varid, name, len) |
Gets the attribute length. | |
-integer function | pio_nf::inq_attlen_id (ncid, varid, name, len) |
Gets the attribute length. | |
integer function pio_nf::inq_attlen_desc | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(kind=pio_offset_kind), intent(out) | -len | -
- | ) | -- |
Gets the attribute length.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
name | : name of attribute |
len | : Length of attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
-integer function | pio_nf::inq_attname_desc (File, vdesc, attnum, name) |
Gets the name of an attribute. | |
-integer function | pio_nf::inq_attname_vid (File, varid, attnum, name) |
Gets the name of an attribute. | |
-integer function | pio_nf::inq_attname_id (ncid, varid, attnum, name) |
Gets the name of an attribute. | |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_dimid_desc (File, name, dimid) |
Returns the netcdf dimension id for the name. More... | |
integer function | pio_nf::inq_dimid_id (ncid, name, dimid) |
Returns the netcdf dimension id for the name. More... | |
integer function pio_nf::inq_dimid_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Returns the netcdf dimension id for the name.
-File | File descriptor structure. This structure holds information associated with each open file |
name | : The name of the netcdf dimension. |
dimid | : The netcdf dimension id. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
Note that we do not want internal error checking for this function.
- -integer function pio_nf::inq_dimid_id | -( | -integer, intent(in) | -ncid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer, intent(out) | -dimid | -
- | ) | -- |
Returns the netcdf dimension id for the name.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_dimlen_desc (File, dimid, len) |
Get information about the length of a particular dimension in netcdf file. More... | |
-integer function | pio_nf::inq_dimlen_desc_long (File, dimid, len) |
Get information about the length of a particular dimension in netcdf file. | |
-integer function | pio_nf::inq_dimlen_id (ncid, dimid, len) |
Get information about the length of a particular dimension in netcdf file. | |
-integer function | pio_nf::inq_dimlen_id_long (ncid, dimid, len) |
Get information about the length of a particular dimension in netcdf file. | |
integer function pio_nf::inq_dimlen_desc | -( | -type(file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -dimid, | -
- | - | integer, intent(out) | -len | -
- | ) | -- |
Get information about the length of a particular dimension in netcdf file.
-File | File descriptor structure. This structure holds information associated with each open file |
dimid | : The netcdf dimension ID. |
len | : The length of the dimesion. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_dimname_desc (File, dimid, name) |
Get information about the name of of a dimension. More... | |
integer function | pio_nf::inq_dimname_id (ncid, dimid, name) |
Get information about the name of of a dimension. More... | |
integer function pio_nf::inq_dimname_desc | -( | -type(file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -dimid, | -
- | - | character(len=*), intent(out) | -name | -
- | ) | -- |
Get information about the name of of a dimension.
-File | File descriptor structure. This structure holds information associated with each open file |
dimid | : The netcdf dimension ID. |
name | : The name of the dimesion. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_dimname_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -dimid, | -
- | - | character(len=*), intent(out) | -name | -
- | ) | -- |
Get information about the name of of a dimension.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_natts_desc (File, natts) |
Get information about the number of global attributes in a file or group. More... | |
integer function | pio_nf::inq_natts_id (ncid, natts) |
Get information about the number of global attributes in a file or group. More... | |
integer function pio_nf::inq_natts_desc | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(out) | -natts | -
- | ) | -- |
Get information about the number of global attributes in a file or group.
-File | File descriptor structure. This structure holds information associated with each open file |
natts | : The number of attributes in the file. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_natts_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(out) | -natts | -
- | ) | -- |
Get information about the number of global attributes in a file or group.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_ndims_desc (File, ndims) |
Get information about the number of dimensions of a file or group. More... | |
integer function | pio_nf::inq_ndims_id (ncid, ndims) |
Get information about the number of dimensions of a file or group. More... | |
integer function pio_nf::inq_ndims_desc | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(out) | -ndims | -
- | ) | -- |
Get information about the number of dimensions of a file or group.
-File | File descriptor structure. This structure holds information associated with each open file |
ndims | : The number of dimensions in the file. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_ndims_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(out) | -ndims | -
- | ) | -- |
Get information about the number of dimensions of a file or group.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_nvars_desc (File, nvars) |
Get information about the number of variables in a file or group. More... | |
integer function | pio_nf::inq_nvars_id (ncid, nvars) |
Get information about the number of variables in a file or group. More... | |
integer function pio_nf::inq_nvars_desc | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(out) | -nvars | -
- | ) | -- |
Get information about the number of variables in a file or group.
-File | File descriptor structure. This structure holds information associated with each open file |
nvars | : The number of variables in the file. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_nvars_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(out) | -nvars | -
- | ) | -- |
Get information about the number of variables in a file or group.
- -
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_var_deflate_desc (File, vardesc, shuffle, deflate, deflate_level) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_var_deflate_vid (File, varid, shuffle, deflate, deflate_level) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_var_deflate_id (ncid, varid, shuffle, deflate, deflate_level) |
Gets metadata information for netcdf file. More... | |
integer function pio_nf::inq_var_deflate_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | integer, intent(out) | -shuffle, | -
- | - | integer, intent(out) | -deflate, | -
- | - | integer, intent(out) | -deflate_level | -
- | ) | -- |
Gets metadata information for netcdf file.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
shuffle | : Value of shuffle |
deflate | : Status of deflate |
deflate_level | : Level of deflate |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_var_deflate_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -shuffle, | -
- | - | integer, intent(out) | -deflate, | -
- | - | integer, intent(out) | -deflate_level | -
- | ) | -- |
Gets metadata information for netcdf file.
- -integer function pio_nf::inq_var_deflate_vid | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -shuffle, | -
- | - | integer, intent(out) | -deflate, | -
- | - | integer, intent(out) | -deflate_level | -
- | ) | -- |
Gets metadata information for netcdf file.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_vardimid_desc (File, vardesc, dimids) |
returns the dimids of the variable as an interger array More... | |
-integer function | pio_nf::inq_vardimid_vid (File, varid, dimids) |
returns the dimids of the variable as an interger array | |
-integer function | pio_nf::inq_vardimid_id (ncid, varid, dimids) |
returns the dimids of the variable as an interger array | |
integer function pio_nf::inq_vardimid_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(out) | -dimids | -
- | ) | -- |
returns the dimids of the variable as an interger array
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
dimids | : The dimension identifier returned by PIO_def_dim |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_varid_desc (File, name, vardesc) |
Returns the ID of a netcdf variable given its name. More... | |
-integer function | pio_nf::inq_varid_vid (File, name, varid) |
Returns the ID of a netcdf variable given its name. | |
-integer function | pio_nf::inq_varid_id (ncid, name, varid) |
Returns the ID of a netcdf variable given its name. | |
integer function pio_nf::inq_varid_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | type (var_desc_t), intent(inout) | -vardesc | -
- | ) | -- |
Returns the ID of a netcdf variable given its name.
-File | File descriptor structure. This structure holds information associated with each open file |
name | : Name of the returned attribute |
vardesc | Variable description structure. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_varname_desc (File, vardesc, name) |
Get the name associated with a variable. More... | |
-integer function | pio_nf::inq_varname_vid (File, varid, name) |
Get the name associated with a variable. | |
-integer function | pio_nf::inq_varname_id (ncid, varid, name) |
Get the name associated with a variable. | |
integer function pio_nf::inq_varname_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), intent(out) | -name | -
- | ) | -- |
Get the name associated with a variable.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
name | : The name of the netcdf variable. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_varnatts_desc (File, vardesc, natts) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_varnatts_vid (File, varid, natts) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_varnatts_id (ncid, varid, natts) |
Gets metadata information for netcdf file. More... | |
integer function pio_nf::inq_varnatts_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | integer, intent(out) | -natts | -
- | ) | -- |
Gets metadata information for netcdf file.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
natts | : The number of atts |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_varnatts_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -natts | -
- | ) | -- |
Gets metadata information for netcdf file.
- -integer function pio_nf::inq_varnatts_vid | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -natts | -
- | ) | -- |
Gets metadata information for netcdf file.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_varndims_desc (File, vardesc, ndims) |
Gets the number of dimension associated with a netcdf variable. More... | |
-integer function | pio_nf::inq_varndims_vid (File, varid, ndims) |
Gets the number of dimension associated with a netcdf variable. | |
-integer function | pio_nf::inq_varndims_id (ncid, varid, ndims) |
Gets the number of dimension associated with a netcdf variable. | |
integer function pio_nf::inq_varndims_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | integer, intent(out) | -ndims | -
- | ) | -- |
Gets the number of dimension associated with a netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ndims | : The number of dimensions for the variable |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inq_vartype_desc (File, vardesc, type) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_vartype_vid (File, varid, type) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inq_vartype_id (ncid, varid, type) |
Gets metadata information for netcdf file. More... | |
integer function pio_nf::inq_vartype_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type (var_desc_t), intent(in) | -vardesc, | -
- | - | integer, intent(out) | -type | -
- | ) | -- |
Gets metadata information for netcdf file.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
type | : The type of variable |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inq_vartype_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -type | -
- | ) | -- |
Gets metadata information for netcdf file.
- -integer function pio_nf::inq_vartype_vid | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, intent(out) | -type | -
- | ) | -- |
Gets metadata information for netcdf file.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inquire_desc (File, nDimensions, nVariables, nAttributes, unlimitedDimID) |
Gets metadata information for netcdf file. More... | |
integer function | pio_nf::inquire_id (ncid, nDimensions, nVariables, nAttributes, unlimitedDimID) |
Gets metadata information for netcdf file. More... | |
integer function pio_nf::inquire_desc | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | integer, intent(out), optional | -nDimensions, | -
- | - | integer, intent(out), optional | -nVariables, | -
- | - | integer, intent(out), optional | -nAttributes, | -
- | - | integer, intent(out), optional | -unlimitedDimID | -
- | ) | -- |
Gets metadata information for netcdf file.
-File | File descriptor structure. This structure holds information associated with each open file |
nDimensions | : Number of dimensions defined for the netcdf file |
nVariables | : Number of variables defined for the netcdf file |
nAttributes | : Number of attributes defined for the netcdf file |
unlimitedDimID | : the Unlimited dimension ID |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::inquire_id | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(out), optional | -nDimensions, | -
- | - | integer, intent(out), optional | -nVariables, | -
- | - | integer, intent(out), optional | -nAttributes, | -
- | - | integer, intent(out), optional | -unlimitedDimID | -
- | ) | -- |
Gets metadata information for netcdf file.
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inquire_dimension_desc (file, dimid, name, len) |
Get information about a particular dimension in netcdf file. More... | |
-integer function | pio_nf::inquire_dimension_id (ncid, dimid, name, len) |
Get information about a particular dimension in netcdf file. | |
integer function pio_nf::inquire_dimension_desc | -( | -type(file_desc_t), intent(in) | -file, | -
- | - | integer, intent(in) | -dimid, | -
- | - | character (len = *), intent(out), optional | -name, | -
- | - | integer, intent(out), optional | -len | -
- | ) | -- |
Get information about a particular dimension in netcdf file.
-file | : A netcdf file descriptor returned by PIO_openfile or PIO_createfile. |
dimid | : The netcdf dimension ID. |
name | : The name of the dimension. |
len | : The length of the dimesions name. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::inquire_variable_desc (file, vardesc, name, xtype, ndims, dimids, natts) |
Inquires if a NetCDF variable is present and returns its attributes. More... | |
-integer function | pio_nf::inquire_variable_vid (file, varid, name, xtype, ndims, dimids, natts) |
Inquires if a NetCDF variable is present and returns its attributes. | |
-integer function | pio_nf::inquire_variable_id (ncid, varid, name, xtype, ndims, dimids, natts) |
Inquires if a NetCDF variable is present and returns its attributes. | |
integer function pio_nf::inquire_variable_desc | -( | -type(file_desc_t), intent(in) | -file, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character (len = *), intent(out), optional | -name, | -
- | - | integer, intent(out), optional | -xtype, | -
- | - | integer, intent(out), optional | -ndims, | -
- | - | integer, dimension(:), intent(out), optional | -dimids, | -
- | - | integer, intent(out), optional | -natts | -
- | ) | -- |
Inquires if a NetCDF variable is present and returns its attributes.
-file | : A netcdf file descriptor returned by PIO_openfile or PIO_createfile. |
vardesc | Variable description structure. |
name | : The name of the variable |
xtype | : The type of the variable |
ndims | : The number of dimensions for the variable. |
dimids | : The dimension identifier returned by PIO_def_dim |
natts | : Number of attributes associated with the variable |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
An integer parameter which controls the iotype. -More...
-An integer parameter which controls the iotype.
-
- PIO
- 2.4.2
-
- |
-
The base types supported by PIO are: -More...
-The base types supported by PIO are:
-
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
int | inq_file_metadata (file_desc_t *file, int ncid, int iotype, int *nvars, int **rec_var, int **pio_type, int **pio_type_size, MPI_Datatype **mpi_type, int **mpi_type_size) |
Internal function used when opening an existing file. More... | |
int | PIOc_openfile_retry (int iosysid, int *ncidp, int *iotype, const char *filename, int mode, int retry) |
Open an existing file using PIO library. More... | |
integer function, public | piolib_mod::pio_openfile (iosystem, file, iotype, fname, mode) |
open an existing file using pio More... | |
int inq_file_metadata | -( | -file_desc_t * | -file, | -
- | - | int | -ncid, | -
- | - | int | -iotype, | -
- | - | int * | -nvars, | -
- | - | int ** | -rec_var, | -
- | - | int ** | -pio_type, | -
- | - | int ** | -pio_type_size, | -
- | - | MPI_Datatype ** | -mpi_type, | -
- | - | int ** | -mpi_type_size | -
- | ) | -- |
Internal function used when opening an existing file.
-This function is called by PIOc_openfile_retry(). It learns some things about the metadata in that file. The results end up in the file_desc_t.
-file | pointer to the file_desc_t for this file. |
ncid | the ncid assigned to the file when opened. |
iotype | the iotype used to open the file. |
nvars | a pointer that gets the number of vars in the file. |
rec_var | gets an array (length nvars) of rec_var values for each var in the file. This array must be freed by caller. |
pio_type | gets an array (length nvars) of pio_type values for each var in the file. This array must be freed by caller. |
pio_type_size | gets an array (length nvars) of the size of the PIO type for each var in the file. This array must be freed by caller. |
mpi_type | gets an array (length nvars) of MPI type values for each var in the file. This array must be freed by caller. |
mpi_type_size | gets an array (length nvars) of the size of the MPI type for each var in the file. This array must be freed by caller. |
integer function, public piolib_mod::pio_openfile | -( | -type (iosystem_desc_t), intent(inout), target | -iosystem, | -
- | - | type (file_desc_t), intent(out) | -file, | -
- | - | integer, intent(in) | -iotype, | -
- | - | character(len=*), intent(in) | -fname, | -
- | - | integer, intent(in), optional | -mode | -
- | ) | -- |
open an existing file using pio
-Input parameters are read on comp task 0 and ignored elsewhere.
iosystem | : a defined pio system descriptor created by a call to PIO_init (see PIO_types) |
file | : the returned file descriptor |
iotype | : An integer parameter which controls the iotype. |
fname | : the name of the file to open |
mode | : a zero value (or PIO_nowrite) specifies the default behavior: open the dataset with read-only access, buffering and caching accesses for efficiency otherwise, the creation mode is PIO_write. setting the PIO_write flag opens the dataset with read-write access. ("writing" means any kind of change to the dataset, including appending or changing data, adding or renaming dimensions, variables, and attributes, or deleting attributes.) |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
int PIOc_openfile_retry | -( | -int | -iosysid, | -
- | - | int * | -ncidp, | -
- | - | int * | -iotype, | -
- | - | const char * | -filename, | -
- | - | int | -mode, | -
- | - | int | -retry | -
- | ) | -- |
Open an existing file using PIO library.
-This is an internal function. Depending on the value of the retry parameter, a failed open operation will be handled differently. If retry is non-zero, then a failed attempt to open a file with netCDF-4 (serial or parallel), or parallel-netcdf will be followed by an attempt to open the file as a serial classic netCDF file. This is an important feature to some NCAR users. The functionality is exposed to the user as PIOc_openfile() (which does the retry), and PIOc_open() (which does not do the retry).
-Input parameters are read on comp task 0 and ignored elsewhere.
-iosysid | a defined pio system descriptor. |
ncidp | a pio file descriptor. |
iotype | a pio output format. |
filename | the filename to open |
mode | the netcdf mode for the open operation |
retry | non-zero to automatically retry with netCDF serial classic. |
Return code from MPI function codes.
- -
- PIO
- 2.4.2
-
- |
-
Writes an netcdf attribute to a file. -More...
--Functions/Subroutines | |
integer function | pionfatt_mod::put_att_desc_text (File, vdesc, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_id_real (ncid, varid, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_id_double (ncid, varid, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_id_int (ncid, varid, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_desc_real (File, varDesc, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_desc_int (File, varDesc, name, values) |
Writes an netcdf attribute to a file. More... | |
integer function | pionfatt_mod::put_att_1d_desc_double (File, varDesc, name, values) |
Writes an netcdf attribute to a file. More... | |
Writes an netcdf attribute to a file.
-integer function pionfatt_mod::put_att_1d_desc_double | -( | -type (file_desc_t), intent(inout), target | -File, | -
- | - | type (var_desc_t), intent(in) | -varDesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r8), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varDesc | Variable description structure. |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_1d_desc_int | -( | -type (file_desc_t), intent(inout), target | -File, | -
- | - | type (var_desc_t), intent(in) | -varDesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(i4), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varDesc | Variable description structure. |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_1d_desc_real | -( | -type (file_desc_t), intent(inout), target | -File, | -
- | - | type (var_desc_t), intent(in) | -varDesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r4), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | File descriptor structure. This structure holds information associated with each open file |
varDesc | Variable description structure. |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_1d_id_double | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r8), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-ncid | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_1d_id_int | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | integer(i4), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-ncid | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_1d_id_real | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | real(r4), dimension(:), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-ncid | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfatt_mod::put_att_desc_text | -( | -type (file_desc_t), intent(in) | -File, | -
- | - | type(var_desc_t), intent(in) | -vdesc, | -
- | - | character(len=*), intent(in) | -name, | -
- | - | character(len=*), intent(in) | -values | -
- | ) | -- |
Writes an netcdf attribute to a file.
-File | File descriptor structure. This structure holds information associated with each open file |
vdesc | : The netcdf variable descriptor |
name | : name of the attribute to add |
values | : The value for the netcdf attribute |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
Writes data to a netCDF file. -More...
--Functions/Subroutines | |
integer function | pionfput_mod::put_var1_text (File, varid, index, ival) |
Write one element of data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var1_int (File, varid, index, ival) |
Write one element of data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var1_real (File, varid, index, ival) |
Write one element of data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var1_double (File, varid, index, ival) |
Write one element of data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var1_vdesc_text (File, vardesc, index, ival) |
Write one element of data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var_0d_text (File, varid, ival) |
Writes a netCDF scalar variable. More... | |
integer function | pionfput_mod::put_var_1d_text (File, varid, ival) |
Writes text data to netcdf variable. More... | |
integer function | pionfput_mod::put_var_2d_text (File, varid, ival) |
Writes text data to netcdf variable. More... | |
integer function | pionfput_mod::put_var_3d_text (File, varid, ival) |
Writes text data to netcdf variable. More... | |
integer function | pionfput_mod::put_var_4d_text (File, varid, ival) |
Writes text data to netcdf variable. More... | |
integer function | pionfput_mod::put_var_5d_text (File, varid, ival) |
Writes text data to netcdf variable. More... | |
integer function | pionfput_mod::put_var_internal_int (ncid, varid, ival) |
Writes int data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var_internal_real (ncid, varid, ival) |
Writes real data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var_internal_double (ncid, varid, ival) |
Writes double data to a netCDF variable. More... | |
integer function | pionfput_mod::put_var_1d_int (File, varid, ival) |
Write int data to a netCDF varaible of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_2d_int (File, varid, ival) |
Write int data to a netCDF varaible of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_3d_int (File, varid, ival) |
Write int data to a netCDF varaible of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_4d_int (File, varid, ival) |
Write int data to a netCDF varaible of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_5d_int (File, varid, ival) |
Write int data to a netCDF varaible of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_1d_real (File, varid, ival) |
Write real data to a netCDF varaible of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_2d_real (File, varid, ival) |
Write real data to a netCDF varaible of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_3d_real (File, varid, ival) |
Write real data to a netCDF varaible of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_4d_real (File, varid, ival) |
Write real data to a netCDF varaible of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_5d_real (File, varid, ival) |
Write real data to a netCDF varaible of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_1d_double (File, varid, ival) |
Write double data to a netCDF varaible of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_2d_double (File, varid, ival) |
Write double data to a netCDF varaible of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_3d_double (File, varid, ival) |
Write double data to a netCDF varaible of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_4d_double (File, varid, ival) |
Write double data to a netCDF varaible of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_5d_double (File, varid, ival) |
Write double data to a netCDF varaible of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_0d_int (File, varid, ival) |
Writes int data to a netCDF scalar variable. More... | |
integer function | pionfput_mod::put_var_0d_real (File, varid, ival) |
Writes real data to a netCDF scalar variable. More... | |
integer function | pionfput_mod::put_var_0d_double (File, varid, ival) |
Writes double data to a netCDF scalar variable. More... | |
integer function | pionfput_mod::put_var_vdesc_0d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 0 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_1d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_2d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_3d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_4d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_5d_text (File, vardesc, ival) |
Write text data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_0d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 0 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_1d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_2d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_3d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_4d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_5d_real (File, vardesc, ival) |
Write real data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_0d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 0 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_1d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_2d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_3d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_4d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_5d_double (File, vardesc, ival) |
Write double data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_0d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 0 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_1d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_2d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_3d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_4d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_var_vdesc_5d_int (File, vardesc, ival) |
Write int data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_1d_text (File, varid, start, count, ival) |
Write text data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_2d_text (File, varid, start, count, ival) |
Write text data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_3d_text (File, varid, start, count, ival) |
Write text data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_4d_text (File, varid, start, count, ival) |
Write text data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_5d_text (File, varid, start, count, ival) |
Write text data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_1d_int (File, varid, start, count, ival) |
Write int data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_2d_int (File, varid, start, count, ival) |
Write int data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_3d_int (File, varid, start, count, ival) |
Write int data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_4d_int (File, varid, start, count, ival) |
Write int data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_5d_int (File, varid, start, count, ival) |
Write int data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_1d_real (File, varid, start, count, ival) |
Write real data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_2d_real (File, varid, start, count, ival) |
Write real data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_3d_real (File, varid, start, count, ival) |
Write real data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_4d_real (File, varid, start, count, ival) |
Write real data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_5d_real (File, varid, start, count, ival) |
Write real data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_1d_double (File, varid, start, count, ival) |
Write double data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_2d_double (File, varid, start, count, ival) |
Write double data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_3d_double (File, varid, start, count, ival) |
Write double data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_4d_double (File, varid, start, count, ival) |
Write double data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_5d_double (File, varid, start, count, ival) |
Write double data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_1d_text (File, vardesc, start, count, ival) |
Write text data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_2d_text (File, vardesc, start, count, ival) |
Write text data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_3d_text (File, vardesc, start, count, ival) |
Write text data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_4d_text (File, vardesc, start, count, ival) |
Write text data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_5d_text (File, vardesc, start, count, ival) |
Write text data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_1d_real (File, vardesc, start, count, ival) |
Write real data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_2d_real (File, vardesc, start, count, ival) |
Write real data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_3d_real (File, vardesc, start, count, ival) |
Write real data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_4d_real (File, vardesc, start, count, ival) |
Write real data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_5d_real (File, vardesc, start, count, ival) |
Write real data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_1d_double (File, vardesc, start, count, ival) |
Write double data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_2d_double (File, vardesc, start, count, ival) |
Write double data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_3d_double (File, vardesc, start, count, ival) |
Write double data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_4d_double (File, vardesc, start, count, ival) |
Write double data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_5d_double (File, vardesc, start, count, ival) |
Write double data to a netcdf variable of 5 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_1d_int (File, vardesc, start, count, ival) |
Write int data to a netcdf variable of 1 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_2d_int (File, vardesc, start, count, ival) |
Write int data to a netcdf variable of 2 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_3d_int (File, vardesc, start, count, ival) |
Write int data to a netcdf variable of 3 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_4d_int (File, vardesc, start, count, ival) |
Write int data to a netcdf variable of 4 dimension(s). More... | |
integer function | pionfput_mod::put_vara_vdesc_5d_int (File, vardesc, start, count, ival) |
Write int data to a netcdf variable of 5 dimension(s). More... | |
Writes data to a netCDF file.
-The put_var interface is provided as a simplified interface to write variables to a netcdf format file.
integer function pionfput_mod::put_var1_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | real(r8), intent(in) | -ival | -
- | ) | -- |
Write one element of data to a netCDF variable.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
index | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var1_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | integer(i4), intent(in) | -ival | -
- | ) | -- |
Write one element of data to a netCDF variable.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
index | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var1_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | real(r4), intent(in) | -ival | -
- | ) | -- |
Write one element of data to a netCDF variable.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
index | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var1_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | character(len=*), intent(in) | -ival | -
- | ) | -- |
Write one element of data to a netCDF variable.
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
index | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var1_vdesc_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -index, | -
- | - | character(len=*), intent(in) | -ival | -
- | ) | -- |
Write one element of data to a netCDF variable.
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
index | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_0d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), intent(in) | -ival | -
- | ) | -- |
Writes double data to a netCDF scalar variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_0d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), intent(in) | -ival | -
- | ) | -- |
Writes int data to a netCDF scalar variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_0d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), intent(in) | -ival | -
- | ) | -- |
Writes real data to a netCDF scalar variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_0d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), intent(in) | -ival | -
- | ) | -- |
Writes a netCDF scalar variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf variable |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netCDF varaible of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netCDF varaible of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netCDF varaible of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_1d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), dimension(:), intent(in) | -ival | -
- | ) | -- |
Writes text data to netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netCDF varaible of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netCDF varaible of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netCDF varaible of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_2d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Writes text data to netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netCDF varaible of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netCDF varaible of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netCDF varaible of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_3d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Writes text data to netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netCDF varaible of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netCDF varaible of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netCDF varaible of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_4d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Writes text data to netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netCDF varaible of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netCDF varaible of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netCDF varaible of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_5d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | character(len=*), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Writes text data to netcdf variable.
-File | File descriptor structure. This structure holds information associated with each open file |
File | : A file handle returne from PIO_openfile or PIO_createfile. |
varid | : The netcdf variable identifier |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_internal_double | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r8), dimension(*), intent(in) | -ival | -
- | ) | -- |
Writes double data to a netCDF variable.
-ncid | : The netcdf file id. |
varid | : The netcdf variable identifier |
ival | : The data to write. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_internal_int | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer(i4), dimension(*), intent(in) | -ival | -
- | ) | -- |
Writes int data to a netCDF variable.
-ncid | : The netcdf file id. |
varid | : The netcdf variable identifier |
ival | : The data to write. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_internal_real | -( | -integer, intent(in) | -ncid, | -
- | - | integer, intent(in) | -varid, | -
- | - | real(r4), dimension(*), intent(in) | -ival | -
- | ) | -- |
Writes real data to a netCDF variable.
-ncid | : The netcdf file id. |
varid | : The netcdf variable identifier |
ival | : The data to write. |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_0d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 0 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_0d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 0 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_0d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 0 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_0d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 0 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_1d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_2d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_3d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_4d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_var_vdesc_5d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | character(len=*), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_1d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_2d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_3d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_4d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_5d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | integer, intent(in) | -varid, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
varid | : The netcdf variable identifier |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_1d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 1 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_2d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 2 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_3d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 3 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_4d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 4 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write double data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write int data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write real data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pionfput_mod::put_vara_vdesc_5d_text | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type(var_desc_t), intent(in) | -vardesc, | -
- | - | integer, dimension(:), intent(in) | -start, | -
- | - | integer, dimension(:), intent(in) | -count, | -
- | - | character(len=*), dimension(:,:,:,:,:), intent(in) | -ival | -
- | ) | -- |
Write text data to a netcdf variable of 5 dimension(s).
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
start | : |
count | : |
ival | : The value for the netcdf metadata |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
- PIO
- 2.4.2
-
- |
-
The overloaded PIO_read_darray function reads a distributed array from disk. -More...
--Functions/Subroutines | |
subroutine | piodarray::read_darray_1d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 1 dimension(s). More... | |
subroutine | piodarray::read_darray_2d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 2 dimension(s). More... | |
subroutine | piodarray::read_darray_3d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 3 dimension(s). More... | |
subroutine | piodarray::read_darray_4d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 4 dimension(s). More... | |
subroutine | piodarray::read_darray_5d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 5 dimension(s). More... | |
subroutine | piodarray::read_darray_6d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 6 dimension(s). More... | |
subroutine | piodarray::read_darray_7d_real (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type real from a netCDF variable of 7 dimension(s). More... | |
subroutine | piodarray::read_darray_1d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 1 dimension(s). More... | |
subroutine | piodarray::read_darray_2d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 2 dimension(s). More... | |
subroutine | piodarray::read_darray_3d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 3 dimension(s). More... | |
subroutine | piodarray::read_darray_4d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 4 dimension(s). More... | |
subroutine | piodarray::read_darray_5d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 5 dimension(s). More... | |
subroutine | piodarray::read_darray_6d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 6 dimension(s). More... | |
subroutine | piodarray::read_darray_7d_int (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type int from a netCDF variable of 7 dimension(s). More... | |
subroutine | piodarray::read_darray_1d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 1 dimension(s). More... | |
subroutine | piodarray::read_darray_2d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 2 dimension(s). More... | |
subroutine | piodarray::read_darray_3d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 3 dimension(s). More... | |
subroutine | piodarray::read_darray_4d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 4 dimension(s). More... | |
subroutine | piodarray::read_darray_5d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 5 dimension(s). More... | |
subroutine | piodarray::read_darray_6d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 6 dimension(s). More... | |
subroutine | piodarray::read_darray_7d_double (File, varDesc, ioDesc, array, iostat) |
Read distributed array of type double from a netCDF variable of 7 dimension(s). More... | |
The overloaded PIO_read_darray function reads a distributed array from disk.
-subroutine piodarray::read_darray_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 1 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 1 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 1 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 2 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 2 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 2 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 3 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 3 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 3 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 4 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 4 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 4 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 5 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 5 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 5 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_6d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 6 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_6d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 6 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_6d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 6 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_7d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type double from a netCDF variable of 7 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_7d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type int from a netCDF variable of 7 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
subroutine piodarray::read_darray_7d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:,:,:), intent(out) | -array, | -
- | - | integer(i4), intent(out) | -iostat | -
- | ) | -- |
Read distributed array of type real from a netCDF variable of 7 dimension(s).
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The read data |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
- PIO
- 2.4.2
-
- |
-
The four choices for rearranger communication direction. -More...
-The four choices for rearranger communication direction.
-
- PIO
- 2.4.2
-
- |
-
Type that defines the PIO rearranger options. -More...
-Type that defines the PIO rearranger options.
-
- PIO
- 2.4.2
-
- |
-
The two choices for rearranger communication. -More...
-The two choices for rearranger communication.
-
- PIO
- 2.4.2
-
- |
-
The three choices to control rearrangement are: -More...
-The three choices to control rearrangement are:
-
- PIO
- 2.4.2
-
- |
-
Type that defines the PIO rearranger options. -More...
-Type that defines the PIO rearranger options.
-
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
integer function | pio_nf::redef_desc (File) |
Exits netcdf define mode. More... | |
integer function | pio_nf::redef_id (ncid) |
Wrapper for the C function PIOc_redef . More... | |
integer function pio_nf::redef_desc | -( | -type (file_desc_t), intent(inout) | -File | ) | -- |
Exits netcdf define mode.
-File | File descriptor structure. This structure holds information associated with each open file |
ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
integer function pio_nf::redef_id | -( | -integer, intent(in) | -ncid | ) | -- |
Wrapper for the C function PIOc_redef .
- -
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
-subroutine | pio::pio_set_blocksize (blocksize) |
Set the target blocksize for the box rearranger. | |
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
sets the level of debug information that pio will generate. -More...
--Functions/Subroutines | |
subroutine | piolib_mod::setdebuglevel (level) |
sets the level of debug information output to stdout by pio More... | |
sets the level of debug information that pio will generate.
-subroutine piolib_mod::setdebuglevel | -( | -integer(i4), intent(in) | -level | ) | -- |
sets the level of debug information output to stdout by pio
-level | : default value is 0, allowed values 0-6 |
- PIO
- 2.4.2
-
- |
-
sets the form of error handling for pio. -More...
--Functions/Subroutines | |
subroutine | piolib_mod::seterrorhandlingfile (file, method, oldmethod) |
set the pio error handling method for a file More... | |
subroutine | piolib_mod::seterrorhandlingiosystem (iosystem, method, oldmethod) |
set the pio error handling method for a pio system More... | |
subroutine | piolib_mod::seterrorhandlingiosysid (iosysid, method, oldmethod) |
set the pio error handling method for a pio system or globally More... | |
sets the form of error handling for pio.
-By default pio handles errors internally by printing a string describing the error and calling mpi_abort. Application developers can change this behavior for calls to the underlying netcdf libraries with a call to PIO_seterrorhandling. For example if a developer wanted to see if an input netcdf format file contained the variable 'u' they might write the following
call pio_seterrorhandling(File, PIO_BCAST_ERROR) - ierr = pio_inq_varid(File, 'U', uid) - call pio_seterrorhandling(File, PIO_INTERNAL_ERROR) - if(ierr/= PIO_NOERR) then - write(stderr,*) 'Variable U not found on input file, setting to 0' - U=0 - else - ... - endif -
subroutine piolib_mod::seterrorhandlingfile | -( | -type(file_desc_t), intent(inout) | -file, | -
- | - | integer, intent(in) | -method, | -
- | - | integer, intent(out), optional | -oldmethod | -
- | ) | -- |
set the pio error handling method for a file
-file | File descriptor structure. This structure holds information associated with each open file |
method | : error handling method |
oldmethod | : old error handling method |
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
- -subroutine piolib_mod::seterrorhandlingiosysid | -( | -integer, intent(in) | -iosysid, | -
- | - | integer, intent(in) | -method, | -
- | - | integer, intent(out), optional | -oldmethod | -
- | ) | -- |
set the pio error handling method for a pio system or globally
-iosysid | : a pio system ID (pass PIO_DEFAULT to change the global default error handling) |
method | : |
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
oldmethod | : old error handling method |
subroutine piolib_mod::seterrorhandlingiosystem | -( | -type(iosystem_desc_t), intent(inout) | -iosystem, | -
- | - | integer, intent(in) | -method, | -
- | - | integer, intent(out), optional | -oldmethod | -
- | ) | -- |
set the pio error handling method for a pio system
-iosystem | : a defined pio system descriptor, see PIO_types |
method | : |
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
oldmethod | : old error handling method |
- PIO
- 2.4.2
-
- |
-
sets the unlimited dimension for netcdf file -More...
--Functions/Subroutines | |
subroutine | piolib_mod::setframe (file, vardesc, frame) |
sets the record dimension of a variable in a netcdf format file or the block address in a binary file More... | |
sets the unlimited dimension for netcdf file
-subroutine piolib_mod::setframe | -( | -type(file_desc_t) | -file, | -
- | - | type(var_desc_t), intent(inout) | -vardesc, | -
- | - | integer(pio_offset_kind), intent(in) | -frame | -
- | ) | -- |
sets the record dimension of a variable in a netcdf format file or the block address in a binary file
-File | File descriptor structure. This structure holds information associated with each open file |
vardesc | Variable description structure. |
frame | : frame number to set |
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
-Functions/Subroutines | |
subroutine | piolib_mod::syncfile (file) |
synchronizing a file forces all writes to complete before the subroutine returns. More... | |
subroutine piolib_mod::syncfile | -( | -type (file_desc_t), target | -file | ) | -- |
synchronizing a file forces all writes to complete before the subroutine returns.
-file | File descriptor structure. This structure holds information associated with each open file |
- PIO
- 2.4.2
-
- |
-
The overloaded PIO_write_darray writes a distributed array to disk. -More...
--Functions/Subroutines | |
subroutine | piodarray::write_darray_multi_1d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 1D array of type real. More... | |
subroutine | piodarray::write_darray_multi_1d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 1D array of type int. More... | |
subroutine | piodarray::write_darray_multi_1d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 1D array of type double. More... | |
subroutine | piodarray::write_darray_2d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 2D array of type real. More... | |
subroutine | piodarray::write_darray_3d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 3D array of type real. More... | |
subroutine | piodarray::write_darray_4d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 4D array of type real. More... | |
subroutine | piodarray::write_darray_5d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 5D array of type real. More... | |
subroutine | piodarray::write_darray_6d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 6D array of type real. More... | |
subroutine | piodarray::write_darray_7d_real (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 7D array of type real. More... | |
subroutine | piodarray::write_darray_2d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 2D array of type int. More... | |
subroutine | piodarray::write_darray_3d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 3D array of type int. More... | |
subroutine | piodarray::write_darray_4d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 4D array of type int. More... | |
subroutine | piodarray::write_darray_5d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 5D array of type int. More... | |
subroutine | piodarray::write_darray_6d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 6D array of type int. More... | |
subroutine | piodarray::write_darray_7d_int (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 7D array of type int. More... | |
subroutine | piodarray::write_darray_2d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 2D array of type double. More... | |
subroutine | piodarray::write_darray_3d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 3D array of type double. More... | |
subroutine | piodarray::write_darray_4d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 4D array of type double. More... | |
subroutine | piodarray::write_darray_5d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 5D array of type double. More... | |
subroutine | piodarray::write_darray_6d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 6D array of type double. More... | |
subroutine | piodarray::write_darray_7d_double (File, varDesc, ioDesc, array, iostat, fillval) |
Writes a 7D array of type double. More... | |
The overloaded PIO_write_darray writes a distributed array to disk.
-subroutine piodarray::write_darray_2d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 2D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_2d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 2D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_2d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 2D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_3d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 3D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_3d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 3D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_3d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 3D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_4d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 4D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_4d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 4D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_4d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 4D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_5d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 5D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_5d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 5D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_5d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 5D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_6d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 6D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_6d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 6D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_6d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 6D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_7d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:,:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 7D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_7d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:,:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 7D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_7d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:,:,:,:,:,:,:), intent(in) | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional | -fillval | -
- | ) | -- |
Writes a 7D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_multi_1d_double | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), dimension(:), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r8), dimension(:), intent(in), target | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r8), intent(in), optional, target | -fillval | -
- | ) | -- |
Writes a 1D array of type double.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_multi_1d_int | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), dimension(:), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | integer(i4), dimension(:), intent(in), target | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | integer(i4), intent(in), optional, target | -fillval | -
- | ) | -- |
Writes a 1D array of type int.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
subroutine piodarray::write_darray_multi_1d_real | -( | -type (file_desc_t), intent(inout) | -File, | -
- | - | type (var_desc_t), dimension(:), intent(inout) | -varDesc, | -
- | - | type (io_desc_t), intent(inout) | -ioDesc, | -
- | - | real(r4), dimension(:), intent(in), target | -array, | -
- | - | integer(i4), intent(out) | -iostat, | -
- | - | real(r4), intent(in), optional, target | -fillval | -
- | ) | -- |
Writes a 1D array of type real.
-File | file_desc_t |
varDesc | var_desc_t |
ioDesc | io_desc_t |
array | : The data to be written |
iostat | : The status returned from this routine (see PIO_seterrorhandling for details) |
fillval | : An optional fill value to fill holes in the data written |
- PIO
- 2.4.2
-
- |
-
: The error return code; ierr != PIO_noerr indicates an error. -More...
-: The error return code; ierr != PIO_noerr indicates an error.
-(see PIO_seterrorhandling )
-
- PIO
- 2.4.2
-
- |
-
The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types). -More...
-The io descriptor structure in defined in this subroutine and subsequently used in PIO_read_darray, PIO_write_darray, PIO_put_var, PIO_get_var calls (see pio_types).
-
- PIO
- 2.4.2
-
- |
-
The Parallel IO libraries (PIO) are high-level parallel I/O C and Fortran libraries for structured grid applications. PIO provides a netCDF-like API, and allows users to designate some subset of processors to perform IO. Computational code calls netCDF-like functions to read and write data, and PIO uses the IO processors to perform all necessary IO.
-PIO also supports the creation of multiple computation components, each containing many processors, and one shared set of IO processors. The computational components can perform write operation asynchronously, and the IO processors will take care of all storage interaction.
-This user's guide provides information about the PIO library and examples on how it can be used. Please watch the PIO GitHub site [https://github.com/NCAR/ParallelIO] for announcements and new releases.
- -
- PIO
- 2.4.2
-
- |
-
The PIO code is currently stored on github at https://github.com/PARALLELIO/ParallelIO. For questions about downloading or developing this code, consult the CIME Git Wiki or email jedwa. rds@ ucar. edu
-PIO can use NetCDF (version 4.6.1+) and/or PnetCDF (version 1.9.0+) for I/O. Ideally, the NetCDF version should be built with MPI, which requires that it be linked with an MPI-enabled version of HDF5. Optionally, NetCDF can be built with DAP support, which introduces a dependency on CURL. Additionally, HDF5, itself, introduces dependencies on LIBZ and (optionally) SZIP.
-To configure the build, PIO requires CMake version 2.8.12+. The typical configuration with CMake can be done as follows:
-> CC=mpicc FC=mpif90 cmake [-DOPTION1=value1 -DOPTION2=value2 ...] /path/to/pio/source -
where mpicc
and mpif90
are the appropriate MPI-enabled compiler wrappers for your system.
The OPTIONS
section typically should consist of pointers to the install locations for various dependencies, assuming these dependencies are not located in canonical search locations.
For each dependency XXX
, one can specify the location of its installation path with the CMake variable XXX_PATH
. If the C
and Fortran
libraries for the dependency are installed in different locations (such as can be done with NetCDF), then you can specify individually XXX_C_PATH
and XXX_Fortran_PATH
. Hence, you can specify the locations of both NetCDF-C and NetCDF-Fortran, as well as PnetCDF, with the following CMake configuration line:
> CC=mpicc FC=mpif90 cmake -DNetCDF_C_PATH=/path/to/netcdf-c \ - -DNetCDF_Fortran_PATH=/path/to/netcdf-fortran \ - -DPnetCDF_PATH=/path/to/pnetcdf \ - /path/to/pio/source -
This works for the dependencies: NetCDF
, PnetCDF
, HDF5
, LIBZ
, SZIP
.
For specific instructions to install on various commonly used super computers, please read the walk-through guide to PIO Installation.
-Additional configuration options can be specified on the command line.
-The PIO_ENABLE_TIMING
option can be set to ON
or OFF
to enable or disable the use of GPTL timing in the PIO libraries. This feature requires the GPTL C library for the PIO C
library and the GPTL Fortran library with the perf_mod.mod
and perf_utils.mod
interface modules. If these GPTL libraries are already installed on the system, the user can point PIO to the location of these libraries with the GPTL_PATH
variable (or, individually, GPTL_C_PATH
and GPTL_Fortran_Perf_PATH
variables). However, if these GPTL libraries are not installed on the system, and GPTL cannot be found, then PIO will build its own internal version of GPTL.
If PnetCDF is not installed on the system, the user can disable its use by setting -DWITH_PNETCDF=OFF
. This will disable the search for PnetCDF on the system and disable the use of PnetCDF from within PIO.
If the user wishes to disable the PIO tests, then the user can set the variable -DPIO_ENABLE_TESTS=OFF
. This will entirely disable the CTest testing suite, as well as remove all of the test build targets.
If you wish to install PIO in a safe location for use later with other software, you may set the CMAKE_INSTALL_PREFIX
variable to point to the desired install location.
Once you have successfully configured PIO with CMake in a build directory. From within the build directory, build PIO with:
-> make -
This will build the pioc
and piof
libraries.
If you desire to do testing, and PIO_ENABLE_TESTS=ON
(which is the default setting), you may build the test executables with:
> make tests -
Once the tests have been built, you may run tests with:
-> ctest -
Note: If you have not run make tests
before you run ctest
, then you will see all of the tests fail.
Alternatively, you may build the test executables and then run tests immediately with:
-> make check -
(similar to the typical make check
Autotools target).
ANOTHER NOTE:* These tests are designed to run in parallel. If you are on one of the supported supercomputing platforms (i.e., NERSC, NWSC, ALCF, etc.), then the ctest
command will assume that the tests will be run in an appropriately configured and scheduled parallel job. This can be done by requesting an interactive session from the login nodes and then running ctest
from within the interactive terminal. Alternatively, this can be done by running the ctest
command from a job submission script. It is important to understand, however, that ctest
itself will preface all of the test executable commands with the appropriate mpirun
/mpiexec
/runjob
/etc. Hence, you should not further preface the ctest
command with these MPI launchers.
Once you have built the PIO libraries, you may install them in the location specified by the CMAKE_INSTALL_PREFIX
. To do this, simply type:
> make install -
If the internal GPTL libraries were built (because GPTL could not be found and the PIO_ENABLE_TIMING
variable is set to ON
), then these libraries will be installed with PIO.
From within the build directory, build the PIO examples with:
-> make examples -
This will build the C and Fortran examples in under the examples subdirectory.
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for piodarray::PIOc_read_darray, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for piodarray::PIOc_write_darray_multi, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_get_att_double, including all inherited members.
-pioc_get_att_double(ncid, varid, name, op) (defined in pionfatt_mod::PIOc_get_att_double) | pionfatt_mod::PIOc_get_att_double |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_get_att_double (ncid, varid, name, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_get_att_float, including all inherited members.
-pioc_get_att_float(ncid, varid, name, op) (defined in pionfatt_mod::PIOc_get_att_float) | pionfatt_mod::PIOc_get_att_float |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_get_att_float (ncid, varid, name, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_get_att_int, including all inherited members.
-pioc_get_att_int(ncid, varid, name, op) (defined in pionfatt_mod::PIOc_get_att_int) | pionfatt_mod::PIOc_get_att_int |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_get_att_int (ncid, varid, name, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_get_att_text, including all inherited members.
-pioc_get_att_text(ncid, varid, name, op) (defined in pionfatt_mod::PIOc_get_att_text) | pionfatt_mod::PIOc_get_att_text |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_get_att_text (ncid, varid, name, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_put_att_double, including all inherited members.
-pioc_put_att_double(ncid, varid, name, xtype, len, op) (defined in pionfatt_mod::PIOc_put_att_double) | pionfatt_mod::PIOc_put_att_double |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_put_att_double (ncid, varid, name, xtype, len, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_put_att_float, including all inherited members.
-pioc_put_att_float(ncid, varid, name, xtype, len, op) (defined in pionfatt_mod::PIOc_put_att_float) | pionfatt_mod::PIOc_put_att_float |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_put_att_float (ncid, varid, name, xtype, len, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_put_att_int, including all inherited members.
-pioc_put_att_int(ncid, varid, name, xtype, len, op) (defined in pionfatt_mod::PIOc_put_att_int) | pionfatt_mod::PIOc_put_att_int |
- PIO
- 2.4.2
-
- |
-
-Public Member Functions | |
-integer(c_int) function | pioc_put_att_int (ncid, varid, name, xtype, len, op) |
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfatt_mod::PIOc_put_att_text, including all inherited members.
-pioc_put_att_text(ncid, varid, name, len, op) (defined in pionfatt_mod::PIOc_put_att_text) | pionfatt_mod::PIOc_put_att_text |
- PIO
- 2.4.2
-
- |
-
Write a netCDF text attribute. - More...
--Public Member Functions | |
-integer(c_int) function | pioc_put_att_text (ncid, varid, name, len, op) |
Write a netCDF text attribute.
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_var_double, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_var_float, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_var_int, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_vara_double, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_vara_float, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_vara_int, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfget_mod::PIOc_get_vara_text, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfput_mod::PIOc_put_vara_double, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfput_mod::PIOc_put_vara_float, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfput_mod::PIOc_put_vara_int, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
This is the complete list of members for pionfput_mod::PIOc_put_vara_text, including all inherited members.
-
- PIO
- 2.4.2
-
- |
-
- PIO
- 2.4.2
-
- |
-
PIO is a software interface layer designed to encapsolate the complexities of parallel IO and make it easier to replace the lower level software backend. It currently supports netcdf and pnetcdf .
-Basic description of how to optimize IO in a parallel environment:
-PIO calls are collective. A MPI communicator is set in a call to PIO_init and all tasks associated with that communicator must participate in all subsequent calls to PIO. An application can make multiple calls to PIO_init in order to support multiple MPI communicators.
-Begin by getting and unpacking the most recent release of PIO from gitHub and installing on your system as per the instructions in the Installation document. Take a look at examples of PIO usage in both complex and simple test programs in the [Examples](Examples) document. Finally, read through the FAQ to see if any remaining questions can be answered.
-t |