mod_oasis_parameters.F90

Go to the documentation of this file.

!> Defines parameters for OASIS

MODULE mod_oasis_parameters
!
! -- clim.h   18-08-95   Version 2.0   Author: Laurent Terray
!    ******
!             26-10-99   Version 2.4   Jean Latour (F.S.E.) MPI-2 support
!@
! -- mod_clim_proto.f90  12-06-02  Version 3.0   A. Caubel 
! --                     20-05-03  added PRISM_Recvd/Sent   S.Legutke
     
!    ******************
!
!@  Contents : variables related to the CLIM library
!@  --------
!@
!
  USE mod_oasis_kinds
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_ok   = 0 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_ok       = prism_ok

!-----Ports status

  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_notdef      = -2 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_notdef      = prism_notdef
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_var_uncpl   = -1
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_out         = 20
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_out         = prism_out
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_in          = 21
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_in          = prism_in
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_inout       = 2 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_inout       = prism_inout
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_recvd       = 3 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_recvd       = prism_recvd
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_sent        = 4 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_sent        = prism_sent
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_loctrans    = 5
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_loctrans    = prism_loctrans
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_torest      = 6
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_torest      = prism_torest
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_output      = 7
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_output      = prism_output
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_sentout     = 8
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_sentout     = prism_sentout
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_torestout   = 9
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_torestout   = prism_torestout
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_fromrest    = 10
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_fromrest    = prism_fromrest
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_input       = 11
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_input       = prism_input
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_recvout     = 12
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_recvout     = prism_recvout
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_fromrestout = 13
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_fromrestout = prism_fromrestout
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_waitgroup   = 14
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_waitgroup   = prism_waitgroup

!-----Coupler Comm Status

  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_none        = 100
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_none        = prism_none
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_comm_ready  = 101
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_comm_ready  = prism_comm_ready
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_comm_wait   = 102
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_comm_wait   = prism_comm_wait
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_put         = 103
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis3_put         = prism_put
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_get         = 104
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis3_get         = prism_get

!-----Field status

  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_exported  = 1
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_ignored   = 2
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_input     = 3
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_output    = 4
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_expout    = 5
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_ignout    = 6
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_auxilary  = 7

!----Field local transformation

  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_instant = 1
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_average = 2
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_accumul = 3
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_min     = 4
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_max     = 5

!----Field conserv option

  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cnone   = 0
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cglobal = 1
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cglbpos = 2
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cbasbal = 4
  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cbaspos = 5

!-----Parallel distribution

  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_strategy = 1 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_segments = 2 

  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_serial   = 0 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_apple    = 1 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_box      = 2 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_orange   = 3 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_points   = 4 

  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_offset   = 2 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_length   = 3 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_sizex    = 3 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_sizey    = 4 
  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_ldx      = 5 

!-----Datatypes

  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_real   = 4  
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_real   = prism_real
  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_double = 8 
  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_double = prism_double

!-----Quit parameters
!
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_ContPvm = 0 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_StopPvm = 1 
!
!-----Error Codes
!
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_MaxCodes  = -22 
!
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Ok   = 0 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_FastExit  = -1 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadName   = -2 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadPort   = -3 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadType   = -4 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: PRISM_DoubleDef= -5 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NotStep   = -6 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_IncStep   = -7 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_IncSize   = -8 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NotClim   = -9 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_TimeOut   = -10 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Pvm       = -11 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_FirstCall = -12 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_PbRoute   = -13 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Group     = -14 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadTaskId = -15 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NoTask    = -16 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_InitBuff  = -17 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Pack      = -18 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Unpack    = -19 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Down      = -20 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_PvmExit   = -21 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Mpi       = -22 
!  INTEGER (kind=ip_intwp_p), PARAMETER :: PRISM_NotFreq  = -23 
!

END MODULE mod_oasis_parameters