New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
bio_medusa_mod.F90 in branches/UKMO/dev_r5518_medusa_chg_trc_bio_medusa/NEMOGCM/NEMO/TOP_SRC/MEDUSA – NEMO

source: branches/UKMO/dev_r5518_medusa_chg_trc_bio_medusa/NEMOGCM/NEMO/TOP_SRC/MEDUSA/bio_medusa_mod.F90 @ 7938

Last change on this file since 7938 was 7938, checked in by marc, 8 years ago

Carbon chemistry has been pulled out of trcbio_medusa.F90 into carb_chem.F90
File size: 14.6 KB
Line 
1MODULE bio_medusa_mod
2   !!======================================================================
3   !!                      ***  MODULE  bio_medusa_mod  ***
4   !! MEDUSA variables   :  module for MEDUSA variables which are shared
5   !!                       across subroutines
6   !!======================================================================
7   !! History :
8   !!   -   ! 2017-04 (M. Stringer)        Code taken from trcbio_medusa.F90
9   !!----------------------------------------------------------------------
10#if defined key_medusa
11   !!----------------------------------------------------------------------
12   !!   'key_medusa'                                           MEDUSA
13   !!----------------------------------------------------------------------
14   USE par_kind,          ONLY: wp
15   
16   IMPLICIT NONE
17   PUBLIC
18
19   PUBLIC   bio_medusa_alloc     ! called by trcini.F90
20
21   !! model state variables
22   REAL(wp), ALLOCATABLE, DIMENSION(:,:) ::    zchn,zchd,zphn,zphd,zpds,zzmi
23   REAL(wp), ALLOCATABLE, DIMENSION(:,:) ::    zzme,zdet,zdtc,zdin,zsil,zfer
24# if defined key_roam
25   REAL(wp), ALLOCATABLE, DIMENSION(:,:) ::    zdic, zalk, zoxy
26   REAL(wp), ALLOCATABLE, DIMENSION(:,:) ::    ztmp, zsal
27# endif
28# if defined key_mocsy
29   REAL(wp), ALLOCATABLE, DIMENSION(:,:) ::    zpho
30# endif
31
32   !! AXY (01/03/10): add in mixed layer PP diagnostics
33   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fprn_ml,fprd_ml
34
35   !! Variable for iron-ligand system
36   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: xFree
37
38   !! Mortality/Remineralisation
39   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fslownflux, fslowcflux
40   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fregenfast,fregenfastsi
41# if defined key_roam
42   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fregenfastc
43# endif
44
45   !! Particle flux
46   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ffastn,ffastsi,ffastfe
47   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ffastc,ffastca
48   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fsedn,fsedsi,fsedfe,fsedc,fsedca
49   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fccd
50
51   !! water column nutrient and flux integrals
52   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ftot_n,ftot_si,ftot_fe
53   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fflx_n,fflx_si,fflx_fe
54   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fifd_n,fifd_si,fifd_fe
55   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fofd_n,fofd_si,fofd_fe
56# if defined key_roam
57   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ftot_c,ftot_a,ftot_o2
58   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fflx_c,fflx_a,fflx_o2
59   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fifd_c,fifd_a,fifd_o2
60   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fofd_c,fofd_a,fofd_o2
61# endif
62
63   !! Zooplankton grazing integrals
64   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fzmi_i,fzmi_o,fzme_i,fzme_o
65
66   !! Limitation term temporary variables
67   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ftot_pn,ftot_pd
68   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: ftot_zmi,ftot_zme,ftot_det,ftot_dtc
69
70   !! Nitrogen and silicon production and consumption
71   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fnit_prod,fnit_cons
72   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fsil_prod,fsil_cons
73
74   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_xco2a
75   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_ph,f_pco2w,f_h2co3
76   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_hco3,f_co3,f_co2flux
77   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_TDIC,f_TALK,f_dcf,f_henry
78   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_pp0
79   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_kw660,f_o2flux,f_o2sat
80   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_omcal,f_omarg
81
82   !! AXY (23/06/15): additional diagnostics for MOCSY and oxygen
83   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_fco2w,f_BetaD,f_rhosw,f_opres
84   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_insitut,f_pco2atm,f_fco2atm
85   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_schmidtco2,f_kwco2,f_K0
86   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_co2starair,f_dpco2,f_kwo2
87
88   INTEGER, ALLOCATABLE, DIMENSION(:,:)  :: iters 
89
90   !! Carbon, alkalinity production and consumption
91   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fcomm_resp
92   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: fcar_prod,fcar_cons
93
94   !! Oxygen production and consumption (and non-consumption)
95   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: foxy_prod,foxy_cons,foxy_anox
96
97   !! Benthic fluxes
98   INTEGER  ::    ibenthic
99   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_sbenin_n,f_sbenin_fe,f_sbenin_c
100   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_fbenin_n,f_fbenin_fe,f_fbenin_si
101   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_fbenin_c,f_fbenin_ca
102   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_benout_n,f_benout_fe,f_benout_si 
103   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_benout_c,f_benout_ca
104
105   !! Benthic fluxes of CaCO3 that shouldn't happen because of lysocline
106   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_benout_lyso_ca
107
108   !! riverine fluxes
109   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_runoff,f_riv_n,f_riv_si
110   REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: f_riv_c,f_riv_alk
111
112   !! Jpalm -- 11-10-2015 -- adapt diag to iom_use
113   !! 2D var for diagnostics.
114   REAL(wp), POINTER, DIMENSION(:,:) :: fprn2d, fdpn2d, fprd2d, fdpd2d
115   REAL(wp), POINTER, DIMENSION(:,:) :: fprds2d, fsdiss2d, fgmipn2d
116   REAL(wp), POINTER, DIMENSION(:,:) :: fgmid2d, fdzmi2d, fgmepn2d
117   REAL(wp), POINTER, DIMENSION(:,:) :: fgmepd2d, fgmezmi2d, fgmed2d
118   REAL(wp), POINTER, DIMENSION(:,:) :: fdzme2d, fslown2d, fdd2d
119   REAL(wp), POINTER, DIMENSION(:,:) :: ffetop2d, ffebot2d, ffescav2d
120   REAL(wp), POINTER, DIMENSION(:,:) :: fjln2d, fnln2d, ffln2d, fjld2d
121   REAL(wp), POINTER, DIMENSION(:,:) :: fnld2d, ffld2d, fsld2d2
122   REAL(wp), POINTER, DIMENSION(:,:) :: fsld2d, fregen2d, fregensi2d
123   REAL(wp), POINTER, DIMENSION(:,:) :: ftempn2d, ftempsi2d, ftempfe2d
124   REAL(wp), POINTER, DIMENSION(:,:) :: ftempc2d, ftempca2d, freminn2d
125   REAL(wp), POINTER, DIMENSION(:,:) :: freminsi2d, freminfe2d
126   REAL(wp), POINTER, DIMENSION(:,:) :: freminc2d, freminca2d
127   REAL(wp), POINTER, DIMENSION(:,:) :: zw2d
128# if defined key_roam
129   REAL(wp), POINTER, DIMENSION(:,:) :: ffastca2d, rivn2d, rivsi2d
130   REAL(wp), POINTER, DIMENSION(:,:) :: rivc2d, rivalk2d, fslowc2d
131   REAL(wp), POINTER, DIMENSION(:,:) :: fdpn22d, fdpd22d, fdzmi22d
132   REAL(wp), POINTER, DIMENSION(:,:) :: fdzme22d, zimesn2d, zimesd2d
133   REAL(wp), POINTER, DIMENSION(:,:) :: zimesc2d, zimesdc2d, ziexcr2d
134   REAL(wp), POINTER, DIMENSION(:,:) :: ziresp2d, zigrow2d, zemesn2d
135   REAL(wp), POINTER, DIMENSION(:,:) :: zemesd2d, zemesc2d, zemesdc2d
136   REAL(wp), POINTER, DIMENSION(:,:) :: zeexcr2d, zeresp2d, zegrow2d
137   REAL(wp), POINTER, DIMENSION(:,:) :: mdetc2d, gmidc2d, gmedc2d
138   REAL(wp), POINTER, DIMENSION(:,:) :: f_pco2a2d, f_pco2w2d, f_co2flux2d
139   REAL(wp), POINTER, DIMENSION(:,:) :: f_TDIC2d, f_TALK2d, f_kw6602d
140   REAL(wp), POINTER, DIMENSION(:,:) :: f_pp02d, f_o2flux2d, f_o2sat2d
141   REAL(wp), POINTER, DIMENSION(:,:) :: dms_andr2d, dms_simo2d, dms_aran2d
142   REAL(wp), POINTER, DIMENSION(:,:) :: dms_hall2d, dms_surf2d
143   REAL(wp), POINTER, DIMENSION(:,:) :: iben_n2d, iben_fe2d, iben_c2d
144   REAL(wp), POINTER, DIMENSION(:,:) :: iben_si2d, iben_ca2d, oben_n2d
145   REAL(wp), POINTER, DIMENSION(:,:) :: oben_fe2d, oben_c2d, oben_si2d
146   REAL(wp), POINTER, DIMENSION(:,:) :: oben_ca2d, sfr_ocal2d
147   REAL(wp), POINTER, DIMENSION(:,:) :: sfr_oarg2d, lyso_ca2d 
148   !! AXY (23/11/16): extra MOCSY diagnostics
149   REAL(wp), POINTER, DIMENSION(:,:) :: f_xco2a_2d, f_fco2w_2d, f_fco2a_2d
150   REAL(wp), POINTER, DIMENSION(:,:) :: f_ocnrhosw_2d, f_ocnschco2_2d
151   REAL(wp), POINTER, DIMENSION(:,:) :: f_ocnkwco2_2d
152   REAL(wp), POINTER, DIMENSION(:,:) :: f_ocnk0_2d, f_co2starair_2d
153   REAL(wp), POINTER, DIMENSION(:,:) :: f_ocndpco2_2d
154# endif
155   !!
156   !! 3D var for diagnostics.
157   REAL(wp), POINTER, DIMENSION(:,:,:) :: tpp3d, detflux3d, remin3dn
158   !!
159# if defined key_roam
160   !! AXY (04/11/16)
161   !! 2D var for new CMIP6 diagnostics (behind a key_roam ifdef
162   !! for simplicity)
163   REAL(wp), POINTER, DIMENSION(:,:) :: fgco2,intdissic,intdissin
164   REAL(wp), POINTER, DIMENSION(:,:) :: intdissisi,inttalk,o2min,zo2min
165   REAL(wp), POINTER, DIMENSION(:,:) :: fbddtalk,fbddtdic,fbddtdife
166   REAL(wp), POINTER, DIMENSION(:,:) :: fbddtdin,fbddtdisi
167   !!
168   !! 3D var for new CMIP6 diagnostics
169   REAL(wp), POINTER, DIMENSION(:,:,:) :: tppd3
170   REAL(wp), POINTER, DIMENSION(:,:,:) :: bddtalk3,bddtdic3,bddtdife3
171   REAL(wp), POINTER, DIMENSION(:,:,:) :: bddtdin3, bddtdisi3
172   REAL(wp), POINTER, DIMENSION(:,:,:) :: fd_nit3,fd_sil3,fd_car3,fd_cal3
173   REAL(wp), POINTER, DIMENSION(:,:,:) :: co33,co3satarag3,co3satcalc3,dcalc3
174   REAL(wp), POINTER, DIMENSION(:,:,:) :: expc3,expn3
175   REAL(wp), POINTER, DIMENSION(:,:,:) :: fediss3,fescav3
176   REAL(wp), POINTER, DIMENSION(:,:,:) :: migrazp3,migrazd3,megrazp3
177   REAL(wp), POINTER, DIMENSION(:,:,:) :: megrazd3, megrazz3
178   REAL(wp), POINTER, DIMENSION(:,:,:) :: o2sat3,pbsi3,pcal3,remoc3
179   REAL(wp), POINTER, DIMENSION(:,:,:) :: pnlimj3,pnlimn3,pnlimfe3
180   REAL(wp), POINTER, DIMENSION(:,:,:) :: pdlimj3,pdlimn3,pdlimfe3,pdlimsi3
181# endif
182   !!----------------------------------------------------------------------
183   !! NEMO/TOP 3.3.1 , NEMO Consortium (2010)
184   !! $Id$
185   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
186   !!----------------------------------------------------------------------
187CONTAINS
188
189   INTEGER FUNCTION bio_medusa_alloc()
190      !!-------------------------------------------------------------------
191      !!                    *** ROUTINE bio_medusa_alloc ***
192      !!-------------------------------------------------------------------
193      USE lib_mpp,           ONLY: ctl_warn
194      USE par_oce,           ONLY: jpi, jpj
195!    USE par_trc
196      !!-------------------------------------------------------------------
197      !
198      ALLOCATE(zchn(jpi,jpj),zchd(jpi,jpj),zphn(jpi,jpj),             &
199               zphd(jpi,jpj),zpds(jpi,jpj),zzmi(jpi,jpj),             &
200               zzme(jpi,jpj),zdet(jpi,jpj),zdtc(jpi,jpj),             &
201               zdin(jpi,jpj),zsil(jpi,jpj),zfer(jpi,jpj),             &
202               zdic(jpi,jpj),zalk(jpi,jpj),zoxy(jpi,jpj),             &
203               ztmp(jpi,jpj),zsal(jpi,jpj),                           &
204               zpho(jpi,jpj),                                         &
205               fprn_ml(jpi,jpj),fprd_ml(jpi,jpj),                     &
206               xFree(jpi,jpj),                                        &
207               fslownflux(jpi,jpj),fslowcflux(jpi,jpj),               &
208               fregenfast(jpi,jpj),fregenfastsi(jpi,jpj),             &
209# if defined key_roam
210               fregenfastc(jpi,jpj),                                  &
211# endif
212               ffastn(jpi,jpj),ffastsi(jpi,jpj),ffastfe(jpi,jpj),     &
213               ffastc(jpi,jpj),ffastca(jpi,jpj),                      &
214               fsedn(jpi,jpj),fsedsi(jpi,jpj),fsedfe(jpi,jpj),        &
215               fsedc(jpi,jpj),fsedca(jpi,jpj),                        &
216               fccd(jpi,jpj),                                         &
217               ftot_n(jpi,jpj),ftot_si(jpi,jpj),ftot_fe(jpi,jpj),     &
218               fflx_n(jpi,jpj),fflx_si(jpi,jpj),fflx_fe(jpi,jpj),     &
219               fifd_n(jpi,jpj),fifd_si(jpi,jpj),fifd_fe(jpi,jpj),     &
220               fofd_n(jpi,jpj),fofd_si(jpi,jpj),fofd_fe(jpi,jpj),     &
221# if defined key_roam
222               ftot_c(jpi,jpj),ftot_a(jpi,jpj),ftot_o2(jpi,jpj),      &
223               fflx_c(jpi,jpj),fflx_a(jpi,jpj),fflx_o2(jpi,jpj),      &
224               fifd_c(jpi,jpj),fifd_a(jpi,jpj),fifd_o2(jpi,jpj),      &
225               fofd_c(jpi,jpj),fofd_a(jpi,jpj),fofd_o2(jpi,jpj),      &
226# endif
227               fzmi_i(jpi,jpj),fzmi_o(jpi,jpj),fzme_i(jpi,jpj),       &
228               fzme_o(jpi,jpj),                                       &
229               ftot_pn(jpi,jpj),ftot_pd(jpi,jpj),                     &
230               ftot_zmi(jpi,jpj),ftot_zme(jpi,jpj),ftot_det(jpi,jpj), &
231               ftot_dtc(jpi,jpj),                                     &
232               fnit_prod(jpi,jpj),fnit_cons(jpi,jpj),                 &
233               fsil_prod(jpi,jpj),fsil_cons(jpi,jpj),                 &
234               f_xco2a(jpi,jpj),                                      &
235               f_ph(jpi,jpj),f_pco2w(jpi,jpj),f_h2co3(jpi,jpj),       &
236               f_hco3(jpi,jpj),f_co3(jpi,jpj),f_co2flux(jpi,jpj),     &
237               f_TDIC(jpi,jpj),f_TALK(jpi,jpj),f_dcf(jpi,jpj),        &
238               f_henry(jpi,jpj),                                      &
239               f_pp0(jpi,jpj),                                        &
240               f_kw660(jpi,jpj),f_o2flux(jpi,jpj),f_o2sat(jpi,jpj),   &
241               f_omcal(jpi,jpj),f_omarg(jpi,jpj),                     &
242               f_fco2w(jpi,jpj),f_BetaD(jpi,jpj),f_rhosw(jpi,jpj),    &
243               f_opres(jpi,jpj),f_insitut(jpi,jpj),                   &
244               f_pco2atm(jpi,jpj),f_fco2atm(jpi,jpj),                 &
245               f_schmidtco2(jpi,jpj),f_kwco2(jpi,jpj),f_K0(jpi,jpj),  &
246               f_co2starair(jpi,jpj),f_dpco2(jpi,jpj),                &
247               f_kwo2(jpi,jpj),                                       &
248               iters(jpi,jpj),                                        &
249               fcomm_resp(jpi,jpj),                                   &
250               fcar_prod(jpi,jpj),fcar_cons(jpi,jpj),                 &
251               foxy_prod(jpi,jpj), foxy_cons(jpi,jpj),                &
252               foxy_anox(jpi,jpj),                                    &
253               f_sbenin_n(jpi,jpj),f_sbenin_fe(jpi,jpj),              &
254               f_sbenin_c(jpi,jpj),                                   &
255               f_fbenin_n(jpi,jpj),f_fbenin_fe(jpi,jpj),              &
256               f_fbenin_si(jpi,jpj),                                  &
257               f_fbenin_c(jpi,jpj),f_fbenin_ca(jpi,jpj),              &
258               f_benout_n(jpi,jpj),f_benout_fe(jpi,jpj),              &
259               f_benout_si(jpi,jpj),                                  &
260               f_benout_c(jpi,jpj),f_benout_ca(jpi,jpj),              &
261               f_benout_lyso_ca(jpi,jpj),                             &
262               f_runoff(jpi,jpj),f_riv_n(jpi,jpj),f_riv_si(jpi,jpj),  &
263               f_riv_c(jpi,jpj),f_riv_alk(jpi,jpj),                   &
264               STAT = bio_medusa_alloc)
265
266      !! Check that allocation was successful
267      IF ( bio_medusa_alloc /= 0 ) THEN 
268         CALL ctl_warn('bio_medusa_alloc: failed to allocate arrays')
269      END IF
270   
271   END FUNCTION bio_medusa_alloc
272
273#else
274   !!----------------------------------------------------------------------
275   !!  Empty module :                                          No MEDUSA
276   !!----------------------------------------------------------------------
277#endif 
278
279   !!======================================================================
280END MODULE bio_medusa_mod
Note: See TracBrowser for help on using the repository browser.