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.
eosbn2.F90 in branches/UKMO/dev_r5518_pcbias_ipc/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/UKMO/dev_r5518_pcbias_ipc/NEMOGCM/NEMO/OPA_SRC/TRA/eosbn2.F90 @ 8444

Last change on this file since 8444 was 8444, checked in by anaguiar, 7 years ago

Changes to avoid merge conflicts with package branch
File size: 73.6 KB
Line 
1MODULE eosbn2
2   !!==============================================================================
3   !!                       ***  MODULE  eosbn2  ***
4   !! Ocean diagnostic variable : equation of state - in situ and potential density
5   !!                                               - Brunt-Vaisala frequency
6   !!==============================================================================
7   !! History :  OPA  ! 1989-03  (O. Marti)  Original code
8   !!            6.0  ! 1994-07  (G. Madec, M. Imbard)  add bn2
9   !!            6.0  ! 1994-08  (G. Madec)  Add Jackett & McDougall eos
10   !!            7.0  ! 1996-01  (G. Madec)  statement function for e3
11   !!            8.1  ! 1997-07  (G. Madec)  density instead of volumic mass
12   !!             -   ! 1999-02  (G. Madec, N. Grima) semi-implicit pressure gradient
13   !!            8.2  ! 2001-09  (M. Ben Jelloul)  bugfix on linear eos
14   !!   NEMO     1.0  ! 2002-10  (G. Madec)  add eos_init
15   !!             -   ! 2002-11  (G. Madec, A. Bozec)  partial step, eos_insitu_2d
16   !!             -   ! 2003-08  (G. Madec)  F90, free form
17   !!            3.0  ! 2006-08  (G. Madec)  add tfreez function (now eos_fzp function)
18   !!            3.3  ! 2010-05  (C. Ethe, G. Madec)  merge TRC-TRA
19   !!             -   ! 2010-10  (G. Nurser, G. Madec)  add alpha/beta used in ldfslp
20   !!            3.7  ! 2012-03  (F. Roquet, G. Madec)  add primitive of alpha and beta used in PE computation
21   !!             -   ! 2012-05  (F. Roquet)  add Vallis and original JM95 equation of state
22   !!             -   ! 2013-04  (F. Roquet, G. Madec)  add eos_rab, change bn2 computation and reorganize the module
23   !!             -   ! 2014-09  (F. Roquet)  add TEOS-10, S-EOS, and modify EOS-80
24   !!----------------------------------------------------------------------
25
26   !!----------------------------------------------------------------------
27   !!   eos            : generic interface of the equation of state
28   !!   eos_insitu     : Compute the in situ density
29   !!   eos_insitu_pot : Compute the insitu and surface referenced potential volumic mass
30   !!   eos_insitu_2d  : Compute the in situ density for 2d fields
31   !!   bn2            : Compute the Brunt-Vaisala frequency
32   !!   eos_rab        : generic interface of in situ thermal/haline expansion ratio
33   !!   eos_rab_3d     : compute in situ thermal/haline expansion ratio
34   !!   eos_rab_2d     : compute in situ thermal/haline expansion ratio for 2d fields
35   !!   eos_fzp_2d     : freezing temperature for 2d fields
36   !!   eos_fzp_0d     : freezing temperature for scalar
37   !!   eos_init       : set eos parameters (namelist)
38   !!----------------------------------------------------------------------
39   USE dom_oce         ! ocean space and time domain
40   USE phycst          ! physical constants
41   !
42   USE in_out_manager  ! I/O manager
43   USE lib_mpp         ! MPP library
44   USE lib_fortran     ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
45   USE prtctl          ! Print control
46   USE wrk_nemo        ! Memory Allocation
47   USE lbclnk         ! ocean lateral boundary conditions
48   USE timing          ! Timing
49   USE stopar          ! Stochastic T/S fluctuations
50   USE stopts          ! Stochastic T/S fluctuations
51
52   IMPLICIT NONE
53   PRIVATE
54
55   !                   !! * Interface
56   INTERFACE eos
57      MODULE PROCEDURE eos_insitu, eos_insitu_pot, eos_insitu_2d
58   END INTERFACE
59   !
60   INTERFACE eos_rab
61      MODULE PROCEDURE rab_3d, rab_2d, rab_0d
62   END INTERFACE
63   !
64   INTERFACE eos_fzp 
65      MODULE PROCEDURE eos_fzp_2d, eos_fzp_0d
66   END INTERFACE
67   !
68   PUBLIC   eos            ! called by step, istate, tranpc and zpsgrd modules
69   PUBLIC   bn2            ! called by step module
70   PUBLIC   eos_rab        ! called by ldfslp, zdfddm, trabbl
71   PUBLIC   eos_pt_from_ct ! called by sbcssm
72   PUBLIC   eos_fzp        ! called by traadv_cen2 and sbcice_... modules
73   PUBLIC   eos_pen        ! used for pe diagnostics in trdpen module
74   PUBLIC   eos_init       ! called by istate module
75
76   !                                !!* Namelist (nameos) *
77   INTEGER , PUBLIC ::   nn_eos     ! = 0/1/2 type of eq. of state and Brunt-Vaisala frequ.
78   LOGICAL , PUBLIC ::   ln_useCT   ! determine if eos_pt_from_ct is used to compute sst_m
79
80   !                                   !!!  simplified eos coefficients
81   ! default value: Vallis 2006
82   REAL(wp) ::   rn_a0      = 1.6550e-1_wp     ! thermal expansion coeff.
83   REAL(wp) ::   rn_b0      = 7.6554e-1_wp     ! saline  expansion coeff.
84   REAL(wp) ::   rn_lambda1 = 5.9520e-2_wp     ! cabbeling coeff. in T^2       
85   REAL(wp) ::   rn_lambda2 = 5.4914e-4_wp     ! cabbeling coeff. in S^2       
86   REAL(wp) ::   rn_mu1     = 1.4970e-4_wp     ! thermobaric coeff. in T 
87   REAL(wp) ::   rn_mu2     = 1.1090e-5_wp     ! thermobaric coeff. in S 
88   REAL(wp) ::   rn_nu      = 2.4341e-3_wp     ! cabbeling coeff. in theta*salt 
89   
90   ! TEOS10/EOS80 parameters
91   REAL(wp) ::   r1_S0, r1_T0, r1_Z0, rdeltaS
92   
93   ! EOS parameters
94   REAL(wp) ::   EOS000 , EOS100 , EOS200 , EOS300 , EOS400 , EOS500 , EOS600
95   REAL(wp) ::   EOS010 , EOS110 , EOS210 , EOS310 , EOS410 , EOS510
96   REAL(wp) ::   EOS020 , EOS120 , EOS220 , EOS320 , EOS420
97   REAL(wp) ::   EOS030 , EOS130 , EOS230 , EOS330
98   REAL(wp) ::   EOS040 , EOS140 , EOS240
99   REAL(wp) ::   EOS050 , EOS150
100   REAL(wp) ::   EOS060
101   REAL(wp) ::   EOS001 , EOS101 , EOS201 , EOS301 , EOS401
102   REAL(wp) ::   EOS011 , EOS111 , EOS211 , EOS311
103   REAL(wp) ::   EOS021 , EOS121 , EOS221
104   REAL(wp) ::   EOS031 , EOS131
105   REAL(wp) ::   EOS041
106   REAL(wp) ::   EOS002 , EOS102 , EOS202
107   REAL(wp) ::   EOS012 , EOS112
108   REAL(wp) ::   EOS022
109   REAL(wp) ::   EOS003 , EOS103
110   REAL(wp) ::   EOS013 
111   
112   ! ALPHA parameters
113   REAL(wp) ::   ALP000 , ALP100 , ALP200 , ALP300 , ALP400 , ALP500
114   REAL(wp) ::   ALP010 , ALP110 , ALP210 , ALP310 , ALP410
115   REAL(wp) ::   ALP020 , ALP120 , ALP220 , ALP320
116   REAL(wp) ::   ALP030 , ALP130 , ALP230
117   REAL(wp) ::   ALP040 , ALP140
118   REAL(wp) ::   ALP050
119   REAL(wp) ::   ALP001 , ALP101 , ALP201 , ALP301
120   REAL(wp) ::   ALP011 , ALP111 , ALP211
121   REAL(wp) ::   ALP021 , ALP121
122   REAL(wp) ::   ALP031
123   REAL(wp) ::   ALP002 , ALP102
124   REAL(wp) ::   ALP012
125   REAL(wp) ::   ALP003
126   
127   ! BETA parameters
128   REAL(wp) ::   BET000 , BET100 , BET200 , BET300 , BET400 , BET500
129   REAL(wp) ::   BET010 , BET110 , BET210 , BET310 , BET410
130   REAL(wp) ::   BET020 , BET120 , BET220 , BET320
131   REAL(wp) ::   BET030 , BET130 , BET230
132   REAL(wp) ::   BET040 , BET140
133   REAL(wp) ::   BET050
134   REAL(wp) ::   BET001 , BET101 , BET201 , BET301
135   REAL(wp) ::   BET011 , BET111 , BET211
136   REAL(wp) ::   BET021 , BET121
137   REAL(wp) ::   BET031
138   REAL(wp) ::   BET002 , BET102
139   REAL(wp) ::   BET012
140   REAL(wp) ::   BET003
141
142   ! PEN parameters
143   REAL(wp) ::   PEN000 , PEN100 , PEN200 , PEN300 , PEN400
144   REAL(wp) ::   PEN010 , PEN110 , PEN210 , PEN310
145   REAL(wp) ::   PEN020 , PEN120 , PEN220
146   REAL(wp) ::   PEN030 , PEN130
147   REAL(wp) ::   PEN040
148   REAL(wp) ::   PEN001 , PEN101 , PEN201
149   REAL(wp) ::   PEN011 , PEN111
150   REAL(wp) ::   PEN021
151   REAL(wp) ::   PEN002 , PEN102
152   REAL(wp) ::   PEN012
153   
154   ! ALPHA_PEN parameters
155   REAL(wp) ::   APE000 , APE100 , APE200 , APE300
156   REAL(wp) ::   APE010 , APE110 , APE210
157   REAL(wp) ::   APE020 , APE120
158   REAL(wp) ::   APE030
159   REAL(wp) ::   APE001 , APE101
160   REAL(wp) ::   APE011
161   REAL(wp) ::   APE002
162
163   ! BETA_PEN parameters
164   REAL(wp) ::   BPE000 , BPE100 , BPE200 , BPE300
165   REAL(wp) ::   BPE010 , BPE110 , BPE210
166   REAL(wp) ::   BPE020 , BPE120
167   REAL(wp) ::   BPE030
168   REAL(wp) ::   BPE001 , BPE101
169   REAL(wp) ::   BPE011
170   REAL(wp) ::   BPE002
171
172   !! * Substitutions
173#  include "domzgr_substitute.h90"
174#  include "vectopt_loop_substitute.h90"
175   !!----------------------------------------------------------------------
176   !! NEMO/OPA 3.7 , NEMO Consortium (2014)
177   !! $Id$
178   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
179   !!----------------------------------------------------------------------
180CONTAINS
181
182   SUBROUTINE eos_insitu( pts, prd, pdep )
183      !!----------------------------------------------------------------------
184      !!                   ***  ROUTINE eos_insitu  ***
185      !!
186      !! ** Purpose :   Compute the in situ density (ratio rho/rau0) from
187      !!       potential temperature and salinity using an equation of state
188      !!       defined through the namelist parameter nn_eos.
189      !!
190      !! ** Method  :   prd(t,s,z) = ( rho(t,s,z) - rau0 ) / rau0
191      !!         with   prd    in situ density anomaly      no units
192      !!                t      TEOS10: CT or EOS80: PT      Celsius
193      !!                s      TEOS10: SA or EOS80: SP      TEOS10: g/kg or EOS80: psu
194      !!                z      depth                        meters
195      !!                rho    in situ density              kg/m^3
196      !!                rau0   reference density            kg/m^3
197      !!
198      !!     nn_eos = -1 : polynomial TEOS-10 equation of state is used for rho(t,s,z).
199      !!         Check value: rho = 1028.21993233072 kg/m^3 for z=3000 dbar, ct=3 Celcius, sa=35.5 g/kg
200      !!
201      !!     nn_eos =  0 : polynomial EOS-80 equation of state is used for rho(t,s,z).
202      !!         Check value: rho = 1028.35011066567 kg/m^3 for z=3000 dbar, pt=3 Celcius, sp=35.5 psu
203      !!
204      !!     nn_eos =  1 : simplified equation of state
205      !!              prd(t,s,z) = ( -a0*(1+lambda/2*(T-T0)+mu*z+nu*(S-S0))*(T-T0) + b0*(S-S0) ) / rau0
206      !!              linear case function of T only: rn_alpha<>0, other coefficients = 0
207      !!              linear eos function of T and S: rn_alpha and rn_beta<>0, other coefficients=0
208      !!              Vallis like equation: use default values of coefficients
209      !!
210      !! ** Action  :   compute prd , the in situ density (no units)
211      !!
212      !! References :   Roquet et al, Ocean Modelling, in preparation (2014)
213      !!                Vallis, Atmospheric and Oceanic Fluid Dynamics, 2006
214      !!                TEOS-10 Manual, 2010
215      !!----------------------------------------------------------------------
216      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::   pts   ! 1 : potential temperature  [Celcius]
217      !                                                               ! 2 : salinity               [psu]
218      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(  out) ::   prd   ! in situ density            [-]
219      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pdep  ! depth                      [m]
220      !
221      INTEGER  ::   ji, jj, jk                ! dummy loop indices
222      REAL(wp) ::   zt , zh , zs , ztm        ! local scalars
223      REAL(wp) ::   zn , zn0, zn1, zn2, zn3   !   -      -
224      !!----------------------------------------------------------------------
225      !
226      IF( nn_timing == 1 )   CALL timing_start('eos-insitu')
227      !
228      SELECT CASE( nn_eos )
229      !
230      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
231         !
232         DO jk = 1, jpkm1
233            DO jj = 1, jpj
234               DO ji = 1, jpi
235                  !
236                  zh  = pdep(ji,jj,jk) * r1_Z0                                  ! depth
237                  zt  = pts (ji,jj,jk,jp_tem) * r1_T0                           ! temperature
238                  zs  = SQRT( ABS( pts(ji,jj,jk,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
239                  ztm = tmask(ji,jj,jk)                                         ! tmask
240                  !
241                  zn3 = EOS013*zt   &
242                     &   + EOS103*zs+EOS003
243                     !
244                  zn2 = (EOS022*zt   &
245                     &   + EOS112*zs+EOS012)*zt   &
246                     &   + (EOS202*zs+EOS102)*zs+EOS002
247                     !
248                  zn1 = (((EOS041*zt   &
249                     &   + EOS131*zs+EOS031)*zt   &
250                     &   + (EOS221*zs+EOS121)*zs+EOS021)*zt   &
251                     &   + ((EOS311*zs+EOS211)*zs+EOS111)*zs+EOS011)*zt   &
252                     &   + (((EOS401*zs+EOS301)*zs+EOS201)*zs+EOS101)*zs+EOS001
253                     !
254                  zn0 = (((((EOS060*zt   &
255                     &   + EOS150*zs+EOS050)*zt   &
256                     &   + (EOS240*zs+EOS140)*zs+EOS040)*zt   &
257                     &   + ((EOS330*zs+EOS230)*zs+EOS130)*zs+EOS030)*zt   &
258                     &   + (((EOS420*zs+EOS320)*zs+EOS220)*zs+EOS120)*zs+EOS020)*zt   &
259                     &   + ((((EOS510*zs+EOS410)*zs+EOS310)*zs+EOS210)*zs+EOS110)*zs+EOS010)*zt   &
260                     &   + (((((EOS600*zs+EOS500)*zs+EOS400)*zs+EOS300)*zs+EOS200)*zs+EOS100)*zs+EOS000
261                     !
262                  zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
263                  !
264                  prd(ji,jj,jk) = (  zn * r1_rau0 - 1._wp  ) * ztm  ! density anomaly (masked)
265                  !
266               END DO
267            END DO
268         END DO
269         !
270      CASE( 1 )                !==  simplified EOS  ==!
271         !
272         DO jk = 1, jpkm1
273            DO jj = 1, jpj
274               DO ji = 1, jpi
275                  zt  = pts  (ji,jj,jk,jp_tem) - 10._wp
276                  zs  = pts  (ji,jj,jk,jp_sal) - 35._wp
277                  zh  = pdep (ji,jj,jk)
278                  ztm = tmask(ji,jj,jk)
279                  !
280                  zn =  - rn_a0 * ( 1._wp + 0.5_wp*rn_lambda1*zt + rn_mu1*zh ) * zt   &
281                     &  + rn_b0 * ( 1._wp - 0.5_wp*rn_lambda2*zs - rn_mu2*zh ) * zs   &
282                     &  - rn_nu * zt * zs
283                     !                                 
284                  prd(ji,jj,jk) = zn * r1_rau0 * ztm                ! density anomaly (masked)
285               END DO
286            END DO
287         END DO
288         !
289      END SELECT
290      !
291      IF(ln_ctl)   CALL prt_ctl( tab3d_1=prd, clinfo1=' eos-insitu  : ', ovlap=1, kdim=jpk )
292      !
293      IF( nn_timing == 1 )   CALL timing_stop('eos-insitu')
294      !
295   END SUBROUTINE eos_insitu
296
297
298   SUBROUTINE eos_insitu_pot( pts, prd, prhop, pdep )
299      !!----------------------------------------------------------------------
300      !!                  ***  ROUTINE eos_insitu_pot  ***
301      !!
302      !! ** Purpose :   Compute the in situ density (ratio rho/rau0) and the
303      !!      potential volumic mass (Kg/m3) from potential temperature and
304      !!      salinity fields using an equation of state defined through the
305      !!     namelist parameter nn_eos.
306      !!
307      !! ** Action  : - prd  , the in situ density (no units)
308      !!              - prhop, the potential volumic mass (Kg/m3)
309      !!
310      !!----------------------------------------------------------------------
311      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::   pts    ! 1 : potential temperature  [Celcius]
312      !                                                                ! 2 : salinity               [psu]
313      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(  out) ::   prd    ! in situ density            [-]
314      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(  out) ::   prhop  ! potential density (surface referenced)
315      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pdep   ! depth                      [m]
316      !
317      INTEGER  ::   ji, jj, jk, jsmp             ! dummy loop indices
318      INTEGER  ::   jdof
319      REAL(wp) ::   zt , zh , zstemp, zs , ztm   ! local scalars
320      REAL(wp) ::   zn , zn0, zn1, zn2, zn3      !   -      -
321      REAL(wp), DIMENSION(:), ALLOCATABLE :: zn0_sto, zn_sto, zsign    ! local vectors
322      !!----------------------------------------------------------------------
323      !
324      IF( nn_timing == 1 )   CALL timing_start('eos-pot')
325      !
326      SELECT CASE ( nn_eos )
327      !
328      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
329         !
330         ! Stochastic equation of state
331         IF ( ln_sto_eos ) THEN
332            ALLOCATE(zn0_sto(1:2*nn_sto_eos))
333            ALLOCATE(zn_sto(1:2*nn_sto_eos))
334            ALLOCATE(zsign(1:2*nn_sto_eos))
335            DO jsmp = 1, 2*nn_sto_eos, 2
336              zsign(jsmp)   = 1._wp
337              zsign(jsmp+1) = -1._wp
338            END DO
339            !
340            DO jk = 1, jpkm1
341               DO jj = 1, jpj
342                  DO ji = 1, jpi
343                     !
344                     ! compute density (2*nn_sto_eos) times:
345                     ! (1) for t+dt, s+ds (with the random TS fluctutation computed in sto_pts)
346                     ! (2) for t-dt, s-ds (with the opposite fluctuation)
347                     DO jsmp = 1, nn_sto_eos*2
348                        jdof   = (jsmp + 1) / 2
349                        zh     = pdep(ji,jj,jk) * r1_Z0                                  ! depth
350                        zt     = (pts (ji,jj,jk,jp_tem) + pts_ran(ji,jj,jk,jp_tem,jdof) * zsign(jsmp)) * r1_T0    ! temperature
351                        zstemp = pts  (ji,jj,jk,jp_sal) + pts_ran(ji,jj,jk,jp_sal,jdof) * zsign(jsmp)
352                        zs     = SQRT( ABS( zstemp + rdeltaS ) * r1_S0 )   ! square root salinity
353                        ztm    = tmask(ji,jj,jk)                                         ! tmask
354                        !
355                        zn3 = EOS013*zt   &
356                           &   + EOS103*zs+EOS003
357                           !
358                        zn2 = (EOS022*zt   &
359                           &   + EOS112*zs+EOS012)*zt   &
360                           &   + (EOS202*zs+EOS102)*zs+EOS002
361                           !
362                        zn1 = (((EOS041*zt   &
363                           &   + EOS131*zs+EOS031)*zt   &
364                           &   + (EOS221*zs+EOS121)*zs+EOS021)*zt   &
365                           &   + ((EOS311*zs+EOS211)*zs+EOS111)*zs+EOS011)*zt   &
366                           &   + (((EOS401*zs+EOS301)*zs+EOS201)*zs+EOS101)*zs+EOS001
367                           !
368                        zn0_sto(jsmp) = (((((EOS060*zt   &
369                           &   + EOS150*zs+EOS050)*zt   &
370                           &   + (EOS240*zs+EOS140)*zs+EOS040)*zt   &
371                           &   + ((EOS330*zs+EOS230)*zs+EOS130)*zs+EOS030)*zt   &
372                           &   + (((EOS420*zs+EOS320)*zs+EOS220)*zs+EOS120)*zs+EOS020)*zt   &
373                           &   + ((((EOS510*zs+EOS410)*zs+EOS310)*zs+EOS210)*zs+EOS110)*zs+EOS010)*zt   &
374                           &   + (((((EOS600*zs+EOS500)*zs+EOS400)*zs+EOS300)*zs+EOS200)*zs+EOS100)*zs+EOS000
375                           !
376                        zn_sto(jsmp)  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0_sto(jsmp)
377                     END DO
378                     !
379                     ! compute stochastic density as the mean of the (2*nn_sto_eos) densities
380                     prhop(ji,jj,jk) = 0._wp ; prd(ji,jj,jk) = 0._wp
381                     DO jsmp = 1, nn_sto_eos*2
382                        prhop(ji,jj,jk) = prhop(ji,jj,jk) + zn0_sto(jsmp)                      ! potential density referenced at the surface
383                        !
384                        prd(ji,jj,jk) = prd(ji,jj,jk) + (  zn_sto(jsmp) * r1_rau0 - 1._wp  )   ! density anomaly (masked)
385                     END DO
386                     prhop(ji,jj,jk) = 0.5_wp * prhop(ji,jj,jk) * ztm / nn_sto_eos
387                     prd  (ji,jj,jk) = 0.5_wp * prd  (ji,jj,jk) * ztm / nn_sto_eos
388                  END DO
389               END DO
390            END DO
391            DEALLOCATE(zn0_sto,zn_sto,zsign)
392         ! Non-stochastic equation of state
393         ELSE
394            DO jk = 1, jpkm1
395               DO jj = 1, jpj
396                  DO ji = 1, jpi
397                     !
398                     zh  = pdep(ji,jj,jk) * r1_Z0                                  ! depth
399                     zt  = pts (ji,jj,jk,jp_tem) * r1_T0                           ! temperature
400                     zs  = SQRT( ABS( pts(ji,jj,jk,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
401                     ztm = tmask(ji,jj,jk)                                         ! tmask
402                     !
403                     zn3 = EOS013*zt   &
404                        &   + EOS103*zs+EOS003
405                        !
406                     zn2 = (EOS022*zt   &
407                        &   + EOS112*zs+EOS012)*zt   &
408                        &   + (EOS202*zs+EOS102)*zs+EOS002
409                        !
410                     zn1 = (((EOS041*zt   &
411                        &   + EOS131*zs+EOS031)*zt   &
412                        &   + (EOS221*zs+EOS121)*zs+EOS021)*zt   &
413                        &   + ((EOS311*zs+EOS211)*zs+EOS111)*zs+EOS011)*zt   &
414                        &   + (((EOS401*zs+EOS301)*zs+EOS201)*zs+EOS101)*zs+EOS001
415                        !
416                     zn0 = (((((EOS060*zt   &
417                        &   + EOS150*zs+EOS050)*zt   &
418                        &   + (EOS240*zs+EOS140)*zs+EOS040)*zt   &
419                        &   + ((EOS330*zs+EOS230)*zs+EOS130)*zs+EOS030)*zt   &
420                        &   + (((EOS420*zs+EOS320)*zs+EOS220)*zs+EOS120)*zs+EOS020)*zt   &
421                        &   + ((((EOS510*zs+EOS410)*zs+EOS310)*zs+EOS210)*zs+EOS110)*zs+EOS010)*zt   &
422                        &   + (((((EOS600*zs+EOS500)*zs+EOS400)*zs+EOS300)*zs+EOS200)*zs+EOS100)*zs+EOS000
423                        !
424                     zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
425                     !
426                     prhop(ji,jj,jk) = zn0 * ztm                           ! potential density referenced at the surface
427                     !
428                     prd(ji,jj,jk) = (  zn * r1_rau0 - 1._wp  ) * ztm      ! density anomaly (masked)
429                  END DO
430               END DO
431            END DO
432         ENDIF
433         
434      CASE( 1 )                !==  simplified EOS  ==!
435         !
436         DO jk = 1, jpkm1
437            DO jj = 1, jpj
438               DO ji = 1, jpi
439                  zt  = pts  (ji,jj,jk,jp_tem) - 10._wp
440                  zs  = pts  (ji,jj,jk,jp_sal) - 35._wp
441                  zh  = pdep (ji,jj,jk)
442                  ztm = tmask(ji,jj,jk)
443                  !                                                     ! potential density referenced at the surface
444                  zn =  - rn_a0 * ( 1._wp + 0.5_wp*rn_lambda1*zt ) * zt   &
445                     &  + rn_b0 * ( 1._wp - 0.5_wp*rn_lambda2*zs ) * zs   &
446                     &  - rn_nu * zt * zs
447                  prhop(ji,jj,jk) = ( rau0 + zn ) * ztm
448                  !                                                     ! density anomaly (masked)
449                  zn = zn - ( rn_a0 * rn_mu1 * zt + rn_b0 * rn_mu2 * zs ) * zh
450                  prd(ji,jj,jk) = zn * r1_rau0 * ztm
451                  !
452               END DO
453            END DO
454         END DO
455         !
456      END SELECT
457      !
458      CALL lbc_lnk( prd, 'T', 1.0_wp )
459      !
460      IF(ln_ctl)   CALL prt_ctl( tab3d_1=prd, clinfo1=' eos-pot: ', tab3d_2=prhop, clinfo2=' pot : ', ovlap=1, kdim=jpk )
461      !
462      IF( nn_timing == 1 )   CALL timing_stop('eos-pot')
463      !
464   END SUBROUTINE eos_insitu_pot
465
466
467   SUBROUTINE eos_insitu_2d( pts, pdep, prd )
468      !!----------------------------------------------------------------------
469      !!                  ***  ROUTINE eos_insitu_2d  ***
470      !!
471      !! ** Purpose :   Compute the in situ density (ratio rho/rau0) from
472      !!      potential temperature and salinity using an equation of state
473      !!      defined through the namelist parameter nn_eos. * 2D field case
474      !!
475      !! ** Action  : - prd , the in situ density (no units) (unmasked)
476      !!
477      !!----------------------------------------------------------------------
478      REAL(wp), DIMENSION(jpi,jpj,jpts), INTENT(in   ) ::   pts   ! 1 : potential temperature  [Celcius]
479      !                                                           ! 2 : salinity               [psu]
480      REAL(wp), DIMENSION(jpi,jpj)     , INTENT(in   ) ::   pdep  ! depth                      [m]
481      REAL(wp), DIMENSION(jpi,jpj)     , INTENT(  out) ::   prd   ! in situ density
482      !
483      INTEGER  ::   ji, jj, jk                ! dummy loop indices
484      REAL(wp) ::   zt , zh , zs              ! local scalars
485      REAL(wp) ::   zn , zn0, zn1, zn2, zn3   !   -      -
486      !!----------------------------------------------------------------------
487      !
488      IF( nn_timing == 1 )   CALL timing_start('eos2d')
489      !
490      prd(:,:) = 0._wp
491      !
492      SELECT CASE( nn_eos )
493      !
494      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
495         !
496         DO jj = 1, jpjm1
497            DO ji = 1, fs_jpim1   ! vector opt.
498               !
499               zh  = pdep(ji,jj) * r1_Z0                                  ! depth
500               zt  = pts (ji,jj,jp_tem) * r1_T0                           ! temperature
501               zs  = SQRT( ABS( pts(ji,jj,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
502               !
503               zn3 = EOS013*zt   &
504                  &   + EOS103*zs+EOS003
505                  !
506               zn2 = (EOS022*zt   &
507                  &   + EOS112*zs+EOS012)*zt   &
508                  &   + (EOS202*zs+EOS102)*zs+EOS002
509                  !
510               zn1 = (((EOS041*zt   &
511                  &   + EOS131*zs+EOS031)*zt   &
512                  &   + (EOS221*zs+EOS121)*zs+EOS021)*zt   &
513                  &   + ((EOS311*zs+EOS211)*zs+EOS111)*zs+EOS011)*zt   &
514                  &   + (((EOS401*zs+EOS301)*zs+EOS201)*zs+EOS101)*zs+EOS001
515                  !
516               zn0 = (((((EOS060*zt   &
517                  &   + EOS150*zs+EOS050)*zt   &
518                  &   + (EOS240*zs+EOS140)*zs+EOS040)*zt   &
519                  &   + ((EOS330*zs+EOS230)*zs+EOS130)*zs+EOS030)*zt   &
520                  &   + (((EOS420*zs+EOS320)*zs+EOS220)*zs+EOS120)*zs+EOS020)*zt   &
521                  &   + ((((EOS510*zs+EOS410)*zs+EOS310)*zs+EOS210)*zs+EOS110)*zs+EOS010)*zt   &
522                  &   + (((((EOS600*zs+EOS500)*zs+EOS400)*zs+EOS300)*zs+EOS200)*zs+EOS100)*zs+EOS000
523                  !
524               zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
525               !
526               prd(ji,jj) = zn * r1_rau0 - 1._wp               ! unmasked in situ density anomaly
527               !
528            END DO
529         END DO
530         !
531         CALL lbc_lnk( prd, 'T', 1. )                    ! Lateral boundary conditions
532         !
533      CASE( 1 )                !==  simplified EOS  ==!
534         !
535         DO jj = 1, jpjm1
536            DO ji = 1, fs_jpim1   ! vector opt.
537               !
538               zt    = pts  (ji,jj,jp_tem)  - 10._wp
539               zs    = pts  (ji,jj,jp_sal)  - 35._wp
540               zh    = pdep (ji,jj)                         ! depth at the partial step level
541               !
542               zn =  - rn_a0 * ( 1._wp + 0.5_wp*rn_lambda1*zt + rn_mu1*zh ) * zt   &
543                  &  + rn_b0 * ( 1._wp - 0.5_wp*rn_lambda2*zs - rn_mu2*zh ) * zs   &
544                  &  - rn_nu * zt * zs
545                  !
546               prd(ji,jj) = zn * r1_rau0               ! unmasked in situ density anomaly
547               !
548            END DO
549         END DO
550         !
551         CALL lbc_lnk( prd, 'T', 1. )                    ! Lateral boundary conditions
552         !
553      END SELECT
554      !
555      IF(ln_ctl)   CALL prt_ctl( tab2d_1=prd, clinfo1=' eos2d: ' )
556      !
557      IF( nn_timing == 1 )   CALL timing_stop('eos2d')
558      !
559   END SUBROUTINE eos_insitu_2d
560
561
562   SUBROUTINE rab_3d( pts, pab )
563      !!----------------------------------------------------------------------
564      !!                 ***  ROUTINE rab_3d  ***
565      !!
566      !! ** Purpose :   Calculates thermal/haline expansion ratio at T-points
567      !!
568      !! ** Method  :   calculates alpha / beta at T-points
569      !!
570      !! ** Action  : - pab     : thermal/haline expansion ratio at T-points
571      !!----------------------------------------------------------------------
572      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::   pts   ! pot. temperature & salinity
573      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(  out) ::   pab   ! thermal/haline expansion ratio
574      !
575      INTEGER  ::   ji, jj, jk                ! dummy loop indices
576      REAL(wp) ::   zt , zh , zs , ztm        ! local scalars
577      REAL(wp) ::   zn , zn0, zn1, zn2, zn3   !   -      -
578      !!----------------------------------------------------------------------
579      !
580      IF( nn_timing == 1 )   CALL timing_start('rab_3d')
581      !
582      SELECT CASE ( nn_eos )
583      !
584      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
585         !
586         DO jk = 1, jpkm1
587            DO jj = 1, jpj
588               DO ji = 1, jpi
589                  !
590                  zh  = fsdept(ji,jj,jk) * r1_Z0                                ! depth
591                  zt  = pts (ji,jj,jk,jp_tem) * r1_T0                           ! temperature
592                  zs  = SQRT( ABS( pts(ji,jj,jk,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
593                  ztm = tmask(ji,jj,jk)                                         ! tmask
594                  !
595                  ! alpha
596                  zn3 = ALP003
597                  !
598                  zn2 = ALP012*zt + ALP102*zs+ALP002
599                  !
600                  zn1 = ((ALP031*zt   &
601                     &   + ALP121*zs+ALP021)*zt   &
602                     &   + (ALP211*zs+ALP111)*zs+ALP011)*zt   &
603                     &   + ((ALP301*zs+ALP201)*zs+ALP101)*zs+ALP001
604                     !
605                  zn0 = ((((ALP050*zt   &
606                     &   + ALP140*zs+ALP040)*zt   &
607                     &   + (ALP230*zs+ALP130)*zs+ALP030)*zt   &
608                     &   + ((ALP320*zs+ALP220)*zs+ALP120)*zs+ALP020)*zt   &
609                     &   + (((ALP410*zs+ALP310)*zs+ALP210)*zs+ALP110)*zs+ALP010)*zt   &
610                     &   + ((((ALP500*zs+ALP400)*zs+ALP300)*zs+ALP200)*zs+ALP100)*zs+ALP000
611                     !
612                  zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
613                  !
614                  pab(ji,jj,jk,jp_tem) = zn * r1_rau0 * ztm
615                  !
616                  ! beta
617                  zn3 = BET003
618                  !
619                  zn2 = BET012*zt + BET102*zs+BET002
620                  !
621                  zn1 = ((BET031*zt   &
622                     &   + BET121*zs+BET021)*zt   &
623                     &   + (BET211*zs+BET111)*zs+BET011)*zt   &
624                     &   + ((BET301*zs+BET201)*zs+BET101)*zs+BET001
625                     !
626                  zn0 = ((((BET050*zt   &
627                     &   + BET140*zs+BET040)*zt   &
628                     &   + (BET230*zs+BET130)*zs+BET030)*zt   &
629                     &   + ((BET320*zs+BET220)*zs+BET120)*zs+BET020)*zt   &
630                     &   + (((BET410*zs+BET310)*zs+BET210)*zs+BET110)*zs+BET010)*zt   &
631                     &   + ((((BET500*zs+BET400)*zs+BET300)*zs+BET200)*zs+BET100)*zs+BET000
632                     !
633                  zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
634                  !
635                  pab(ji,jj,jk,jp_sal) = zn / zs * r1_rau0 * ztm
636                  !
637               END DO
638            END DO
639         END DO
640         !
641      CASE( 1 )                  !==  simplified EOS  ==!
642         !
643         DO jk = 1, jpkm1
644            DO jj = 1, jpj
645               DO ji = 1, jpi
646                  zt  = pts (ji,jj,jk,jp_tem) - 10._wp   ! pot. temperature anomaly (t-T0)
647                  zs  = pts (ji,jj,jk,jp_sal) - 35._wp   ! abs. salinity anomaly (s-S0)
648                  zh  = fsdept(ji,jj,jk)                 ! depth in meters at t-point
649                  ztm = tmask(ji,jj,jk)                  ! land/sea bottom mask = surf. mask
650                  !
651                  zn  = rn_a0 * ( 1._wp + rn_lambda1*zt + rn_mu1*zh ) + rn_nu*zs
652                  pab(ji,jj,jk,jp_tem) = zn * r1_rau0 * ztm   ! alpha
653                  !
654                  zn  = rn_b0 * ( 1._wp - rn_lambda2*zs - rn_mu2*zh ) - rn_nu*zt
655                  pab(ji,jj,jk,jp_sal) = zn * r1_rau0 * ztm   ! beta
656                  !
657               END DO
658            END DO
659         END DO
660         !
661      CASE DEFAULT
662         IF(lwp) WRITE(numout,cform_err)
663         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
664         nstop = nstop + 1
665         !
666      END SELECT
667      !
668      IF(ln_ctl)   CALL prt_ctl( tab3d_1=pab(:,:,:,jp_tem), clinfo1=' rab_3d_t: ', &
669         &                       tab3d_2=pab(:,:,:,jp_sal), clinfo2=' rab_3d_s : ', ovlap=1, kdim=jpk )
670      !
671      IF( nn_timing == 1 )   CALL timing_stop('rab_3d')
672      !
673   END SUBROUTINE rab_3d
674
675   SUBROUTINE rab_2d( pts, pdep, pab )
676      !!----------------------------------------------------------------------
677      !!                 ***  ROUTINE rab_2d  ***
678      !!
679      !! ** Purpose :   Calculates thermal/haline expansion ratio for a 2d field (unmasked)
680      !!
681      !! ** Action  : - pab     : thermal/haline expansion ratio at T-points
682      !!----------------------------------------------------------------------
683      REAL(wp), DIMENSION(jpi,jpj,jpts)    , INTENT(in   ) ::   pts    ! pot. temperature & salinity
684      REAL(wp), DIMENSION(jpi,jpj)         , INTENT(in   ) ::   pdep   ! depth                  [m]
685      REAL(wp), DIMENSION(jpi,jpj,jpts)    , INTENT(  out) ::   pab    ! thermal/haline expansion ratio
686      !
687      INTEGER  ::   ji, jj, jk                ! dummy loop indices
688      REAL(wp) ::   zt , zh , zs              ! local scalars
689      REAL(wp) ::   zn , zn0, zn1, zn2, zn3   !   -      -
690      !!----------------------------------------------------------------------
691      !
692      IF( nn_timing == 1 ) CALL timing_start('rab_2d')
693      !
694      pab(:,:,:) = 0._wp
695      !
696      SELECT CASE ( nn_eos )
697      !
698      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
699         !
700         DO jj = 1, jpjm1
701            DO ji = 1, fs_jpim1   ! vector opt.
702               !
703               zh  = pdep(ji,jj) * r1_Z0                                  ! depth
704               zt  = pts (ji,jj,jp_tem) * r1_T0                           ! temperature
705               zs  = SQRT( ABS( pts(ji,jj,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
706               !
707               ! alpha
708               zn3 = ALP003
709               !
710               zn2 = ALP012*zt + ALP102*zs+ALP002
711               !
712               zn1 = ((ALP031*zt   &
713                  &   + ALP121*zs+ALP021)*zt   &
714                  &   + (ALP211*zs+ALP111)*zs+ALP011)*zt   &
715                  &   + ((ALP301*zs+ALP201)*zs+ALP101)*zs+ALP001
716                  !
717               zn0 = ((((ALP050*zt   &
718                  &   + ALP140*zs+ALP040)*zt   &
719                  &   + (ALP230*zs+ALP130)*zs+ALP030)*zt   &
720                  &   + ((ALP320*zs+ALP220)*zs+ALP120)*zs+ALP020)*zt   &
721                  &   + (((ALP410*zs+ALP310)*zs+ALP210)*zs+ALP110)*zs+ALP010)*zt   &
722                  &   + ((((ALP500*zs+ALP400)*zs+ALP300)*zs+ALP200)*zs+ALP100)*zs+ALP000
723                  !
724               zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
725               !
726               pab(ji,jj,jp_tem) = zn * r1_rau0
727               !
728               ! beta
729               zn3 = BET003
730               !
731               zn2 = BET012*zt + BET102*zs+BET002
732               !
733               zn1 = ((BET031*zt   &
734                  &   + BET121*zs+BET021)*zt   &
735                  &   + (BET211*zs+BET111)*zs+BET011)*zt   &
736                  &   + ((BET301*zs+BET201)*zs+BET101)*zs+BET001
737                  !
738               zn0 = ((((BET050*zt   &
739                  &   + BET140*zs+BET040)*zt   &
740                  &   + (BET230*zs+BET130)*zs+BET030)*zt   &
741                  &   + ((BET320*zs+BET220)*zs+BET120)*zs+BET020)*zt   &
742                  &   + (((BET410*zs+BET310)*zs+BET210)*zs+BET110)*zs+BET010)*zt   &
743                  &   + ((((BET500*zs+BET400)*zs+BET300)*zs+BET200)*zs+BET100)*zs+BET000
744                  !
745               zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
746               !
747               pab(ji,jj,jp_sal) = zn / zs * r1_rau0
748               !
749               !
750            END DO
751         END DO
752         !
753         CALL lbc_lnk( pab(:,:,jp_tem), 'T', 1. )                    ! Lateral boundary conditions
754         CALL lbc_lnk( pab(:,:,jp_sal), 'T', 1. )                   
755         !
756      CASE( 1 )                  !==  simplified EOS  ==!
757         !
758         DO jj = 1, jpjm1
759            DO ji = 1, fs_jpim1   ! vector opt.
760               !
761               zt    = pts  (ji,jj,jp_tem) - 10._wp   ! pot. temperature anomaly (t-T0)
762               zs    = pts  (ji,jj,jp_sal) - 35._wp   ! abs. salinity anomaly (s-S0)
763               zh    = pdep (ji,jj)                   ! depth at the partial step level
764               !
765               zn  = rn_a0 * ( 1._wp + rn_lambda1*zt + rn_mu1*zh ) + rn_nu*zs
766               pab(ji,jj,jp_tem) = zn * r1_rau0   ! alpha
767               !
768               zn  = rn_b0 * ( 1._wp - rn_lambda2*zs - rn_mu2*zh ) - rn_nu*zt
769               pab(ji,jj,jp_sal) = zn * r1_rau0   ! beta
770               !
771            END DO
772         END DO
773         !
774         CALL lbc_lnk( pab(:,:,jp_tem), 'T', 1. )                    ! Lateral boundary conditions
775         CALL lbc_lnk( pab(:,:,jp_sal), 'T', 1. )                   
776         !
777      CASE DEFAULT
778         IF(lwp) WRITE(numout,cform_err)
779         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
780         nstop = nstop + 1
781         !
782      END SELECT
783      !
784      IF(ln_ctl)   CALL prt_ctl( tab2d_1=pab(:,:,jp_tem), clinfo1=' rab_2d_t: ', &
785         &                       tab2d_2=pab(:,:,jp_sal), clinfo2=' rab_2d_s : ' )
786      !
787      IF( nn_timing == 1 )   CALL timing_stop('rab_2d')
788      !
789   END SUBROUTINE rab_2d
790
791
792   SUBROUTINE rab_0d( pts, pdep, pab )
793      !!----------------------------------------------------------------------
794      !!                 ***  ROUTINE rab_0d  ***
795      !!
796      !! ** Purpose :   Calculates thermal/haline expansion ratio for a 2d field (unmasked)
797      !!
798      !! ** Action  : - pab     : thermal/haline expansion ratio at T-points
799      !!----------------------------------------------------------------------
800      REAL(wp), DIMENSION(jpts)    , INTENT(in   ) ::   pts    ! pot. temperature & salinity
801      REAL(wp),                      INTENT(in   ) ::   pdep   ! depth                  [m]
802      REAL(wp), DIMENSION(jpts)    , INTENT(  out) ::   pab    ! thermal/haline expansion ratio
803      !
804      REAL(wp) ::   zt , zh , zs              ! local scalars
805      REAL(wp) ::   zn , zn0, zn1, zn2, zn3   !   -      -
806      !!----------------------------------------------------------------------
807      !
808      IF( nn_timing == 1 ) CALL timing_start('rab_2d')
809      !
810      pab(:) = 0._wp
811      !
812      SELECT CASE ( nn_eos )
813      !
814      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
815         !
816         !
817         zh  = pdep * r1_Z0                                  ! depth
818         zt  = pts (jp_tem) * r1_T0                           ! temperature
819         zs  = SQRT( ABS( pts(jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
820         !
821         ! alpha
822         zn3 = ALP003
823         !
824         zn2 = ALP012*zt + ALP102*zs+ALP002
825         !
826         zn1 = ((ALP031*zt   &
827            &   + ALP121*zs+ALP021)*zt   &
828            &   + (ALP211*zs+ALP111)*zs+ALP011)*zt   &
829            &   + ((ALP301*zs+ALP201)*zs+ALP101)*zs+ALP001
830            !
831         zn0 = ((((ALP050*zt   &
832            &   + ALP140*zs+ALP040)*zt   &
833            &   + (ALP230*zs+ALP130)*zs+ALP030)*zt   &
834            &   + ((ALP320*zs+ALP220)*zs+ALP120)*zs+ALP020)*zt   &
835            &   + (((ALP410*zs+ALP310)*zs+ALP210)*zs+ALP110)*zs+ALP010)*zt   &
836            &   + ((((ALP500*zs+ALP400)*zs+ALP300)*zs+ALP200)*zs+ALP100)*zs+ALP000
837            !
838         zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
839         !
840         pab(jp_tem) = zn * r1_rau0
841         !
842         ! beta
843         zn3 = BET003
844         !
845         zn2 = BET012*zt + BET102*zs+BET002
846         !
847         zn1 = ((BET031*zt   &
848            &   + BET121*zs+BET021)*zt   &
849            &   + (BET211*zs+BET111)*zs+BET011)*zt   &
850            &   + ((BET301*zs+BET201)*zs+BET101)*zs+BET001
851            !
852         zn0 = ((((BET050*zt   &
853            &   + BET140*zs+BET040)*zt   &
854            &   + (BET230*zs+BET130)*zs+BET030)*zt   &
855            &   + ((BET320*zs+BET220)*zs+BET120)*zs+BET020)*zt   &
856            &   + (((BET410*zs+BET310)*zs+BET210)*zs+BET110)*zs+BET010)*zt   &
857            &   + ((((BET500*zs+BET400)*zs+BET300)*zs+BET200)*zs+BET100)*zs+BET000
858            !
859         zn  = ( ( zn3 * zh + zn2 ) * zh + zn1 ) * zh + zn0
860         !
861         pab(jp_sal) = zn / zs * r1_rau0
862         !
863         !
864         !
865      CASE( 1 )                  !==  simplified EOS  ==!
866         !
867         zt    = pts(jp_tem) - 10._wp   ! pot. temperature anomaly (t-T0)
868         zs    = pts(jp_sal) - 35._wp   ! abs. salinity anomaly (s-S0)
869         zh    = pdep                    ! depth at the partial step level
870         !
871         zn  = rn_a0 * ( 1._wp + rn_lambda1*zt + rn_mu1*zh ) + rn_nu*zs
872         pab(jp_tem) = zn * r1_rau0   ! alpha
873         !
874         zn  = rn_b0 * ( 1._wp - rn_lambda2*zs - rn_mu2*zh ) - rn_nu*zt
875         pab(jp_sal) = zn * r1_rau0   ! beta
876         !
877      CASE DEFAULT
878         IF(lwp) WRITE(numout,cform_err)
879         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
880         nstop = nstop + 1
881         !
882      END SELECT
883      !
884      IF( nn_timing == 1 )   CALL timing_stop('rab_2d')
885      !
886   END SUBROUTINE rab_0d
887
888
889   SUBROUTINE bn2( pts, pab, pn2 )
890      !!----------------------------------------------------------------------
891      !!                  ***  ROUTINE bn2  ***
892      !!
893      !! ** Purpose :   Compute the local Brunt-Vaisala frequency at the
894      !!                time-step of the input arguments
895      !!
896      !! ** Method  :   pn2 = grav * (alpha dk[T] + beta dk[S] ) / e3w
897      !!      where alpha and beta are given in pab, and computed on T-points.
898      !!      N.B. N^2 is set one for all to zero at jk=1 in istate module.
899      !!
900      !! ** Action  :   pn2 : square of the brunt-vaisala frequency at w-point
901      !!
902      !!----------------------------------------------------------------------
903      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::  pts   ! pot. temperature and salinity   [Celcius,psu]
904      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::  pab   ! thermal/haline expansion coef.  [Celcius-1,psu-1]
905      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(  out) ::  pn2   ! Brunt-Vaisala frequency squared [1/s^2]
906      !
907      INTEGER  ::   ji, jj, jk      ! dummy loop indices
908      REAL(wp) ::   zaw, zbw, zrw   ! local scalars
909      !!----------------------------------------------------------------------
910      !
911      IF( nn_timing == 1 ) CALL timing_start('bn2')
912      !
913      DO jk = 2, jpkm1           ! interior points only (2=< jk =< jpkm1 )
914         DO jj = 1, jpj          ! surface and bottom value set to zero one for all in istate.F90
915            DO ji = 1, jpi
916               zrw =   ( fsdepw(ji,jj,jk  ) - fsdept(ji,jj,jk) )   &
917                  &  / ( fsdept(ji,jj,jk-1) - fsdept(ji,jj,jk) ) 
918                  !
919               zaw = pab(ji,jj,jk,jp_tem) * (1. - zrw) + pab(ji,jj,jk-1,jp_tem) * zrw 
920               zbw = pab(ji,jj,jk,jp_sal) * (1. - zrw) + pab(ji,jj,jk-1,jp_sal) * zrw
921               !
922               pn2(ji,jj,jk) = grav * (  zaw * ( pts(ji,jj,jk-1,jp_tem) - pts(ji,jj,jk,jp_tem) )     &
923                  &                    - zbw * ( pts(ji,jj,jk-1,jp_sal) - pts(ji,jj,jk,jp_sal) )  )  &
924                  &            / fse3w(ji,jj,jk) * tmask(ji,jj,jk)
925            END DO
926         END DO
927      END DO
928      !
929      IF(ln_ctl)   CALL prt_ctl( tab3d_1=pn2, clinfo1=' bn2  : ', ovlap=1, kdim=jpk )
930      !
931      IF( nn_timing == 1 )   CALL timing_stop('bn2')
932      !
933   END SUBROUTINE bn2
934
935
936   FUNCTION eos_pt_from_ct( ctmp, psal ) RESULT( ptmp )
937      !!----------------------------------------------------------------------
938      !!                 ***  ROUTINE eos_pt_from_ct  ***
939      !!
940      !! ** Purpose :   Compute pot.temp. from cons. temp. [Celcius]
941      !!
942      !! ** Method  :   rational approximation (5/3th order) of TEOS-10 algorithm
943      !!       checkvalue: pt=20.02391895 Celsius for sa=35.7g/kg, ct=20degC
944      !!
945      !! Reference  :   TEOS-10, UNESCO
946      !!                Rational approximation to TEOS10 algorithm (rms error on WOA13 values: 4.0e-5 degC)
947      !!----------------------------------------------------------------------
948      REAL(wp), DIMENSION(jpi,jpj), INTENT(in   ) ::   ctmp   ! Cons. Temp [Celcius]
949      REAL(wp), DIMENSION(jpi,jpj), INTENT(in   ) ::   psal   ! salinity   [psu]
950      ! Leave result array automatic rather than making explicitly allocated
951      REAL(wp), DIMENSION(jpi,jpj) ::   ptmp   ! potential temperature [Celcius]
952      !
953      INTEGER  ::   ji, jj               ! dummy loop indices
954      REAL(wp) ::   zt , zs , ztm        ! local scalars
955      REAL(wp) ::   zn , zd              ! local scalars
956      REAL(wp) ::   zdeltaS , z1_S0 , z1_T0
957      !!----------------------------------------------------------------------
958      !
959      IF ( nn_timing == 1 )   CALL timing_start('eos_pt_from_ct')
960      !
961      zdeltaS = 5._wp
962      z1_S0   = 0.875_wp/35.16504_wp
963      z1_T0   = 1._wp/40._wp
964      !
965      DO jj = 1, jpj
966         DO ji = 1, jpi
967            !
968            zt  = ctmp   (ji,jj) * z1_T0
969            zs  = SQRT( ABS( psal(ji,jj) + zdeltaS ) * r1_S0 )
970            ztm = tmask(ji,jj,1)
971            !
972            zn = ((((-2.1385727895e-01_wp*zt   &
973               &   - 2.7674419971e-01_wp*zs+1.0728094330_wp)*zt   &
974               &   + (2.6366564313_wp*zs+3.3546960647_wp)*zs-7.8012209473_wp)*zt   &
975               &   + ((1.8835586562_wp*zs+7.3949191679_wp)*zs-3.3937395875_wp)*zs-5.6414948432_wp)*zt   &
976               &   + (((3.5737370589_wp*zs-1.5512427389e+01_wp)*zs+2.4625741105e+01_wp)*zs   &
977               &      +1.9912291000e+01_wp)*zs-3.2191146312e+01_wp)*zt   &
978               &   + ((((5.7153204649e-01_wp*zs-3.0943149543_wp)*zs+9.3052495181_wp)*zs   &
979               &      -9.4528934807_wp)*zs+3.1066408996_wp)*zs-4.3504021262e-01_wp
980               !
981            zd = (2.0035003456_wp*zt   &
982               &   -3.4570358592e-01_wp*zs+5.6471810638_wp)*zt   &
983               &   + (1.5393993508_wp*zs-6.9394762624_wp)*zs+1.2750522650e+01_wp
984               !
985            ptmp(ji,jj) = ( zt / z1_T0 + zn / zd ) * ztm
986               !
987         END DO
988      END DO
989      !
990      IF( nn_timing == 1 )   CALL timing_stop('eos_pt_from_ct')
991      !
992   END FUNCTION eos_pt_from_ct
993
994
995   FUNCTION eos_fzp_2d( psal, pdep ) RESULT( ptf )
996      !!----------------------------------------------------------------------
997      !!                 ***  ROUTINE eos_fzp  ***
998      !!
999      !! ** Purpose :   Compute the freezing point temperature [Celcius]
1000      !!
1001      !! ** Method  :   UNESCO freezing point (ptf) in Celcius is given by
1002      !!       ptf(t,z) = (-.0575+1.710523e-3*sqrt(abs(s))-2.154996e-4*s)*s - 7.53e-4*z
1003      !!       checkvalue: tf=-2.588567 Celsius for s=40psu, z=500m
1004      !!
1005      !! Reference  :   UNESCO tech. papers in the marine science no. 28. 1978
1006      !!----------------------------------------------------------------------
1007      REAL(wp), DIMENSION(jpi,jpj), INTENT(in   )           ::   psal   ! salinity   [psu]
1008      REAL(wp), DIMENSION(jpi,jpj), INTENT(in   ), OPTIONAL ::   pdep   ! depth      [m]
1009      REAL(wp), DIMENSION(jpi,jpj)                          ::   ptf   ! freezing temperature [Celcius]
1010      !
1011      INTEGER  ::   ji, jj   ! dummy loop indices
1012      REAL(wp) ::   zt, zs   ! local scalars
1013      !!----------------------------------------------------------------------
1014      !
1015      SELECT CASE ( nn_eos )
1016      !
1017      CASE ( -1, 1 )                !==  CT,SA (TEOS-10 formulation) ==!
1018         !
1019         DO jj = 1, jpj
1020            DO ji = 1, jpi
1021               zs= SQRT( ABS( psal(ji,jj) ) * r1_S0 )           ! square root salinity
1022               ptf(ji,jj) = ((((1.46873e-03_wp*zs-9.64972e-03_wp)*zs+2.28348e-02_wp)*zs &
1023                  &          - 3.12775e-02_wp)*zs+2.07679e-02_wp)*zs-5.87701e-02_wp
1024            END DO
1025         END DO
1026         ptf(:,:) = ptf(:,:) * psal(:,:)
1027         !
1028         IF( PRESENT( pdep ) )   ptf(:,:) = ptf(:,:) - 7.53e-4 * pdep(:,:)
1029         !
1030      CASE ( 0 )                     !==  PT,SP (UNESCO formulation)  ==!
1031         !
1032         ptf(:,:) = ( - 0.0575_wp + 1.710523e-3_wp * SQRT( psal(:,:) )   &
1033            &                     - 2.154996e-4_wp *       psal(:,:)   ) * psal(:,:)
1034            !
1035         IF( PRESENT( pdep ) )   ptf(:,:) = ptf(:,:) - 7.53e-4 * pdep(:,:)
1036         !
1037      CASE DEFAULT
1038         IF(lwp) WRITE(numout,cform_err)
1039         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
1040         nstop = nstop + 1
1041         !
1042      END SELECT
1043      !
1044   END FUNCTION eos_fzp_2d
1045
1046  FUNCTION eos_fzp_0d( psal, pdep ) RESULT( ptf )
1047      !!----------------------------------------------------------------------
1048      !!                 ***  ROUTINE eos_fzp  ***
1049      !!
1050      !! ** Purpose :   Compute the freezing point temperature [Celcius]
1051      !!
1052      !! ** Method  :   UNESCO freezing point (ptf) in Celcius is given by
1053      !!       ptf(t,z) = (-.0575+1.710523e-3*sqrt(abs(s))-2.154996e-4*s)*s - 7.53e-4*z
1054      !!       checkvalue: tf=-2.588567 Celsius for s=40psu, z=500m
1055      !!
1056      !! Reference  :   UNESCO tech. papers in the marine science no. 28. 1978
1057      !!----------------------------------------------------------------------
1058      REAL(wp), INTENT(in)           ::   psal   ! salinity   [psu]
1059      REAL(wp), INTENT(in), OPTIONAL ::   pdep   ! depth      [m]
1060      REAL(wp)                       ::   ptf   ! freezing temperature [Celcius]
1061      !
1062      REAL(wp) :: zs   ! local scalars
1063      !!----------------------------------------------------------------------
1064      !
1065      SELECT CASE ( nn_eos )
1066      !
1067      CASE ( -1, 1 )                !==  CT,SA (TEOS-10 formulation) ==!
1068         !
1069         zs  = SQRT( ABS( psal ) * r1_S0 )           ! square root salinity
1070         ptf = ((((1.46873e-03_wp*zs-9.64972e-03_wp)*zs+2.28348e-02_wp)*zs &
1071                  &          - 3.12775e-02_wp)*zs+2.07679e-02_wp)*zs-5.87701e-02_wp
1072         ptf = ptf * psal
1073         !
1074         IF( PRESENT( pdep ) )   ptf = ptf - 7.53e-4 * pdep
1075         !
1076      CASE ( 0 )                     !==  PT,SP (UNESCO formulation)  ==!
1077         !
1078         ptf = ( - 0.0575_wp + 1.710523e-3_wp * SQRT( psal )   &
1079            &                - 2.154996e-4_wp *       psal   ) * psal
1080            !
1081         IF( PRESENT( pdep ) )   ptf = ptf - 7.53e-4 * pdep
1082         !
1083      CASE DEFAULT
1084         IF(lwp) WRITE(numout,cform_err)
1085         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
1086         nstop = nstop + 1
1087         !
1088      END SELECT
1089      !
1090   END FUNCTION eos_fzp_0d
1091
1092
1093   SUBROUTINE eos_pen( pts, pab_pe, ppen )
1094      !!----------------------------------------------------------------------
1095      !!                 ***  ROUTINE eos_pen  ***
1096      !!
1097      !! ** Purpose :   Calculates nonlinear anomalies of alpha_PE, beta_PE and PE at T-points
1098      !!
1099      !! ** Method  :   PE is defined analytically as the vertical
1100      !!                   primitive of EOS times -g integrated between 0 and z>0.
1101      !!                pen is the nonlinear bsq-PE anomaly: pen = ( PE - rau0 gz ) / rau0 gz - rd
1102      !!                                                      = 1/z * /int_0^z rd dz - rd
1103      !!                                where rd is the density anomaly (see eos_rhd function)
1104      !!                ab_pe are partial derivatives of PE anomaly with respect to T and S:
1105      !!                    ab_pe(1) = - 1/(rau0 gz) * dPE/dT + drd/dT = - d(pen)/dT
1106      !!                    ab_pe(2) =   1/(rau0 gz) * dPE/dS + drd/dS =   d(pen)/dS
1107      !!
1108      !! ** Action  : - pen         : PE anomaly given at T-points
1109      !!            : - pab_pe  : given at T-points
1110      !!                    pab_pe(:,:,:,jp_tem) is alpha_pe
1111      !!                    pab_pe(:,:,:,jp_sal) is beta_pe
1112      !!----------------------------------------------------------------------
1113      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(in   ) ::   pts     ! pot. temperature & salinity
1114      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(  out) ::   pab_pe  ! alpha_pe and beta_pe
1115      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(  out) ::   ppen     ! potential energy anomaly
1116      !
1117      INTEGER  ::   ji, jj, jk                ! dummy loop indices
1118      REAL(wp) ::   zt , zh , zs , ztm        ! local scalars
1119      REAL(wp) ::   zn , zn0, zn1, zn2        !   -      -
1120      !!----------------------------------------------------------------------
1121      !
1122      IF( nn_timing == 1 )   CALL timing_start('eos_pen')
1123      !
1124      SELECT CASE ( nn_eos )
1125      !
1126      CASE( -1, 0 )                !==  polynomial TEOS-10 / EOS-80 ==!
1127         !
1128         DO jk = 1, jpkm1
1129            DO jj = 1, jpj
1130               DO ji = 1, jpi
1131                  !
1132                  zh  = fsdept(ji,jj,jk) * r1_Z0                                ! depth
1133                  zt  = pts (ji,jj,jk,jp_tem) * r1_T0                           ! temperature
1134                  zs  = SQRT( ABS( pts(ji,jj,jk,jp_sal) + rdeltaS ) * r1_S0 )   ! square root salinity
1135                  ztm = tmask(ji,jj,jk)                                         ! tmask
1136                  !
1137                  ! potential energy non-linear anomaly
1138                  zn2 = (PEN012)*zt   &
1139                     &   + PEN102*zs+PEN002
1140                     !
1141                  zn1 = ((PEN021)*zt   &
1142                     &   + PEN111*zs+PEN011)*zt   &
1143                     &   + (PEN201*zs+PEN101)*zs+PEN001
1144                     !
1145                  zn0 = ((((PEN040)*zt   &
1146                     &   + PEN130*zs+PEN030)*zt   &
1147                     &   + (PEN220*zs+PEN120)*zs+PEN020)*zt   &
1148                     &   + ((PEN310*zs+PEN210)*zs+PEN110)*zs+PEN010)*zt   &
1149                     &   + (((PEN400*zs+PEN300)*zs+PEN200)*zs+PEN100)*zs+PEN000
1150                     !
1151                  zn  = ( zn2 * zh + zn1 ) * zh + zn0
1152                  !
1153                  ppen(ji,jj,jk)  = zn * zh * r1_rau0 * ztm
1154                  !
1155                  ! alphaPE non-linear anomaly
1156                  zn2 = APE002
1157                  !
1158                  zn1 = (APE011)*zt   &
1159                     &   + APE101*zs+APE001
1160                     !
1161                  zn0 = (((APE030)*zt   &
1162                     &   + APE120*zs+APE020)*zt   &
1163                     &   + (APE210*zs+APE110)*zs+APE010)*zt   &
1164                     &   + ((APE300*zs+APE200)*zs+APE100)*zs+APE000
1165                     !
1166                  zn  = ( zn2 * zh + zn1 ) * zh + zn0
1167                  !                             
1168                  pab_pe(ji,jj,jk,jp_tem) = zn * zh * r1_rau0 * ztm
1169                  !
1170                  ! betaPE non-linear anomaly
1171                  zn2 = BPE002
1172                  !
1173                  zn1 = (BPE011)*zt   &
1174                     &   + BPE101*zs+BPE001
1175                     !
1176                  zn0 = (((BPE030)*zt   &
1177                     &   + BPE120*zs+BPE020)*zt   &
1178                     &   + (BPE210*zs+BPE110)*zs+BPE010)*zt   &
1179                     &   + ((BPE300*zs+BPE200)*zs+BPE100)*zs+BPE000
1180                     !
1181                  zn  = ( zn2 * zh + zn1 ) * zh + zn0
1182                  !                             
1183                  pab_pe(ji,jj,jk,jp_sal) = zn / zs * zh * r1_rau0 * ztm
1184                  !
1185               END DO
1186            END DO
1187         END DO
1188         !
1189      CASE( 1 )                !==  Vallis (2006) simplified EOS  ==!
1190         !
1191         DO jk = 1, jpkm1
1192            DO jj = 1, jpj
1193               DO ji = 1, jpi
1194                  zt  = pts(ji,jj,jk,jp_tem) - 10._wp  ! temperature anomaly (t-T0)
1195                  zs = pts (ji,jj,jk,jp_sal) - 35._wp  ! abs. salinity anomaly (s-S0)
1196                  zh  = fsdept(ji,jj,jk)               ! depth in meters  at t-point
1197                  ztm = tmask(ji,jj,jk)                ! tmask
1198                  zn  = 0.5_wp * zh * r1_rau0 * ztm
1199                  !                                    ! Potential Energy
1200                  ppen(ji,jj,jk) = ( rn_a0 * rn_mu1 * zt + rn_b0 * rn_mu2 * zs ) * zn
1201                  !                                    ! alphaPE
1202                  pab_pe(ji,jj,jk,jp_tem) = - rn_a0 * rn_mu1 * zn
1203                  pab_pe(ji,jj,jk,jp_sal) =   rn_b0 * rn_mu2 * zn
1204                  !
1205               END DO
1206            END DO
1207         END DO
1208         !
1209      CASE DEFAULT
1210         IF(lwp) WRITE(numout,cform_err)
1211         IF(lwp) WRITE(numout,*) '          bad flag value for nn_eos = ', nn_eos
1212         nstop = nstop + 1
1213         !
1214      END SELECT
1215      !
1216      IF( nn_timing == 1 )   CALL timing_stop('eos_pen')
1217      !
1218   END SUBROUTINE eos_pen
1219
1220
1221   SUBROUTINE eos_init
1222      !!----------------------------------------------------------------------
1223      !!                 ***  ROUTINE eos_init  ***
1224      !!
1225      !! ** Purpose :   initializations for the equation of state
1226      !!
1227      !! ** Method  :   Read the namelist nameos and control the parameters
1228      !!----------------------------------------------------------------------
1229      INTEGER  ::   ios   ! local integer
1230      !!
1231      NAMELIST/nameos/ nn_eos, ln_useCT, rn_a0, rn_b0, rn_lambda1, rn_mu1,   &
1232         &                                             rn_lambda2, rn_mu2, rn_nu
1233      !!----------------------------------------------------------------------
1234      !
1235      REWIND( numnam_ref )              ! Namelist nameos in reference namelist : equation of state
1236      READ  ( numnam_ref, nameos, IOSTAT = ios, ERR = 901 )
1237901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nameos in reference namelist', lwp )
1238      !
1239      REWIND( numnam_cfg )              ! Namelist nameos in configuration namelist : equation of state
1240      READ  ( numnam_cfg, nameos, IOSTAT = ios, ERR = 902 )
1241902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'nameos in configuration namelist', lwp )
1242      IF(lwm) WRITE( numond, nameos )
1243      !
1244      rau0        = 1026._wp                 !: volumic mass of reference     [kg/m3]
1245      rcp         = 3991.86795711963_wp      !: heat capacity     [J/K]
1246      !
1247      IF(lwp) THEN                ! Control print
1248         WRITE(numout,*)
1249         WRITE(numout,*) 'eos_init : equation of state'
1250         WRITE(numout,*) '~~~~~~~~'
1251         WRITE(numout,*) '          Namelist nameos : set eos parameters'
1252         WRITE(numout,*) '             flag for eq. of state and N^2  nn_eos   = ', nn_eos
1253         IF( ln_useCT )   THEN
1254            WRITE(numout,*) '             model uses Conservative Temperature'
1255            WRITE(numout,*) '             Important: model must be initialized with CT and SA fields'
1256         ELSE
1257            WRITE(numout,*) '             model does not use Conservative Temperature'
1258         ENDIF
1259      ENDIF
1260      !
1261      SELECT CASE( nn_eos )         ! check option
1262      !
1263      CASE( -1 )                       !==  polynomial TEOS-10  ==!
1264         IF(lwp) WRITE(numout,*)
1265         IF(lwp) WRITE(numout,*) '          use of TEOS-10 equation of state (cons. temp. and abs. salinity)'
1266         !
1267         rdeltaS = 32._wp
1268         r1_S0  = 0.875_wp/35.16504_wp
1269         r1_T0  = 1._wp/40._wp
1270         r1_Z0  = 1.e-4_wp
1271         !
1272         EOS000 = 8.0189615746e+02_wp
1273         EOS100 = 8.6672408165e+02_wp
1274         EOS200 = -1.7864682637e+03_wp
1275         EOS300 = 2.0375295546e+03_wp
1276         EOS400 = -1.2849161071e+03_wp
1277         EOS500 = 4.3227585684e+02_wp
1278         EOS600 = -6.0579916612e+01_wp
1279         EOS010 = 2.6010145068e+01_wp
1280         EOS110 = -6.5281885265e+01_wp
1281         EOS210 = 8.1770425108e+01_wp
1282         EOS310 = -5.6888046321e+01_wp
1283         EOS410 = 1.7681814114e+01_wp
1284         EOS510 = -1.9193502195_wp
1285         EOS020 = -3.7074170417e+01_wp
1286         EOS120 = 6.1548258127e+01_wp
1287         EOS220 = -6.0362551501e+01_wp
1288         EOS320 = 2.9130021253e+01_wp
1289         EOS420 = -5.4723692739_wp
1290         EOS030 = 2.1661789529e+01_wp
1291         EOS130 = -3.3449108469e+01_wp
1292         EOS230 = 1.9717078466e+01_wp
1293         EOS330 = -3.1742946532_wp
1294         EOS040 = -8.3627885467_wp
1295         EOS140 = 1.1311538584e+01_wp
1296         EOS240 = -5.3563304045_wp
1297         EOS050 = 5.4048723791e-01_wp
1298         EOS150 = 4.8169980163e-01_wp
1299         EOS060 = -1.9083568888e-01_wp
1300         EOS001 = 1.9681925209e+01_wp
1301         EOS101 = -4.2549998214e+01_wp
1302         EOS201 = 5.0774768218e+01_wp
1303         EOS301 = -3.0938076334e+01_wp
1304         EOS401 = 6.6051753097_wp
1305         EOS011 = -1.3336301113e+01_wp
1306         EOS111 = -4.4870114575_wp
1307         EOS211 = 5.0042598061_wp
1308         EOS311 = -6.5399043664e-01_wp
1309         EOS021 = 6.7080479603_wp
1310         EOS121 = 3.5063081279_wp
1311         EOS221 = -1.8795372996_wp
1312         EOS031 = -2.4649669534_wp
1313         EOS131 = -5.5077101279e-01_wp
1314         EOS041 = 5.5927935970e-01_wp
1315         EOS002 = 2.0660924175_wp
1316         EOS102 = -4.9527603989_wp
1317         EOS202 = 2.5019633244_wp
1318         EOS012 = 2.0564311499_wp
1319         EOS112 = -2.1311365518e-01_wp
1320         EOS022 = -1.2419983026_wp
1321         EOS003 = -2.3342758797e-02_wp
1322         EOS103 = -1.8507636718e-02_wp
1323         EOS013 = 3.7969820455e-01_wp
1324         !
1325         ALP000 = -6.5025362670e-01_wp
1326         ALP100 = 1.6320471316_wp
1327         ALP200 = -2.0442606277_wp
1328         ALP300 = 1.4222011580_wp
1329         ALP400 = -4.4204535284e-01_wp
1330         ALP500 = 4.7983755487e-02_wp
1331         ALP010 = 1.8537085209_wp
1332         ALP110 = -3.0774129064_wp
1333         ALP210 = 3.0181275751_wp
1334         ALP310 = -1.4565010626_wp
1335         ALP410 = 2.7361846370e-01_wp
1336         ALP020 = -1.6246342147_wp
1337         ALP120 = 2.5086831352_wp
1338         ALP220 = -1.4787808849_wp
1339         ALP320 = 2.3807209899e-01_wp
1340         ALP030 = 8.3627885467e-01_wp
1341         ALP130 = -1.1311538584_wp
1342         ALP230 = 5.3563304045e-01_wp
1343         ALP040 = -6.7560904739e-02_wp
1344         ALP140 = -6.0212475204e-02_wp
1345         ALP050 = 2.8625353333e-02_wp
1346         ALP001 = 3.3340752782e-01_wp
1347         ALP101 = 1.1217528644e-01_wp
1348         ALP201 = -1.2510649515e-01_wp
1349         ALP301 = 1.6349760916e-02_wp
1350         ALP011 = -3.3540239802e-01_wp
1351         ALP111 = -1.7531540640e-01_wp
1352         ALP211 = 9.3976864981e-02_wp
1353         ALP021 = 1.8487252150e-01_wp
1354         ALP121 = 4.1307825959e-02_wp
1355         ALP031 = -5.5927935970e-02_wp
1356         ALP002 = -5.1410778748e-02_wp
1357         ALP102 = 5.3278413794e-03_wp
1358         ALP012 = 6.2099915132e-02_wp
1359         ALP003 = -9.4924551138e-03_wp
1360         !
1361         BET000 = 1.0783203594e+01_wp
1362         BET100 = -4.4452095908e+01_wp
1363         BET200 = 7.6048755820e+01_wp
1364         BET300 = -6.3944280668e+01_wp
1365         BET400 = 2.6890441098e+01_wp
1366         BET500 = -4.5221697773_wp
1367         BET010 = -8.1219372432e-01_wp
1368         BET110 = 2.0346663041_wp
1369         BET210 = -2.1232895170_wp
1370         BET310 = 8.7994140485e-01_wp
1371         BET410 = -1.1939638360e-01_wp
1372         BET020 = 7.6574242289e-01_wp
1373         BET120 = -1.5019813020_wp
1374         BET220 = 1.0872489522_wp
1375         BET320 = -2.7233429080e-01_wp
1376         BET030 = -4.1615152308e-01_wp
1377         BET130 = 4.9061350869e-01_wp
1378         BET230 = -1.1847737788e-01_wp
1379         BET040 = 1.4073062708e-01_wp
1380         BET140 = -1.3327978879e-01_wp
1381         BET050 = 5.9929880134e-03_wp
1382         BET001 = -5.2937873009e-01_wp
1383         BET101 = 1.2634116779_wp
1384         BET201 = -1.1547328025_wp
1385         BET301 = 3.2870876279e-01_wp
1386         BET011 = -5.5824407214e-02_wp
1387         BET111 = 1.2451933313e-01_wp
1388         BET211 = -2.4409539932e-02_wp
1389         BET021 = 4.3623149752e-02_wp
1390         BET121 = -4.6767901790e-02_wp
1391         BET031 = -6.8523260060e-03_wp
1392         BET002 = -6.1618945251e-02_wp
1393         BET102 = 6.2255521644e-02_wp
1394         BET012 = -2.6514181169e-03_wp
1395         BET003 = -2.3025968587e-04_wp
1396         !
1397         PEN000 = -9.8409626043_wp
1398         PEN100 = 2.1274999107e+01_wp
1399         PEN200 = -2.5387384109e+01_wp
1400         PEN300 = 1.5469038167e+01_wp
1401         PEN400 = -3.3025876549_wp
1402         PEN010 = 6.6681505563_wp
1403         PEN110 = 2.2435057288_wp
1404         PEN210 = -2.5021299030_wp
1405         PEN310 = 3.2699521832e-01_wp
1406         PEN020 = -3.3540239802_wp
1407         PEN120 = -1.7531540640_wp
1408         PEN220 = 9.3976864981e-01_wp
1409         PEN030 = 1.2324834767_wp
1410         PEN130 = 2.7538550639e-01_wp
1411         PEN040 = -2.7963967985e-01_wp
1412         PEN001 = -1.3773949450_wp
1413         PEN101 = 3.3018402659_wp
1414         PEN201 = -1.6679755496_wp
1415         PEN011 = -1.3709540999_wp
1416         PEN111 = 1.4207577012e-01_wp
1417         PEN021 = 8.2799886843e-01_wp
1418         PEN002 = 1.7507069098e-02_wp
1419         PEN102 = 1.3880727538e-02_wp
1420         PEN012 = -2.8477365341e-01_wp
1421         !
1422         APE000 = -1.6670376391e-01_wp
1423         APE100 = -5.6087643219e-02_wp
1424         APE200 = 6.2553247576e-02_wp
1425         APE300 = -8.1748804580e-03_wp
1426         APE010 = 1.6770119901e-01_wp
1427         APE110 = 8.7657703198e-02_wp
1428         APE210 = -4.6988432490e-02_wp
1429         APE020 = -9.2436260751e-02_wp
1430         APE120 = -2.0653912979e-02_wp
1431         APE030 = 2.7963967985e-02_wp
1432         APE001 = 3.4273852498e-02_wp
1433         APE101 = -3.5518942529e-03_wp
1434         APE011 = -4.1399943421e-02_wp
1435         APE002 = 7.1193413354e-03_wp
1436         !
1437         BPE000 = 2.6468936504e-01_wp
1438         BPE100 = -6.3170583896e-01_wp
1439         BPE200 = 5.7736640125e-01_wp
1440         BPE300 = -1.6435438140e-01_wp
1441         BPE010 = 2.7912203607e-02_wp
1442         BPE110 = -6.2259666565e-02_wp
1443         BPE210 = 1.2204769966e-02_wp
1444         BPE020 = -2.1811574876e-02_wp
1445         BPE120 = 2.3383950895e-02_wp
1446         BPE030 = 3.4261630030e-03_wp
1447         BPE001 = 4.1079296834e-02_wp
1448         BPE101 = -4.1503681096e-02_wp
1449         BPE011 = 1.7676120780e-03_wp
1450         BPE002 = 1.7269476440e-04_wp
1451         !
1452      CASE( 0 )                        !==  polynomial EOS-80 formulation  ==!
1453         !
1454         IF(lwp) WRITE(numout,*)
1455         IF(lwp) WRITE(numout,*) '          use of EOS-80 equation of state (pot. temp. and pract. salinity)'
1456         !
1457         rdeltaS = 20._wp
1458         r1_S0  = 1._wp/40._wp
1459         r1_T0  = 1._wp/40._wp
1460         r1_Z0  = 1.e-4_wp
1461         !
1462         EOS000 = 9.5356891948e+02_wp
1463         EOS100 = 1.7136499189e+02_wp
1464         EOS200 = -3.7501039454e+02_wp
1465         EOS300 = 5.1856810420e+02_wp
1466         EOS400 = -3.7264470465e+02_wp
1467         EOS500 = 1.4302533998e+02_wp
1468         EOS600 = -2.2856621162e+01_wp
1469         EOS010 = 1.0087518651e+01_wp
1470         EOS110 = -1.3647741861e+01_wp
1471         EOS210 = 8.8478359933_wp
1472         EOS310 = -7.2329388377_wp
1473         EOS410 = 1.4774410611_wp
1474         EOS510 = 2.0036720553e-01_wp
1475         EOS020 = -2.5579830599e+01_wp
1476         EOS120 = 2.4043512327e+01_wp
1477         EOS220 = -1.6807503990e+01_wp
1478         EOS320 = 8.3811577084_wp
1479         EOS420 = -1.9771060192_wp
1480         EOS030 = 1.6846451198e+01_wp
1481         EOS130 = -2.1482926901e+01_wp
1482         EOS230 = 1.0108954054e+01_wp
1483         EOS330 = -6.2675951440e-01_wp
1484         EOS040 = -8.0812310102_wp
1485         EOS140 = 1.0102374985e+01_wp
1486         EOS240 = -4.8340368631_wp
1487         EOS050 = 1.2079167803_wp
1488         EOS150 = 1.1515380987e-01_wp
1489         EOS060 = -2.4520288837e-01_wp
1490         EOS001 = 1.0748601068e+01_wp
1491         EOS101 = -1.7817043500e+01_wp
1492         EOS201 = 2.2181366768e+01_wp
1493         EOS301 = -1.6750916338e+01_wp
1494         EOS401 = 4.1202230403_wp
1495         EOS011 = -1.5852644587e+01_wp
1496         EOS111 = -7.6639383522e-01_wp
1497         EOS211 = 4.1144627302_wp
1498         EOS311 = -6.6955877448e-01_wp
1499         EOS021 = 9.9994861860_wp
1500         EOS121 = -1.9467067787e-01_wp
1501         EOS221 = -1.2177554330_wp
1502         EOS031 = -3.4866102017_wp
1503         EOS131 = 2.2229155620e-01_wp
1504         EOS041 = 5.9503008642e-01_wp
1505         EOS002 = 1.0375676547_wp
1506         EOS102 = -3.4249470629_wp
1507         EOS202 = 2.0542026429_wp
1508         EOS012 = 2.1836324814_wp
1509         EOS112 = -3.4453674320e-01_wp
1510         EOS022 = -1.2548163097_wp
1511         EOS003 = 1.8729078427e-02_wp
1512         EOS103 = -5.7238495240e-02_wp
1513         EOS013 = 3.8306136687e-01_wp
1514         !
1515         ALP000 = -2.5218796628e-01_wp
1516         ALP100 = 3.4119354654e-01_wp
1517         ALP200 = -2.2119589983e-01_wp
1518         ALP300 = 1.8082347094e-01_wp
1519         ALP400 = -3.6936026529e-02_wp
1520         ALP500 = -5.0091801383e-03_wp
1521         ALP010 = 1.2789915300_wp
1522         ALP110 = -1.2021756164_wp
1523         ALP210 = 8.4037519952e-01_wp
1524         ALP310 = -4.1905788542e-01_wp
1525         ALP410 = 9.8855300959e-02_wp
1526         ALP020 = -1.2634838399_wp
1527         ALP120 = 1.6112195176_wp
1528         ALP220 = -7.5817155402e-01_wp
1529         ALP320 = 4.7006963580e-02_wp
1530         ALP030 = 8.0812310102e-01_wp
1531         ALP130 = -1.0102374985_wp
1532         ALP230 = 4.8340368631e-01_wp
1533         ALP040 = -1.5098959754e-01_wp
1534         ALP140 = -1.4394226233e-02_wp
1535         ALP050 = 3.6780433255e-02_wp
1536         ALP001 = 3.9631611467e-01_wp
1537         ALP101 = 1.9159845880e-02_wp
1538         ALP201 = -1.0286156825e-01_wp
1539         ALP301 = 1.6738969362e-02_wp
1540         ALP011 = -4.9997430930e-01_wp
1541         ALP111 = 9.7335338937e-03_wp
1542         ALP211 = 6.0887771651e-02_wp
1543         ALP021 = 2.6149576513e-01_wp
1544         ALP121 = -1.6671866715e-02_wp
1545         ALP031 = -5.9503008642e-02_wp
1546         ALP002 = -5.4590812035e-02_wp
1547         ALP102 = 8.6134185799e-03_wp
1548         ALP012 = 6.2740815484e-02_wp
1549         ALP003 = -9.5765341718e-03_wp
1550         !
1551         BET000 = 2.1420623987_wp
1552         BET100 = -9.3752598635_wp
1553         BET200 = 1.9446303907e+01_wp
1554         BET300 = -1.8632235232e+01_wp
1555         BET400 = 8.9390837485_wp
1556         BET500 = -1.7142465871_wp
1557         BET010 = -1.7059677327e-01_wp
1558         BET110 = 2.2119589983e-01_wp
1559         BET210 = -2.7123520642e-01_wp
1560         BET310 = 7.3872053057e-02_wp
1561         BET410 = 1.2522950346e-02_wp
1562         BET020 = 3.0054390409e-01_wp
1563         BET120 = -4.2018759976e-01_wp
1564         BET220 = 3.1429341406e-01_wp
1565         BET320 = -9.8855300959e-02_wp
1566         BET030 = -2.6853658626e-01_wp
1567         BET130 = 2.5272385134e-01_wp
1568         BET230 = -2.3503481790e-02_wp
1569         BET040 = 1.2627968731e-01_wp
1570         BET140 = -1.2085092158e-01_wp
1571         BET050 = 1.4394226233e-03_wp
1572         BET001 = -2.2271304375e-01_wp
1573         BET101 = 5.5453416919e-01_wp
1574         BET201 = -6.2815936268e-01_wp
1575         BET301 = 2.0601115202e-01_wp
1576         BET011 = -9.5799229402e-03_wp
1577         BET111 = 1.0286156825e-01_wp
1578         BET211 = -2.5108454043e-02_wp
1579         BET021 = -2.4333834734e-03_wp
1580         BET121 = -3.0443885826e-02_wp
1581         BET031 = 2.7786444526e-03_wp
1582         BET002 = -4.2811838287e-02_wp
1583         BET102 = 5.1355066072e-02_wp
1584         BET012 = -4.3067092900e-03_wp
1585         BET003 = -7.1548119050e-04_wp
1586         !
1587         PEN000 = -5.3743005340_wp
1588         PEN100 = 8.9085217499_wp
1589         PEN200 = -1.1090683384e+01_wp
1590         PEN300 = 8.3754581690_wp
1591         PEN400 = -2.0601115202_wp
1592         PEN010 = 7.9263222935_wp
1593         PEN110 = 3.8319691761e-01_wp
1594         PEN210 = -2.0572313651_wp
1595         PEN310 = 3.3477938724e-01_wp
1596         PEN020 = -4.9997430930_wp
1597         PEN120 = 9.7335338937e-02_wp
1598         PEN220 = 6.0887771651e-01_wp
1599         PEN030 = 1.7433051009_wp
1600         PEN130 = -1.1114577810e-01_wp
1601         PEN040 = -2.9751504321e-01_wp
1602         PEN001 = -6.9171176978e-01_wp
1603         PEN101 = 2.2832980419_wp
1604         PEN201 = -1.3694684286_wp
1605         PEN011 = -1.4557549876_wp
1606         PEN111 = 2.2969116213e-01_wp
1607         PEN021 = 8.3654420645e-01_wp
1608         PEN002 = -1.4046808820e-02_wp
1609         PEN102 = 4.2928871430e-02_wp
1610         PEN012 = -2.8729602515e-01_wp
1611         !
1612         APE000 = -1.9815805734e-01_wp
1613         APE100 = -9.5799229402e-03_wp
1614         APE200 = 5.1430784127e-02_wp
1615         APE300 = -8.3694846809e-03_wp
1616         APE010 = 2.4998715465e-01_wp
1617         APE110 = -4.8667669469e-03_wp
1618         APE210 = -3.0443885826e-02_wp
1619         APE020 = -1.3074788257e-01_wp
1620         APE120 = 8.3359333577e-03_wp
1621         APE030 = 2.9751504321e-02_wp
1622         APE001 = 3.6393874690e-02_wp
1623         APE101 = -5.7422790533e-03_wp
1624         APE011 = -4.1827210323e-02_wp
1625         APE002 = 7.1824006288e-03_wp
1626         !
1627         BPE000 = 1.1135652187e-01_wp
1628         BPE100 = -2.7726708459e-01_wp
1629         BPE200 = 3.1407968134e-01_wp
1630         BPE300 = -1.0300557601e-01_wp
1631         BPE010 = 4.7899614701e-03_wp
1632         BPE110 = -5.1430784127e-02_wp
1633         BPE210 = 1.2554227021e-02_wp
1634         BPE020 = 1.2166917367e-03_wp
1635         BPE120 = 1.5221942913e-02_wp
1636         BPE030 = -1.3893222263e-03_wp
1637         BPE001 = 2.8541225524e-02_wp
1638         BPE101 = -3.4236710714e-02_wp
1639         BPE011 = 2.8711395266e-03_wp
1640         BPE002 = 5.3661089288e-04_wp
1641         !
1642      CASE( 1 )                        !==  Simplified EOS     ==!
1643         IF(lwp) THEN
1644            WRITE(numout,*)
1645            WRITE(numout,*) '          use of simplified eos:    rhd(dT=T-10,dS=S-35,Z) = '
1646            WRITE(numout,*) '             [-a0*(1+lambda1/2*dT+mu1*Z)*dT + b0*(1+lambda2/2*dT+mu2*Z)*dS - nu*dT*dS]/rau0'
1647            WRITE(numout,*)
1648            WRITE(numout,*) '             thermal exp. coef.    rn_a0      = ', rn_a0
1649            WRITE(numout,*) '             saline  cont. coef.   rn_b0      = ', rn_b0
1650            WRITE(numout,*) '             cabbeling coef.       rn_lambda1 = ', rn_lambda1
1651            WRITE(numout,*) '             cabbeling coef.       rn_lambda2 = ', rn_lambda2
1652            WRITE(numout,*) '             thermobar. coef.      rn_mu1     = ', rn_mu1
1653            WRITE(numout,*) '             thermobar. coef.      rn_mu2     = ', rn_mu2
1654            WRITE(numout,*) '             2nd cabbel. coef.     rn_nu      = ', rn_nu
1655            WRITE(numout,*) '               Caution: rn_beta0=0 incompatible with ddm parameterization '
1656         ENDIF
1657         !
1658      CASE DEFAULT                     !==  ERROR in nn_eos  ==!
1659         WRITE(ctmp1,*) '          bad flag value for nn_eos = ', nn_eos
1660         CALL ctl_stop( ctmp1 )
1661         !
1662      END SELECT
1663      !
1664      rau0_rcp    = rau0 * rcp 
1665      r1_rau0     = 1._wp / rau0
1666      r1_rcp      = 1._wp / rcp
1667      r1_rau0_rcp = 1._wp / rau0_rcp 
1668      !
1669      IF(lwp) WRITE(numout,*)
1670      IF(lwp) WRITE(numout,*) '          volumic mass of reference           rau0  = ', rau0   , ' kg/m^3'
1671      IF(lwp) WRITE(numout,*) '          1. / rau0                        r1_rau0  = ', r1_rau0, ' m^3/kg'
1672      IF(lwp) WRITE(numout,*) '          ocean specific heat                 rcp   = ', rcp    , ' J/Kelvin'
1673      IF(lwp) WRITE(numout,*) '          rau0 * rcp                       rau0_rcp = ', rau0_rcp
1674      IF(lwp) WRITE(numout,*) '          1. / ( rau0 * rcp )           r1_rau0_rcp = ', r1_rau0_rcp
1675      !
1676   END SUBROUTINE eos_init
1677
1678   !!======================================================================
1679END MODULE eosbn2
Note: See TracBrowser for help on using the repository browser.