source: CONFIG/UNIFORM/v6/NEMO_v6.5/SOURCES/p4zopt.F90 @ 6786

Last change on this file since 6786 was 6601, checked in by cetlod, 9 months ago

NEMOv6.5 : Update config to switch to NEMOv4.2.1 and PISCES gas
File size: 23.8 KB
Line 
1MODULE p4zopt
2   !!======================================================================
3   !!                         ***  MODULE p4zopt  ***
4   !! TOP - PISCES : Compute the light availability in the water column
5   !!======================================================================
6   !! History :  1.0  !  2004     (O. Aumont) Original code
7   !!            2.0  !  2007-12  (C. Ethe, G. Madec)  F90
8   !!            3.2  !  2009-04  (C. Ethe, G. Madec)  optimisation
9   !!            3.4  !  2011-06  (O. Aumont, C. Ethe) Improve light availability of nano & diat
10   !!----------------------------------------------------------------------
11   !!   p4z_opt       : light availability in the water column
12   !!----------------------------------------------------------------------
13   USE trc            ! tracer variables
14   USE oce_trc        ! tracer-ocean share variables
15   USE sms_pisces     ! Source Minus Sink of PISCES
16   USE iom            ! I/O manager
17   USE fldread        !  time interpolation
18   USE prtctl         !  print control for debugging
19
20   IMPLICIT NONE
21   PRIVATE
22
23   PUBLIC   p4z_opt        ! called in p4zbio.F90 module
24   PUBLIC   p4z_opt_init   ! called in trcsms_pisces.F90 module
25   PUBLIC   p4z_opt_alloc
26
27   !! * Shared module variables
28
29   LOGICAL  ::   ln_varpar   ! boolean for variable PAR fraction
30   REAL(wp) ::   parlux      ! Fraction of shortwave as PAR
31   REAL(wp) ::   xparsw      ! parlux/3
32   REAL(wp) ::   xsi0r       ! 1. /rn_si0
33
34   TYPE(FLD), ALLOCATABLE, DIMENSION(:) ::   sf_par      ! structure of input par
35   INTEGER , PARAMETER :: nbtimes = 366  !: maximum number of times record in a file
36   INTEGER  :: ntimes_par                ! number of time steps in a file
37   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   par_varsw      ! PAR fraction of shortwave
38   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   ekb, ekg, ekr  ! wavelength (Red-Green-Blue)
39   
40   !! * Substitutions
41#  include "do_loop_substitute.h90"
42#  include "domzgr_substitute.h90"
43   !!----------------------------------------------------------------------
44   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
45   !! $Id: p4zopt.F90 15459 2021-10-29 08:19:18Z cetlod $
46   !! Software governed by the CeCILL license (see ./LICENSE)
47   !!----------------------------------------------------------------------
48CONTAINS
49
50   SUBROUTINE p4z_opt( kt, knt, Kbb, Kmm )
51      !!---------------------------------------------------------------------
52      !!                     ***  ROUTINE p4z_opt  ***
53      !!
54      !! ** Purpose :   Compute the light availability in the water column
55      !!              depending on the depth and the chlorophyll concentration
56      !!
57      !! ** Method  : - ???
58      !!---------------------------------------------------------------------
59      INTEGER, INTENT(in) ::   kt, knt   ! ocean time step
60      INTEGER, INTENT(in) ::   Kbb, Kmm  ! time level indices
61      !
62      INTEGER  ::   ji, jj, jk
63      INTEGER  ::   irgb
64      REAL(wp) ::   zchl
65      REAL(wp) ::   zc0 , zc1 , zc2, zc3, z1_dep
66      REAL(wp), ALLOCATABLE, DIMENSION(:,:  ) :: zetmp5
67      REAL(wp), DIMENSION(jpi,jpj    ) :: zdepmoy, zetmp1, zetmp2, zetmp3, zetmp4
68      REAL(wp), DIMENSION(jpi,jpj    ) :: zqsr100, zqsr_corr
69      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zpar, ze0, ze1, ze2, ze3
70      !!---------------------------------------------------------------------
71      !
72      IF( ln_timing )   CALL timing_start('p4z_opt')
73
74      IF( knt == 1 .AND. ln_varpar )   CALL p4z_opt_sbc( kt )
75
76      !     Initialisation of variables used to compute PAR
77      !     -----------------------------------------------
78      ze1(:,:,:) = 0._wp
79      ze2(:,:,:) = 0._wp
80      ze3(:,:,:) = 0._wp
81
82      !
83      ! Attenuation coef. function of Chlorophyll and wavelength (Red-Green-Blue)
84      ! Thus the light penetration scheme is based on a decomposition of PAR
85      ! into three wave length domains. This was first officially published
86      ! in Lengaigne et al. (2007).
87      ! --------------------------------------------------------
88      !
89      ! Computation of the light attenuation parameters based on a
90      ! look-up table
91      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpkm1)
92         zchl =  ( tr(ji,jj,jk,jpnch,Kbb) + tr(ji,jj,jk,jpdch,Kbb) + rtrn ) * 1.e6
93         IF( ln_p5z )   zchl = zchl + tr(ji,jj,jk,jppch,Kbb) * 1.e6
94         zchl = MIN(  10. , MAX( 0.05, zchl )  )
95         irgb = NINT( 41 + 20.* LOG10( zchl ) + rtrn )
96         !                                                         
97         ekb(ji,jj,jk) = rkrgb(1,irgb) * e3t(ji,jj,jk,Kmm)
98         ekg(ji,jj,jk) = rkrgb(2,irgb) * e3t(ji,jj,jk,Kmm)
99         ekr(ji,jj,jk) = rkrgb(3,irgb) * e3t(ji,jj,jk,Kmm)
100      END_3D
101
102
103      ! Photosynthetically Available Radiation (PAR)
104      ! Two cases are considered in the following :
105      ! (1) An explicit diunal cycle is activated. In that case, mean
106      ! QSR is used as PISCES in its current state has not been parameterized
107      ! for an explicit diurnal cycle
108      ! (2) no diurnal cycle of SW is active and in that case, QSR is used.
109      ! --------------------------------------------
110      IF( ln_trcdc2dm ) THEN                     !  diurnal cycle
111         IF ( ln_p4z_dcyc ) THEN   ! Diurnal cycle in PISCES
112            !
113            !
114            ! SW over the ice free zone of the grid cell. This assumes that
115            ! SW is zero below sea ice which is a very crude assumption that is
116            ! not fully correct with LIM3 and SI3 but no information is
117            ! currently available to do a better job. SHould be improved in the
118            ! (near) future.
119            zqsr_corr(:,:) = MAX( 0._wp, qsr_mean(:,:) ) / ( 1.-fr_i(:,:) + rtrn )
120            !
121            CALL p4z_opt_par( kt, Kmm, zqsr_corr, ze1, ze2, ze3, pqsr100 = zqsr100 )
122            !
123            ! Used PAR is computed for each phytoplankton species
124            ! etot_ndcy is PAR at level jk averaged over 24h.
125            ! Due to their size, they have different light absorption characteristics
126            DO jk = 1, nksr
127               etot_ndcy(:,:,jk) =  ze1(:,:,jk) + ze2(:,:,jk) + ze3(:,:,jk)
128            END DO
129            !
130            ! SW over the ice free zone of the grid cell. This assumes that
131            ! SW is zero below sea ice which is a very crude assumption that is
132            ! not fully correct with LIM3 and SI3 but no information is
133            ! currently available to do a better job. SHould be improved in the
134            ! (near) future.
135            zqsr_corr(:,:) = MAX( 0._wp, qsr(:,:) ) / ( 1.-fr_i(:,:) + rtrn )
136            !
137            CALL p4z_opt_par( kt, Kmm, zqsr_corr, ze1, ze2, ze3 )
138            !
139            ! Total PAR computation at level jk that includes the diurnal cycle
140            DO jk = 1, nksr
141               etot (:,:,jk) =  ze1(:,:,jk) + ze2(:,:,jk) + ze3(:,:,jk)
142               enano(:,:,jk) =  1.85 * ze1(:,:,jk) + 0.69 * ze2(:,:,jk) + 0.46 * ze3(:,:,jk)
143               ediat(:,:,jk) =  1.62 * ze1(:,:,jk) + 0.74 * ze2(:,:,jk) + 0.63 * ze3(:,:,jk)
144            END DO
145            IF( ln_p5z ) THEN
146               DO jk = 1, nksr
147                  epico  (:,:,jk) =  1.94 * ze1(:,:,jk) + 0.66 * ze2(:,:,jk) + 0.4 * ze3(:,:,jk)
148               END DO
149            ENDIF
150
151         ELSE ! No diurnal cycle in PISCES
152
153            !
154            !
155            ! SW over the ice free zone of the grid cell. This assumes that
156            ! SW is zero below sea ice which is a very crude assumption that is
157            ! not fully correct with LIM3 and SI3 but no information is
158            ! currently available to do a better job. SHould be improved in the
159            ! (near) future.
160            zqsr_corr(:,:) = MAX( 0._wp, qsr_mean(:,:) ) / ( 1.-fr_i(:,:) + rtrn )
161            !
162            CALL p4z_opt_par( kt, Kmm, zqsr_corr, ze1, ze2, ze3, pqsr100 = zqsr100 ) 
163            !
164            ! Used PAR is computed for each phytoplankton species
165            ! etot_ndcy is PAR at level jk averaged over 24h.
166            ! Due to their size, they have different light absorption characteristics
167            DO jk = 1, nksr     
168               etot_ndcy(:,:,jk) =        ze1(:,:,jk) +        ze2(:,:,jk) +       ze3(:,:,jk)
169               enano    (:,:,jk) =  1.85 * ze1(:,:,jk) + 0.69 * ze2(:,:,jk) + 0.46 * ze3(:,:,jk)
170               ediat    (:,:,jk) =  1.62 * ze1(:,:,jk) + 0.74 * ze2(:,:,jk) + 0.63 * ze3(:,:,jk)
171            END DO
172            IF( ln_p5z ) THEN
173               DO jk = 1, nksr     
174                  epico  (:,:,jk) =  1.94 * ze1(:,:,jk) + 0.66 * ze2(:,:,jk) + 0.4 * ze3(:,:,jk)
175               END DO
176            ENDIF
177            !
178            ! SW over the ice free zone of the grid cell. This assumes that
179            ! SW is zero below sea ice which is a very crude assumption that is
180            ! not fully correct with LIM3 and SI3 but no information is
181            ! currently available to do a better job. SHould be improved in the
182            ! (near) future.
183            zqsr_corr(:,:) = MAX( 0._wp, qsr(:,:) ) / ( 1.-fr_i(:,:) + rtrn )
184            !
185            CALL p4z_opt_par( kt, Kmm, zqsr_corr, ze1, ze2, ze3 ) 
186            !
187            ! Total PAR computation at level jk that includes the diurnal cycle
188            DO jk = 1, nksr     
189               etot(:,:,jk) =  ze1(:,:,jk) + ze2(:,:,jk) + ze3(:,:,jk)
190            END DO
191         ENDIF
192         !
193      ELSE   ! no diurnal cycle
194         !
195         !
196         ! SW over the ice free zone of the grid cell. This assumes that
197         ! SW is zero below sea ice which is a very crude assumption that is
198         ! not fully correct with LIM3 and SI3 but no information is
199         ! currently available to do a better job. SHould be improved in the
200         ! (near) future.
201         zqsr_corr(:,:) = MAX( 0._wp, qsr(:,:) ) / ( 1.-fr_i(:,:) + rtrn )
202         !
203         CALL p4z_opt_par( kt, Kmm, zqsr_corr, ze1, ze2, ze3, pqsr100 = zqsr100  ) 
204         !
205
206         ! Used PAR is computed for each phytoplankton species
207         ! Due to their size, they have different light absorption characteristics
208         DO jk = 1, nksr     
209            etot (:,:,jk) =        ze1(:,:,jk) +        ze2(:,:,jk) +       ze3(:,:,jk)    ! Total PAR
210            enano(:,:,jk) =  1.85 * ze1(:,:,jk) + 0.69 * ze2(:,:,jk) + 0.46 * ze3(:,:,jk)  ! Nanophytoplankton
211            ediat(:,:,jk) =  1.62 * ze1(:,:,jk) + 0.74 * ze2(:,:,jk) + 0.63 * ze3(:,:,jk)  ! Diatoms
212         END DO
213         IF( ln_p5z ) THEN
214            DO jk = 1, nksr     
215              epico(:,:,jk) =  1.94 * ze1(:,:,jk) + 0.66 * ze2(:,:,jk) + 0.4 * ze3(:,:,jk)  ! Picophytoplankton (PISCES-QUOTA)
216            END DO
217         ENDIF
218         etot_ndcy(:,:,:) =  etot(:,:,:) 
219      ENDIF
220     
221      ! Biophysical feedback part (computation of vertical penetration of SW)
222      IF( ln_qsr_bio ) THEN                    !* heat flux accros w-level (used in the dynamics)
223         !                                     !  ------------------------
224         CALL p4z_opt_par( kt, Kmm, qsr, ze1, ze2, ze3, pe0=ze0 )
225         !
226         etot3(:,:,1) =  MAX( 0._wp, qsr(:,:) ) * tmask(:,:,1)
227         DO jk = 2, nksr + 1
228            etot3(:,:,jk) =  ( ze0(:,:,jk) + ze1(:,:,jk) + ze2(:,:,jk) + ze3(:,:,jk) ) * tmask(:,:,jk)
229         END DO
230         !
231      ENDIF
232     
233      ! Euphotic depth and level
234      ! Two definitions of the euphotic zone are used here.
235      ! (1) The classical definition based on the relative threshold value
236      ! (2) An alternative definition based on a absolute threshold value.
237      ! -------------------------------------------------------------------
238      neln(:,:) = 1
239      heup   (:,:) = gdepw(:,:,2,Kmm)
240      heup_01(:,:) = gdepw(:,:,2,Kmm)
241
242      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 2, nksr)
243        IF( etot_ndcy(ji,jj,jk) * tmask(ji,jj,jk) >=  zqsr100(ji,jj) )  THEN
244           neln(ji,jj) = jk+1                    ! Euphotic level : 1rst T-level strictly below Euphotic layer
245           !                                     ! nb: ensure the compatibility with nmld_trc definition in trd_mld_trc_zint
246           heup(ji,jj) = gdepw(ji,jj,jk+1,Kmm)     ! Euphotic layer depth
247        ENDIF
248        IF( etot_ndcy(ji,jj,jk) * tmask(ji,jj,jk) >= 0.10 )  THEN
249           heup_01(ji,jj) = gdepw(ji,jj,jk+1,Kmm)  ! Euphotic layer depth (light level definition)
250        ENDIF
251      END_3D
252      !
253      ! The euphotic depth can not exceed 300 meters.
254      heup   (:,:) = MIN( 300., heup   (:,:) )
255      heup_01(:,:) = MIN( 300., heup_01(:,:) )
256     
257      ! Mean PAR over the mixed layer
258      ! -----------------------------
259      zdepmoy(:,:)   = 0.e0             
260      zetmp1 (:,:)   = 0.e0
261      zetmp2 (:,:)   = 0.e0
262
263      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
264         IF( gdepw(ji,jj,jk+1,Kmm) <= hmld(ji,jj) ) THEN
265            zetmp1 (ji,jj) = zetmp1 (ji,jj) + etot     (ji,jj,jk) * e3t(ji,jj,jk,Kmm) ! Actual PAR for remineralisation
266            zetmp2 (ji,jj) = zetmp2 (ji,jj) + etot_ndcy(ji,jj,jk) * e3t(ji,jj,jk,Kmm) ! Par averaged over 24h for production
267            zdepmoy(ji,jj) = zdepmoy(ji,jj) +                       e3t(ji,jj,jk,Kmm)
268         ENDIF
269      END_3D
270      !
271      emoy(:,:,:) = etot(:,:,:)       ! remineralisation
272      zpar(:,:,:) = etot_ndcy(:,:,:)  ! diagnostic : PAR with no diurnal cycle
273      !
274      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
275         IF( gdepw(ji,jj,jk+1,Kmm) <= hmld(ji,jj) ) THEN
276            z1_dep = 1. / ( zdepmoy(ji,jj) + rtrn )
277            emoy (ji,jj,jk) = zetmp1(ji,jj) * z1_dep
278            zpar (ji,jj,jk) = zetmp2(ji,jj) * z1_dep
279         ENDIF
280      END_3D
281
282      ! Computation of the mean usable light for the different phytoplankton
283      ! groups based on their absorption characteristics.
284      zdepmoy(:,:)   = 0.e0
285      zetmp3 (:,:)   = 0.e0
286      zetmp4 (:,:)   = 0.e0
287      !
288      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
289         IF( gdepw(ji,jj,jk+1,Kmm) <= MIN(hmld(ji,jj), heup_01(ji,jj)) ) THEN
290            zetmp3 (ji,jj) = zetmp3 (ji,jj) + enano    (ji,jj,jk) * e3t(ji,jj,jk,Kmm) ! Nanophytoplankton
291            zetmp4 (ji,jj) = zetmp4 (ji,jj) + ediat    (ji,jj,jk) * e3t(ji,jj,jk,Kmm) ! Diatoms
292            zdepmoy(ji,jj) = zdepmoy(ji,jj) +                       e3t(ji,jj,jk,Kmm)
293         ENDIF
294      END_3D
295      enanom(:,:,:) = enano(:,:,:)
296      ediatm(:,:,:) = ediat(:,:,:)
297      !
298      DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
299         IF( gdepw(ji,jj,jk+1,Kmm) <= hmld(ji,jj) ) THEN
300            z1_dep = 1. / ( zdepmoy(ji,jj) + rtrn )
301            enanom(ji,jj,jk) = zetmp3(ji,jj) * z1_dep
302            ediatm(ji,jj,jk) = zetmp4(ji,jj) * z1_dep
303         ENDIF
304      END_3D
305      !
306      IF( ln_p5z ) THEN
307         ! Picophytoplankton when using PISCES-QUOTA
308         ALLOCATE( zetmp5(jpi,jpj) )  ;   zetmp5 (:,:) = 0.e0
309         DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
310            IF( gdepw(ji,jj,jk+1,Kmm) <= MIN(hmld(ji,jj), heup_01(ji,jj)) ) THEN
311               zetmp5(ji,jj)  = zetmp5 (ji,jj) + epico(ji,jj,jk) * e3t(ji,jj,jk,Kmm)
312            ENDIF
313         END_3D
314         !
315         epicom(:,:,:) = epico(:,:,:)
316         !
317         DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, nksr)
318            IF( gdepw(ji,jj,jk+1,Kmm) <= hmld(ji,jj) ) THEN
319               z1_dep = 1. / ( zdepmoy(ji,jj) + rtrn )
320               epicom(ji,jj,jk) = zetmp5(ji,jj) * z1_dep
321            ENDIF
322         END_3D
323         DEALLOCATE( zetmp5 )
324      ENDIF
325      !
326      IF( lk_iomput .AND.  knt == nrdttrc ) THEN
327         CALL iom_put( "Heup" , heup(:,:  ) * tmask(:,:,1) )  ! euphotic layer deptht
328         IF( iom_use( "PAR" ) ) THEN
329            zpar(:,:,1) = zpar(:,:,1) * ( 1._wp - fr_i(:,:) )
330            CALL iom_put( "PAR", zpar(:,:,:) * tmask(:,:,:) )  ! Photosynthetically Available Radiation
331         ENDIF
332      ENDIF
333      !
334      IF( ln_timing )   CALL timing_stop('p4z_opt')
335      !
336   END SUBROUTINE p4z_opt
337
338
339   SUBROUTINE p4z_opt_par( kt, Kmm, pqsr, pe1, pe2, pe3, pe0, pqsr100 ) 
340      !!----------------------------------------------------------------------
341      !!                  ***  routine p4z_opt_par  ***
342      !!
343      !! ** purpose :   compute PAR of each wavelength (Red-Green-Blue)
344      !!                for a given shortwave radiation
345      !!
346      !!----------------------------------------------------------------------
347      INTEGER                         , INTENT(in)              ::   kt                ! ocean time-step
348      INTEGER                         , INTENT(in)              ::   Kmm               ! ocean time-index
349      REAL(wp), DIMENSION(jpi,jpj)    , INTENT(in)              ::   pqsr              ! shortwave
350      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout)           ::   pe1 , pe2 , pe3   ! PAR ( R-G-B)
351      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout), OPTIONAL ::   pe0               !
352      REAL(wp), DIMENSION(jpi,jpj)    , INTENT(  out), OPTIONAL ::   pqsr100           !
353      !
354      INTEGER    ::   ji, jj, jk     ! dummy loop indices
355      REAL(wp), DIMENSION(jpi,jpj) ::  zqsr   ! shortwave
356      !!----------------------------------------------------------------------
357
358      !  Real shortwave
359      IF( ln_varpar ) THEN  ;  zqsr(:,:) = par_varsw(:,:) * pqsr(:,:)
360      ELSE                  ;  zqsr(:,:) = xparsw         * pqsr(:,:)
361      ENDIF
362     
363      !  Light at the euphotic depth
364      IF( PRESENT( pqsr100 ) )   pqsr100(:,:) = 0.01 * 3. * zqsr(:,:)
365
366      IF( PRESENT( pe0 ) ) THEN     !  W-level
367         !
368         pe0(:,:,1) = pqsr(:,:) - 3. * zqsr(:,:)    !   ( 1 - 3 * alpha ) * q
369         pe1(:,:,1) = zqsr(:,:)         
370         pe2(:,:,1) = zqsr(:,:)
371         pe3(:,:,1) = zqsr(:,:)
372         !
373         DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 2, nksr + 1)
374            pe0(ji,jj,jk) = pe0(ji,jj,jk-1) * EXP( -e3t(ji,jj,jk-1,Kmm) * xsi0r )
375            pe1(ji,jj,jk) = pe1(ji,jj,jk-1) * EXP( -ekb  (ji,jj,jk-1 )        )
376            pe2(ji,jj,jk) = pe2(ji,jj,jk-1) * EXP( -ekg  (ji,jj,jk-1 )        )
377            pe3(ji,jj,jk) = pe3(ji,jj,jk-1) * EXP( -ekr  (ji,jj,jk-1 )        )
378        END_3D
379        !
380      ELSE   ! T- level
381        !
382        pe1(:,:,1) = zqsr(:,:) * EXP( -0.5 * ekb(:,:,1) )
383        pe2(:,:,1) = zqsr(:,:) * EXP( -0.5 * ekg(:,:,1) )
384        pe3(:,:,1) = zqsr(:,:) * EXP( -0.5 * ekr(:,:,1) )
385        !
386        DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 2, nksr)
387           pe1(ji,jj,jk) = pe1(ji,jj,jk-1) * EXP( -0.5 * ( ekb(ji,jj,jk-1) + ekb(ji,jj,jk) ) )
388           pe2(ji,jj,jk) = pe2(ji,jj,jk-1) * EXP( -0.5 * ( ekg(ji,jj,jk-1) + ekg(ji,jj,jk) ) )
389           pe3(ji,jj,jk) = pe3(ji,jj,jk-1) * EXP( -0.5 * ( ekr(ji,jj,jk-1) + ekr(ji,jj,jk) ) )
390        END_3D
391        !
392      ENDIF
393      !
394   END SUBROUTINE p4z_opt_par
395
396
397   SUBROUTINE p4z_opt_sbc( kt )
398      !!----------------------------------------------------------------------
399      !!                  ***  routine p4z_opt_sbc  ***
400      !!
401      !! ** purpose :   read and interpolate the variable PAR fraction
402      !!                of shortwave radiation
403      !!
404      !! ** method  :   read the files and interpolate the appropriate variables
405      !!
406      !! ** input   :   external netcdf files
407      !!
408      !!----------------------------------------------------------------------
409      INTEGER, INTENT(in) ::   kt   ! ocean time step
410      !
411      INTEGER  :: ji,jj
412      REAL(wp) :: zcoef
413      !!---------------------------------------------------------------------
414      !
415      IF( ln_timing )  CALL timing_start('p4z_optsbc')
416      !
417      ! Compute par_varsw at nit000 or only if there is more than 1 time record in par coefficient file
418      IF( ln_varpar ) THEN
419         IF( kt == nit000 .OR. ( kt /= nit000 .AND. ntimes_par > 1 ) ) THEN
420            CALL fld_read( kt, 1, sf_par )
421            par_varsw(:,:) = ( sf_par(1)%fnow(:,:,1) ) / 3.0
422         ENDIF
423      ENDIF
424      !
425      IF( ln_timing )  CALL timing_stop('p4z_optsbc')
426      !
427   END SUBROUTINE p4z_opt_sbc
428
429
430   SUBROUTINE p4z_opt_init
431      !!----------------------------------------------------------------------
432      !!                  ***  ROUTINE p4z_opt_init  ***
433      !!
434      !! ** Purpose :   Initialization of tabulated attenuation coef
435      !!                and of the percentage of PAR in Shortwave
436      !!
437      !! ** Input   :   external ascii and netcdf files
438      !!----------------------------------------------------------------------
439      INTEGER :: numpar, ierr, ios   ! Local integer
440      !
441      CHARACTER(len=100) ::  cn_dir          ! Root directory for location of ssr files
442      TYPE(FLD_N) ::   sn_par                ! informations about the fields to be read
443      !
444      NAMELIST/nampisopt/cn_dir, sn_par, ln_varpar, parlux, ln_p4z_dcyc
445      !!----------------------------------------------------------------------
446      IF(lwp) THEN
447         WRITE(numout,*)
448         WRITE(numout,*) 'p4z_opt_init : '
449         WRITE(numout,*) '~~~~~~~~~~~~ '
450      ENDIF
451      READ  ( numnatp_ref, nampisopt, IOSTAT = ios, ERR = 901)
452901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'nampisopt in reference namelist' )
453      READ  ( numnatp_cfg, nampisopt, IOSTAT = ios, ERR = 902 )
454902   IF( ios >  0 )   CALL ctl_nam ( ios , 'nampisopt in configuration namelist' )
455      IF(lwm) WRITE ( numonp, nampisopt )
456
457      IF(lwp) THEN
458         WRITE(numout,*) '   Namelist : nampisopt '
459         WRITE(numout,*) '      PAR as a variable fraction of SW       ln_varpar      = ', ln_varpar
460         WRITE(numout,*) '      Default value for the PAR fraction     parlux         = ', parlux
461         WRITE(numout,*) '      Activate the diurnal cycle in PISCES   ln_p4z_dcyc    = ', ln_p4z_dcyc
462      ENDIF
463      !
464      xparsw = parlux / 3.0
465      xsi0r  = 1.e0 / rn_si0
466
467      ! Warning : activate the diurnal cycle with no diurnal cycle in the forcing fields makes no sense
468      ! That does not produce a bug because the model does not use the flag but a warning is necessary
469      ! ----------------------------------------------------------------------------------------------
470      IF ( ln_p4z_dcyc .AND. l_trcdm2dc ) THEN
471         IF (lwp) WRITE(numout,*) 'No diurnal cycle in the PAR forcing field '
472         IF (lwp) WRITE(numout,*) 'Activating the diurnal cycle in PISCES has no effect'
473      ENDIF
474      !
475      ! Variable PAR at the surface of the ocean
476      ! ----------------------------------------
477      IF( ln_varpar ) THEN
478         IF(lwp) WRITE(numout,*)
479         IF(lwp) WRITE(numout,*) '   ==>>>   initialize variable par fraction (ln_varpar=T)'
480         !
481         ALLOCATE( par_varsw(jpi,jpj) )
482         !
483         ALLOCATE( sf_par(1), STAT=ierr )           !* allocate and fill sf_sst (forcing structure) with sn_sst
484         IF( ierr > 0 )   CALL ctl_stop( 'STOP', 'p4z_opt_init: unable to allocate sf_par structure' )
485         !
486         CALL fld_fill( sf_par, (/ sn_par /), cn_dir, 'p4z_opt_init', 'Variable PAR fraction ', 'nampisopt' )
487                                   ALLOCATE( sf_par(1)%fnow(jpi,jpj,1)   )
488         IF( sn_par%ln_tint )      ALLOCATE( sf_par(1)%fdta(jpi,jpj,1,2) )
489
490         CALL iom_open (  TRIM( sn_par%clname ) , numpar )
491         ntimes_par = iom_getszuld( numpar )   ! get number of record in file
492      ENDIF
493      !
494                         ekr      (:,:,:) = 0._wp
495                         ekb      (:,:,:) = 0._wp
496                         ekg      (:,:,:) = 0._wp
497                         etot     (:,:,:) = 0._wp
498                         etot_ndcy(:,:,:) = 0._wp
499                         enano    (:,:,:) = 0._wp
500                         ediat    (:,:,:) = 0._wp
501      IF( ln_p5z     )   epico    (:,:,:) = 0._wp
502      IF( ln_qsr_bio )   etot3    (:,:,:) = 0._wp
503      !
504   END SUBROUTINE p4z_opt_init
505
506
507   INTEGER FUNCTION p4z_opt_alloc()
508      !!----------------------------------------------------------------------
509      !!                     ***  ROUTINE p4z_opt_alloc  ***
510      !!----------------------------------------------------------------------
511      !
512      ALLOCATE( ekb(jpi,jpj,jpk), ekr(jpi,jpj,jpk),  &
513                ekg(jpi,jpj,jpk), STAT= p4z_opt_alloc  ) 
514      !
515      IF( p4z_opt_alloc /= 0 ) CALL ctl_stop( 'STOP', 'p4z_opt_alloc : failed to allocate arrays.' )
516      !
517   END FUNCTION p4z_opt_alloc
518
519   !!======================================================================
520END MODULE p4zopt
Note: See TracBrowser for help on using the repository browser.