SABER
tools_netcdf Module Reference

Generic ranks, dimensions and types. More...

Data Types

type  registry_type
 
interface  create_file
 
interface  open_file
 
interface  define_grp
 
interface  inquire_grp
 
interface  put_att
 
interface  get_att
 
interface  define_dim
 
interface  inquire_dim
 
interface  inquire_dim_size
 
interface  check_dim
 
interface  define_var
 
interface  inquire_var
 
interface  inquire_var_presence
 
interface  inquire_var_rank
 
interface  inquire_var_dim_size
 
interface  put_var
 
interface  get_var
 
interface  close_file
 
interface  strerror
 

Functions/Subroutines

subroutine registry_report (registry, mpl)
 Print registry report. More...
 
subroutine registry_save (registry, mpl, parent_id, child_id, child_name)
 Save ID in registry. More...
 
integer function registry_get_root_id (registry, mpl, ncid)
 Get root ID in registry from a given ID. More...
 
subroutine registry_free (registry, mpl, ncid)
 Free registry slot. More...
 
recursive subroutine registry_recursive_cleaning (registry, mpl, parent_id)
 Recursive registry cleaning. More...
 
integer function netcdf_create_file (mpl, filename, iproc)
 Create file. More...
 
integer function netcdf_open_file (mpl, filename, iproc)
 Open file. More...
 
integer function netcdf_define_grp (mpl, ncid, grpname)
 Define group. More...
 
integer function netcdf_inquire_grp (mpl, ncid, grpname)
 Inquire group ID. More...
 
subroutine netcdf_put_att_int (mpl, ncid, attname, att, varid)
 Put attribute. More...
 
subroutine netcdf_put_att_real (mpl, ncid, attname, att, varid)
 Put attribute. More...
 
subroutine netcdf_put_att_logical (mpl, ncid, attname, att, varid)
 Put attribute. More...
 
subroutine netcdf_put_att_string (mpl, ncid, attname, att, varid)
 Put attribute. More...
 
subroutine netcdf_get_att_int (mpl, ncid, attname, att, varid)
 Get attribute. More...
 
subroutine netcdf_get_att_real (mpl, ncid, attname, att, varid)
 Get attribute. More...
 
subroutine netcdf_get_att_logical (mpl, ncid, attname, att, varid)
 Get attribute. More...
 
subroutine netcdf_get_att_string (mpl, ncid, attname, att, varid)
 Get attribute. More...
 
integer function netcdf_define_dim (mpl, ncid, dimname, dimsize)
 Define dimension. More...
 
integer function netcdf_inquire_dim (mpl, ncid, dimname)
 Inquire dimension ID. More...
 
integer function netcdf_inquire_dim_size (mpl, ncid, dimname, default)
 Inquire dimension size. More...
 
logical function netcdf_check_dim_size (mpl, ncid, dimname, dimsize)
 Check dimension size. More...
 
integer function netcdf_define_var (mpl, ncid, varname, varkind, varshape, unitname)
 Define variable. More...
 
integer function netcdf_inquire_var (mpl, ncid, varname)
 Inquire variable ID. More...
 
logical function netcdf_inquire_var_presence (mpl, ncid, varname)
 Inquire variable presence. More...
 
integer function netcdf_inquire_var_rank (mpl, ncid, varname)
 Inquire variable rank. More...
 
integer function netcdf_inquire_var_dim_size (mpl, ncid, varname, dimindex)
 Inquire variable dimension size. More...
 
subroutine netcdf_put_var_int_r0 (mpl, ncid, varid, var, varstart)
 Put variable. More...
 
subroutine netcdf_put_var_real_r0 (mpl, ncid, varid, var, varstart)
 Put variable. More...
 
subroutine netcdf_put_var_logical_r0 (mpl, ncid, varid, var, varstart)
 Put variable. More...
 
subroutine netcdf_put_var_int_r1 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_real_r1 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_logical_r1 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_int_r2 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_real_r2 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_logical_r2 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_int_r3 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_real_r3 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_logical_r3 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_int_r4 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_real_r4 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_put_var_logical_r4 (mpl, ncid, varid, var, varstart, varcount)
 Put variable. More...
 
subroutine netcdf_get_var_byte_r0 (mpl, ncid, varid, var, varstart)
 Get variable. More...
 
subroutine netcdf_get_var_int_r0 (mpl, ncid, varid, var, varstart)
 Get variable. More...
 
subroutine netcdf_get_var_float_r0 (mpl, ncid, varid, var, varstart)
 Get variable. More...
 
subroutine netcdf_get_var_real_r0 (mpl, ncid, varid, var, varstart)
 Get variable. More...
 
subroutine netcdf_get_var_logical_r0 (mpl, ncid, varid, var, varstart)
 Get variable. More...
 
subroutine netcdf_get_var_byte_r1 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_int_r1 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_float_r1 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_real_r1 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_logical_r1 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_byte_r2 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_int_r2 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_float_r2 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_real_r2 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_logical_r2 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_byte_r3 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_int_r3 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_float_r3 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_real_r3 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_logical_r3 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_byte_r4 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_int_r4 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_float_r4 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_real_r4 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_get_var_logical_r4 (mpl, ncid, varid, var, varstart, varcount)
 Get variable. More...
 
subroutine netcdf_close_file (mpl, ncid)
 Close file. More...
 
subroutine netcdf_strerror (mpl, subr, ncid, info, hint, hint_id)
 Handle error. More...
 

Variables

integer, parameter nidmax = 1000
 Maximum number of simultaneous file and group ids. More...
 
integer, parameter ncharmax = 1024
 Maximum number of characters to store file and group names. More...
 
type(registry_type), public registry
 

Detailed Description

Generic ranks, dimensions and types.

Subroutines/functions list Instrumentation functions NetCDF wrappers

Function/Subroutine Documentation

◆ netcdf_check_dim_size()

logical function tools_netcdf::netcdf_check_dim_size ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname,
integer, intent(in)  dimsize 
)
private

Check dimension size.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]dimnameDimension name
[in]dimsizeExpected dimension size

Definition at line 1197 of file tools_netcdf.F90.

◆ netcdf_close_file()

subroutine tools_netcdf::netcdf_close_file ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid 
)
private

Close file.

Parameters
[in,out]mplMPI data
[in]ncidFile ID

Definition at line 3456 of file tools_netcdf.F90.

◆ netcdf_create_file()

integer function tools_netcdf::netcdf_create_file ( type(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  filename,
integer, intent(in), optional  iproc 
)
private

Create file.

Parameters
[in,out]mplMPI data
[in]filenameFile name
[in]iprocProcessor index

Definition at line 485 of file tools_netcdf.F90.

◆ netcdf_define_dim()

integer function tools_netcdf::netcdf_define_dim ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname,
integer, intent(in)  dimsize 
)
private

Define dimension.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]dimnameDimension name
[in]dimsizeDimension size

Definition at line 1061 of file tools_netcdf.F90.

◆ netcdf_define_grp()

integer function tools_netcdf::netcdf_define_grp ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  grpname 
)
private

Define group.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]grpnameGroup name

Definition at line 615 of file tools_netcdf.F90.

◆ netcdf_define_var()

integer function tools_netcdf::netcdf_define_var ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname,
character(len=*), intent(in)  varkind,
integer, dimension(:), intent(in)  varshape,
character(len=*), intent(in), optional  unitname 
)
private

Define variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varnameVariable name
[in]varkindVariable kind
[in]varshapeVariable shape
[in]unitnameUnit name

Definition at line 1242 of file tools_netcdf.F90.

◆ netcdf_get_att_int()

subroutine tools_netcdf::netcdf_get_att_int ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
integer(kind_int), intent(out)  att,
integer, intent(in), optional  varid 
)
private

Get attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[out]attAttribute
[in]varidVariable ID

Definition at line 883 of file tools_netcdf.F90.

◆ netcdf_get_att_logical()

subroutine tools_netcdf::netcdf_get_att_logical ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
logical, intent(out)  att,
integer, intent(in), optional  varid 
)
private

Get attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[out]attAttribute
[in]varidVariable ID

Definition at line 971 of file tools_netcdf.F90.

◆ netcdf_get_att_real()

subroutine tools_netcdf::netcdf_get_att_real ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
real(kind_real), intent(out)  att,
integer, intent(in), optional  varid 
)
private

Get attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[out]attAttribute
[in]varidVariable ID

Definition at line 927 of file tools_netcdf.F90.

◆ netcdf_get_att_string()

subroutine tools_netcdf::netcdf_get_att_string ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
character(len=*), intent(out)  att,
integer, intent(in), optional  varid 
)
private

Get attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[out]attAttribute
[in]varidVariable ID

Definition at line 1016 of file tools_netcdf.F90.

◆ netcdf_get_var_byte_r0()

subroutine tools_netcdf::netcdf_get_var_byte_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_signed_char), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart

Definition at line 2244 of file tools_netcdf.F90.

◆ netcdf_get_var_byte_r1()

subroutine tools_netcdf::netcdf_get_var_byte_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_signed_char), dimension(:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2468 of file tools_netcdf.F90.

◆ netcdf_get_var_byte_r2()

subroutine tools_netcdf::netcdf_get_var_byte_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_signed_char), dimension(:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2715 of file tools_netcdf.F90.

◆ netcdf_get_var_byte_r3()

subroutine tools_netcdf::netcdf_get_var_byte_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_signed_char), dimension(:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2962 of file tools_netcdf.F90.

◆ netcdf_get_var_byte_r4()

subroutine tools_netcdf::netcdf_get_var_byte_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_signed_char), dimension(:,:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3209 of file tools_netcdf.F90.

◆ netcdf_get_var_float_r0()

subroutine tools_netcdf::netcdf_get_var_float_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_float), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart

Definition at line 2332 of file tools_netcdf.F90.

◆ netcdf_get_var_float_r1()

subroutine tools_netcdf::netcdf_get_var_float_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_float), dimension(:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2562 of file tools_netcdf.F90.

◆ netcdf_get_var_float_r2()

subroutine tools_netcdf::netcdf_get_var_float_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_float), dimension(:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2809 of file tools_netcdf.F90.

◆ netcdf_get_var_float_r3()

subroutine tools_netcdf::netcdf_get_var_float_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_float), dimension(:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3056 of file tools_netcdf.F90.

◆ netcdf_get_var_float_r4()

subroutine tools_netcdf::netcdf_get_var_float_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_float), dimension(:,:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3303 of file tools_netcdf.F90.

◆ netcdf_get_var_int_r0()

subroutine tools_netcdf::netcdf_get_var_int_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart

Definition at line 2288 of file tools_netcdf.F90.

◆ netcdf_get_var_int_r1()

subroutine tools_netcdf::netcdf_get_var_int_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2515 of file tools_netcdf.F90.

◆ netcdf_get_var_int_r2()

subroutine tools_netcdf::netcdf_get_var_int_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2762 of file tools_netcdf.F90.

◆ netcdf_get_var_int_r3()

subroutine tools_netcdf::netcdf_get_var_int_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3009 of file tools_netcdf.F90.

◆ netcdf_get_var_int_r4()

subroutine tools_netcdf::netcdf_get_var_int_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3256 of file tools_netcdf.F90.

◆ netcdf_get_var_logical_r0()

subroutine tools_netcdf::netcdf_get_var_logical_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, intent(out)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart

Definition at line 2420 of file tools_netcdf.F90.

◆ netcdf_get_var_logical_r1()

subroutine tools_netcdf::netcdf_get_var_logical_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2656 of file tools_netcdf.F90.

◆ netcdf_get_var_logical_r2()

subroutine tools_netcdf::netcdf_get_var_logical_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2903 of file tools_netcdf.F90.

◆ netcdf_get_var_logical_r3()

subroutine tools_netcdf::netcdf_get_var_logical_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3150 of file tools_netcdf.F90.

◆ netcdf_get_var_logical_r4()

subroutine tools_netcdf::netcdf_get_var_logical_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3397 of file tools_netcdf.F90.

◆ netcdf_get_var_real_r0()

subroutine tools_netcdf::netcdf_get_var_real_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart

Definition at line 2376 of file tools_netcdf.F90.

◆ netcdf_get_var_real_r1()

subroutine tools_netcdf::netcdf_get_var_real_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2609 of file tools_netcdf.F90.

◆ netcdf_get_var_real_r2()

subroutine tools_netcdf::netcdf_get_var_real_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2856 of file tools_netcdf.F90.

◆ netcdf_get_var_real_r3()

subroutine tools_netcdf::netcdf_get_var_real_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3103 of file tools_netcdf.F90.

◆ netcdf_get_var_real_r4()

subroutine tools_netcdf::netcdf_get_var_real_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:,:,:), intent(out)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Get variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[out]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 3350 of file tools_netcdf.F90.

◆ netcdf_inquire_dim()

integer function tools_netcdf::netcdf_inquire_dim ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname 
)
private

Inquire dimension ID.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]dimnameDimension name

Definition at line 1103 of file tools_netcdf.F90.

Here is the caller graph for this function:

◆ netcdf_inquire_dim_size()

integer function tools_netcdf::netcdf_inquire_dim_size ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname,
integer, intent(in), optional  default 
)
private

Inquire dimension size.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]dimnameDimension name
[in]defaultDefault value

Definition at line 1150 of file tools_netcdf.F90.

Here is the caller graph for this function:

◆ netcdf_inquire_grp()

integer function tools_netcdf::netcdf_inquire_grp ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  grpname 
)
private

Inquire group ID.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]grpnameGroup name

Definition at line 659 of file tools_netcdf.F90.

◆ netcdf_inquire_var()

integer function tools_netcdf::netcdf_inquire_var ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname 
)
private

Inquire variable ID.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varnameVariable name

Definition at line 1302 of file tools_netcdf.F90.

◆ netcdf_inquire_var_dim_size()

integer function tools_netcdf::netcdf_inquire_var_dim_size ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname,
integer, intent(in)  dimindex 
)
private

Inquire variable dimension size.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varnameVariable name
[in]dimindexDimension index

Definition at line 1430 of file tools_netcdf.F90.

◆ netcdf_inquire_var_presence()

logical function tools_netcdf::netcdf_inquire_var_presence ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname 
)
private

Inquire variable presence.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varnameVariable name

Definition at line 1341 of file tools_netcdf.F90.

◆ netcdf_inquire_var_rank()

integer function tools_netcdf::netcdf_inquire_var_rank ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname 
)
private

Inquire variable rank.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varnameVariable name

Definition at line 1385 of file tools_netcdf.F90.

◆ netcdf_open_file()

integer function tools_netcdf::netcdf_open_file ( type(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  filename,
integer, intent(in), optional  iproc 
)
private

Open file.

Parameters
[in,out]mplMPI data
[in]filenameFile name
[in]iprocProcessor index

Definition at line 551 of file tools_netcdf.F90.

◆ netcdf_put_att_int()

subroutine tools_netcdf::netcdf_put_att_int ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
integer(kind_int), intent(in)  att,
integer, intent(in), optional  varid 
)
private

Put attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[in]attAttribute
[in]varidVariable ID

Definition at line 704 of file tools_netcdf.F90.

◆ netcdf_put_att_logical()

subroutine tools_netcdf::netcdf_put_att_logical ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
logical, intent(in)  att,
integer, intent(in), optional  varid 
)
private

Put attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[in]attAttribute
[in]varidVariable ID

Definition at line 792 of file tools_netcdf.F90.

◆ netcdf_put_att_real()

subroutine tools_netcdf::netcdf_put_att_real ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
real(kind_real), intent(in)  att,
integer, intent(in), optional  varid 
)
private

Put attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[in]attAttribute
[in]varidVariable ID

Definition at line 748 of file tools_netcdf.F90.

◆ netcdf_put_att_string()

subroutine tools_netcdf::netcdf_put_att_string ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  attname,
character(len=*), intent(in)  att,
integer, intent(in), optional  varid 
)
private

Put attribute.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]attnameAttribute name
[in]attAttribute
[in]varidVariable ID

Definition at line 837 of file tools_netcdf.F90.

◆ netcdf_put_var_int_r0()

subroutine tools_netcdf::netcdf_put_var_int_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart

Definition at line 1495 of file tools_netcdf.F90.

◆ netcdf_put_var_int_r1()

subroutine tools_netcdf::netcdf_put_var_int_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1631 of file tools_netcdf.F90.

◆ netcdf_put_var_int_r2()

subroutine tools_netcdf::netcdf_put_var_int_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1784 of file tools_netcdf.F90.

◆ netcdf_put_var_int_r3()

subroutine tools_netcdf::netcdf_put_var_int_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1937 of file tools_netcdf.F90.

◆ netcdf_put_var_int_r4()

subroutine tools_netcdf::netcdf_put_var_int_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
integer(kind_int), dimension(:,:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2090 of file tools_netcdf.F90.

◆ netcdf_put_var_logical_r0()

subroutine tools_netcdf::netcdf_put_var_logical_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, intent(in)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart

Definition at line 1583 of file tools_netcdf.F90.

◆ netcdf_put_var_logical_r1()

subroutine tools_netcdf::netcdf_put_var_logical_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1725 of file tools_netcdf.F90.

◆ netcdf_put_var_logical_r2()

subroutine tools_netcdf::netcdf_put_var_logical_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1878 of file tools_netcdf.F90.

◆ netcdf_put_var_logical_r3()

subroutine tools_netcdf::netcdf_put_var_logical_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2031 of file tools_netcdf.F90.

◆ netcdf_put_var_logical_r4()

subroutine tools_netcdf::netcdf_put_var_logical_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
logical, dimension(:,:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2184 of file tools_netcdf.F90.

◆ netcdf_put_var_real_r0()

subroutine tools_netcdf::netcdf_put_var_real_r0 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart

Definition at line 1539 of file tools_netcdf.F90.

◆ netcdf_put_var_real_r1()

subroutine tools_netcdf::netcdf_put_var_real_r1 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1678 of file tools_netcdf.F90.

◆ netcdf_put_var_real_r2()

subroutine tools_netcdf::netcdf_put_var_real_r2 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1831 of file tools_netcdf.F90.

◆ netcdf_put_var_real_r3()

subroutine tools_netcdf::netcdf_put_var_real_r3 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 1984 of file tools_netcdf.F90.

◆ netcdf_put_var_real_r4()

subroutine tools_netcdf::netcdf_put_var_real_r4 ( type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
integer, intent(in)  varid,
real(kind_real), dimension(:,:,:,:), intent(in)  var,
integer, dimension(:), intent(in), optional  varstart,
integer, dimension(:), intent(in), optional  varcount 
)
private

Put variable.

Parameters
[in,out]mplMPI data
[in]ncidFile ID
[in]varidVariable ID
[in]varVariable
[in]varstartStart
[in]varcountCount

Definition at line 2137 of file tools_netcdf.F90.

◆ netcdf_strerror()

subroutine tools_netcdf::netcdf_strerror ( type(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
integer, intent(in)  info,
character(len=*), intent(in), optional  hint,
integer, intent(in), optional  hint_id 
)
private

Handle error.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidFile ID
[in]infoInfo index
[in]hint_idHint ID

Definition at line 3493 of file tools_netcdf.F90.

◆ registry_free()

subroutine tools_netcdf::registry_free ( class(registry_type), intent(inout)  registry,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid 
)
private

Free registry slot.

Parameters
[in,out]mplMPI data
[in]ncidChild ID

Definition at line 412 of file tools_netcdf.F90.

◆ registry_get_root_id()

integer function tools_netcdf::registry_get_root_id ( class(registry_type), intent(inout)  registry,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid 
)
private

Get root ID in registry from a given ID.

Parameters
[in,out]mplMPI data
[in]ncidChild ID

Definition at line 344 of file tools_netcdf.F90.

◆ registry_recursive_cleaning()

recursive subroutine tools_netcdf::registry_recursive_cleaning ( class(registry_type), intent(inout)  registry,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  parent_id 
)
private

Recursive registry cleaning.

Parameters
[in,out]mplMPI data
[in]parent_idParent ID

Definition at line 442 of file tools_netcdf.F90.

◆ registry_report()

subroutine tools_netcdf::registry_report ( class(registry_type), intent(inout)  registry,
type(mpl_type), intent(inout)  mpl 
)
private

Print registry report.

Parameters
[in,out]mplMPI data

Definition at line 259 of file tools_netcdf.F90.

◆ registry_save()

subroutine tools_netcdf::registry_save ( class(registry_type), intent(inout)  registry,
type(mpl_type), intent(inout)  mpl,
integer, intent(in)  parent_id,
integer, intent(in)  child_id,
character(len=*), intent(in)  child_name 
)
private

Save ID in registry.

Parameters
[in,out]mplMPI data
[in]parent_idParent ID
[in]child_idChild ID
[in]child_nameChild name

Definition at line 289 of file tools_netcdf.F90.

Variable Documentation

◆ ncharmax

integer, parameter tools_netcdf::ncharmax = 1024

Maximum number of characters to store file and group names.

Definition at line 56 of file tools_netcdf.F90.

◆ nidmax

integer, parameter tools_netcdf::nidmax = 1000

Maximum number of simultaneous file and group ids.

Definition at line 55 of file tools_netcdf.F90.

◆ registry

type(registry_type), public tools_netcdf::registry

Definition at line 74 of file tools_netcdf.F90.