A class to hold example code and data. More...
Public Member Functions | |
| procedure, public | init |
| Initialize MPI, ParallelIO, and example data. More... | |
| procedure, public | createdecomp |
| Create the decomposition for the example. More... | |
| procedure, public | createfile |
| Create netCDF output file. More... | |
| procedure, public | definevar |
| Define the netCDF metadata. More... | |
| procedure, public | writevar |
| Write the sample data to the output file. More... | |
| procedure, public | readvar |
| Read the sample data from the output file. More... | |
| procedure, public | closefile |
| Close the netCDF output file. More... | |
| procedure, public | cleanup |
| Clean up resources. More... | |
Public Attributes | |
| integer | myrank |
| Rank of processor running the code. | |
| integer | ntasks |
| Number of processors participating in MPI communicator. | |
| integer | niotasks |
| Number of processors performing I/O. | |
| integer | stride |
| Stride in the mpi rank between io tasks. | |
| integer | numaggregator |
| Number of aggregator. | |
| integer | optbase |
| Start index of I/O processors. | |
| type(iosystem_desc_t) | pioiosystem |
| The ParallelIO system set up by Initialize an IOSystem. | |
| type(file_desc_t) | piofiledesc |
| Contains data identifying the file. | |
| type(var_desc_t) | piovar |
| The netCDF variable ID. | |
| type(io_desc_t) | iodescncells |
| An io descriptor handle that is generated in Define a Decomposition. | |
| integer | iotype |
| Specifies the flavor of netCDF output. | |
| integer | piodimid |
| The netCDF dimension ID. | |
| integer | ista |
| 1-based index of start of this processors data in full data array. | |
| integer | isto |
| Size of data array for this processor. | |
| integer | arridxperpe |
| Number of elements handled by each processor. | |
| integer, dimension(1) | dimlen |
| The length of the dimension of the netCDF variable. | |
| integer, dimension(:), allocatable | databuffer |
| Buffer to hold sample data that is written to netCDF file. | |
| integer, dimension(:), allocatable | readbuffer |
| Buffer to read data into. | |
| integer, dimension(:), allocatable | compdof |
| Array describing the decomposition of the data. | |
| character(len=255) | filename |
| Name of the sample netCDF file written by this example. | |
Detailed Description
A class to hold example code and data.
This class contains the data and functions to execute the example.
Member Function/Subroutine Documentation
◆ cleanup()
| procedure, public pioexample::pioexampleclass::cleanup |
Clean up resources.
This subroutine cleans up resources used in the example. The ParallelIO and MPI libraries are finalized, and memory allocated in this example program is freed.
◆ closefile()
| procedure, public pioexample::pioexampleclass::closefile |
Close the netCDF output file.
This subroutine closes the output file used by this example.
◆ createdecomp()
| procedure, public pioexample::pioexampleclass::createdecomp |
Create the decomposition for the example.
This subroutine creates the decomposition for the example.
◆ createfile()
| procedure, public pioexample::pioexampleclass::createfile |
Create netCDF output file.
This subroutine creates the netCDF output file for the example.
◆ definevar()
| procedure, public pioexample::pioexampleclass::definevar |
Define the netCDF metadata.
This subroutine defines the netCDF dimension and variable used in the output file.
◆ init()
| procedure, public pioexample::pioexampleclass::init |
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.
◆ readvar()
| procedure, public pioexample::pioexampleclass::readvar |
Read the sample data from the output file.
This subroutine reads the sample data array from the netCDF output file.
◆ writevar()
| procedure, public pioexample::pioexampleclass::writevar |
Write the sample data to the output file.
This subroutine writes the sample data array to the netCDF output file.
The documentation for this type was generated from the following file:
