+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+
+ 1.8.13
+
+
+
diff --git a/docs/annotated.html b/docs/annotated.html
new file mode 100644
index 00000000000..2291d5b9b52
--- /dev/null
+++ b/docs/annotated.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
| ▼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 |
| ▼Npionfatt_mod | |
| CPIOc_get_att_double | |
| CPIOc_get_att_float | |
| CPIOc_get_att_int | |
| CPIOc_get_att_text | |
| CPIOc_put_att_double | |
| CPIOc_put_att_float | |
| CPIOc_put_att_int | |
| CPIOc_put_att_text | Write a netCDF text attribute |
| ▼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 |
+ 1.8.13
+
+
+
diff --git a/docs/api.html b/docs/api.html
new file mode 100644
index 00000000000..e78f0442824
--- /dev/null
+++ b/docs/api.html
@@ -0,0 +1,157 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is a list of all user interface routines:
+Also see: http://www.unidata.ucar.edu/software/netcdf/docs/
+
+ 1.8.13
+
+
+
diff --git a/docs/bc_s.png b/docs/bc_s.png
new file mode 100644
index 00000000000..224b29aa984
Binary files /dev/null and b/docs/bc_s.png differ
diff --git a/docs/bdwn.png b/docs/bdwn.png
new file mode 100644
index 00000000000..940a0b95044
Binary files /dev/null and b/docs/bdwn.png differ
diff --git a/docs/closed.png b/docs/closed.png
new file mode 100644
index 00000000000..98cc2c909da
Binary files /dev/null and b/docs/closed.png differ
diff --git a/docs/contributing_code.html b/docs/contributing_code.html
new file mode 100644
index 00000000000..55fb7b55fc9
--- /dev/null
+++ b/docs/contributing_code.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+
+ 1.8.13
+
+
+
diff --git a/docs/customdoxygen.css b/docs/customdoxygen.css
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/docs/decomp.html b/docs/decomp.html
new file mode 100644
index 00000000000..7f319c0d77d
--- /dev/null
+++ b/docs/decomp.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+
+ 1.8.13
+
+
+
diff --git a/docs/deprecated.html b/docs/deprecated.html
new file mode 100644
index 00000000000..3e617b5eeee
--- /dev/null
+++ b/docs/deprecated.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/dir_000001_000005.html b/docs/dir_000001_000005.html
new file mode 100644
index 00000000000..61716c5ad2a
--- /dev/null
+++ b/docs/dir_000001_000005.html
@@ -0,0 +1,75 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
| File in examples/c | Includes file in src |
|---|---|
| darray_async.c | clib / pio.h |
| darray_no_async.c | clib / pio.h |
| example1.c | clib / pio.h |
| example2.c | clib / pio.h |
| examplePio.c | clib / pio.h |
+ 1.8.13
+
+
+
diff --git a/docs/dir_105b7c361203833ef447ec1f3c9e0fde.html b/docs/dir_105b7c361203833ef447ec1f3c9e0fde.html
new file mode 100644
index 00000000000..a75b1deed25
--- /dev/null
+++ b/docs/dir_105b7c361203833ef447ec1f3c9e0fde.html
@@ -0,0 +1,98 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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 | piolib_mod.F90 |
| Initialization Routines for PIO. | |
+ 1.8.13
+
+
+
diff --git a/docs/dir_209baab7a174f8da935e472521be6c82.html b/docs/dir_209baab7a174f8da935e472521be6c82.html
new file mode 100644
index 00000000000..d42010e9135
--- /dev/null
+++ b/docs/dir_209baab7a174f8da935e472521be6c82.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Files | |
| file | examplePio.f90 |
| A simple Fortran example for the ParallelIO Library. | |
+ 1.8.13
+
+
+
diff --git a/docs/dir_4e7c8c4fc0d923782da8a23d70a9725b.html b/docs/dir_4e7c8c4fc0d923782da8a23d70a9725b.html
new file mode 100644
index 00000000000..9be3674bc89
--- /dev/null
+++ b/docs/dir_4e7c8c4fc0d923782da8a23d70a9725b.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
new file mode 100644
index 00000000000..d7edda724c8
--- /dev/null
+++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/dir_6df6542b1223c38c3752260fabab64d0.html b/docs/dir_6df6542b1223c38c3752260fabab64d0.html
new file mode 100644
index 00000000000..8c9b23290d0
--- /dev/null
+++ b/docs/dir_6df6542b1223c38c3752260fabab64d0.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
+ 1.8.13
+
+
+
diff --git a/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.map b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.map
new file mode 100644
index 00000000000..31f56c199ef
--- /dev/null
+++ b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.map
@@ -0,0 +1,6 @@
+
diff --git a/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.md5 b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.md5
new file mode 100644
index 00000000000..a48c18bc29c
--- /dev/null
+++ b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.md5
@@ -0,0 +1 @@
+c15eae5ab828351daca656d5f8d55de9
\ No newline at end of file
diff --git a/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.png b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.png
new file mode 100644
index 00000000000..201d2aaeec0
Binary files /dev/null and b/docs/dir_6df6542b1223c38c3752260fabab64d0_dep.png differ
diff --git a/docs/dir_d28a4824dc47e487b107a5db32ef43c4.html b/docs/dir_d28a4824dc47e487b107a5db32ef43c4.html
new file mode 100644
index 00000000000..b4922ff8d94
--- /dev/null
+++ b/docs/dir_d28a4824dc47e487b107a5db32ef43c4.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.map b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.map
new file mode 100644
index 00000000000..34341e04354
--- /dev/null
+++ b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.map
@@ -0,0 +1,7 @@
+
diff --git a/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.md5 b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.md5
new file mode 100644
index 00000000000..1eaf263e79e
--- /dev/null
+++ b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.md5
@@ -0,0 +1 @@
+9e340fa03f75ff81b19de76fe100348e
\ No newline at end of file
diff --git a/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.png b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.png
new file mode 100644
index 00000000000..efb6c649617
Binary files /dev/null and b/docs/dir_d28a4824dc47e487b107a5db32ef43c4_dep.png differ
diff --git a/docs/dir_dd5ba6a73ef501ea0d15f68121a953e3.html b/docs/dir_dd5ba6a73ef501ea0d15f68121a953e3.html
new file mode 100644
index 00000000000..4869779e111
--- /dev/null
+++ b/docs/dir_dd5ba6a73ef501ea0d15f68121a953e3.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Files | |
| file | piodarray.F90 |
| Read and write routines for decomposed data. | |
| file | pionfatt_mod.F90 |
| NetCDF attribute interface to PIO. | |
| file | pionfget_mod.F90 |
| Read Routines for non-decomposed NetCDF data. | |
| file | pionfput_mod.F90 |
| Write routines for non-decomposed NetCDF data. | |
+ 1.8.13
+
+
+
diff --git a/docs/dir_fbdd47254eba6596566cfbbd6768a55d.html b/docs/dir_fbdd47254eba6596566cfbbd6768a55d.html
new file mode 100644
index 00000000000..f277b5e7b86
--- /dev/null
+++ b/docs/dir_fbdd47254eba6596566cfbbd6768a55d.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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 (excluding varm functions). | |
| 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_sc.c |
| Compute start and count arrays for the box rearranger. | |
+ 1.8.13
+
+
+
diff --git a/docs/doc.png b/docs/doc.png
new file mode 100644
index 00000000000..17edabff95f
Binary files /dev/null and b/docs/doc.png differ
diff --git a/docs/doxygen.css b/docs/doxygen.css
new file mode 100644
index 00000000000..4f1ab9195b4
--- /dev/null
+++ b/docs/doxygen.css
@@ -0,0 +1,1596 @@
+/* The standard CSS for doxygen 1.8.13 */
+
+body, table, div, p, dl {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+p.reference, p.definition {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+/* @group Heading Levels */
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+.title {
+ font: 400 14px/28px Roboto,sans-serif;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
+}
+
+h2.groupheader {
+ border-bottom: 1px solid #879ECB;
+ color: #354C7B;
+ font-size: 150%;
+ font-weight: normal;
+ margin-top: 1.75em;
+ padding-top: 8px;
+ padding-bottom: 4px;
+ width: 100%;
+}
+
+h3.groupheader {
+ font-size: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ -webkit-transition: text-shadow 0.5s linear;
+ -moz-transition: text-shadow 0.5s linear;
+ -ms-transition: text-shadow 0.5s linear;
+ -o-transition: text-shadow 0.5s linear;
+ transition: text-shadow 0.5s linear;
+ margin-right: 15px;
+}
+
+h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
+ text-shadow: 0 0 15px cyan;
+}
+
+dt {
+ font-weight: bold;
+}
+
+div.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+p.starttd {
+ margin-top: 0px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.qindex, div.navtab{
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+}
+
+div.qindex, div.navpath {
+ width: 100%;
+ line-height: 140%;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a {
+ color: #3D578C;
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: #4665A2;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+a.qindex {
+ font-weight: bold;
+}
+
+a.qindexHL {
+ font-weight: bold;
+ background-color: #9CAFD4;
+ color: #ffffff;
+ border: 1px double #869DCA;
+}
+
+.contents a.qindexHL:visited {
+ color: #ffffff;
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+ color: #4665A2;
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+ color: #4665A2;
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+pre.fragment {
+ border: 1px solid #C4CFE5;
+ background-color: #FBFCFD;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
+ font-family: monospace, fixed;
+ font-size: 105%;
+}
+
+div.fragment {
+ padding: 0px;
+ margin: 4px 8px 4px 2px;
+ background-color: #FBFCFD;
+ border: 1px solid #C4CFE5;
+}
+
+div.line {
+ font-family: monospace, fixed;
+ font-size: 13px;
+ min-height: 13px;
+ line-height: 1.0;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+div.line:after {
+ content:"\000A";
+ white-space: pre;
+}
+
+div.line.glow {
+ background-color: cyan;
+ box-shadow: 0 0 10px cyan;
+}
+
+
+span.lineno {
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #0F0;
+ background-color: #E8E8E8;
+ white-space: pre;
+}
+span.lineno a {
+ background-color: #D8D8D8;
+}
+
+span.lineno a:hover {
+ background-color: #C8C8C8;
+}
+
+.lineno {
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+div.ah, span.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: solid thin #333;
+ border-radius: 0.5em;
+ -webkit-border-radius: .5em;
+ -moz-border-radius: .5em;
+ box-shadow: 2px 2px 3px #999;
+ -webkit-box-shadow: 2px 2px 3px #999;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
+ background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%);
+}
+
+div.classindex ul {
+ list-style: none;
+ padding-left: 0;
+}
+
+div.classindex span.ai {
+ display: inline-block;
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background-color: white;
+ color: black;
+ margin: 0;
+}
+
+div.contents {
+ margin-top: 10px;
+ margin-left: 12px;
+ margin-right: 8px;
+}
+
+td.indexkey {
+ background-color: #EBEFF6;
+ font-weight: bold;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+ white-space: nowrap;
+ vertical-align: top;
+}
+
+td.indexvalue {
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: #008000
+}
+
+span.keywordtype {
+ color: #604020
+}
+
+span.keywordflow {
+ color: #e08000
+}
+
+span.comment {
+ color: #800000
+}
+
+span.preprocessor {
+ color: #806020
+}
+
+span.stringliteral {
+ color: #002080
+}
+
+span.charliteral {
+ color: #008080
+}
+
+span.vhdldigit {
+ color: #ff00ff
+}
+
+span.vhdlchar {
+ color: #000000
+}
+
+span.vhdlkeyword {
+ color: #700070
+}
+
+span.vhdllogic {
+ color: #ff0000
+}
+
+blockquote {
+ background-color: #F7F8FB;
+ border-left: 2px solid #9CAFD4;
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+/* @end */
+
+/*
+.search {
+ color: #003399;
+ font-weight: bold;
+}
+
+form.search {
+ margin-bottom: 0px;
+ margin-top: 0px;
+}
+
+input.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
+}
+*/
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
+}
+
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: bold;
+}
+
+hr {
+ height: 0px;
+ border: none;
+ border-top: 1px solid #4A6AAA;
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: cyan;
+ box-shadow: 0 0 15px cyan;
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #F9FAFC;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memSeparator {
+ border-bottom: 1px solid #DEE4F0;
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: #4665A2;
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtitle {
+ padding: 8px;
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ margin-bottom: -1px;
+ background-image: url('nav_f.png');
+ background-repeat: repeat-x;
+ background-color: #E2E8F2;
+ line-height: 1.25;
+ font-weight: 300;
+ float:left;
+}
+
+.permalink
+{
+ font-size: 65%;
+ display: inline-block;
+ vertical-align: middle;
+}
+
+.memtemplate {
+ font-size: 80%;
+ color: #4665A2;
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.memnav {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
+ -webkit-transition: box-shadow 0.5s linear;
+ -moz-transition: box-shadow 0.5s linear;
+ -ms-transition: box-shadow 0.5s linear;
+ -o-transition: box-shadow 0.5s linear;
+ transition: box-shadow 0.5s linear;
+ display: table !important;
+ width: 100%;
+}
+
+.memitem.glow {
+ box-shadow: 0 0 15px cyan;
+}
+
+.memname {
+ font-weight: 400;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 0px 6px 0px;
+ color: #253555;
+ font-weight: bold;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ background-color: #DFE5F1;
+ /* opera specific markup */
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-top-right-radius: 4px;
+ /* firefox specific markup */
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ -moz-border-radius-topright: 4px;
+ /* webkit specific markup */
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -webkit-border-top-right-radius: 4px;
+
+}
+
+.overload {
+ font-family: "courier new",courier,monospace;
+ font-size: 65%;
+}
+
+.memdoc, dl.reflist dd {
+ border-bottom: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 10px 2px 10px;
+ background-color: #FBFCFD;
+ border-top-width: 0;
+ background-image:url('nav_g.png');
+ background-repeat:repeat-x;
+ background-color: #FFFFFF;
+ /* opera specific markup */
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ /* firefox specific markup */
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ /* webkit specific markup */
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+.paramname code {
+ line-height: 14px;
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir {
+ font-family: "courier new",courier,monospace;
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: #728DC1;
+ border-top:1px solid #5373B4;
+ border-left:1px solid #5373B4;
+ border-right:1px solid #C4CFE5;
+ border-bottom:1px solid #C4CFE5;
+ text-shadow: none;
+ color: white;
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view inside a (index) page */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid #9CAFD4;
+ border-bottom: 1px solid #9CAFD4;
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding-right: 6px;
+ padding-top: 3px;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ border-left: 1px solid rgba(0,0,0,0.05);
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: #F7F8FB;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: #3D578C;
+}
+
+.arrow {
+ color: #9CAFD4;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+}
+
+.icon {
+ font-family: Arial, Helvetica;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: #728DC1;
+ color: white;
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderopen.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('folderclosed.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('doc.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+table.directory {
+ font: 400 14px Roboto,sans-serif;
+}
+
+/* @end */
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: #2A3D61;
+}
+
+table.doxtable caption {
+ caption-side: top;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ /*width: 100%;*/
+ margin-bottom: 10px;
+ border: 1px solid #A8B8D9;
+ border-spacing: 0px;
+ -moz-border-radius: 4px;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid #A8B8D9;
+ border-bottom: 1px solid #A8B8D9;
+ vertical-align: top;
+}
+
+.fieldtable td.fieldname {
+ padding-top: 3px;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid #A8B8D9;
+ /*width: 100%;*/
+}
+
+.fieldtable td.fielddoc p:first-child {
+ margin-top: 0px;
+}
+
+.fieldtable td.fielddoc p:last-child {
+ margin-bottom: 2px;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-image:url('nav_f.png');
+ background-repeat:repeat-x;
+ background-color: #E2E8F2;
+ font-size: 90%;
+ color: #253555;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ font-weight: 400;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid #A8B8D9;
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: url('tab_b.png');
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath ul
+{
+ font-size: 11px;
+ background-image:url('tab_b.png');
+ background-repeat:repeat-x;
+ background-position: 0 -5px;
+ height:30px;
+ line-height:30px;
+ color:#8AA0CC;
+ border:solid 1px #C2CDE4;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li
+{
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:url('bc_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+}
+
+.navpath li.navelem a
+{
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
+ color: #283A5D;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover
+{
+ color:#6884BD;
+}
+
+.navpath li.footer
+{
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+ font-size: 8pt;
+}
+
+
+div.summary
+{
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
+
+div.summary a
+{
+ white-space: nowrap;
+}
+
+table.classindex
+{
+ margin: 10px;
+ white-space: nowrap;
+ margin-left: 3%;
+ margin-right: 3%;
+ width: 94%;
+ border: 0;
+ border-spacing: 0;
+ padding: 0;
+}
+
+div.ingroups
+{
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a
+{
+ white-space: nowrap;
+}
+
+div.header
+{
+ background-image:url('nav_h.png');
+ background-repeat:repeat-x;
+ background-color: #F9FAFC;
+ margin: 0px;
+ border-bottom: 1px solid #C4CFE5;
+}
+
+div.headertitle
+{
+ padding: 5px 5px 5px 10px;
+}
+
+dl
+{
+ padding: 0 0 0 10px;
+}
+
+/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
+dl.section
+{
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.note
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #505050;
+}
+
+dl.todo
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #C08050;
+}
+
+dl.section dd {
+ margin-bottom: 6px;
+}
+
+
+#projectlogo
+{
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img
+{
+ border: 0px none;
+}
+
+#projectalign
+{
+ vertical-align: middle;
+}
+
+#projectname
+{
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief
+{
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber
+{
+ font: 50% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea
+{
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #5373B4;
+}
+
+.image
+{
+ text-align: center;
+}
+
+.dotgraph
+{
+ text-align: center;
+}
+
+.mscgraph
+{
+ text-align: center;
+}
+
+.plantumlgraph
+{
+ text-align: center;
+}
+
+.diagraph
+{
+ text-align: center;
+}
+
+.caption
+{
+ font-weight: bold;
+}
+
+div.zoom
+{
+ border: 1px solid #90A5CE;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:#334975;
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+}
+
+dl.citelist dd {
+ margin:2px 0;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: #F4F6FA;
+ border: 1px solid #D8DFEE;
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 8px 10px 10px;
+ width: 200px;
+}
+
+div.toc li {
+ background: url("bdwn.png") no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 Arial,FreeSans,sans-serif;
+ color: #4665A2;
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 30px;
+}
+
+div.toc li.level4 {
+ margin-left: 45px;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: gray;
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ white-space: nowrap;
+ background-color: white;
+ border: 1px solid gray;
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: 1px 1px 7px gray;
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: grey;
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: #006318;
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font: 12px/16px Roboto,sans-serif;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before {
+ border-top-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+@media print
+{
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
+/* @group Markdown */
+
+/*
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.markdownTableHead tr {
+}
+
+table.markdownTableBodyLeft td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+th.markdownTableHeadLeft th.markdownTableHeadRight th.markdownTableHeadCenter th.markdownTableHeadNone {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter {
+ text-align: center
+}
+*/
+
+table.markdownTable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.markdownTable td, table.markdownTable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.markdownTable tr {
+}
+
+th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+th.markdownTableHeadLeft, td.markdownTableBodyLeft {
+ text-align: left
+}
+
+th.markdownTableHeadRight, td.markdownTableBodyRight {
+ text-align: right
+}
+
+th.markdownTableHeadCenter, td.markdownTableBodyCenter {
+ text-align: center
+}
+
+
+/* @end */
diff --git a/docs/doxygen.png b/docs/doxygen.png
new file mode 100644
index 00000000000..3ff17d807fd
Binary files /dev/null and b/docs/doxygen.png differ
diff --git a/docs/dtypes_8h_source.html b/docs/dtypes_8h_source.html
new file mode 100644
index 00000000000..97606c8970a
--- /dev/null
+++ b/docs/dtypes_8h_source.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
new file mode 100644
index 00000000000..85e18369095
--- /dev/null
+++ b/docs/dynsections.js
@@ -0,0 +1,97 @@
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+ content.hide();
+ summary.show();
+ $(linkObj).addClass('closed').removeClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ content.show();
+ summary.hide();
+ $(linkObj).removeClass('closed').addClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ return false;
+}
+
+function updateStripes()
+{
+ $('table.directory tr').
+ removeClass('even').filter(':visible:even').addClass('even');
+}
+
+function toggleLevel(level)
+{
+ $('table.directory tr').each(function() {
+ var l = this.id.split('_').length-1;
+ var i = $('#img'+this.id.substring(3));
+ var a = $('#arr'+this.id.substring(3));
+ if (l|
+ PIO
+ 2.4.0
+
+ |
+
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
+The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
+
+ 1.8.13
+
+
+
diff --git a/docs/examp.html b/docs/examp.html
new file mode 100644
index 00000000000..67b75fc57cf
--- /dev/null
+++ b/docs/examp.html
@@ -0,0 +1,95 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/example1_8c.html b/docs/example1_8c.html
new file mode 100644
index 00000000000..fd16d231125
--- /dev/null
+++ b/docs/example1_8c.html
@@ -0,0 +1,486 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/example1_8c__incl.map b/docs/example1_8c__incl.map
new file mode 100644
index 00000000000..0eb046f1dcf
--- /dev/null
+++ b/docs/example1_8c__incl.map
@@ -0,0 +1,3 @@
+
diff --git a/docs/example1_8c__incl.md5 b/docs/example1_8c__incl.md5
new file mode 100644
index 00000000000..f6cf399f15f
--- /dev/null
+++ b/docs/example1_8c__incl.md5
@@ -0,0 +1 @@
+55e365c2810caf69105a63b48a9c55d7
\ No newline at end of file
diff --git a/docs/example1_8c__incl.png b/docs/example1_8c__incl.png
new file mode 100644
index 00000000000..1bf1957bfe1
Binary files /dev/null and b/docs/example1_8c__incl.png differ
diff --git a/docs/example2_8c.html b/docs/example2_8c.html
new file mode 100644
index 00000000000..169eede751b
--- /dev/null
+++ b/docs/example2_8c.html
@@ -0,0 +1,714 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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][NC_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.
+ +Length of chunksizes to use in netCDF-4 files.
+ +Length of the dimensions in the sample data.
+ +| char dim_name[NDIM][NC_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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/example2_8c__incl.map b/docs/example2_8c__incl.map
new file mode 100644
index 00000000000..5954de96525
--- /dev/null
+++ b/docs/example2_8c__incl.map
@@ -0,0 +1,3 @@
+
diff --git a/docs/example2_8c__incl.md5 b/docs/example2_8c__incl.md5
new file mode 100644
index 00000000000..b976a8f4ce9
--- /dev/null
+++ b/docs/example2_8c__incl.md5
@@ -0,0 +1 @@
+859389a04a3976b66e38e403dd77936a
\ No newline at end of file
diff --git a/docs/example2_8c__incl.png b/docs/example2_8c__incl.png
new file mode 100644
index 00000000000..df2f7a695de
Binary files /dev/null and b/docs/example2_8c__incl.png differ
diff --git a/docs/example_pio_8c.html b/docs/example_pio_8c.html
new file mode 100644
index 00000000000..2e1af34a805
--- /dev/null
+++ b/docs/example_pio_8c.html
@@ -0,0 +1,635 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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. |
+ 1.8.13
+
+
+
diff --git a/docs/example_pio_8c__incl.map b/docs/example_pio_8c__incl.map
new file mode 100644
index 00000000000..3632c25cc60
--- /dev/null
+++ b/docs/example_pio_8c__incl.map
@@ -0,0 +1,3 @@
+
diff --git a/docs/example_pio_8c__incl.md5 b/docs/example_pio_8c__incl.md5
new file mode 100644
index 00000000000..b2ea0cf9b6e
--- /dev/null
+++ b/docs/example_pio_8c__incl.md5
@@ -0,0 +1 @@
+358e3b409d794bc3922912702840cf7e
\ No newline at end of file
diff --git a/docs/example_pio_8c__incl.png b/docs/example_pio_8c__incl.png
new file mode 100644
index 00000000000..f0a1ea1e2f8
Binary files /dev/null and b/docs/example_pio_8c__incl.png differ
diff --git a/docs/example_pio_8f90.html b/docs/example_pio_8f90.html
new file mode 100644
index 00000000000..09798385397
--- /dev/null
+++ b/docs/example_pio_8f90.html
@@ -0,0 +1,157 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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:
+
+ 1.8.13
+
+
+
diff --git a/docs/faq.html b/docs/faq.html
new file mode 100644
index 00000000000..117d4a05d50
--- /dev/null
+++ b/docs/faq.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
Here is a list of frequently asked questions and their answers.
The PIO Library distribution contains a testpio subdirectory with a number of programs to test the PIO library. Please see the Examples page for details.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/files.html b/docs/files.html
new file mode 100644
index 00000000000..05cd8ac0bbd
--- /dev/null
+++ b/docs/files.html
@@ -0,0 +1,102 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
| dtypes.h | |
| 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 (excluding varm functions) |
| 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_sc.c | Compute start and count arrays for the box rearranger |
| piodarray.F90 | Read and write routines for decomposed data |
| piolib_mod.F90 | Initialization Routines for PIO |
| pionfatt_mod.F90 | NetCDF attribute interface to PIO |
| pionfget_mod.F90 | Read Routines for non-decomposed NetCDF data |
| pionfput_mod.F90 | Write routines for non-decomposed NetCDF data |
+ 1.8.13
+
+
+
diff --git a/docs/folderclosed.png b/docs/folderclosed.png
new file mode 100644
index 00000000000..bb8ab35edce
Binary files /dev/null and b/docs/folderclosed.png differ
diff --git a/docs/folderopen.png b/docs/folderopen.png
new file mode 100644
index 00000000000..d6c7f676a3b
Binary files /dev/null and b/docs/folderopen.png differ
diff --git a/docs/globals.html b/docs/globals.html
new file mode 100644
index 00000000000..b81bd21ba54
--- /dev/null
+++ b/docs/globals.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_c.html b/docs/globals_c.html
new file mode 100644
index 00000000000..9736c57ee87
--- /dev/null
+++ b/docs/globals_c.html
@@ -0,0 +1,91 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_d.html b/docs/globals_d.html
new file mode 100644
index 00000000000..fdefab383c4
--- /dev/null
+++ b/docs/globals_d.html
@@ -0,0 +1,96 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_defs.html b/docs/globals_defs.html
new file mode 100644
index 00000000000..6a5c49a0b0f
--- /dev/null
+++ b/docs/globals_defs.html
@@ -0,0 +1,149 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_e.html b/docs/globals_e.html
new file mode 100644
index 00000000000..b162401c91f
--- /dev/null
+++ b/docs/globals_e.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_enum.html b/docs/globals_enum.html
new file mode 100644
index 00000000000..d194de860da
--- /dev/null
+++ b/docs/globals_enum.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_eval.html b/docs/globals_eval.html
new file mode 100644
index 00000000000..15bdcd5684d
--- /dev/null
+++ b/docs/globals_eval.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_f.html b/docs/globals_f.html
new file mode 100644
index 00000000000..ebd7e3d8594
--- /dev/null
+++ b/docs/globals_f.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func.html b/docs/globals_func.html
new file mode 100644
index 00000000000..243c2845507
--- /dev/null
+++ b/docs/globals_func.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_e.html b/docs/globals_func_e.html
new file mode 100644
index 00000000000..ff954d16026
--- /dev/null
+++ b/docs/globals_func_e.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_f.html b/docs/globals_func_f.html
new file mode 100644
index 00000000000..379cbbf3892
--- /dev/null
+++ b/docs/globals_func_f.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_g.html b/docs/globals_func_g.html
new file mode 100644
index 00000000000..d085b74cfdd
--- /dev/null
+++ b/docs/globals_func_g.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_i.html b/docs/globals_func_i.html
new file mode 100644
index 00000000000..766853c6964
--- /dev/null
+++ b/docs/globals_func_i.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_l.html b/docs/globals_func_l.html
new file mode 100644
index 00000000000..82f9028f88a
--- /dev/null
+++ b/docs/globals_func_l.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_m.html b/docs/globals_func_m.html
new file mode 100644
index 00000000000..5f363317885
--- /dev/null
+++ b/docs/globals_func_m.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_func_p.html b/docs/globals_func_p.html
new file mode 100644
index 00000000000..85ceb6a267a
--- /dev/null
+++ b/docs/globals_func_p.html
@@ -0,0 +1,911 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_g.html b/docs/globals_g.html
new file mode 100644
index 00000000000..eb6de43c457
--- /dev/null
+++ b/docs/globals_g.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_i.html b/docs/globals_i.html
new file mode 100644
index 00000000000..1949f0bcaaa
--- /dev/null
+++ b/docs/globals_i.html
@@ -0,0 +1,87 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_l.html b/docs/globals_l.html
new file mode 100644
index 00000000000..93d6d318af8
--- /dev/null
+++ b/docs/globals_l.html
@@ -0,0 +1,81 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_m.html b/docs/globals_m.html
new file mode 100644
index 00000000000..c703013c5a1
--- /dev/null
+++ b/docs/globals_m.html
@@ -0,0 +1,88 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_n.html b/docs/globals_n.html
new file mode 100644
index 00000000000..b6fca347d7c
--- /dev/null
+++ b/docs/globals_n.html
@@ -0,0 +1,89 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_p.html b/docs/globals_p.html
new file mode 100644
index 00000000000..2f1a9865af4
--- /dev/null
+++ b/docs/globals_p.html
@@ -0,0 +1,994 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_r.html b/docs/globals_r.html
new file mode 100644
index 00000000000..ceffd825982
--- /dev/null
+++ b/docs/globals_r.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_s.html b/docs/globals_s.html
new file mode 100644
index 00000000000..8103f5af9b8
--- /dev/null
+++ b/docs/globals_s.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_type.html b/docs/globals_type.html
new file mode 100644
index 00000000000..0e4d0c22ce7
--- /dev/null
+++ b/docs/globals_type.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_v.html b/docs/globals_v.html
new file mode 100644
index 00000000000..654b13fbf75
--- /dev/null
+++ b/docs/globals_v.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_vars.html b/docs/globals_vars.html
new file mode 100644
index 00000000000..a122758a854
--- /dev/null
+++ b/docs/globals_vars.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_w.html b/docs/globals_w.html
new file mode 100644
index 00000000000..df454522e32
--- /dev/null
+++ b/docs/globals_w.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/globals_x.html b/docs/globals_x.html
new file mode 100644
index 00000000000..f16b4c8364f
--- /dev/null
+++ b/docs/globals_x.html
@@ -0,0 +1,78 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/graph_legend.html b/docs/graph_legend.html
new file mode 100644
index 00000000000..dfda35b6726
--- /dev/null
+++ b/docs/graph_legend.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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:
+
+ 1.8.13
+
+
+
diff --git a/docs/graph_legend.md5 b/docs/graph_legend.md5
new file mode 100644
index 00000000000..a06ed050cbb
--- /dev/null
+++ b/docs/graph_legend.md5
@@ -0,0 +1 @@
+387ff8eb65306fa251338d3c9bd7bfff
\ No newline at end of file
diff --git a/docs/graph_legend.png b/docs/graph_legend.png
new file mode 100644
index 00000000000..81788d8b778
Binary files /dev/null and b/docs/graph_legend.png differ
diff --git a/docs/group___p_i_o__advanceframe.html b/docs/group___p_i_o__advanceframe.html
new file mode 100644
index 00000000000..ff3af972a23
--- /dev/null
+++ b/docs/group___p_i_o__advanceframe.html
@@ -0,0 +1,122 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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
+| [in,out] | vardesc | Variable description structure. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__closefile.html b/docs/group___p_i_o__closefile.html
new file mode 100644
index 00000000000..162b35cba49
--- /dev/null
+++ b/docs/group___p_i_o__closefile.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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 |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__createfile.html b/docs/group___p_i_o__createfile.html
new file mode 100644
index 00000000000..6d2c8c61066
--- /dev/null
+++ b/docs/group___p_i_o__createfile.html
@@ -0,0 +1,220 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Functions/Subroutines | |
| integer function | piolib_mod::createfile (iosystem, file, iotype, fname, amode_in) |
| Create a NetCDF or PNetCDF file using PIO. More... | |
| int | PIOc_createfile (int iosysid, int *ncidp, int *iotype, const char *filename, int mode) |
| Create a new 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 | +iosysid, | +
| + | + | int * | +ncidp, | +
| + | + | int * | +iotype, | +
| + | + | const char * | +filename, | +
| + | + | int | +mode | +
| + | ) | ++ |
Create a new file using pio.
+Input parameters are read on comp task 0 and ignored elsewhere. NOFILL mode will be turned on in all cases.
+| iosysid | A defined pio system ID, obtained from PIOc_InitIntercomm() 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. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__def__dim.html b/docs/group___p_i_o__def__dim.html
new file mode 100644
index 00000000000..4f1f1a093d3
--- /dev/null
+++ b/docs/group___p_i_o__def__dim.html
@@ -0,0 +1,331 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_def_dim (int ncid, const char *name, PIO_Offset len, int *idp) |
| The PIO-C interface for the NetCDF function nc_def_dim. 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.
+ +| int PIOc_def_dim | +( | +int | +ncid, | +
| + | + | const char * | +name, | +
| + | + | PIO_Offset | +len, | +
| + | + | int * | +idp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_def_dim.
+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__dimensions.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| idp | a pointer that will get the id of the variable or attribute. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__def__var.html b/docs/group___p_i_o__def__var.html
new file mode 100644
index 00000000000..6da12c9d277
--- /dev/null
+++ b/docs/group___p_i_o__def__var.html
@@ -0,0 +1,718 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_def_var_deflate (int ncid, int varid, int shuffle, int deflate, int deflate_level) |
| Set deflate (zlib) settings for a variable. More... | |
| int | PIOc_def_var_chunking (int ncid, int varid, int storage, const PIO_Offset *chunksizesp) |
| Set chunksizes for a variable. More... | |
| int | PIOc_def_var_endian (int ncid, int varid, int endian) |
| Set chunksizes for a variable. More... | |
| int | PIOc_set_chunk_cache (int iosysid, int iotype, PIO_Offset size, PIO_Offset nelems, float preemption) |
| Set chunk cache netCDF files to be opened/created. More... | |
| int | PIOc_get_chunk_cache (int iosysid, int iotype, PIO_Offset *sizep, PIO_Offset *nelemsp, float *preemptionp) |
| Get current file chunk cache settings from HDF5. More... | |
| int | PIOc_set_var_chunk_cache (int ncid, int varid, PIO_Offset size, PIO_Offset nelems, float preemption) |
| Set chunksizes for a variable. More... | |
| int | PIOc_def_var (int ncid, const char *name, nc_type xtype, int ndims, const int *dimidsp, int *varidp) |
| The PIO-C interface for the NetCDF function nc_def_var. More... | |
| int | PIOc_def_var_fill (int ncid, int varid, int fill_mode, const void *fill_valuep) |
| Set the fill value for a variable. More... | |
| 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 ) |
| int PIOc_def_var | +( | +int | +ncid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | int | +ndims, | +
| + | + | const int * | +dimidsp, | +
| + | + | int * | +varidp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_def_var.
+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__variables.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| varidp | a pointer that will get the variable id |
| int PIOc_def_var_chunking | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +storage, | +
| + | + | const PIO_Offset * | +chunksizesp | +
| + | ) | ++ |
Set chunksizes for a variable.
+This function only applies to netCDF-4 files. When used with netCDF classic files, the error PIO_ENOTNC4 will be returned.
+Chunksizes have important performance repercussions. NetCDF attempts to choose sensible chunk sizes by default, but for best performance check chunking against access patterns.
+See the netCDF variable documentation for details about the operation of this function.
+| ncid | the ncid of the open file. |
| varid | the ID of the variable to set chunksizes for. |
| storage | NC_CONTIGUOUS or NC_CHUNKED. |
| chunksizep | an array of chunksizes. Must have a chunksize for every variable dimension. |
| int PIOc_def_var_deflate | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +shuffle, | +
| + | + | int | +deflate, | +
| + | + | int | +deflate_level | +
| + | ) | ++ |
Set deflate (zlib) settings for a variable.
+This function only applies to netCDF-4 files. When used with netCDF classic files, the error PIO_ENOTNC4 will be returned.
+See the netCDF variable documentation for details about the operation of this function.
+| ncid | the ncid of the open file. |
| varid | the ID of the variable. |
| shuffle | non-zero to turn on shuffle filter (can be good for integer data). |
| deflate | non-zero to turn on zlib compression for this variable. |
| deflate_level | 1 to 9, with 1 being faster and 9 being more compressed. |
| int PIOc_def_var_endian | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +endian | +
| + | ) | ++ |
Set chunksizes for a variable.
+This function only applies to netCDF-4 files. When used with netCDF classic files, the error PIO_ENOTNC4 will be returned.
+See the netCDF variable documentation for details about the operation of this function.
+Chunksizes have important performance repercussions. NetCDF attempts to choose sensible chunk sizes by default, but for best performance check chunking against access patterns.
+| ncid | the ncid of the open file. |
| varid | the ID of the variable to set chunksizes for. |
| storage | NC_CONTIGUOUS or NC_CHUNKED. |
| chunksizep | an array of chunksizes. Must have a chunksize for every variable dimension. |
| int PIOc_def_var_fill | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +fill_mode, | +
| + | + | const void * | +fill_valuep | +
| + | ) | ++ |
Set the fill value for a variable.
+See the netCDF variable documentation for details about the operation of this function.
+When the fill mode for the file is NC_FILL, then fill values are used for missing data. This function sets the fill value to be used for a variable. If no specific fill value is set (as a _FillValue attribute), then the default fill values from netcdf.h are used.
+NetCDF-4 and pnetcdf files allow setting fill_mode (to NC_FILL or NC_NOFILL) on a per-variable basis. NetCDF classic only allows the fill_mode setting to be set for the whole file. For this function, the fill_mode parameter is ignored for classic files. Set the file-level fill mode with PIOc_set_fill().
+| ncid | the ncid of the open file. |
| varid | the ID of the variable to set chunksizes for. |
| fill_mode | fill mode for this variable (NC_FILL or NC_NOFILL) |
| fill_value | pointer to the fill value to be used if fill_mode is set to NC_FILL. |
| int PIOc_get_chunk_cache | +( | +int | +iosysid, | +
| + | + | int | +iotype, | +
| + | + | PIO_Offset * | +sizep, | +
| + | + | PIO_Offset * | +nelemsp, | +
| + | + | float * | +preemptionp | +
| + | ) | ++ |
Get current file chunk cache settings from HDF5.
+This function has no effect on netCDF classic files. Calling this function with iotype of PIO_IOTYPE_PNETCDF or PIO_IOTYPE_NETCDF returns an error.
+The file chunk cache for HDF5 can be set, and will apply for any files opened or created until the program ends, or the settings are changed again. The cache settings apply only to the open file. They do not persist with the file, and must be set each time the file is opened, before it is opened, if they are to have effect.
+See the netCDF variable documentation for details about the operation of this function.
+Chunksizes have important performance repercussions. NetCDF attempts to choose sensible chunk sizes by default, but for best performance check chunking against access patterns.
+| iotype | the iotype of files to be created or opened. |
| sizep | gets the size of file cache. |
| nelemsp | gets the number of elements in file cache. |
| preemptionp | gets the preemption setting for file cache. |
| int PIOc_set_chunk_cache | +( | +int | +iosysid, | +
| + | + | int | +iotype, | +
| + | + | PIO_Offset | +size, | +
| + | + | PIO_Offset | +nelems, | +
| + | + | float | +preemption | +
| + | ) | ++ |
Set chunk cache netCDF files to be opened/created.
+This function only applies to netCDF-4 files. When used with netCDF classic files, the error PIO_ENOTNC4 will be returned.
+The file chunk cache for HDF5 can be set, and will apply for any files opened or created until the program ends, or the settings are changed again. The cache settings apply only to the open file. They do not persist with the file, and must be set each time the file is opened, before it is opened, if they are to have effect.
+See the netCDF variable documentation for details about the operation of this function.
+| iotype | the iotype of files to be created or opened. |
| size | size of file cache. |
| nelems | number of elements in file cache. |
| preemption | preemption setting for file cache. |
| int PIOc_set_var_chunk_cache | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | PIO_Offset | +size, | +
| + | + | PIO_Offset | +nelems, | +
| + | + | float | +preemption | +
| + | ) | ++ |
Set chunksizes for a variable.
+This function only applies to netCDF-4 files. When used with netCDF classic files, the error PIO_ENOTNC4 will be returned.
+See the netCDF variable documentation for details about the operation of this function.
+Chunksizes have important performance repercussions. NetCDF attempts to choose sensible chunk sizes by default, but for best performance check chunking against access patterns.
+| ncid | the ncid of the open file. |
| varid | the ID of the variable to set chunksizes for. |
| storage | NC_CONTIGUOUS or NC_CHUNKED. |
| chunksizep | an array of chunksizes. Must have a chunksize for every variable dimension. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__enddef.html b/docs/group___p_i_o__enddef.html
new file mode 100644
index 00000000000..45a72f7d764
--- /dev/null
+++ b/docs/group___p_i_o__enddef.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_enddef (int ncid) |
| The PIO-C interface for the NetCDF function nc_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 .
+ +| int PIOc_enddef | +( | +int | +ncid | ) | ++ |
The PIO-C interface for the NetCDF function nc_enddef.
+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__datasets.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__error__method.html b/docs/group___p_i_o__error__method.html
new file mode 100644
index 00000000000..38eafea098f
--- /dev/null
+++ b/docs/group___p_i_o__error__method.html
@@ -0,0 +1,224 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Functions/Subroutines | |
| int | PIOc_Set_File_Error_Handling (int ncid, int method) |
| Set the error handling method to be used for subsequent pio library calls, returns the previous method setting. More... | |
| int | PIOc_Set_IOSystem_Error_Handling (int iosysid, int method) |
| Set the error handling method used for subsequent calls. More... | |
| int | PIOc_set_iosystem_error_handling (int iosysid, int method, int *old_method) |
| Set the error handling method used for subsequent calls for this IO system. More... | |
The three types of error handling methods are:
Use this instead of ios to set error handling for the library.
+| int PIOc_Set_File_Error_Handling | +( | +int | +ncid, | +
| + | + | int | +method | +
| + | ) | ++ |
Set the error handling method to be used for subsequent pio library calls, returns the previous method setting.
+Note that this changes error handling for the IO system that was used when this file was opened. Other files opened with the same IO system will also he affected by this call. This function is supported but deprecated. New code should use PIOc_set_iosystem_error_handling(). This method has no way to return an error, so any failure will result in MPI_Abort.
+| ncid | the ncid of an open file |
| method | the error handling method |
| int PIOc_Set_IOSystem_Error_Handling | +( | +int | +iosysid, | +
| + | + | int | +method | +
| + | ) | ++ |
Set the error handling method used for subsequent calls.
+This function is deprecated. New code should use PIOc_set_iosystem_error_handling(). This method has no way to return an error, so any failure will result in MPI_Abort.
+| iosysid | the IO system ID |
| method | the error handling method |
| int PIOc_set_iosystem_error_handling | +( | +int | +iosysid, | +
| + | + | int | +method, | +
| + | + | int * | +old_method | +
| + | ) | ++ |
Set the error handling method used for subsequent calls for this IO system.
+| iosysid | the IO system ID. Passing PIO_DEFAULT instead changes the default error handling for the library. |
| method | the error handling method |
| old_method | pointer to int that will get old method. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__finalize.html b/docs/group___p_i_o__finalize.html
new file mode 100644
index 00000000000..8f0b2c03bac
--- /dev/null
+++ b/docs/group___p_i_o__finalize.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_finalize (int iosysid) |
| Clean up internal data structures, free MPI resources, and exit the pio library. 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 ) |
| int PIOc_finalize | +( | +int | +iosysid | ) | ++ |
Clean up internal data structures, free MPI resources, and exit the pio library.
+| iosysid | the io system ID provided by PIOc_Init_Intracomm(). |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__freedecomp.html b/docs/group___p_i_o__freedecomp.html
new file mode 100644
index 00000000000..e0a734940e1
--- /dev/null
+++ b/docs/group___p_i_o__freedecomp.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__get__att.html b/docs/group___p_i_o__get__att.html
new file mode 100644
index 00000000000..d78ea6acd72
--- /dev/null
+++ b/docs/group___p_i_o__get__att.html
@@ -0,0 +1,1189 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_get_att (int ncid, int varid, const char *name, void *ip) |
| Get the value of an attribute of any type, with no type conversion. More... | |
| int | PIOc_get_att_double (int ncid, int varid, const char *name, double *ip) |
| Get the value of an 64-bit floating point array attribute. More... | |
| int | PIOc_get_att_uchar (int ncid, int varid, const char *name, unsigned char *ip) |
| Get the value of an 8-bit unsigned char array attribute. More... | |
| int | PIOc_get_att_ushort (int ncid, int varid, const char *name, unsigned short *ip) |
| Get the value of an 16-bit unsigned integer array attribute. More... | |
| int | PIOc_get_att_uint (int ncid, int varid, const char *name, unsigned int *ip) |
| Get the value of an 32-bit unsigned integer array attribute. More... | |
| int | PIOc_get_att_long (int ncid, int varid, const char *name, long *ip) |
| Get the value of an 32-bit ingeger array attribute. More... | |
| int | PIOc_get_att_text (int ncid, int varid, const char *name, char *ip) |
| Get the value of an text attribute. More... | |
| int | PIOc_get_att_schar (int ncid, int varid, const char *name, signed char *ip) |
| Get the value of an 8-bit signed char array attribute. More... | |
| int | PIOc_get_att_ulonglong (int ncid, int varid, const char *name, unsigned long long *ip) |
| Get the value of an 64-bit unsigned integer array attribute. More... | |
| int | PIOc_get_att_short (int ncid, int varid, const char *name, short *ip) |
| Get the value of an 16-bit integer array attribute. More... | |
| int | PIOc_get_att_int (int ncid, int varid, const char *name, int *ip) |
| Get the value of an 32-bit integer array attribute. More... | |
| int | PIOc_get_att_longlong (int ncid, int varid, const char *name, long long *ip) |
| Get the value of an 64-bit integer array attribute. More... | |
| int | PIOc_get_att_float (int ncid, int varid, const char *name, float *ip) |
| Get the value of an 32-bit floating point array attribute. 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.
+| 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 ) |
| int PIOc_get_att | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | void * | +ip | +
| + | ) | ++ |
Get the value of an attribute of any type, with no type conversion.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_double | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | double * | +ip | +
| + | ) | ++ |
Get the value of an 64-bit floating point array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_float | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | float * | +ip | +
| + | ) | ++ |
Get the value of an 32-bit floating point array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_int | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | int * | +ip | +
| + | ) | ++ |
Get the value of an 32-bit integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_long | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | long * | +ip | +
| + | ) | ++ |
Get the value of an 32-bit ingeger array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_longlong | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | long long * | +ip | +
| + | ) | ++ |
Get the value of an 64-bit integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_schar | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | signed char * | +ip | +
| + | ) | ++ |
Get the value of an 8-bit signed char array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_short | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | short * | +ip | +
| + | ) | ++ |
Get the value of an 16-bit integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_text | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | char * | +ip | +
| + | ) | ++ |
Get the value of an text attribute.
+There is no type conversion with this call. If the attribute is not of type NC_CHAR, then an error will be returned.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_uchar | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | unsigned char * | +ip | +
| + | ) | ++ |
Get the value of an 8-bit unsigned char array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_uint | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | unsigned int * | +ip | +
| + | ) | ++ |
Get the value of an 32-bit unsigned integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_ulonglong | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | unsigned long long * | +ip | +
| + | ) | ++ |
Get the value of an 64-bit unsigned integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
| int PIOc_get_att_ushort | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | unsigned short * | +ip | +
| + | ) | ++ |
Get the value of an 16-bit unsigned integer array attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute to get |
| ip | a pointer that will get the attribute value. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__get__local__array__size.html b/docs/group___p_i_o__get__local__array__size.html
new file mode 100644
index 00000000000..79a09b0a29b
--- /dev/null
+++ b/docs/group___p_i_o__get__local__array__size.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__get__var.html b/docs/group___p_i_o__get__var.html
new file mode 100644
index 00000000000..e5e53e89c60
--- /dev/null
+++ b/docs/group___p_i_o__get__var.html
@@ -0,0 +1,2659 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__getnumiotasks.html b/docs/group___p_i_o__getnumiotasks.html
new file mode 100644
index 00000000000..cc2883991f2
--- /dev/null
+++ b/docs/group___p_i_o__getnumiotasks.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__init.html b/docs/group___p_i_o__init.html
new file mode 100644
index 00000000000..018470f0fe9
--- /dev/null
+++ b/docs/group___p_i_o__init.html
@@ -0,0 +1,450 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_Init_Intracomm (MPI_Comm comp_comm, int num_iotasks, int stride, int base, int rearr, int *iosysidp) |
| Library initialization used when IO tasks are a subset of compute tasks. More... | |
| int | PIOc_init_async (MPI_Comm world, int num_io_procs, int *io_proc_list, int component_count, int *num_procs_per_comp, int **proc_list, MPI_Comm *user_io_comm, MPI_Comm *user_comp_comm, int rearranger, int *iosysidp) |
| Library initialization used when IO tasks are distinct from compute tasks. 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. |
| int PIOc_init_async | +( | +MPI_Comm | +world, | +
| + | + | int | +num_io_procs, | +
| + | + | int * | +io_proc_list, | +
| + | + | int | +component_count, | +
| + | + | int * | +num_procs_per_comp, | +
| + | + | int ** | +proc_list, | +
| + | + | MPI_Comm * | +user_io_comm, | +
| + | + | MPI_Comm * | +user_comp_comm, | +
| + | + | int | +rearranger, | +
| + | + | int * | +iosysidp | +
| + | ) | ++ |
Library initialization used when IO tasks are distinct from compute tasks.
+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.
+Here is the sequence of events that needs to occur when an IO operation is called from the collection of compute tasks. I'm going to use pio_put_var because write_darray has some special characteristics that make it a bit more complicated...
+Compute tasks call pio_put_var with an integer argument
+The MPI_Send sends a message from comp_rank=0 to io_rank=0 on union_comm (a comm defined as the union of io and compute tasks) msg is an integer which indicates the function being called, in this case the msg is PIO_MSG_PUT_VAR_INT
+The iotasks now know what additional arguments they should expect to receive from the compute tasks, in this case a file handle, a variable id, the length of the array and the array itself.
+The iotasks now have the information they need to complete the operation and they call the pio_put_var routine. (In pio1 this bit of code is in pio_get_put_callbacks.F90.in)
+After the netcdf operation is completed (in the case of an inq or get operation) the result is communicated back to the compute tasks.
+| world | the communicator containing all the available tasks. |
| num_io_procs | the number of processes for the IO component. |
| io_proc_list | an array of lenth num_io_procs with the processor number for each IO processor. If NULL then the IO processes are assigned starting at processes 0. |
| component_count | number of computational components |
| num_procs_per_comp | an array of int, of length component_count, with the number of processors in each computation component. |
| proc_list | an array of arrays containing the processor numbers for each computation component. If NULL then the computation components are assigned processors sequentially starting with processor num_io_procs. |
| user_io_comm | pointer to an MPI_Comm. If not NULL, it will get an MPI duplicate of the IO communicator. (It is a full duplicate and later must be freed with MPI_Free() by the caller.) |
| user_comp_comm | pointer to an array of pointers to MPI_Comm; the array is of length component_count. If not NULL, it will get an MPI duplicate of each computation communicator. (These are full duplicates and each must later be freed with MPI_Free() by the caller.) |
| rearranger | the default rearranger to use for decompositions in this IO system. Only PIO_REARR_BOX is supported for async. Support for PIO_REARR_SUBSET will be provided in a future version. |
| iosysidp | pointer to array of length component_count that gets the iosysid for each component. |
| int PIOc_Init_Intracomm | +( | +MPI_Comm | +comp_comm, | +
| + | + | int | +num_iotasks, | +
| + | + | int | +stride, | +
| + | + | int | +base, | +
| + | + | int | +rearr, | +
| + | + | int * | +iosysidp | +
| + | ) | ++ |
Library initialization used when IO tasks are a subset of compute tasks.
+This function creates an MPI intracommunicator between a set of IO tasks and one or more sets of computational tasks.
+The caller must create all comp_comm and the io_comm MPI communicators before calling this function.
+Internally, this function does the following:
+When complete, there are three MPI communicators (ios->comp_comm, ios->union_comm, and ios->io_comm) that must be freed by MPI.
+| comp_comm | the MPI_Comm of the compute tasks. |
| num_iotasks | the number of io tasks to use. |
| stride | the offset between io tasks in the comp_comm. |
| base | the comp_comm index of the first io task. |
| rearr | the rearranger to use by default, this may be overriden in the PIO_init_decomp(). The rearranger is not used until the decomposition is initialized. |
| iosysidp | index of the defined system descriptor. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__initdecomp.html b/docs/group___p_i_o__initdecomp.html
new file mode 100644
index 00000000000..ea7ff81c6bd
--- /dev/null
+++ b/docs/group___p_i_o__initdecomp.html
@@ -0,0 +1,905 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 decomp_bc 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 decomp_dof for PIO_initdecomp (previous name: initdecomp_1dof_nf_box) More... | |
| int | PIOc_InitDecomp (int iosysid, int pio_type, int ndims, const int *gdimlen, int maplen, const PIO_Offset *compmap, int *ioidp, const int *rearranger, const PIO_Offset *iostart, const PIO_Offset *iocount) |
| Initialize the decomposition used with distributed arrays. More... | |
| int | PIOc_init_decomp (int iosysid, int pio_type, int ndims, const int *gdimlen, int maplen, const PIO_Offset *compmap, int *ioidp, int rearranger, const PIO_Offset *iostart, const PIO_Offset *iocount) |
| Initialize the decomposition used with distributed arrays. More... | |
| int | PIOc_InitDecomp_bc (int iosysid, int pio_type, int ndims, const int *gdimlen, const long int *start, const long int *count, int *ioidp) |
| This is a simplified initdecomp which can be used if the memory order of the data can be expressed in terms of start and count on the file. 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 decomp_bc 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 decomp_dof 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 (see decomp_dof). 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). |
| iostart | The start index for the block-cyclic io decomposition |
| iocount | The count for the block-cyclic io decomposition |
| int PIOc_init_decomp | +( | +int | +iosysid, | +
| + | + | int | +pio_type, | +
| + | + | int | +ndims, | +
| + | + | const int * | +gdimlen, | +
| + | + | int | +maplen, | +
| + | + | const PIO_Offset * | +compmap, | +
| + | + | int * | +ioidp, | +
| + | + | int | +rearranger, | +
| + | + | const PIO_Offset * | +iostart, | +
| + | + | const PIO_Offset * | +iocount | +
| + | ) | ++ |
Initialize the decomposition used with distributed arrays.
+The decomposition describes how the data will be distributed between tasks.
+| iosysid | the IO system ID. |
| pio_type | the basic PIO data type used. |
| ndims | the number of dimensions in the variable, not including the unlimited dimension. |
| gdimlen | an array length ndims with the sizes of the global dimensions. |
| maplen | the local length of the compmap array. |
| compmap | a 0 based array of offsets into the array record on file. A -1 in this array indicates a value which should not be transfered. |
| ioidp | pointer that will get the io description ID. |
| rearranger | the rearranger to be used for this decomp or 0 to use the default. Valid rearrangers are PIO_REARR_BOX and PIO_REARR_SUBSET. |
| iostart | An array of start values for block cyclic decompositions. If NULL ??? |
| iocount | An array of count values for block cyclic decompositions. If NULL ??? |
| int PIOc_InitDecomp | +( | +int | +iosysid, | +
| + | + | int | +pio_type, | +
| + | + | int | +ndims, | +
| + | + | const int * | +gdimlen, | +
| + | + | int | +maplen, | +
| + | + | const PIO_Offset * | +compmap, | +
| + | + | int * | +ioidp, | +
| + | + | const int * | +rearranger, | +
| + | + | const PIO_Offset * | +iostart, | +
| + | + | const PIO_Offset * | +iocount | +
| + | ) | ++ |
Initialize the decomposition used with distributed arrays.
+The decomposition describes how the data will be distributed between tasks.
+Internally, this function will:
| iosysid | the IO system ID. |
| pio_type | the basic PIO data type used. |
| ndims | the number of dimensions in the variable, not including the unlimited dimension. |
| gdimlen | an array length ndims with the sizes of the global dimensions. |
| maplen | the local length of the compmap array. |
| compmap | a 1 based array of offsets into the array record on file. A 0 in this array indicates a value which should not be transfered. |
| ioidp | pointer that will get the io description ID. Ignored if NULL. |
| rearranger | pointer to the rearranger to be used for this decomp or NULL to use the default. |
| iostart | An array of start values for block cyclic decompositions for the SUBSET rearranger. Ignored if block rearranger is used. If NULL and SUBSET rearranger is used, the iostarts are generated. |
| iocount | An array of count values for block cyclic decompositions for the SUBSET rearranger. Ignored if block rearranger is used. If NULL and SUBSET rearranger is used, the iostarts are generated. |
| int PIOc_InitDecomp_bc | +( | +int | +iosysid, | +
| + | + | int | +pio_type, | +
| + | + | int | +ndims, | +
| + | + | const int * | +gdimlen, | +
| + | + | const long int * | +start, | +
| + | + | const long int * | +count, | +
| + | + | int * | +ioidp | +
| + | ) | ++ |
This is a simplified initdecomp which can be used if the memory order of the data can be expressed in terms of start and count on the file.
+In this case we compute the compdof.
+| iosysid | the IO system ID |
| pio_type | |
| ndims | the number of dimensions |
| gdimlen | an array length ndims with the sizes of the global dimensions. |
| start | start array |
| count | count array |
| pointer | that gets the IO ID. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__att.html b/docs/group___p_i_o__inq__att.html
new file mode 100644
index 00000000000..82dad37e2c8
--- /dev/null
+++ b/docs/group___p_i_o__inq__att.html
@@ -0,0 +1,294 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_att_eh (int ncid, int varid, const char *name, int eh, nc_type *xtypep, PIO_Offset *lenp) |
| The PIO-C interface for the NetCDF function nc_inq_att. More... | |
| int | PIOc_inq_att (int ncid, int varid, const char *name, nc_type *xtypep, PIO_Offset *lenp) |
| The PIO-C interface for the NetCDF function nc_inq_att. More... | |
| 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 ) |
| int PIOc_inq_att | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type * | +xtypep, | +
| + | + | PIO_Offset * | +lenp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_inq_att.
+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
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| varid | the variable ID or NC_GLOBAL. |
| name | name of the attribute. |
| xtypep | a pointer that will get the type of the attribute. |
| lenp | a pointer that will get the number of values |
| int PIOc_inq_att_eh | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | int | +eh, | +
| + | + | nc_type * | +xtypep, | +
| + | + | PIO_Offset * | +lenp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_inq_att.
+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
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID or NC_GLOBAL. |
| name | name of the attribute. |
| eh | non-zero to handle errors in the function. This will cause program to halt if PIO error handler is set to INTERNAL. |
| xtypep | a pointer that will get the type of the attribute. |
| lenp | a pointer that will get the number of values |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__attlen.html b/docs/group___p_i_o__inq__attlen.html
new file mode 100644
index 00000000000..cb51d1b6adb
--- /dev/null
+++ b/docs/group___p_i_o__inq__attlen.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_attlen (int ncid, int varid, const char *name, PIO_Offset *lenp) |
| Get the length of an attribute. More... | |
| 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 ) |
| int PIOc_inq_attlen | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | PIO_Offset * | +lenp | +
| + | ) | ++ |
Get the length of an attribute.
+| ncid | the ID of an open file. |
| varid | the variable ID, or NC_GLOBAL for global attributes. |
| name | the name of the attribute. |
| lenp | a pointer that gets the lenght of the attribute array. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__attname.html b/docs/group___p_i_o__inq__attname.html
new file mode 100644
index 00000000000..35916c3eca7
--- /dev/null
+++ b/docs/group___p_i_o__inq__attname.html
@@ -0,0 +1,151 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_attname (int ncid, int varid, int attnum, char *name) |
| The PIO-C interface for the NetCDF function nc_inq_attname. More... | |
| int PIOc_inq_attname | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +attnum, | +
| + | + | char * | +name | +
| + | ) | ++ |
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
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| attnum | the attribute ID. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__dimid.html b/docs/group___p_i_o__inq__dimid.html
new file mode 100644
index 00000000000..f8e8c1e2c0d
--- /dev/null
+++ b/docs/group___p_i_o__inq__dimid.html
@@ -0,0 +1,225 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_dimid (int ncid, const char *name, int *idp) |
| The PIO-C interface for the NetCDF function nc_inq_dimid. 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.
+ +| int PIOc_inq_dimid | +( | +int | +ncid, | +
| + | + | const char * | +name, | +
| + | + | int * | +idp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_inq_dimid.
+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__dimensions.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| idp | a pointer that will get the id of the variable or attribute. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__dimlen.html b/docs/group___p_i_o__inq__dimlen.html
new file mode 100644
index 00000000000..830a4004e0b
--- /dev/null
+++ b/docs/group___p_i_o__inq__dimlen.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_dimlen (int ncid, int dimid, PIO_Offset *lenp) |
| Find the length of a dimension. More... | |
| 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 ) |
| int PIOc_inq_dimlen | +( | +int | +ncid, | +
| + | + | int | +dimid, | +
| + | + | PIO_Offset * | +lenp | +
| + | ) | ++ |
Find the length of a dimension.
+| ncid | the ncid of an open file. |
| dimid | the dimension ID. |
| lenp | a pointer that gets the length of the dimension. Igorned if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__dimname.html b/docs/group___p_i_o__inq__dimname.html
new file mode 100644
index 00000000000..e516ef533c9
--- /dev/null
+++ b/docs/group___p_i_o__inq__dimname.html
@@ -0,0 +1,224 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_dimname (int ncid, int dimid, char *name) |
| Find the name 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. |
| len | : The length 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.
+ +| int PIOc_inq_dimname | +( | +int | +ncid, | +
| + | + | int | +dimid, | +
| + | + | char * | +name | +
| + | ) | ++ |
Find the name of a dimension.
+| ncid | the ncid of an open file. |
| dimid | the dimension ID. |
| name | a pointer that gets the name of the dimension. Igorned if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__natts.html b/docs/group___p_i_o__inq__natts.html
new file mode 100644
index 00000000000..4451d5d556c
--- /dev/null
+++ b/docs/group___p_i_o__inq__natts.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_natts (int ncid, int *ngattsp) |
| Find out how many global attributes are defined in a file. 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.
+ +| int PIOc_inq_natts | +( | +int | +ncid, | +
| + | + | int * | +ngattsp | +
| + | ) | ++ |
Find out how many global attributes are defined in a file.
+| ncid | the ncid of the open file. |
| nattsp | a pointer that will get the number of attributes. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__ndims.html b/docs/group___p_i_o__inq__ndims.html
new file mode 100644
index 00000000000..352e5be9f4d
--- /dev/null
+++ b/docs/group___p_i_o__inq__ndims.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_ndims (int ncid, int *ndimsp) |
| Find out how many dimensions are defined in the file. 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.
+ +| int PIOc_inq_ndims | +( | +int | +ncid, | +
| + | + | int * | +ndimsp | +
| + | ) | ++ |
Find out how many dimensions are defined in the file.
+| ncid | the ncid of the open file. |
| ndimsp | a pointer that will get the number of dimensions. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__nvars.html b/docs/group___p_i_o__inq__nvars.html
new file mode 100644
index 00000000000..5b9809a77f7
--- /dev/null
+++ b/docs/group___p_i_o__inq__nvars.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_nvars (int ncid, int *nvarsp) |
| Find out how many variables are defined in a file. 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.
+ +| int PIOc_inq_nvars | +( | +int | +ncid, | +
| + | + | int * | +nvarsp | +
| + | ) | ++ |
Find out how many variables are defined in a file.
+| ncid | the ncid of the open file. |
| nvarsp | a pointer that will get the number of variables. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__unlimdim.html b/docs/group___p_i_o__inq__unlimdim.html
new file mode 100644
index 00000000000..77b25399a15
--- /dev/null
+++ b/docs/group___p_i_o__inq__unlimdim.html
@@ -0,0 +1,175 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Functions/Subroutines | |
| int | PIOc_inq_unlimdim (int ncid, int *unlimdimidp) |
| Find out the dimension ids of the unlimited dimension. More... | |
| int | PIOc_inq_unlimdims (int ncid, int *nunlimdimsp, int *unlimdimidsp) |
| Find out the dimension ids of all unlimited dimensions. More... | |
| int PIOc_inq_unlimdim | +( | +int | +ncid, | +
| + | + | int * | +unlimdimidp | +
| + | ) | ++ |
Find out the dimension ids of the unlimited dimension.
+| ncid | the ncid of the open file. |
| unlimdimidp | a pointer that will the ID of the unlimited dimension, or -1 if there is no unlimited dimension. |
| int PIOc_inq_unlimdims | +( | +int | +ncid, | +
| + | + | int * | +nunlimdimsp, | +
| + | + | int * | +unlimdimidsp | +
| + | ) | ++ |
Find out the dimension ids of all unlimited dimensions.
+Note that only netCDF-4 files can have more than 1 unlimited dimension.
+| ncid | the ncid of the open file. |
| nunlimdimsp | a pointer that gets the number of unlimited dimensions. Ignored if NULL. |
| unlimdimidsp | a pointer that will get an array of unlimited dimension IDs. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__var__deflate.html b/docs/group___p_i_o__inq__var__deflate.html
new file mode 100644
index 00000000000..d190b0c97e3
--- /dev/null
+++ b/docs/group___p_i_o__inq__var__deflate.html
@@ -0,0 +1,250 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. |
| type | : The type of variable |
| 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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__vardimid.html b/docs/group___p_i_o__inq__vardimid.html
new file mode 100644
index 00000000000..f106b267c5a
--- /dev/null
+++ b/docs/group___p_i_o__inq__vardimid.html
@@ -0,0 +1,193 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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 | |
| int | PIOc_inq_vardimid (int ncid, int varid, int *dimidsp) |
| Find the dimension IDs associated with a variable. More... | |
| 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 ) |
| int PIOc_inq_vardimid | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int * | +dimidsp | +
| + | ) | ++ |
Find the dimension IDs associated with a variable.
+| ncid | the ncid of the open file. |
| varid | the variable ID. |
| dimidsp | a pointer that will get an array of dimids. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__varid.html b/docs/group___p_i_o__inq__varid.html
new file mode 100644
index 00000000000..4654dfd9b8b
--- /dev/null
+++ b/docs/group___p_i_o__inq__varid.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_varid (int ncid, const char *name, int *varidp) |
| The PIO-C interface for the NetCDF function nc_inq_varid. More... | |
| 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 ) |
| int PIOc_inq_varid | +( | +int | +ncid, | +
| + | + | const char * | +name, | +
| + | + | int * | +varidp | +
| + | ) | ++ |
The PIO-C interface for the NetCDF function nc_inq_varid.
+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__variables.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| varidp | a pointer that will get the variable id |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__varname.html b/docs/group___p_i_o__inq__varname.html
new file mode 100644
index 00000000000..bc8a8d2280c
--- /dev/null
+++ b/docs/group___p_i_o__inq__varname.html
@@ -0,0 +1,193 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_varname (int ncid, int varid, char *name) |
| Get the name of a variable. More... | |
| 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 ) |
| int PIOc_inq_varname | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | char * | +name | +
| + | ) | ++ |
Get the name of a variable.
+| ncid | the ncid of the open file. |
| varid | the variable ID. |
| name | a pointer that will get the variable name. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__varnatts.html b/docs/group___p_i_o__inq__varnatts.html
new file mode 100644
index 00000000000..b5d4a8fc9f4
--- /dev/null
+++ b/docs/group___p_i_o__inq__varnatts.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_varnatts (int ncid, int varid, int *nattsp) |
| Find the number of attributes associated with a variable. 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. |
| type | : The type of variable |
| 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.
+ +| int PIOc_inq_varnatts | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int * | +nattsp | +
| + | ) | ++ |
Find the number of attributes associated with a variable.
+| ncid | the ncid of the open file. |
| varid | the variable ID. |
| nattsp | a pointer that will get the number of attriburtes. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__varndims.html b/docs/group___p_i_o__inq__varndims.html
new file mode 100644
index 00000000000..36e1367c2cb
--- /dev/null
+++ b/docs/group___p_i_o__inq__varndims.html
@@ -0,0 +1,193 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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. | |
| int | PIOc_inq_varndims (int ncid, int varid, int *ndimsp) |
| Find the number of dimensions of a variable. More... | |
| 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 ) |
| int PIOc_inq_varndims | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int * | +ndimsp | +
| + | ) | ++ |
Find the number of dimensions of a variable.
+| ncid | the ncid of the open file. |
| varid | the variable ID. |
| ndimsp | a pointer that will get the number of dimensions. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inq__vartype.html b/docs/group___p_i_o__inq__vartype.html
new file mode 100644
index 00000000000..e2461cda1aa
--- /dev/null
+++ b/docs/group___p_i_o__inq__vartype.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_inq_vartype (int ncid, int varid, nc_type *xtypep) |
| Find the type of a variable. 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.
+ +| int PIOc_inq_vartype | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | nc_type * | +xtypep | +
| + | ) | ++ |
Find the type of a variable.
+| ncid | the ncid of the open file. |
| varid | the variable ID. |
| xtypep | a pointer that will get the type of the attribute. Ignored if NULL. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inquire.html b/docs/group___p_i_o__inquire.html
new file mode 100644
index 00000000000..7fa8884c3c4
--- /dev/null
+++ b/docs/group___p_i_o__inquire.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inquire__dimension.html b/docs/group___p_i_o__inquire__dimension.html
new file mode 100644
index 00000000000..bf5b2d5fa0f
--- /dev/null
+++ b/docs/group___p_i_o__inquire__dimension.html
@@ -0,0 +1,147 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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.
+| ncid | : 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 ) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__inquire__variable.html b/docs/group___p_i_o__inquire__variable.html
new file mode 100644
index 00000000000..778f0ad37c9
--- /dev/null
+++ b/docs/group___p_i_o__inquire__variable.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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.
+| ncid | : 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 ) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__iotype.html b/docs/group___p_i_o__iotype.html
new file mode 100644
index 00000000000..84379b7b533
--- /dev/null
+++ b/docs/group___p_i_o__iotype.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
An integer parameter which controls the iotype. +More...
+An integer parameter which controls the iotype.
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__kinds.html b/docs/group___p_i_o__kinds.html
new file mode 100644
index 00000000000..160b19aef23
--- /dev/null
+++ b/docs/group___p_i_o__kinds.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
The base types supported by PIO are: +More...
+The base types supported by PIO are:
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__openfile.html b/docs/group___p_i_o__openfile.html
new file mode 100644
index 00000000000..d7c49f6f89f
--- /dev/null
+++ b/docs/group___p_i_o__openfile.html
@@ -0,0 +1,337 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Functions/Subroutines | |
| integer function, public | piolib_mod::pio_openfile (iosystem, file, iotype, fname, mode) |
| open an existing file using pio More... | |
| int | PIOc_openfile (int iosysid, int *ncidp, int *iotype, const char *filename, int mode) |
| Open an existing file using PIO library. More... | |
| int | PIOc_openfile2 (int iosysid, int *ncidp, int *iotype, const char *filename, int mode) |
| Open an existing file using PIO library. More... | |
| int | PIOc_open (int iosysid, const char *path, int mode, int *ncidp) |
| Open an existing file using PIO library. More... | |
| 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_open | +( | +int | +iosysid, | +
| + | + | const char * | +path, | +
| + | + | int | +mode, | +
| + | + | int * | +ncidp | +
| + | ) | ++ |
Open an existing file using PIO library.
+Input parameters are read on comp task 0 and ignored elsewhere.
+| iosysid | A defined pio system descriptor |
| path | The filename to open |
| mode | The netcdf mode for the open operation |
| ncidp | pointer to int where ncid will go |
| int PIOc_openfile | +( | +int | +iosysid, | +
| + | + | int * | +ncidp, | +
| + | + | int * | +iotype, | +
| + | + | const char * | +filename, | +
| + | + | int | +mode | +
| + | ) | ++ |
Open an existing file using PIO library.
+If the open fails, try again as netCDF serial before giving up. Input parameters are read on comp task 0 and ignored elsewhere.
+Note that the file is opened with default fill mode, NOFILL for pnetcdf, and FILL for netCDF classic and netCDF-4 files.
+| iosysid | : A defined pio system descriptor (input) |
| ncidp | : A pio file descriptor (output) |
| iotype | : A pio output format (input) |
| filename | : The filename to open |
| mode | : The netcdf mode for the open operation |
| int PIOc_openfile2 | +( | +int | +iosysid, | +
| + | + | int * | +ncidp, | +
| + | + | int * | +iotype, | +
| + | + | const char * | +filename, | +
| + | + | int | +mode | +
| + | ) | ++ |
Open an existing file using PIO library.
+This is like PIOc_openfile(), but if the open fails, this function will not try to open again as netCDF serial before giving up. Input parameters are read on comp task 0 and ignored elsewhere.
+Note that the file is opened with default fill mode, NOFILL for pnetcdf, and FILL for netCDF classic and netCDF-4 files.
+| iosysid | : A defined pio system descriptor (input) |
| ncidp | : A pio file descriptor (output) |
| iotype | : A pio output format (input) |
| filename | : The filename to open |
| mode | : The netcdf mode for the open operation |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__put__att.html b/docs/group___p_i_o__put__att.html
new file mode 100644
index 00000000000..6f3e1545408
--- /dev/null
+++ b/docs/group___p_i_o__put__att.html
@@ -0,0 +1,1424 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_put_att (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const void *op) |
| Write a netCDF attribute of any type. More... | |
| int | PIOc_put_att_schar (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const signed char *op) |
| Write a netCDF attribute array of 8-bit signed chars. More... | |
| int | PIOc_put_att_long (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const long *op) |
| Write a netCDF attribute array of 32-bit signed integers. More... | |
| int | PIOc_put_att_int (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const int *op) |
| Write a netCDF attribute array of 32-bit signed integers. More... | |
| int | PIOc_put_att_uchar (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const unsigned char *op) |
| Write a netCDF attribute array of 8-bit unsigned chars. More... | |
| int | PIOc_put_att_longlong (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const long long *op) |
| Write a netCDF attribute array of 64-bit signed integers. More... | |
| int | PIOc_put_att_uint (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const unsigned int *op) |
| Write a netCDF attribute array of 32-bit unsigned integers. More... | |
| int | PIOc_put_att_float (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const float *op) |
| Write a netCDF attribute array of 32-bit floating points. More... | |
| int | PIOc_put_att_ulonglong (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const unsigned long long *op) |
| Write a netCDF attribute array of 64-bit unsigned integers. More... | |
| int | PIOc_put_att_ushort (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const unsigned short *op) |
| Write a netCDF attribute array of 16-bit unsigned integers. More... | |
| int | PIOc_put_att_text (int ncid, int varid, const char *name, PIO_Offset len, const char *op) |
| Write a netCDF text attribute. More... | |
| int | PIOc_put_att_short (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const short *op) |
| Write a netCDF attribute array of 16-bit integers. More... | |
| int | PIOc_put_att_double (int ncid, int varid, const char *name, nc_type xtype, PIO_Offset len, const double *op) |
| Write a netCDF attribute array of 64-bit floating points. More... | |
Writes an netcdf attribute to a file.
+| int PIOc_put_att | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const void * | +op | +
| + | ) | ++ |
Write a netCDF attribute of any type.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_double | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const double * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 64-bit floating points.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_float | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const float * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 32-bit floating points.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_int | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const int * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 32-bit signed integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_long | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const long * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 32-bit signed integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_longlong | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const long long * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 64-bit signed integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_schar | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const signed char * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 8-bit signed chars.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_short | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const short * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 16-bit integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_text | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | PIO_Offset | +len, | +
| + | + | const char * | +op | +
| + | ) | ++ |
Write a netCDF text attribute.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_uchar | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const unsigned char * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 8-bit unsigned chars.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_uint | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const unsigned int * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 32-bit unsigned integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_ulonglong | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const unsigned long long * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 64-bit unsigned integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| int PIOc_put_att_ushort | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | const char * | +name, | +
| + | + | nc_type | +xtype, | +
| + | + | PIO_Offset | +len, | +
| + | + | const unsigned short * | +op | +
| + | ) | ++ |
Write a netCDF attribute array of 16-bit unsigned integers.
+This routine is called collectively by all tasks in the communicator ios.union_comm.
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| varid | the variable ID. |
| name | the name of the attribute. |
| xtype | the nc_type of the attribute. |
| len | the length of the attribute array. |
| op | a pointer with the attribute data. |
| 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 |
| var | : 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 |
| var | : 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 |
| var | : 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.
+| File | 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.
+| File | 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.
+| File | 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 |
| varid | : The netcdf variable identifier |
| name | : name of the attribute to add |
| var | : The value for the netcdf attribute |
| ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__put__var.html b/docs/group___p_i_o__put__var.html
new file mode 100644
index 00000000000..1e1db7d55f8
--- /dev/null
+++ b/docs/group___p_i_o__put__var.html
@@ -0,0 +1,5798 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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. |
| start | : |
| 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.
+| 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 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.
+| 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 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.
+| 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 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 ) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__read__darray.html b/docs/group___p_i_o__read__darray.html
new file mode 100644
index 00000000000..5f5f848bfcc
--- /dev/null
+++ b/docs/group___p_i_o__read__darray.html
@@ -0,0 +1,1431 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_read_darray (int ncid, int varid, int ioid, PIO_Offset arraylen, void *array) |
| Read a field from a file to the IO library. More... | |
The overloaded PIO_read_darray function reads a distributed array from disk.
+| int PIOc_read_darray | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +ioid, | +
| + | + | PIO_Offset | +arraylen, | +
| + | + | void * | +array | +
| + | ) | ++ |
Read a field from a file to the IO library.
+| ncid | identifies the netCDF file |
| varid | the variable ID to be read |
| ioid | the I/O description ID as passed back by PIOc_InitDecomp(). |
| arraylen | the length of the array to be read. This is the length of the distrubited array. That is, the length of the portion of the data that is on the processor. |
| array | pointer to the data to be read. This is a pointer to the distributed portion of the array that is on this processor. |
| 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) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__rearr__comm__dir.html b/docs/group___p_i_o__rearr__comm__dir.html
new file mode 100644
index 00000000000..2a82772f982
--- /dev/null
+++ b/docs/group___p_i_o__rearr__comm__dir.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
The four choices for rearranger communication direction. +More...
+The four choices for rearranger communication direction.
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__rearr__comm__fc__options.html b/docs/group___p_i_o__rearr__comm__fc__options.html
new file mode 100644
index 00000000000..cb9572e4edb
--- /dev/null
+++ b/docs/group___p_i_o__rearr__comm__fc__options.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
Type that defines the PIO rearranger options. +More...
+Type that defines the PIO rearranger options.
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__rearr__comm__t.html b/docs/group___p_i_o__rearr__comm__t.html
new file mode 100644
index 00000000000..54ebf0c7af1
--- /dev/null
+++ b/docs/group___p_i_o__rearr__comm__t.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
The two choices for rearranger communication. +More...
+The two choices for rearranger communication.
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__rearr__method.html b/docs/group___p_i_o__rearr__method.html
new file mode 100644
index 00000000000..ca2da8ccee4
--- /dev/null
+++ b/docs/group___p_i_o__rearr__method.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
The three choices to control rearrangement are: +More...
+The three choices to control rearrangement are:
+PIO_rearr_subset : Use a PIO internal subsetting rearrangement
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__rearr__options.html b/docs/group___p_i_o__rearr__options.html
new file mode 100644
index 00000000000..a2a791c64a9
--- /dev/null
+++ b/docs/group___p_i_o__rearr__options.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
Type that defines the PIO rearranger options. +More...
+Type that defines the PIO rearranger options.
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__redef.html b/docs/group___p_i_o__redef.html
new file mode 100644
index 00000000000..7335703799c
--- /dev/null
+++ b/docs/group___p_i_o__redef.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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... | |
| int | PIOc_redef (int ncid) |
| The PIO-C interface for the NetCDF function nc_redef. More... | |
| int PIOc_redef | +( | +int | +ncid | ) | ++ |
The PIO-C interface for the NetCDF function nc_redef.
+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__datasets.html
+| ncid | the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile(). |
| 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 .
+ +
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__set__blocksize.html b/docs/group___p_i_o__set__blocksize.html
new file mode 100644
index 00000000000..c92dd91d94b
--- /dev/null
+++ b/docs/group___p_i_o__set__blocksize.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Functions/Subroutines | |
| +subroutine | pio::pio_set_blocksize (blocksize) |
| Set the target blocksize for the box rearranger. | |
| int | PIOc_set_blocksize (int newblocksize) |
| Set the target blocksize for the box rearranger. More... | |
| int PIOc_set_blocksize | +( | +int | +newblocksize | ) | ++ |
Set the target blocksize for the box rearranger.
+| newblocksize | the new blocksize. |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__set__hint.html b/docs/group___p_i_o__set__hint.html
new file mode 100644
index 00000000000..a0a5f167835
--- /dev/null
+++ b/docs/group___p_i_o__set__hint.html
@@ -0,0 +1,93 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
set file system hints using mpi_info_set +More...
+set file system hints using mpi_info_set
+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. |
| hint | the string name of the hint to define |
| hintval | the string value to set the hint to |
| ierr | : The error return code; ierr != PIO_noerr indicates an error. (see PIO_seterrorhandling ) |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__set__log__level.html b/docs/group___p_i_o__set__log__level.html
new file mode 100644
index 00000000000..f6b0b3fe80e
--- /dev/null
+++ b/docs/group___p_i_o__set__log__level.html
@@ -0,0 +1,76 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__setdebuglevel.html b/docs/group___p_i_o__setdebuglevel.html
new file mode 100644
index 00000000000..25cff14ff1a
--- /dev/null
+++ b/docs/group___p_i_o__setdebuglevel.html
@@ -0,0 +1,116 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__seterrorhandling.html b/docs/group___p_i_o__seterrorhandling.html
new file mode 100644
index 00000000000..da6d1fe694c
--- /dev/null
+++ b/docs/group___p_i_o__seterrorhandling.html
@@ -0,0 +1,243 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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
| 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 | : |
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.
+ +| 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.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__setframe.html b/docs/group___p_i_o__setframe.html
new file mode 100644
index 00000000000..49035fce3c8
--- /dev/null
+++ b/docs/group___p_i_o__setframe.html
@@ -0,0 +1,182 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_setframe (int ncid, int varid, int frame) |
| Set the unlimited dimension of the given variable. More... | |
sets the unlimited dimension for netcdf file
+| int PIOc_setframe | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +frame | +
| + | ) | ++ |
Set the unlimited dimension of the given variable.
+| ncid | the ncid of the file. |
| varid | the varid of the variable |
| frame | the value of the unlimited dimension. In c 0 for the first record, 1 for the second |
| 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
+| vardesc | Variable description structure. |
| frame | : frame number to set |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__strerror.html b/docs/group___p_i_o__strerror.html
new file mode 100644
index 00000000000..9eac990f36d
--- /dev/null
+++ b/docs/group___p_i_o__strerror.html
@@ -0,0 +1,76 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__syncfile.html b/docs/group___p_i_o__syncfile.html
new file mode 100644
index 00000000000..d03d6666a1f
--- /dev/null
+++ b/docs/group___p_i_o__syncfile.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+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 |
+ 1.8.13
+
+
+
diff --git a/docs/group___p_i_o__write__darray.html b/docs/group___p_i_o__write__darray.html
new file mode 100644
index 00000000000..5f3b9143981
--- /dev/null
+++ b/docs/group___p_i_o__write__darray.html
@@ -0,0 +1,1763 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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... | |
| int | PIOc_write_darray_multi (int ncid, const int *varids, int ioid, int nvars, PIO_Offset arraylen, void *array, const int *frame, void **fillvalue, bool flushtodisk) |
| Write one or more arrays with the same IO decomposition to the file. More... | |
| int | find_var_fillvalue (file_desc_t *file, int varid, var_desc_t *vdesc) |
| Find the fillvalue that should be used for a variable. More... | |
| int | PIOc_write_darray (int ncid, int varid, int ioid, PIO_Offset arraylen, void *array, void *fillvalue) |
| Write a distributed array to the output file. More... | |
The overloaded PIO_write_darray writes a distributed array to disk.
+| int find_var_fillvalue | +( | +file_desc_t * | +file, | +
| + | + | int | +varid, | +
| + | + | var_desc_t * | +vdesc | +
| + | ) | ++ |
Find the fillvalue that should be used for a variable.
+| file | Info about file we are writing to. |
| varid | the variable ID. |
| vdesc | pointer to var_desc_t info for this var. |
| int PIOc_write_darray | +( | +int | +ncid, | +
| + | + | int | +varid, | +
| + | + | int | +ioid, | +
| + | + | PIO_Offset | +arraylen, | +
| + | + | void * | +array, | +
| + | + | void * | +fillvalue | +
| + | ) | ++ |
Write a distributed array to the output file.
+This routine aggregates output on the compute nodes and only sends it to the IO nodes when the compute buffer is full or when a flush is triggered.
+Internally, this function will:
NOTE: The write multi buffer wmulti_buffer is the cache on compute nodes that will collect and store multiple variables before sending them to the io nodes. Aggregating variables in this way leads to a considerable savings in communication expense. Variables in the wmb array must have the same decomposition and base data size and we also need to keep track of whether each is a recordvar (has an unlimited dimension) or not.
+| ncid | the ncid of the open netCDF file. |
| varid | the ID of the variable that these data will be written to. |
| ioid | the I/O description ID as passed back by PIOc_InitDecomp(). |
| arraylen | the length of the array to be written. This should be at least the length of the local component of the distrubited array. (Any values beyond length of the local component will be ignored.) |
| array | pointer to an array of length arraylen with the data to be written. This is a pointer to the distributed portion of the array that is on this task. |
| fillvalue | pointer to the fill value to be used for missing data. |
| int PIOc_write_darray_multi | +( | +int | +ncid, | +
| + | + | const int * | +varids, | +
| + | + | int | +ioid, | +
| + | + | int | +nvars, | +
| + | + | PIO_Offset | +arraylen, | +
| + | + | void * | +array, | +
| + | + | const int * | +frame, | +
| + | + | void ** | +fillvalue, | +
| + | + | bool | +flushtodisk | +
| + | ) | ++ |
Write one or more arrays with the same IO decomposition to the file.
+This funciton is similar to PIOc_write_darray(), but allows the caller to use their own data buffering (instead of using the buffering implemented in PIOc_write_darray()).
+When the user calls PIOc_write_darray() one or more times, then PIO_write_darray_multi() will be called when the buffer is flushed.
+Internally, this function will:
| ncid | identifies the netCDF file. |
| varids | an array of length nvars containing the variable ids to be written. |
| ioid | the I/O description ID as passed back by PIOc_InitDecomp(). |
| nvars | the number of variables to be written with this call. |
| arraylen | the length of the array to be written. This is the length of the distrubited array. That is, the length of the portion of the data that is on the processor. The same arraylen is used for all variables in the call. |
| array | pointer to the data to be written. This is a pointer to an array of arrays with the distributed portion of the array that is on this processor. There are nvars arrays of data, and each array of data contains one record worth of data for that variable. |
| frame | an array of length nvars with the frame or record dimension for each of the nvars variables in IOBUF. NULL if this iodesc contains non-record vars. |
| fillvalue | pointer an array (of length nvars) of pointers to the fill value to be used for missing data. |
| flushtodisk | non-zero to cause buffers to be flushed 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 |
+ 1.8.13
+
+
+
diff --git a/docs/group__error__return.html b/docs/group__error__return.html
new file mode 100644
index 00000000000..10626c9f989
--- /dev/null
+++ b/docs/group__error__return.html
@@ -0,0 +1,80 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
: The error return code; ierr != PIO_noerr indicates an error. +More...
+: The error return code; ierr != PIO_noerr indicates an error.
+(see PIO_seterrorhandling )
+
+ 1.8.13
+
+
+
diff --git a/docs/group__iodesc__generate.html b/docs/group__iodesc__generate.html
new file mode 100644
index 00000000000..1e1457e6595
--- /dev/null
+++ b/docs/group__iodesc__generate.html
@@ -0,0 +1,79 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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).
+
+ 1.8.13
+
+
+
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 00000000000..7b1216c429e
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
The Parallel I/O (PIO) library has been developed over several years to improve the ability of component models of the Community Earth System Model (CESM) to perform I/O. We believe that the interface is sufficiently general to be useful to a broader spectrum of applications. The focus of development has been on backend tools that use the NetCDF file format. PIO currently supports NetCDF and PnetCDF as backend libraries, both can be linked and used with runtime options controlling which is used for a given file.
+PIO2 represents a significant rewrite of the PIO library and includes a C API as well as the original F90 API. A new decomposition strategy has been introduced which gives the user more ability to tune io communications.
+This user's guide provides information about the PIO library and examples on how it can be used. Please review the ChangeLog that is included with the distribution for up-to-date release information.
+ +
+ 1.8.13
+
+
+
diff --git a/docs/install.html b/docs/install.html
new file mode 100644
index 00000000000..6fe33b91172
--- /dev/null
+++ b/docs/install.html
@@ -0,0 +1,118 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 jedwards@ucar.edu.
+PIO can use NetCDF (version 4.3.3+) and/or PnetCDF (version 1.6.1+) 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.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepiodarray_1_1_p_i_oc__read__darray-members.html b/docs/interfacepiodarray_1_1_p_i_oc__read__darray-members.html
new file mode 100644
index 00000000000..4468aade4b7
--- /dev/null
+++ b/docs/interfacepiodarray_1_1_p_i_oc__read__darray-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for piodarray::PIOc_read_darray, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepiodarray_1_1_p_i_oc__read__darray.html b/docs/interfacepiodarray_1_1_p_i_oc__read__darray.html
new file mode 100644
index 00000000000..d4c35a8c8e7
--- /dev/null
+++ b/docs/interfacepiodarray_1_1_p_i_oc__read__darray.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi-members.html b/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi-members.html
new file mode 100644
index 00000000000..3154009f26b
--- /dev/null
+++ b/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for piodarray::PIOc_write_darray_multi, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi.html b/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi.html
new file mode 100644
index 00000000000..07df9604564
--- /dev/null
+++ b/docs/interfacepiodarray_1_1_p_i_oc__write__darray__multi.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double-members.html
new file mode 100644
index 00000000000..bc4e837e488
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double.html
new file mode 100644
index 00000000000..c6192963521
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__double.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_get_att_double (ncid, varid, name, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float-members.html
new file mode 100644
index 00000000000..76f3dcc08da
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float.html
new file mode 100644
index 00000000000..224701ca25c
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__float.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_get_att_float (ncid, varid, name, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int-members.html
new file mode 100644
index 00000000000..8936fa65684
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int.html
new file mode 100644
index 00000000000..32a8f5609ee
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__int.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_get_att_int (ncid, varid, name, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text-members.html
new file mode 100644
index 00000000000..24cb5aa8a62
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text.html
new file mode 100644
index 00000000000..c2fa27c2b36
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__get__att__text.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_get_att_text (ncid, varid, name, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double-members.html
new file mode 100644
index 00000000000..75f958591d1
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double.html
new file mode 100644
index 00000000000..f40f0948015
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__double.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_put_att_double (ncid, varid, name, xtype, len, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float-members.html
new file mode 100644
index 00000000000..e1b74a144a9
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float.html
new file mode 100644
index 00000000000..5cb50ff0fc9
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__float.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_put_att_float (ncid, varid, name, xtype, len, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int-members.html
new file mode 100644
index 00000000000..fb9b4074d43
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int.html
new file mode 100644
index 00000000000..fb71d1c5bc6
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__int.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+Public Member Functions | |
| +integer(c_int) function | pioc_put_att_int (ncid, varid, name, xtype, len, op) |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text-members.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text-members.html
new file mode 100644
index 00000000000..58df4507610
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 |
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text.html b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text.html
new file mode 100644
index 00000000000..5c5871e87be
--- /dev/null
+++ b/docs/interfacepionfatt__mod_1_1_p_i_oc__put__att__text.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double-members.html
new file mode 100644
index 00000000000..c3bd199e95c
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_var_double, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double.html
new file mode 100644
index 00000000000..7378e16ef51
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__double.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float-members.html
new file mode 100644
index 00000000000..b36f755d774
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_var_float, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float.html
new file mode 100644
index 00000000000..30e86dad333
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__float.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int-members.html
new file mode 100644
index 00000000000..fd8a38638f7
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_var_int, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int.html
new file mode 100644
index 00000000000..73913f1898a
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__var__int.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double-members.html
new file mode 100644
index 00000000000..c1fab91d8fa
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_vara_double, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double.html
new file mode 100644
index 00000000000..802e4ad1cbe
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__double.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float-members.html
new file mode 100644
index 00000000000..c4f73580f60
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_vara_float, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float.html
new file mode 100644
index 00000000000..f127c75ee8a
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__float.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int-members.html
new file mode 100644
index 00000000000..3c479a42f30
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_vara_int, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int.html
new file mode 100644
index 00000000000..4fc73da8b26
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__int.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text-members.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text-members.html
new file mode 100644
index 00000000000..40905405248
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfget_mod::PIOc_get_vara_text, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text.html b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text.html
new file mode 100644
index 00000000000..c11868a1a80
--- /dev/null
+++ b/docs/interfacepionfget__mod_1_1_p_i_oc__get__vara__text.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double-members.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double-members.html
new file mode 100644
index 00000000000..e3942c9557f
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfput_mod::PIOc_put_vara_double, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double.html
new file mode 100644
index 00000000000..8dfba1526cf
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__double.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float-members.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float-members.html
new file mode 100644
index 00000000000..302beecd807
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfput_mod::PIOc_put_vara_float, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float.html
new file mode 100644
index 00000000000..87242d93291
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__float.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int-members.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int-members.html
new file mode 100644
index 00000000000..23be64403e3
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfput_mod::PIOc_put_vara_int, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int.html
new file mode 100644
index 00000000000..178a6240718
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__int.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text-members.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text-members.html
new file mode 100644
index 00000000000..315280516e4
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
This is the complete list of members for pionfput_mod::PIOc_put_vara_text, including all inherited members.
+
+ 1.8.13
+
+
+
diff --git a/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text.html b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text.html
new file mode 100644
index 00000000000..39453cb54f4
--- /dev/null
+++ b/docs/interfacepionfput__mod_1_1_p_i_oc__put__vara__text.html
@@ -0,0 +1,84 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
+ 1.8.13
+
+
+
diff --git a/docs/intro.html b/docs/intro.html
new file mode 100644
index 00000000000..bd9386482b8
--- /dev/null
+++ b/docs/intro.html
@@ -0,0 +1,85 @@
+
+
+
+
+
+
+
+|
+ PIO
+ 2.4.0
+
+ |
+
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 checking out a copy 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 document. Finally, read through the FAQ to see if any remaining questions can be answered.
+
+ 1.8.13
+
+
+
diff --git a/docs/jquery.js b/docs/jquery.js
new file mode 100644
index 00000000000..f5343eda922
--- /dev/null
+++ b/docs/jquery.js
@@ -0,0 +1,87 @@
+/*!
+ * jQuery JavaScript Library v1.7.1
+ * http://jquery.com/
+ *
+ * Copyright 2011, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ * Copyright 2011, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ *
+ * Date: Mon Nov 21 21:11:03 2011 -0500
+ */
+(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b4| t |
