mod_oasis_getput_interface Module Reference

OASIS send/receive (put/get) user interfaces. More...

Data Types
interface	oasis_get
	Generic overloaded interface for data get (receive) More...
interface	oasis_put
	Generic overloaded interface for data put (send) More...

Functions/Subroutines
subroutine	oasis_put_r14 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 4 byte real 1D data. More...
subroutine	oasis_put_r18 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 4 byte real 1D data. More...
subroutine	oasis_put_r24 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 4 byte real 2D data. More...
subroutine	oasis_put_r34 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 4 byte real 2D bundled data. More...
subroutine	oasis_put_r28 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 8 byte real 2D data. More...
subroutine	oasis_put_r38 (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart)
	Send 8 byte real 2D bundled data. More...
subroutine	oasis_put_worker (var_id, kstep, fld1, kinfo, fld2, fld3, fld4, fld5, write_restart, varnum)
	Send worker routine puts 8 byte real 1D data. More...
subroutine	oasis_get_r14 (var_id, kstep, fld, kinfo)
	Receive 4 byte real 1D data. More...
subroutine	oasis_get_r18 (var_id, kstep, fld, kinfo)
	Receive 8 byte real 1D data. More...
subroutine	oasis_get_r24 (var_id, kstep, fld, kinfo)
	Receive 4 byte real 2D data. More...
subroutine	oasis_get_r34 (var_id, kstep, fld, kinfo)
	Receive 4 byte real 2D bundled data. More...
subroutine	oasis_get_r28 (var_id, kstep, fld, kinfo)
	Receive 8 byte real 2D data. More...
subroutine	oasis_get_r38 (var_id, kstep, fld, kinfo)
	Receive 8 byte real 2D bundled data. More...
subroutine	oasis_get_worker (var_id, kstep, fld, kinfo, varnum)
	Receive subroutine that actually does the work on 8 byte 1D data. More...

Variables
integer(kind=ip_i4_p), dimension(mpi_status_size)	istatus

Detailed Description

OASIS send/receive (put/get) user interfaces.

Function/Subroutine Documentation

oasis_get_r14()

subroutine mod_oasis_getput_interface::oasis_get_r14 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 4 byte real 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 807 of file mod_oasis_getput_interface.F90.

oasis_get_r18()

subroutine mod_oasis_getput_interface::oasis_get_r18 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_r8_p), dimension(:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 8 byte real 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 854 of file mod_oasis_getput_interface.F90.

oasis_get_r24()

subroutine mod_oasis_getput_interface::oasis_get_r24 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:,:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 4 byte real 2D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 890 of file mod_oasis_getput_interface.F90.

oasis_get_r28()

subroutine mod_oasis_getput_interface::oasis_get_r28 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:,:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 8 byte real 2D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 1025 of file mod_oasis_getput_interface.F90.

oasis_get_r34()

subroutine mod_oasis_getput_interface::oasis_get_r34 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:,:,:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 4 byte real 2D bundled data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 963 of file mod_oasis_getput_interface.F90.

oasis_get_r38()

subroutine mod_oasis_getput_interface::oasis_get_r38 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:,:,:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo  )

private

Receive 8 byte real 2D bundled data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code

Definition at line 1095 of file mod_oasis_getput_interface.F90.

oasis_get_worker()

subroutine mod_oasis_getput_interface::oasis_get_worker ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:), intent(inout)  fld, integer(kind=ip_i4_p), intent(out)  kinfo, integer(kind=ip_i4_p), optional  varnum  )

private

Receive subroutine that actually does the work on 8 byte 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
[in,out]	fld	field data
[out]	kinfo	return code
	varnum	variable num in bundled field

Definition at line 1154 of file mod_oasis_getput_interface.F90.

oasis_put_r14()

subroutine mod_oasis_getput_interface::oasis_put_r14 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_single_p), dimension(:), optional  fld2, real(kind=ip_single_p), dimension(:), optional  fld3, real(kind=ip_single_p), dimension(:), optional  fld4, real(kind=ip_single_p), dimension(:), optional  fld5, logical, optional  write_restart  )

private

Send 4 byte real 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 58 of file mod_oasis_getput_interface.F90.

oasis_put_r18()

subroutine mod_oasis_getput_interface::oasis_put_r18 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_double_p), dimension(:), optional  fld2, real(kind=ip_double_p), dimension(:), optional  fld3, real(kind=ip_double_p), dimension(:), optional  fld4, real(kind=ip_double_p), dimension(:), optional  fld5, logical, optional  write_restart  )

private

Send 4 byte real 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 124 of file mod_oasis_getput_interface.F90.

oasis_put_r24()

subroutine mod_oasis_getput_interface::oasis_put_r24 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:,:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_single_p), dimension(:,:), optional  fld2, real(kind=ip_single_p), dimension(:,:), optional  fld3, real(kind=ip_single_p), dimension(:,:), optional  fld4, real(kind=ip_single_p), dimension(:,:), optional  fld5, logical, optional  write_restart  )

private

Send 4 byte real 2D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 190 of file mod_oasis_getput_interface.F90.

oasis_put_r28()

subroutine mod_oasis_getput_interface::oasis_put_r28 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:,:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_double_p), dimension(:,:), optional  fld2, real(kind=ip_double_p), dimension(:,:), optional  fld3, real(kind=ip_double_p), dimension(:,:), optional  fld4, real(kind=ip_double_p), dimension(:,:), optional  fld5, logical, optional  write_restart  )

private

Send 8 byte real 2D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 420 of file mod_oasis_getput_interface.F90.

oasis_put_r34()

subroutine mod_oasis_getput_interface::oasis_put_r34 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_single_p), dimension(:,:,:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_single_p), dimension(:,:,:), optional  fld2, real(kind=ip_single_p), dimension(:,:,:), optional  fld3, real(kind=ip_single_p), dimension(:,:,:), optional  fld4, real(kind=ip_single_p), dimension(:,:,:), optional  fld5, logical, optional  write_restart  )

private

Send 4 byte real 2D bundled data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 314 of file mod_oasis_getput_interface.F90.

oasis_put_r38()

subroutine mod_oasis_getput_interface::oasis_put_r38 ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:,:,:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_double_p), dimension(:,:,:), optional  fld2, real(kind=ip_double_p), dimension(:,:,:), optional  fld3, real(kind=ip_double_p), dimension(:,:,:), optional  fld4, real(kind=ip_double_p), dimension(:,:,:), optional  fld5, logical, optional  write_restart  )

private

Send 8 byte real 2D bundled data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now

Definition at line 543 of file mod_oasis_getput_interface.F90.

oasis_put_worker()

subroutine mod_oasis_getput_interface::oasis_put_worker ( integer(kind=ip_i4_p), intent(in)  var_id, integer(kind=ip_i4_p), intent(in)  kstep, real(kind=ip_double_p), dimension(:)  fld1, integer(kind=ip_i4_p), intent(out)  kinfo, real(kind=ip_double_p), dimension(:), optional  fld2, real(kind=ip_double_p), dimension(:), optional  fld3, real(kind=ip_double_p), dimension(:), optional  fld4, real(kind=ip_double_p), dimension(:), optional  fld5, logical, optional  write_restart, integer(kind=ip_i4_p), optional  varnum  )

private

Send worker routine puts 8 byte real 1D data.

Parameters

[in]	var_id	variable id
[in]	kstep	model time in seconds
	fld1	field data
[out]	kinfo	return code
	fld2	higher order field data
	fld3	higher order field data
	fld4	higher order field data
	fld5	higher order field data
	write_restart	write restart now
	varnum	varnum in bundled field

Definition at line 648 of file mod_oasis_getput_interface.F90.

Variable Documentation

istatus

integer(kind=ip_i4_p), dimension(mpi_status_size) mod_oasis_getput_interface::istatus

private

Definition at line 23 of file mod_oasis_getput_interface.F90.