[358] | 1 | MODULE dynspg |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE dynspg *** |
---|
| 4 | !! Ocean dynamics: surface pressure gradient control |
---|
| 5 | !!====================================================================== |
---|
[1566] | 6 | !! History : 1.0 ! 2005-12 (C. Talandier, G. Madec, V. Garnier) Original code |
---|
| 7 | !! 3.2 ! 2009-07 (R. Benshila) Suppression of rigid-lid option |
---|
[503] | 8 | !!---------------------------------------------------------------------- |
---|
[358] | 9 | |
---|
| 10 | !!---------------------------------------------------------------------- |
---|
[5930] | 11 | !! dyn_spg : update the dynamics trend with surface pressure gradient |
---|
| 12 | !! dyn_spg_init: initialization, namelist read, and parameters control |
---|
[358] | 13 | !!---------------------------------------------------------------------- |
---|
| 14 | USE oce ! ocean dynamics and tracers variables |
---|
| 15 | USE dom_oce ! ocean space and time domain variables |
---|
[4245] | 16 | USE c1d ! 1D vertical configuration |
---|
[2715] | 17 | USE phycst ! physical constants |
---|
[2528] | 18 | USE sbc_oce ! surface boundary condition: ocean |
---|
| 19 | USE sbcapr ! surface boundary condition: atmospheric pressure |
---|
[358] | 20 | USE dynspg_exp ! surface pressure gradient (dyn_spg_exp routine) |
---|
| 21 | USE dynspg_ts ! surface pressure gradient (dyn_spg_ts routine) |
---|
[6140] | 22 | USE sbctide ! |
---|
| 23 | USE updtide ! |
---|
[4990] | 24 | USE trd_oce ! trends: ocean variables |
---|
| 25 | USE trddyn ! trend manager: dynamics |
---|
| 26 | ! |
---|
[358] | 27 | USE prtctl ! Print control (prt_ctl routine) |
---|
| 28 | USE in_out_manager ! I/O manager |
---|
[2715] | 29 | USE lib_mpp ! MPP library |
---|
[4990] | 30 | USE wrk_nemo ! Memory Allocation |
---|
| 31 | USE timing ! Timing |
---|
[358] | 32 | |
---|
| 33 | IMPLICIT NONE |
---|
| 34 | PRIVATE |
---|
| 35 | |
---|
[2528] | 36 | PUBLIC dyn_spg ! routine called by step module |
---|
| 37 | PUBLIC dyn_spg_init ! routine called by opa module |
---|
[358] | 38 | |
---|
[6140] | 39 | INTEGER :: nspg = 0 ! type of surface pressure gradient scheme defined from lk_dynspg_... |
---|
[358] | 40 | |
---|
[6140] | 41 | ! ! Parameter to control the surface pressure gradient scheme |
---|
| 42 | INTEGER, PARAMETER :: np_TS = 1 ! split-explicit time stepping (Time-Splitting) |
---|
| 43 | INTEGER, PARAMETER :: np_EXP = 0 ! explicit time stepping |
---|
| 44 | INTEGER, PARAMETER :: np_NO =-1 ! no surface pressure gradient, no scheme |
---|
| 45 | |
---|
[358] | 46 | !! * Substitutions |
---|
| 47 | # include "vectopt_loop_substitute.h90" |
---|
| 48 | !!---------------------------------------------------------------------- |
---|
[1566] | 49 | !! NEMO/OPA 3.2 , LODYC-IPSL (2009) |
---|
[1152] | 50 | !! $Id$ |
---|
[2715] | 51 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[358] | 52 | !!---------------------------------------------------------------------- |
---|
| 53 | CONTAINS |
---|
| 54 | |
---|
[5930] | 55 | SUBROUTINE dyn_spg( kt ) |
---|
[358] | 56 | !!---------------------------------------------------------------------- |
---|
| 57 | !! *** ROUTINE dyn_spg *** |
---|
| 58 | !! |
---|
[6140] | 59 | !! ** Purpose : compute surface pressure gradient including the |
---|
| 60 | !! atmospheric pressure forcing (ln_apr_dyn=T). |
---|
[1566] | 61 | !! |
---|
[5930] | 62 | !! ** Method : Two schemes: |
---|
[6140] | 63 | !! - explicit : the spg is evaluated at now |
---|
| 64 | !! - split-explicit : a time splitting technique is used |
---|
[1566] | 65 | !! |
---|
[2528] | 66 | !! ln_apr_dyn=T : the atmospheric pressure forcing is applied |
---|
| 67 | !! as the gradient of the inverse barometer ssh: |
---|
| 68 | !! apgu = - 1/rau0 di[apr] = 0.5*grav di[ssh_ib+ssh_ibb] |
---|
| 69 | !! apgv = - 1/rau0 dj[apr] = 0.5*grav dj[ssh_ib+ssh_ibb] |
---|
| 70 | !! Note that as all external forcing a time averaging over a two rdt |
---|
| 71 | !! period is used to prevent the divergence of odd and even time step. |
---|
[358] | 72 | !!---------------------------------------------------------------------- |
---|
[1566] | 73 | INTEGER, INTENT(in ) :: kt ! ocean time-step index |
---|
[2715] | 74 | ! |
---|
[2528] | 75 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
[3625] | 76 | REAL(wp) :: z2dt, zg_2, zintp, zgrau0r ! temporary scalar |
---|
[3294] | 77 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdu, ztrdv |
---|
[3625] | 78 | REAL(wp), POINTER, DIMENSION(:,:) :: zpice |
---|
[358] | 79 | !!---------------------------------------------------------------------- |
---|
[3294] | 80 | ! |
---|
| 81 | IF( nn_timing == 1 ) CALL timing_start('dyn_spg') |
---|
| 82 | ! |
---|
[358] | 83 | IF( l_trddyn ) THEN ! temporary save of ta and sa trends |
---|
[6140] | 84 | CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv ) |
---|
[7753] | 85 | ztrdu(:,:,:) = ua(:,:,:) |
---|
| 86 | ztrdv(:,:,:) = va(:,:,:) |
---|
[358] | 87 | ENDIF |
---|
[6140] | 88 | ! |
---|
[4292] | 89 | IF( ln_apr_dyn & ! atmos. pressure |
---|
[7646] | 90 | .OR. ( .NOT.ln_dynspg_ts .AND. (ln_tide_pot .AND. ln_tide) ) & ! tide potential (no time slitting) |
---|
[4292] | 91 | .OR. nn_ice_embd == 2 ) THEN ! embedded sea-ice |
---|
| 92 | ! |
---|
| 93 | DO jj = 2, jpjm1 |
---|
[2528] | 94 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[4292] | 95 | spgu(ji,jj) = 0._wp |
---|
| 96 | spgv(ji,jj) = 0._wp |
---|
[2528] | 97 | END DO |
---|
[4292] | 98 | END DO |
---|
| 99 | ! |
---|
[6140] | 100 | IF( ln_apr_dyn .AND. .NOT.ln_dynspg_ts ) THEN !== Atmospheric pressure gradient (added later in time-split case) ==! |
---|
[4292] | 101 | zg_2 = grav * 0.5 |
---|
| 102 | DO jj = 2, jpjm1 ! gradient of Patm using inverse barometer ssh |
---|
[2528] | 103 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[4292] | 104 | spgu(ji,jj) = spgu(ji,jj) + zg_2 * ( ssh_ib (ji+1,jj) - ssh_ib (ji,jj) & |
---|
[5836] | 105 | & + ssh_ibb(ji+1,jj) - ssh_ibb(ji,jj) ) * r1_e1u(ji,jj) |
---|
[4292] | 106 | spgv(ji,jj) = spgv(ji,jj) + zg_2 * ( ssh_ib (ji,jj+1) - ssh_ib (ji,jj) & |
---|
[5836] | 107 | & + ssh_ibb(ji,jj+1) - ssh_ibb(ji,jj) ) * r1_e2v(ji,jj) |
---|
[2528] | 108 | END DO |
---|
| 109 | END DO |
---|
[4292] | 110 | ENDIF |
---|
| 111 | ! |
---|
| 112 | ! !== tide potential forcing term ==! |
---|
[7646] | 113 | IF( .NOT.ln_dynspg_ts .AND. ( ln_tide_pot .AND. ln_tide ) ) THEN ! N.B. added directly at sub-time-step in ts-case |
---|
[4292] | 114 | ! |
---|
| 115 | CALL upd_tide( kt ) ! update tide potential |
---|
| 116 | ! |
---|
| 117 | DO jj = 2, jpjm1 ! add tide potential forcing |
---|
| 118 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[5836] | 119 | spgu(ji,jj) = spgu(ji,jj) + grav * ( pot_astro(ji+1,jj) - pot_astro(ji,jj) ) * r1_e1u(ji,jj) |
---|
| 120 | spgv(ji,jj) = spgv(ji,jj) + grav * ( pot_astro(ji,jj+1) - pot_astro(ji,jj) ) * r1_e2v(ji,jj) |
---|
[4292] | 121 | END DO |
---|
[3625] | 122 | END DO |
---|
[4292] | 123 | ENDIF |
---|
| 124 | ! |
---|
| 125 | IF( nn_ice_embd == 2 ) THEN !== embedded sea ice: Pressure gradient due to snow-ice mass ==! |
---|
[6140] | 126 | CALL wrk_alloc( jpi,jpj, zpice ) |
---|
[4292] | 127 | ! |
---|
| 128 | zintp = REAL( MOD( kt-1, nn_fsbc ) ) / REAL( nn_fsbc ) |
---|
| 129 | zgrau0r = - grav * r1_rau0 |
---|
[7753] | 130 | zpice(:,:) = ( zintp * snwice_mass(:,:) + ( 1.- zintp ) * snwice_mass_b(:,:) ) * zgrau0r |
---|
[3625] | 131 | DO jj = 2, jpjm1 |
---|
| 132 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[5836] | 133 | spgu(ji,jj) = spgu(ji,jj) + ( zpice(ji+1,jj) - zpice(ji,jj) ) * r1_e1u(ji,jj) |
---|
| 134 | spgv(ji,jj) = spgv(ji,jj) + ( zpice(ji,jj+1) - zpice(ji,jj) ) * r1_e2v(ji,jj) |
---|
[4292] | 135 | END DO |
---|
| 136 | END DO |
---|
| 137 | ! |
---|
[6140] | 138 | CALL wrk_dealloc( jpi,jpj, zpice ) |
---|
[4292] | 139 | ENDIF |
---|
| 140 | ! |
---|
[6140] | 141 | DO jk = 1, jpkm1 !== Add all terms to the general trend |
---|
[4292] | 142 | DO jj = 2, jpjm1 |
---|
| 143 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[3625] | 144 | ua(ji,jj,jk) = ua(ji,jj,jk) + spgu(ji,jj) |
---|
| 145 | va(ji,jj,jk) = va(ji,jj,jk) + spgv(ji,jj) |
---|
| 146 | END DO |
---|
| 147 | END DO |
---|
[4990] | 148 | END DO |
---|
[6140] | 149 | ! |
---|
[4990] | 150 | !!gm add here a call to dyn_trd for ice pressure gradient, the surf pressure trends ???? |
---|
[6140] | 151 | ! |
---|
[3625] | 152 | ENDIF |
---|
[6140] | 153 | ! |
---|
| 154 | SELECT CASE ( nspg ) !== surface pressure gradient computed and add to the general trend ==! |
---|
| 155 | CASE ( np_EXP ) ; CALL dyn_spg_exp( kt ) ! explicit |
---|
| 156 | CASE ( np_TS ) ; CALL dyn_spg_ts ( kt ) ! time-splitting |
---|
[358] | 157 | END SELECT |
---|
[503] | 158 | ! |
---|
[6140] | 159 | IF( l_trddyn ) THEN ! save the surface pressure gradient trends for further diagnostics |
---|
[7753] | 160 | ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:) |
---|
| 161 | ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:) |
---|
[4990] | 162 | CALL trd_dyn( ztrdu, ztrdv, jpdyn_spg, kt ) |
---|
[6140] | 163 | CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv ) |
---|
[358] | 164 | ENDIF |
---|
[6140] | 165 | ! ! print mean trends (used for debugging) |
---|
[358] | 166 | IF(ln_ctl) CALL prt_ctl( tab3d_1=ua, clinfo1=' spg - Ua: ', mask1=umask, & |
---|
| 167 | & tab3d_2=va, clinfo2= ' Va: ', mask2=vmask, clinfo3='dyn' ) |
---|
[503] | 168 | ! |
---|
[3294] | 169 | IF( nn_timing == 1 ) CALL timing_stop('dyn_spg') |
---|
[2715] | 170 | ! |
---|
[358] | 171 | END SUBROUTINE dyn_spg |
---|
| 172 | |
---|
| 173 | |
---|
[2528] | 174 | SUBROUTINE dyn_spg_init |
---|
[358] | 175 | !!--------------------------------------------------------------------- |
---|
[2528] | 176 | !! *** ROUTINE dyn_spg_init *** |
---|
[358] | 177 | !! |
---|
[5930] | 178 | !! ** Purpose : Control the consistency between namelist options for |
---|
[1566] | 179 | !! surface pressure gradient schemes |
---|
[358] | 180 | !!---------------------------------------------------------------------- |
---|
[6140] | 181 | INTEGER :: ioptio, ios ! local integers |
---|
[5930] | 182 | ! |
---|
[6140] | 183 | NAMELIST/namdyn_spg/ ln_dynspg_exp , ln_dynspg_ts, & |
---|
| 184 | & ln_bt_fw, ln_bt_av , ln_bt_auto , & |
---|
| 185 | & nn_baro , rn_bt_cmax, nn_bt_flt |
---|
[358] | 186 | !!---------------------------------------------------------------------- |
---|
[3294] | 187 | ! |
---|
| 188 | IF( nn_timing == 1 ) CALL timing_start('dyn_spg_init') |
---|
| 189 | ! |
---|
[5930] | 190 | REWIND( numnam_ref ) ! Namelist namdyn_spg in reference namelist : Free surface |
---|
| 191 | READ ( numnam_ref, namdyn_spg, IOSTAT = ios, ERR = 901) |
---|
[6140] | 192 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_spg in reference namelist', lwp ) |
---|
| 193 | ! |
---|
[5930] | 194 | REWIND( numnam_cfg ) ! Namelist namdyn_spg in configuration namelist : Free surface |
---|
| 195 | READ ( numnam_cfg, namdyn_spg, IOSTAT = ios, ERR = 902 ) |
---|
[6140] | 196 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_spg in configuration namelist', lwp ) |
---|
[5930] | 197 | IF(lwm) WRITE ( numond, namdyn_spg ) |
---|
| 198 | ! |
---|
| 199 | IF(lwp) THEN ! Namelist print |
---|
[358] | 200 | WRITE(numout,*) |
---|
[2528] | 201 | WRITE(numout,*) 'dyn_spg_init : choice of the surface pressure gradient scheme' |
---|
[358] | 202 | WRITE(numout,*) '~~~~~~~~~~~' |
---|
[5930] | 203 | WRITE(numout,*) ' Explicit free surface ln_dynspg_exp = ', ln_dynspg_exp |
---|
| 204 | WRITE(numout,*) ' Free surface with time splitting ln_dynspg_ts = ', ln_dynspg_ts |
---|
[358] | 205 | ENDIF |
---|
[6140] | 206 | ! ! Control of surface pressure gradient scheme options |
---|
[6981] | 207 | nspg = np_NO ; ioptio = 0 |
---|
[6140] | 208 | IF( ln_dynspg_exp ) THEN ; nspg = np_EXP ; ioptio = ioptio + 1 ; ENDIF |
---|
| 209 | IF( ln_dynspg_ts ) THEN ; nspg = np_TS ; ioptio = ioptio + 1 ; ENDIF |
---|
[1566] | 210 | ! |
---|
[6140] | 211 | IF( ioptio > 1 ) CALL ctl_stop( 'Choose only one surface pressure gradient scheme' ) |
---|
| 212 | IF( ioptio == 0 ) CALL ctl_warn( 'NO surface pressure gradient trend in momentum Eqs.' ) |
---|
| 213 | IF( ln_dynspg_exp .AND. ln_isfcav ) & |
---|
| 214 | & CALL ctl_stop( ' dynspg_exp not tested with ice shelf cavity ' ) |
---|
[1566] | 215 | ! |
---|
| 216 | IF(lwp) THEN |
---|
[358] | 217 | WRITE(numout,*) |
---|
[7646] | 218 | IF( nspg == np_EXP ) WRITE(numout,*) ' ===>> explicit free surface' |
---|
| 219 | IF( nspg == np_TS ) WRITE(numout,*) ' ===>> free surface with time splitting scheme' |
---|
| 220 | IF( nspg == np_NO ) WRITE(numout,*) ' ===>> No surface surface pressure gradient trend in momentum Eqs.' |
---|
[358] | 221 | ENDIF |
---|
[1566] | 222 | ! |
---|
[6140] | 223 | IF( nspg == np_TS ) THEN ! split-explicit scheme initialisation |
---|
| 224 | CALL dyn_spg_ts_init ! do it first: set nn_baro used to allocate some arrays later on |
---|
| 225 | IF( dyn_spg_ts_alloc() /= 0 ) CALL ctl_stop('STOP', 'dyn_spg_init: failed to allocate dynspg_ts arrays' ) |
---|
| 226 | IF( neuler/=0 .AND. ln_bt_fw ) CALL ts_rst( nit000, 'READ' ) |
---|
| 227 | ENDIF |
---|
| 228 | ! |
---|
[3294] | 229 | IF( nn_timing == 1 ) CALL timing_stop('dyn_spg_init') |
---|
| 230 | ! |
---|
[2528] | 231 | END SUBROUTINE dyn_spg_init |
---|
[358] | 232 | |
---|
| 233 | !!====================================================================== |
---|
| 234 | END MODULE dynspg |
---|