Oasis3-MCT
 All Classes Files Functions Variables Macros Pages
mod_oasis_parameters.F90
Go to the documentation of this file.
1 
2 !> Defines parameters for OASIS
3 
5 !
6 ! -- clim.h 18-08-95 Version 2.0 Author: Laurent Terray
7 ! ******
8 ! 26-10-99 Version 2.4 Jean Latour (F.S.E.) MPI-2 support
9 !@
10 ! -- mod_clim_proto.f90 12-06-02 Version 3.0 A. Caubel
11 ! -- 20-05-03 added PRISM_Recvd/Sent S.Legutke
12 
13 ! ******************
14 !
15 !@ Contents : variables related to the CLIM library
16 !@ --------
17 !@
18 !
19  USE mod_oasis_kinds
20  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_ok = 0
21  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_ok = prism_ok
22 
23 !-----Ports status
24 
25  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_notdef = -2
26  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_notdef = prism_notdef
27  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_var_uncpl = -1
28  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_out = 20
29  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_out = prism_out
30  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_in = 21
31  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_in = prism_in
32  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_inout = 2
33  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_inout = prism_inout
34  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_recvd = 3
35  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_recvd = prism_recvd
36  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_sent = 4
37  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_sent = prism_sent
38  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_loctrans = 5
39  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_loctrans = prism_loctrans
40  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_torest = 6
41  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_torest = prism_torest
42  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_output = 7
43  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_output = prism_output
44  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_sentout = 8
45  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_sentout = prism_sentout
46  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_torestout = 9
47  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_torestout = prism_torestout
48  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_fromrest = 10
49  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_fromrest = prism_fromrest
50  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_input = 11
51  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_input = prism_input
52  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_recvout = 12
53  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_recvout = prism_recvout
54  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_fromrestout = 13
55  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_fromrestout = prism_fromrestout
56  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_waitgroup = 14
57  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_waitgroup = prism_waitgroup
58 
59 !-----Coupler Comm Status
60 
61  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_none = 100
62  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_none = prism_none
63  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_comm_ready = 101
64  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_comm_ready = prism_comm_ready
65  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_comm_wait = 102
66  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_comm_wait = prism_comm_wait
67  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_put = 103
68  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis3_put = prism_put
69  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_get = 104
70  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis3_get = prism_get
71 
72 !-----Field status
73 
74  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_exported = 1
75  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_ignored = 2
76  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_input = 3
77  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_output = 4
78  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_expout = 5
79  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_ignout = 6
80  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_auxilary = 7
81 
82 !----Field local transformation
83 
84  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_instant = 1
85  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_average = 2
86  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_accumul = 3
87  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_min = 4
88  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_max = 5
89 
90 !----Field conserv option
91 
92  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cnone = 0
93  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cglobal = 1
94  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cglbpos = 2
95  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cbasbal = 4
96  INTEGER (kind=ip_intwp_p), PARAMETER :: ip_cbaspos = 5
97 
98 !-----Parallel distribution
99 
100  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_strategy = 1
101  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_segments = 2
102 
103  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_serial = 0
104  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_apple = 1
105  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_box = 2
106  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_orange = 3
107  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_points = 4
108 
109  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_offset = 2
110  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_length = 3
111  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_sizex = 3
112  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_sizey = 4
113  INTEGER (kind=ip_intwp_p), PARAMETER :: clim_ldx = 5
114 
115 !-----Datatypes
116 
117  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_real = 4
118  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_real = prism_real
119  INTEGER (kind=ip_intwp_p), PARAMETER :: prism_double = 8
120  INTEGER (kind=ip_intwp_p), PARAMETER :: oasis_double = prism_double
121 
122 !-----Quit parameters
123 !
124 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_ContPvm = 0
125 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_StopPvm = 1
126 !
127 !-----Error Codes
128 !
129 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_MaxCodes = -22
130 !
131 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Ok = 0
132 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_FastExit = -1
133 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadName = -2
134 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadPort = -3
135 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadType = -4
136 ! INTEGER (kind=ip_intwp_p), PARAMETER :: PRISM_DoubleDef= -5
137 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NotStep = -6
138 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_IncStep = -7
139 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_IncSize = -8
140 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NotClim = -9
141 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_TimeOut = -10
142 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Pvm = -11
143 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_FirstCall = -12
144 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_PbRoute = -13
145 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Group = -14
146 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_BadTaskId = -15
147 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_NoTask = -16
148 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_InitBuff = -17
149 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Pack = -18
150 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Unpack = -19
151 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Down = -20
152 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_PvmExit = -21
153 ! INTEGER (kind=ip_intwp_p), PARAMETER :: CLIM_Mpi = -22
154 ! INTEGER (kind=ip_intwp_p), PARAMETER :: PRISM_NotFreq = -23
155 !
156 
157 END MODULE mod_oasis_parameters
158 
Defines kinds for OASIS.
Defines parameters for OASIS.