io_routines::io_read Interface Reference

---

Generic interface to the netcdf read routines

More...

Public Member Functions
subroutine	io_read2d (filename, varname, data_in, extradim)
	Same as io_read3d but for 2-dimensional data More...
subroutine	io_read3d (filename, varname, data_in, extradim)
	Same as io_read6d but for 3-dimensional data More...
subroutine	io_read6d (filename, varname, data_in, extradim)
	Reads in a variable from a netcdf file, allocating memory in data_in for it. More...
subroutine	io_read2di (filename, varname, data_in, extradim)
	Same as io_read2d but for integer data More...
subroutine	io_read1d (filename, varname, data_in, extradim)
	Same as io_read3d but for 1-dimensional data More...

Detailed Description

---

Generic interface to the netcdf read routines

Member Function/Subroutine Documentation

subroutine io_routines::io_read::io_read1d	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	varname,
		real, dimension(:), intent(out), allocatable	data_in,
		integer, intent(in), optional	extradim
	)

---

Same as io_read3d but for 1-dimensional data

Reads in a variable from a netcdf file, allocating memory in data_in for it.

if extradim is provided specifies this index for any extra dimensions (dims>1) e.g. we may only want one time slice from a 1d variable

Parameters

	filename	Name of NetCDF file to look at
	varname	Name of the NetCDF variable to read
[out]	data_in	Allocatable 1-dimensional array to store output
	extradim	OPTIONAL: specify the position to read for any extra (e.g. time) dimension

Return values

data_in

Allocated 1-dimensional array with the netCDF data

subroutine io_routines::io_read::io_read2d	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	varname,
		real, dimension(:,:), intent(out), allocatable	data_in,
		integer, intent(in), optional	extradim
	)

---

Same as io_read3d but for 2-dimensional data

Reads in a variable from a netcdf file, allocating memory in data_in for it.

if extradim is provided specifies this index for any extra dimensions (dims>2) e.g. we may only want one time slice from a 2d variable

Parameters

	filename	Name of NetCDF file to look at
	varname	Name of the NetCDF variable to read
[out]	data_in	Allocatable 2-dimensional array to store output
	extradim	OPTIONAL: specify the position to read for any extra (e.g. time) dimension

Return values

data_in

Allocated 2-dimensional array with the netCDF data

Here is the caller graph for this function:

subroutine io_routines::io_read::io_read2di	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	varname,
		integer, dimension(:,:), intent(out), allocatable	data_in,
		integer, intent(in), optional	extradim
	)

---

Same as io_read2d but for integer data

Reads in a variable from a netcdf file, allocating memory in data_in for it.

if extradim is provided specifies this index for any extra dimensions (dims>2) e.g. we may only want one time slice from a 2d variable

Parameters

	filename	Name of NetCDF file to look at
	varname	Name of the NetCDF variable to read
[out]	data_in	Allocatable 2-dimensional array to store output
	extradim	OPTIONAL: specify the position to read for any extra (e.g. time) dimension

Return values

data_in

Allocated 2-dimensional array with the netCDF data

Here is the caller graph for this function:

subroutine io_routines::io_read::io_read3d	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	varname,
		real, dimension(:,:,:), intent(out), allocatable	data_in,
		integer, intent(in), optional	extradim
	)

---

Same as io_read6d but for 3-dimensional data

Reads in a variable from a netcdf file, allocating memory in data_in for it.

if extradim is provided specifies this index for any extra dimensions (dims>3) e.g. we may only want one time slice from a 3d variable

Parameters

	filename	Name of NetCDF file to look at
	varname	Name of the NetCDF variable to read
[out]	data_in	Allocatable 3-dimensional array to store output
	extradim	OPTIONAL: specify the position to read for any extra (e.g. time) dimension

Return values

data_in

Allocated 3-dimensional array with the netCDF data

Here is the caller graph for this function:

subroutine io_routines::io_read::io_read6d	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	varname,
		real, dimension(:,:,:,:,:,:), intent(out), allocatable	data_in,
		integer, intent(in), optional	extradim
	)

---

Reads in a variable from a netcdf file, allocating memory in data_in for it.

if extradim is provided specifies this index for any extra dimensions (dims>6) e.g. we may only want one time slice from a 6d variable

Parameters

	filename	Name of NetCDF file to look at
	varname	Name of the NetCDF variable to read
[out]	data_in	Allocatable 6-dimensional array to store output
	extradim	OPTIONAL: specify the position to read for any extra (e.g. time) dimension

Return values

data_in

Allocated 6-dimensional array with the netCDF data

---

The documentation for this interface was generated from the following file:

• io/io_routines.f90