Auxiliary OASIS user interfaces. More...
Public Member Functions | |
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... | |
Private Attributes | |
integer(kind=ip_i4_p), dimension(mpi_status_size) | istatus |
Auxiliary OASIS user interfaces.
Definition at line 4 of file mod_oasis_auxiliary_routines.F90.
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.
[in] | icpl | coupling process flag |
[in] | allcomm | input MPI communicator |
[out] | cplcomm | reduced MPI communicator |
[in,out] | kinfo | return code |
Definition at line 112 of file mod_oasis_auxiliary_routines.F90.
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.
[out] | debug | debug level |
[in,out] | kinfo | return code |
Definition at line 158 of file mod_oasis_auxiliary_routines.F90.
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.
[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.
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.
[out] | new_comm | out MPI communicator |
[in] | cdnam | other model name to link with |
[out] | kinfo | return code |
Definition at line 210 of file mod_oasis_auxiliary_routines.F90.
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.
[out] | new_comm | output MPI communicator |
[in] | cdnam | other model name |
[out] | kinfo | return code |
Definition at line 264 of file mod_oasis_auxiliary_routines.F90.
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.
[out] | localcomm | MPI communicator |
[in,out] | kinfo | return code |
Definition at line 42 of file mod_oasis_auxiliary_routines.F90.
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.
[in] | varid | variable id |
[out] | ncpl | number of namcouple couplings |
[out] | kinfo | return code |
Definition at line 294 of file mod_oasis_auxiliary_routines.F90.
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.
[in] | varid | variable id |
[in] | msec | model time in seconds |
[out] | kinfo | return code |
Definition at line 410 of file mod_oasis_auxiliary_routines.F90.
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.
[in] | localcomm | MPI communicator |
[in,out] | kinfo | return code |
Definition at line 71 of file mod_oasis_auxiliary_routines.F90.
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.
[in] | debug | debug level |
[in,out] | kinfo | return code |
Definition at line 182 of file mod_oasis_auxiliary_routines.F90.
|
private |
Definition at line 34 of file mod_oasis_auxiliary_routines.F90.