Provides reusable IO routines for OASIS. More...

Public Member Functions
subroutine, public	oasis_io_read_avfld (filename, av, gsmap, mpicom, avfld, filefld, fldtype)
	Reads single field from a file into an attribute Vector. More...

subroutine, public	oasis_io_write_avfile (rstfile, av, gsmap, mpicom, nx, ny, nampre)
	Writes all fields from an attribute vector to a file. More...

subroutine, public	oasis_io_read_avfile (rstfile, av, gsmap, mpicom, abort, nampre, didread)
	Reads all fields for an attribute vector from a file. More...

subroutine, public	oasis_io_read_array (rstfile, mpicom, iarray, ivarname, rarray, rvarname, abort)
	Reads an integer or real field from a file into an array. More...

subroutine, public	oasis_io_write_array (rstfile, mpicom, iarray, ivarname, rarray, rvarname)
	Writes a real or integer array to a file. More...

subroutine, public	oasis_io_write_avfbf (av, gsmap, mpicom, nx, ny, msec, f_string, filename)
	Write each field in an attribute vector to an individual files. More...

subroutine, public	oasis_io_read_avfbf (av, gsmap, mpicom, msec, f_string, filename)
	Read each field in an attribute vector from individual files. More...

subroutine, public	oasis_io_read_field_fromroot (filename, fldname, ifld2, fld2, fld3, nx, ny, nz)
	Read a field on the root task from a file into an array. More...

subroutine, public	oasis_io_write_2dgridfld_fromroot (filename, fldname, fld, nx, ny)
	Write a real array named field from the root task to a file. More...

subroutine, public	oasis_io_write_2dgridint_fromroot (filename, fldname, fld, nx, ny)
	Write an integer array named field from the root task to a file. More...

subroutine, public	oasis_io_write_3dgridfld_fromroot (filename, fldname, fld, nx, ny, nc)
	Write a 3d real array named field from the root task to a file. More...

Detailed Description

Provides reusable IO routines for OASIS.

Definition at line 4 of file mod_oasis_io.F90.

Member Function/Subroutine Documentation

subroutine, public mod_oasis_io::oasis_io_read_array	(	character(len=*), intent(in)	rstfile,
		integer(ip_i4_p), intent(in)	mpicom,
		integer(ip_i4_p), dimension(:), intent(inout), optional	iarray,
		character(len=*), intent(in), optional	ivarname,
		real(ip_double_p), dimension(:), intent(inout), optional	rarray,
		character(len=*), intent(in), optional	rvarname,
		logical, intent(in), optional	abort
	)

Reads an integer or real field from a file into an array.

Parameters

[in]	rstfile	filename
[in]	mpicom	mpicom
[in,out]	iarray	integer data on root
[in]	ivarname	integer variable name on file
[in,out]	rarray	real data on root
[in]	rvarname	real variable name on file
[in]	abort	abort on error flag, default is true

Definition at line 519 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_read_avfbf	(	type(mct_avect), intent(inout)	av,
		type(mct_gsmap), intent(in)	gsmap,
		integer(ip_i4_p), intent(in)	mpicom,
		integer(ip_i4_p), intent(in), optional	msec,
		character(len=*), intent(in), optional	f_string,
		character(len=*), intent(in), optional	filename
	)

Read each field in an attribute vector from individual files.

Parameters

[in,out]	av	avect
[in]	gsmap	gsmap
[in]	mpicom	mpicom
[in]	msec	optional time info in seconds
[in]	f_string	optional f_string to append to filename
[in]	filename	optional input filename

Definition at line 1022 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_read_avfile	(	character(len=*), intent(in)	rstfile,
		type(mct_avect), intent(inout)	av,
		type(mct_gsmap), intent(in)	gsmap,
		integer(ip_i4_p), intent(in)	mpicom,
		logical, intent(in), optional	abort,
		character(len=*), intent(in), optional	nampre,
		logical, intent(out), optional	didread
	)

Reads all fields for an attribute vector from a file.

Parameters

[in]	rstfile	filename
[in,out]	av	avect
[in]	gsmap	gsmap
[in]	mpicom	mpicom
[in]	abort	abort on error flag, default is true
[in]	nampre	name prepend string for fields on file
[out]	didread	flag indicating that read was successful

Definition at line 364 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_read_avfld	(	character(len=*), intent(in)	filename,
		type(mct_avect), intent(inout)	av,
		type(mct_gsmap), intent(in)	gsmap,
		integer(ip_i4_p), intent(in)	mpicom,
		character(len=*), intent(in)	avfld,
		character(len=*), intent(in)	filefld,
		character(len=*), intent(in), optional	fldtype
	)

Reads single field from a file into an attribute Vector.

Parameters

[in]	filename	filename
[in,out]	av	avect
[in]	gsmap	gsmap
[in]	mpicom	mpicom
[in]	avfld	av field name
[in]	filefld	file field name
[in]	fldtype	kind

Definition at line 40 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_read_field_fromroot	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	fldname,
		integer(ip_i4_p), dimension(:,:), intent(inout), optional	ifld2,
		real(ip_realwp_p), dimension(:,:), intent(inout), optional	fld2,
		real(ip_realwp_p), dimension(:,:,:), intent(inout), optional	fld3,
		integer(ip_i4_p), intent(inout), optional	nx,
		integer(ip_i4_p), intent(inout), optional	ny,
		integer(ip_i4_p), intent(inout), optional	nz
	)

Read a field on the root task from a file into an array.

Parameters

[in]	filename	filename
[in]	fldname	field name
[in,out]	ifld2	2d integer array
[in,out]	fld2	2d real array
[in,out]	fld3	3d real array
[in,out]	nx	global nx size
[in,out]	ny	global ny size
[in,out]	nz	global nz size

Definition at line 1184 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_2dgridfld_fromroot	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	fldname,
		real(ip_realwp_p), dimension(:,:), intent(in)	fld,
		integer(ip_i4_p), intent(in)	nx,
		integer(ip_i4_p), intent(in)	ny
	)

Write a real array named field from the root task to a file.

Parameters

[in]	filename	file name
[in]	fldname	field name
[in]	fld	2d real field
[in]	nx	2d global nx size
[in]	ny	2d global ny size

Definition at line 1303 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_2dgridint_fromroot	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	fldname,
		integer(ip_i4_p), dimension(:,:), intent(in)	fld,
		integer(ip_i4_p), intent(in)	nx,
		integer(ip_i4_p), intent(in)	ny
	)

Write an integer array named field from the root task to a file.

Parameters

[in]	filename	file name
[in]	fldname	field name
[in]	fld	integer field
[in]	nx	2d global nx size
[in]	ny	2d global ny size

Definition at line 1406 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_3dgridfld_fromroot	(	character(len=*), intent(in)	filename,
		character(len=*), intent(in)	fldname,
		real(ip_realwp_p), dimension(:,:,:), intent(in)	fld,
		integer(ip_i4_p), intent(in)	nx,
		integer(ip_i4_p), intent(in)	ny,
		integer(ip_i4_p), intent(in)	nc
	)

Write a 3d real array named field from the root task to a file.

Parameters

[in]	filename	file name
[in]	fldname	field name
[in]	fld	3d real array
[in]	nx	3d global nx size
[in]	ny	3d global ny size
[in]	nc	3d global nz size or nc size for corners

Definition at line 1509 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_array	(	character(len=*), intent(in)	rstfile,
		integer(ip_i4_p), intent(in)	mpicom,
		integer(ip_i4_p), dimension(:), intent(in), optional	iarray,
		character(len=*), intent(in), optional	ivarname,
		real(ip_double_p), dimension(:), intent(in), optional	rarray,
		character(len=*), intent(in), optional	rvarname
	)

Writes a real or integer array to a file.

Parameters

[in]	rstfile	filename
[in]	mpicom	mpicom
[in]	iarray	integer data on root
[in]	ivarname	integer variable name on file
[in]	rarray	real data on root
[in]	rvarname	real variable name on file

Definition at line 684 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_avfbf	(	type(mct_avect), intent(in)	av,
		type(mct_gsmap), intent(in)	gsmap,
		integer(ip_i4_p), intent(in)	mpicom,
		integer(ip_i4_p), intent(in)	nx,
		integer(ip_i4_p), intent(in)	ny,
		integer(ip_i4_p), intent(in), optional	msec,
		character(len=*), intent(in), optional	f_string,
		character(len=*), intent(in), optional	filename
	)

Write each field in an attribute vector to an individual files.

Parameters

[in]	av	avect
[in]	gsmap	gsmap
[in]	mpicom	mpicom
[in]	nx	2d global nx size
[in]	ny	2d global ny size
[in]	msec	optional time info in seconds
[in]	f_string	optional f_string to append to filename
[in]	filename	optional output filename

Definition at line 831 of file mod_oasis_io.F90.

subroutine, public mod_oasis_io::oasis_io_write_avfile	(	character(len=*), intent(in)	rstfile,
		type(mct_avect), intent(in)	av,
		type(mct_gsmap), intent(in)	gsmap,
		integer(ip_i4_p), intent(in)	mpicom,
		integer(ip_i4_p), intent(in)	nx,
		integer(ip_i4_p), intent(in)	ny,
		character(len=*), intent(in), optional	nampre
	)

Writes all fields from an attribute vector to a file.

Parameters

[in]	rstfile	filename
[in]	av	avect
[in]	gsmap	gsmap
[in]	mpicom	mpicom
[in]	nx	2d global nx size
[in]	ny	2d global ny size
[in]	nampre	field name prepend string on file

Definition at line 188 of file mod_oasis_io.F90.

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

/Users/tcraig/Desktop/oasis/oasis3-mct.trunk/lib/psmile/src/mod_oasis_io.F90

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation