mod_oasis_auxiliary_routines Module Reference

Auxiliary OASIS user interfaces. More...

Functions/Subroutines
subroutine, public	oasis_get_localcomm (localcomm, kinfo)
	OASIS user query for the local MPI communicator. More...
subroutine, public	oasis_set_couplcomm (localcomm, kinfo)
	OASIS user call to specify a local communicator. More...
subroutine, public	oasis_create_couplcomm (icpl, allcomm, cplcomm, kinfo)
	OASIS user call to create a new communicator. More...
subroutine, public	oasis_get_debug (debug, kinfo)
	OASIS user interface to query debug level. More...
subroutine, public	oasis_set_debug (debug, kinfo)
	OASIS user interface to set debug level. More...
subroutine, public	oasis_get_intercomm (new_comm, cdnam, kinfo)
	OASIS user interface to establish an intercomm communicator between the root of two models. More...
subroutine, public	oasis_get_intracomm (new_comm, cdnam, kinfo)
	OASIS user interface to establish an intracomm communicator between the root of two models. More...
subroutine, public	oasis_get_ncpl (varid, ncpl, kinfo)
	OASIS user query for the number of unique couplings associated with a variable. More...
subroutine, public	oasis_get_freqs (varid, mop, ncpl, cpl_freqs, kinfo)
	OASIS user query for the coupling periods for a given variable. More...
subroutine, public	oasis_put_inquire (varid, msec, kinfo)
	OASIS user query to indicate put return code expected at a specified time for a given variable. More...

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

Detailed Description

Auxiliary OASIS user interfaces.

Function/Subroutine Documentation

oasis_create_couplcomm()

subroutine, public mod_oasis_auxiliary_routines::oasis_create_couplcomm	(	integer (kind=ip_intwp_p), intent(in)	icpl,
		integer (kind=ip_intwp_p), intent(in)	allcomm,
		integer (kind=ip_intwp_p), intent(out)	cplcomm,
		integer (kind=ip_intwp_p), intent(inout), optional	kinfo
	)

OASIS user call to create a new communicator.

Parameters

[in]	icpl	coupling process flag
[in]	allcomm	input MPI communicator
[out]	cplcomm	reduced MPI communicator
[in,out]	kinfo	return code

Definition at line 113 of file mod_oasis_auxiliary_routines.F90.

oasis_get_debug()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_debug	(	integer (kind=ip_intwp_p), intent(out)	debug,
		integer (kind=ip_intwp_p), intent(inout), optional	kinfo
	)

OASIS user interface to query debug level.

Parameters

[out]	debug	debug level
[in,out]	kinfo	return code

Definition at line 159 of file mod_oasis_auxiliary_routines.F90.

oasis_get_freqs()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_freqs	(	integer(kind=ip_i4_p), intent(in)	varid,
		integer(kind=ip_i4_p), intent(in)	mop,
		integer(kind=ip_i4_p), intent(in)	ncpl,
		integer(kind=ip_i4_p), dimension(ncpl), intent(out)	cpl_freqs,
		integer(kind=ip_i4_p), intent(out)	kinfo
	)

OASIS user query for the coupling periods for a given variable.

Parameters

[in]	varid	variable id
[in]	mop	OASIS_Out or OASIS_In type
[in]	ncpl	number of namcouple couplings
[out]	cpl_freqs	coupling period (sec)
[out]	kinfo	return code

Definition at line 339 of file mod_oasis_auxiliary_routines.F90.

oasis_get_intercomm()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_intercomm	(	integer (kind=ip_intwp_p), intent(out)	new_comm,
		character(len=*), intent(in)	cdnam,
		integer (kind=ip_intwp_p), intent(out), optional	kinfo
	)

OASIS user interface to establish an intercomm communicator between the root of two models.

Parameters

[out]	new_comm	out MPI communicator
[in]	cdnam	other model name to link with
[out]	kinfo	return code

Definition at line 211 of file mod_oasis_auxiliary_routines.F90.

oasis_get_intracomm()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_intracomm	(	integer (kind=ip_intwp_p), intent(out)	new_comm,
		character(len=*), intent(in)	cdnam,
		integer (kind=ip_intwp_p), intent(out), optional	kinfo
	)

OASIS user interface to establish an intracomm communicator between the root of two models.

Parameters

[out]	new_comm	output MPI communicator
[in]	cdnam	other model name
[out]	kinfo	return code

Definition at line 265 of file mod_oasis_auxiliary_routines.F90.

oasis_get_localcomm()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_localcomm	(	integer (kind=ip_intwp_p), intent(out)	localcomm,
		integer (kind=ip_intwp_p), intent(inout), optional	kinfo
	)

OASIS user query for the local MPI communicator.

Parameters

[out]	localcomm	MPI communicator
[in,out]	kinfo	return code

Definition at line 43 of file mod_oasis_auxiliary_routines.F90.

oasis_get_ncpl()

subroutine, public mod_oasis_auxiliary_routines::oasis_get_ncpl	(	integer(kind=ip_i4_p), intent(in)	varid,
		integer(kind=ip_i4_p), intent(out)	ncpl,
		integer(kind=ip_i4_p), intent(out)	kinfo
	)

OASIS user query for the number of unique couplings associated with a variable.

Parameters

[in]	varid	variable id
[out]	ncpl	number of namcouple couplings
[out]	kinfo	return code

Definition at line 295 of file mod_oasis_auxiliary_routines.F90.

oasis_put_inquire()

subroutine, public mod_oasis_auxiliary_routines::oasis_put_inquire	(	integer(kind=ip_i4_p), intent(in)	varid,
		integer(kind=ip_i4_p), intent(in)	msec,
		integer(kind=ip_i4_p), intent(out)	kinfo
	)

OASIS user query to indicate put return code expected at a specified time for a given variable.

Parameters

[in]	varid	variable id
[in]	msec	model time in seconds
[out]	kinfo	return code

Definition at line 409 of file mod_oasis_auxiliary_routines.F90.

oasis_set_couplcomm()

subroutine, public mod_oasis_auxiliary_routines::oasis_set_couplcomm	(	integer (kind=ip_intwp_p), intent(in)	localcomm,
		integer (kind=ip_intwp_p), intent(inout), optional	kinfo
	)

OASIS user call to specify a local communicator.

Parameters

[in]	localcomm	MPI communicator
[in,out]	kinfo	return code

Definition at line 72 of file mod_oasis_auxiliary_routines.F90.

oasis_set_debug()

subroutine, public mod_oasis_auxiliary_routines::oasis_set_debug	(	integer (kind=ip_intwp_p), intent(in)	debug,
		integer (kind=ip_intwp_p), intent(inout), optional	kinfo
	)

OASIS user interface to set debug level.

Parameters

[in]	debug	debug level
[in,out]	kinfo	return code

Definition at line 183 of file mod_oasis_auxiliary_routines.F90.

Variable Documentation

istatus

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

private

Definition at line 34 of file mod_oasis_auxiliary_routines.F90.