1 | MODULE oce |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE oce *** |
---|
4 | !! Ocean : dynamics and active tracers defined in memory |
---|
5 | !!====================================================================== |
---|
6 | !! History : 1.0 ! 2002-11 (G. Madec) F90: Free form and module |
---|
7 | !! 3.1 ! 2009-02 (G. Madec, M. Leclair) pure z* coordinate |
---|
8 | !! 3.3 ! 2010-09 (C. Ethe) TRA-TRC merge: add ts, gtsu, gtsv 4D arrays |
---|
9 | !!---------------------------------------------------------------------- |
---|
10 | USE par_oce ! ocean parameters |
---|
11 | USE lib_mpp ! MPP library |
---|
12 | |
---|
13 | IMPLICIT NONE |
---|
14 | PRIVATE |
---|
15 | |
---|
16 | PUBLIC oce_alloc ! routine called by nemo_init in nemogcm.F90 |
---|
17 | |
---|
18 | LOGICAL, PUBLIC :: l_traldf_rot = .FALSE. !: rotated laplacian operator for lateral diffusion |
---|
19 | |
---|
20 | !! dynamics and tracer fields ! before ! now ! after ! the after trends becomes the fields |
---|
21 | !! -------------------------- ! fields ! fields ! trends ! only after tra_zdf and dyn_spg |
---|
22 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ub , un , ua !: i-horizontal velocity [m/s] |
---|
23 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: vb , vn , va !: j-horizontal velocity [m/s] |
---|
24 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ua_sv, va_sv !: Saved trends (time spliting) [m/s2] |
---|
25 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: wn !: vertical velocity [m/s] |
---|
26 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rotb , rotn !: relative vorticity [s-1] |
---|
27 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdivb, hdivn !: horizontal divergence [s-1] |
---|
28 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: tsb , tsn , tsa !: 4D T-S fields [Celcius,psu] |
---|
29 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: rab_b, rab_n !: thermal/haline expansion coef. [Celcius-1,psu-1] |
---|
30 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rn2b , rn2 !: brunt-vaisala frequency**2 [s-2] |
---|
31 | ! |
---|
32 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhd !: in situ density anomalie rhd=(rho-rau0)/rau0 [no units] |
---|
33 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhop !: potential volumic mass [kg/m3] |
---|
34 | |
---|
35 | !! free surface ! before ! now ! after ! |
---|
36 | !! ------------ ! fields ! fields ! fields ! |
---|
37 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ub_b , un_b , ua_b !: Barotropic velocities at u-point [m/s] |
---|
38 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vb_b , vn_b , va_b !: Barotropic velocities at v-point [m/s] |
---|
39 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshb , sshn , ssha !: sea surface height at t-point [m] |
---|
40 | ! |
---|
41 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: spgu, spgv !: horizontal surface pressure gradient |
---|
42 | |
---|
43 | !! interpolated gradient (only used in zps case) |
---|
44 | !! --------------------- |
---|
45 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtsu, gtsv !: horizontal gradient of T, S bottom u-point |
---|
46 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: gru , grv !: horizontal gradient of rd at bottom u-point |
---|
47 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: aru , arv |
---|
48 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: gzu , gzv |
---|
49 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ge3ru, ge3rv !: horizontal gradient of T, S and rd at top v-point |
---|
50 | |
---|
51 | !! (ISF) interpolated gradient (only used for ice shelf case) |
---|
52 | !! --------------------- |
---|
53 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtui, gtvi !: horizontal gradient of T, S and rd at top u-point |
---|
54 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: grui, grvi !: horizontal gradient of T, S and rd at top v-point |
---|
55 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: arui, arvi !: horizontal average of rd at top v-point |
---|
56 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: gzui, gzvi !: horizontal gradient of z at top v-point |
---|
57 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ge3rui, ge3rvi !: horizontal gradient of T, S and rd at top v-point |
---|
58 | !! (ISF) ice load |
---|
59 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: riceload |
---|
60 | |
---|
61 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rke !: kinetic energy |
---|
62 | |
---|
63 | !! arrays relating to embedding ice in the ocean. These arrays need to be declared |
---|
64 | !! even if no ice model is required. In the no ice model or traditional levitating |
---|
65 | !! ice cases they contain only zeros |
---|
66 | !! --------------------- |
---|
67 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: snwice_mass !: mass of snow and ice at current ice time step [Kg/m2] |
---|
68 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: snwice_mass_b !: mass of snow and ice at previous ice time step [Kg/m2] |
---|
69 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: snwice_fmass !: time evolution of mass of snow+ice [Kg/m2/s] |
---|
70 | |
---|
71 | !! Energy budget of the leads (open water embedded in sea ice) |
---|
72 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fraqsr_1lev !: fraction of solar net radiation absorbed in the first ocean level [-] |
---|
73 | |
---|
74 | !! Arrays used in coupling when MEDUSA is present. These arrays need to be declared |
---|
75 | !! even if MEDUSA is not active, to allow compilation, in which case they will not be allocated. |
---|
76 | !! --------------------- |
---|
77 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE :: CO2Flux_out_cpl(:,:) ! Output coupling CO2 flux |
---|
78 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE :: DMS_out_cpl(:,:) ! Output coupling DMS |
---|
79 | |
---|
80 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE :: PCO2a_in_cpl(:,:) ! Input coupling CO2 partial pressure |
---|
81 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE :: Dust_in_cpl(:,:) ! Input coupling dust |
---|
82 | |
---|
83 | #if defined key_medusa |
---|
84 | LOGICAL, PUBLIC, PARAMETER :: ln_medusa=.TRUE. ! Medusa switched on or off. |
---|
85 | #else |
---|
86 | LOGICAL, PUBLIC, PARAMETER :: ln_medusa=.FALSE. ! Medusa switched on or off. |
---|
87 | #endif |
---|
88 | !!---------------------------------------------------------------------- |
---|
89 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
---|
90 | !! $Id$ |
---|
91 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
92 | !!---------------------------------------------------------------------- |
---|
93 | CONTAINS |
---|
94 | |
---|
95 | INTEGER FUNCTION oce_alloc() |
---|
96 | !!---------------------------------------------------------------------- |
---|
97 | !! *** FUNCTION oce_alloc *** |
---|
98 | !!---------------------------------------------------------------------- |
---|
99 | INTEGER :: ierr(4) |
---|
100 | !!---------------------------------------------------------------------- |
---|
101 | ! |
---|
102 | ALLOCATE( ub (jpi,jpj,jpk) , un (jpi,jpj,jpk) , ua(jpi,jpj,jpk) , & |
---|
103 | & vb (jpi,jpj,jpk) , vn (jpi,jpj,jpk) , va(jpi,jpj,jpk) , & |
---|
104 | & ua_sv(jpi,jpj,jpk) , va_sv(jpi,jpj,jpk) , & |
---|
105 | & wn (jpi,jpj,jpk) , & |
---|
106 | & rotb (jpi,jpj,jpk) , rotn (jpi,jpj,jpk) , & |
---|
107 | & hdivb(jpi,jpj,jpk) , hdivn(jpi,jpj,jpk) , & |
---|
108 | & tsb (jpi,jpj,jpk,jpts) , tsn (jpi,jpj,jpk,jpts) , tsa(jpi,jpj,jpk,jpts) , & |
---|
109 | & rab_b(jpi,jpj,jpk,jpts) , rab_n(jpi,jpj,jpk,jpts) , & |
---|
110 | & rn2b (jpi,jpj,jpk) , rn2 (jpi,jpj,jpk) , STAT=ierr(1) ) |
---|
111 | ! |
---|
112 | ALLOCATE(rhd (jpi,jpj,jpk) , & |
---|
113 | & rhop(jpi,jpj,jpk) , & |
---|
114 | & rke(jpi,jpj,jpk) , & |
---|
115 | & sshb(jpi,jpj) , sshn(jpi,jpj) , ssha(jpi,jpj) , & |
---|
116 | & ub_b(jpi,jpj) , un_b(jpi,jpj) , ua_b(jpi,jpj) , & |
---|
117 | & vb_b(jpi,jpj) , vn_b(jpi,jpj) , va_b(jpi,jpj) , & |
---|
118 | & spgu (jpi,jpj) , spgv(jpi,jpj) , & |
---|
119 | & gtsu(jpi,jpj,jpts), gtsv(jpi,jpj,jpts), & |
---|
120 | & aru(jpi,jpj) , arv(jpi,jpj) , & |
---|
121 | & gzu(jpi,jpj) , gzv(jpi,jpj) , & |
---|
122 | & gru(jpi,jpj) , grv(jpi,jpj) , & |
---|
123 | & ge3ru(jpi,jpj) , ge3rv(jpi,jpj) , & |
---|
124 | & gtui(jpi,jpj,jpts), gtvi(jpi,jpj,jpts), & |
---|
125 | & arui(jpi,jpj) , arvi(jpi,jpj) , & |
---|
126 | & gzui(jpi,jpj) , gzvi(jpi,jpj) , & |
---|
127 | & ge3rui(jpi,jpj) , ge3rvi(jpi,jpj) , & |
---|
128 | & grui(jpi,jpj) , grvi(jpi,jpj) , & |
---|
129 | & riceload(jpi,jpj), STAT=ierr(2) ) |
---|
130 | ! |
---|
131 | ALLOCATE( snwice_mass(jpi,jpj) , snwice_mass_b(jpi,jpj), snwice_fmass(jpi,jpj) , STAT=ierr(3) ) |
---|
132 | ! |
---|
133 | ALLOCATE( fraqsr_1lev(jpi,jpj) , STAT=ierr(4) ) |
---|
134 | ! |
---|
135 | #if defined key_oasis3 |
---|
136 | IF (ln_medusa) THEN |
---|
137 | ! We only actually need these arrays to be allocated if coupling and MEDUSA |
---|
138 | ! are enabled |
---|
139 | ALLOCATE( CO2Flux_out_cpl(jpi,jpj), DMS_out_cpl(jpi,jpj), & |
---|
140 | PCO2a_in_cpl(jpi,jpj), Dust_in_cpl(jpi,jpj), STAT=ierr(5) ) |
---|
141 | |
---|
142 | ENDIF |
---|
143 | #endif |
---|
144 | |
---|
145 | oce_alloc = MAXVAL( ierr ) |
---|
146 | IF( oce_alloc /= 0 ) CALL ctl_warn('oce_alloc: failed to allocate arrays') |
---|
147 | ! |
---|
148 | END FUNCTION oce_alloc |
---|
149 | |
---|
150 | !!====================================================================== |
---|
151 | END MODULE oce |
---|