Oasis3-MCT
 All Classes Files Functions Variables Macros Pages
mod_oasis.F90
Go to the documentation of this file.
1 !> @mainpage Oasis3-MCT Version 3.0: April, 2015
2 !> This provides documentation of the Oasis3-MCT implementation for developers.
3 !> A separate Oasis3-MCT User Guide is available for Oasis users.
4 
5 !> Provides top level OASIS interfaces to the user community.
6 
7 MODULE mod_oasis
8 
9 ! !USES:
10  USE mod_oasis_kinds ,ONLY: ip_single_p
11  USE mod_oasis_kinds ,ONLY: ip_double_p
12  USE mod_oasis_kinds ,ONLY: ip_realwp_p
13  USE mod_oasis_kinds ,ONLY: ll_single
14  USE mod_oasis_kinds ,ONLY: ip_i2_p
15  USE mod_oasis_kinds ,ONLY: ip_i4_p
16  USE mod_oasis_kinds ,ONLY: ip_i8_p
17  USE mod_oasis_kinds ,ONLY: ip_intwp_p
18 
21 
24  USE mod_oasis_method ,ONLY: oasis_enddef
25 
27 
28  USE mod_oasis_var ,ONLY: oasis_def_var
29 
32 
40 
51 
52  USE mod_oasis_sys ,ONLY: oasis_abort
53 
54  IMPLICIT NONE
55 
56 !===============================================================================
57 
58 END MODULE mod_oasis
subroutine, public oasis_get_intracomm(new_comm, cdnam, kinfo)
OASIS user interface to establish an intracomm communicator between the root of two models...
OASIS partition data and methods.
System type methods.
Generic interface to support writing 4 or 8 byte reals.
subroutine, public oasis_get_intercomm(new_comm, cdnam, kinfo)
OASIS user interface to establish an intercomm communicator between the root of two models...
Reads the namcouple file for use in OASIS.
subroutine, public oasis_def_var(id_nports, cdport, id_part, id_var_nodims, kinout, id_var_shape, ktype, kinfo)
The OASIS user interface to define variables.
Generic interface to support writing 4 or 8 byte reals.
subroutine, public oasis_set_debug(debug, kinfo)
OASIS user interface to set debug level.
subroutine, public oasis_get_localcomm(localcomm, kinfo)
OASIS user query for the local MPI communicator.
subroutine, public oasis_set_couplcomm(localcomm, kinfo)
OASIS user call to specify a local communicator.
subroutine, public oasis_get_debug(debug, kinfo)
OASIS user interface to query debug level.
Generic interface to support writing 4 or 8 byte reals.
subroutine, public oasis_get_freqs(varid, mop, ncpl, cpl_freqs, kinfo)
OASIS user query for the coupling periods for a given variable.
Generic interface to support writing 4 or 8 byte reals.
Defines kinds for OASIS.
Auxiliary OASIS user interfaces.
subroutine, public oasis_terminate_grids_writing()
User interface to indicate user defined grids are done.
subroutine, public oasis_def_partition(id_part, kparal, kinfo, ig_size, name)
The OASIS user interface to define partitions.
subroutine, public oasis_enddef(kinfo)
OASIS user interface specifying the OASIS definition phase is complete.
subroutine, public oasis_write_mask(cgrid, nx, ny, mask, partid)
User interface to set integer mask values.
subroutine, public oasis_abort(id_compid, cd_routine, cd_message)
OASIS abort method, publically available to users.
subroutine, public oasis_create_couplcomm(icpl, allcomm, cplcomm, kinfo)
OASIS user call to create a new communicator.
High level OASIS user interfaces.
subroutine, public oasis_start_grids_writing(iwrite)
User interface to initialize grid writing.
OASIS grid data and methods.
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...
subroutine, public oasis_init_comp(mynummod, cdnam, kinfo, coupled)
OASIS user init method.
subroutine, public oasis_get_ncpl(varid, ncpl, kinfo)
OASIS user query for the number of unique couplings associated with a variable.
Generic overloaded interface for data get (receive)
OASIS variable data and methods.
Defines parameters for OASIS.
Provides top level OASIS interfaces to the user community.
Definition: mod_oasis.F90:7
OASIS send/receive (put/get) user interfaces.
subroutine, public oasis_terminate(kinfo)
OASIS user finalize method.
Generic overloaded interface for data put (send)