PIO  1.7.1
 All Classes Files Functions Groups Pages
Functions/Subroutines
PIO_initdecomp

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, iostart, iocount)
 Implements the Block-cyclic interface for PIO_initdecomp. More...
 
subroutine piolib_mod::pio_initdecomp_dof_dof (iosystem, basepiotype, dims, compdof, iodesc, iodof)
 Implements the Degree of freedom interface 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, iostart, iocount, num_ts, bsize)
 Implements the Degree of freedom interface for PIO_initdecomp (previous name: initdecomp_1dof_nf_box) More...
 

Detailed Description

PIO_initdecomp is an overload interface the models decomposition to pio.

Function/Subroutine Documentation

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(kind=pio_offset), dimension(:), intent(in)  compdof,
integer(kind=pio_offset), dimension(:), intent(in)  iodofr,
type (io_desc_t), intent(inout)  iodesc 
)

A deprecated interface to the PIO_initdecomp method.

Deprecated:
Parameters
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:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
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\copybriefiodesc_generate
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(kind=pio_offset), dimension(:), intent(in)  start,
integer(kind=pio_offset), dimension(:), intent(in)  count,
type (io_desc_t), intent(inout)  iodesc 
)

A deprecated interface to the PIO_initdecomp method.

Deprecated:
Parameters
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:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
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\copybriefiodesc_generate
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.

Deprecated:
Parameters
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:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
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\copybriefiodesc_generate
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(kind=pio_offset), dimension(:), intent(in)  start,
integer(kind=pio_offset), dimension(:), intent(in)  count,
type (io_desc_t), intent(inout)  iodesc 
)

A deprecated interface to the PIO_initdecomp method.

Deprecated:
Parameters
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:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
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\copybriefiodesc_generate
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), dimension(:)  compstart,
integer (kind=pio_offset), dimension(:)  compcount,
type (io_desc_t), intent(out)  iodesc,
integer (kind=pio_offset), dimension(:), optional  iostart,
integer (kind=pio_offset), dimension(:), optional  iocount 
)

Implements the Block-cyclic interface 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

Parameters
iosystem\copybriefiosystem_desc_t
Parameters
basepiotype\copybriefuse_PIO_kinds

The base types supported by PIO are:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
dimsAn array of the global length of each dimesion of the variable(s)
compstartThe start index into the block-cyclic computational decomposition
compcountThe count for the block-cyclic computational decomposition
iodesc\copybriefiodesc_generate
Parameters
iostartThe start index for the block-cyclic io decomposition
iocountThe count for the block-cyclic io decomposition
subroutine piolib_mod::pio_initdecomp_dof_dof ( 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(out)  iodesc,
integer(i4), dimension(:), intent(in)  iodof 
)

Implements the Degree of freedom interface for PIO_initdecomp.

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 metehod (see Degree of freedom interface). This subroutine also requires the user to specify the IO decomposition using the degree of freedom method. This version of the subroutine is most suitable for those who want complete control over the actions of PIO.

Parameters
iosystem\copybriefiosystem_desc_t
Parameters
basepiotype\copybriefuse_PIO_kinds

The base types supported by PIO are:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
dimsAn array of the global length of each dimesion of the variable(s)
compdofMapping of the storage order for the computatinal decomposition to its memory order
iodesc\copybriefiodesc_generate
Parameters
iodofMapping of the storage order for the IO decomposition its memory order
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 (kind=pio_offset), dimension(:), optional  iostart,
integer (kind=pio_offset), dimension(:), optional  iocount,
integer(i4), intent(in), optional  num_ts,
integer(i4), dimension(3), intent(in), optional  bsize 
)

Implements the Degree of freedom interface 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 Degree of freedom interface). 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

Parameters
iosystem\copybriefiosystem_desc_t
Parameters
basepiotype\copybriefuse_PIO_kinds

The base types supported by PIO are:

  • PIO_double : 8-byte reals or double precision
  • PIO_real : 4-byte reals
  • PIO_int : 4-byte integers
  • PIO_char : character
Parameters
dimsAn array of the global length of each dimesion of the variable(s)
compdofMapping of the storage order for the computational decomposition to its memory order
iodesc\copybriefiodesc_generate
Parameters
iostartThe start index for the block-cyclic io decomposition
iocountThe count for the block-cyclic io decomposition