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