[4619] | 1 | MODULE trdpen |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE trdpen *** |
---|
| 4 | !! Ocean diagnostics: Potential Energy trends |
---|
| 5 | !!===================================================================== |
---|
| 6 | !! History : 3.5 ! 2012-02 (G. Madec) original code |
---|
| 7 | !!---------------------------------------------------------------------- |
---|
| 8 | |
---|
| 9 | !!---------------------------------------------------------------------- |
---|
| 10 | !! trd_pen : compute and output Potential Energy trends from T & S trends |
---|
| 11 | !! trd_pen_init : initialisation of PE trends |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
| 13 | USE oce ! ocean dynamics and tracers variables |
---|
| 14 | USE dom_oce ! ocean domain |
---|
| 15 | USE sbc_oce ! surface boundary condition: ocean |
---|
| 16 | USE zdf_oce ! ocean vertical physics |
---|
| 17 | USE trd_oce ! trends: ocean variables |
---|
| 18 | USE eosbn2 ! equation of state and related derivatives |
---|
[5836] | 19 | USE ldftra ! lateral diffusion: eddy diffusivity & EIV coeff. |
---|
[4619] | 20 | USE zdfddm ! vertical physics: double diffusion |
---|
| 21 | USE phycst ! physical constants |
---|
[5836] | 22 | ! |
---|
[4619] | 23 | USE in_out_manager ! I/O manager |
---|
| 24 | USE iom ! I/O manager library |
---|
| 25 | USE lib_mpp ! MPP library |
---|
| 26 | |
---|
| 27 | IMPLICIT NONE |
---|
| 28 | PRIVATE |
---|
| 29 | |
---|
| 30 | PUBLIC trd_pen ! called by all trdtra module |
---|
| 31 | PUBLIC trd_pen_init ! called by all nemogcm module |
---|
| 32 | |
---|
| 33 | INTEGER :: nkstp ! current time step |
---|
| 34 | |
---|
| 35 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: rab_pe ! partial derivatives of PE anomaly with respect to T and S |
---|
| 36 | |
---|
| 37 | !! * Substitutions |
---|
| 38 | # include "vectopt_loop_substitute.h90" |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
[9598] | 40 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[5215] | 41 | !! $Id$ |
---|
[10068] | 42 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[4619] | 43 | !!---------------------------------------------------------------------- |
---|
| 44 | CONTAINS |
---|
| 45 | |
---|
| 46 | INTEGER FUNCTION trd_pen_alloc() |
---|
| 47 | !!--------------------------------------------------------------------- |
---|
| 48 | !! *** FUNCTION trd_tra_alloc *** |
---|
| 49 | !!--------------------------------------------------------------------- |
---|
| 50 | ALLOCATE( rab_pe(jpi,jpj,jpk,jpts) , STAT= trd_pen_alloc ) |
---|
| 51 | ! |
---|
[10425] | 52 | CALL mpp_sum ( 'trdpen', trd_pen_alloc ) |
---|
| 53 | IF( trd_pen_alloc /= 0 ) CALL ctl_stop( 'STOP', 'trd_pen_alloc: failed to allocate arrays' ) |
---|
[4619] | 54 | END FUNCTION trd_pen_alloc |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | SUBROUTINE trd_pen( ptrdx, ptrdy, ktrd, kt, pdt ) |
---|
| 58 | !!--------------------------------------------------------------------- |
---|
| 59 | !! *** ROUTINE trd_tra_mng *** |
---|
| 60 | !! |
---|
| 61 | !! ** Purpose : Dispatch all trends computation, e.g. 3D output, integral |
---|
| 62 | !! constraints, barotropic vorticity, kinetic enrgy, |
---|
| 63 | !! potential energy, and/or mixed layer budget. |
---|
| 64 | !!---------------------------------------------------------------------- |
---|
| 65 | REAL(wp), DIMENSION(:,:,:), INTENT(in) :: ptrdx, ptrdy ! Temperature & Salinity trends |
---|
| 66 | INTEGER , INTENT(in) :: ktrd ! tracer trend index |
---|
| 67 | INTEGER , INTENT(in) :: kt ! time step index |
---|
| 68 | REAL(wp) , INTENT(in) :: pdt ! time step [s] |
---|
| 69 | ! |
---|
| 70 | INTEGER :: jk ! dummy loop indices |
---|
[9125] | 71 | REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: z2d ! 2D workspace |
---|
| 72 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zpe ! 3D workspace |
---|
[4619] | 73 | !!---------------------------------------------------------------------- |
---|
| 74 | ! |
---|
| 75 | zpe(:,:,:) = 0._wp |
---|
| 76 | ! |
---|
[6140] | 77 | IF( kt /= nkstp ) THEN ! full eos: set partial derivatives at the 1st call of kt time step |
---|
[4619] | 78 | nkstp = kt |
---|
| 79 | CALL eos_pen( tsn, rab_PE, zpe ) |
---|
| 80 | CALL iom_put( "alphaPE", rab_pe(:,:,:,jp_tem) ) |
---|
| 81 | CALL iom_put( "betaPE" , rab_pe(:,:,:,jp_sal) ) |
---|
| 82 | CALL iom_put( "PEanom" , zpe ) |
---|
| 83 | ENDIF |
---|
| 84 | ! |
---|
| 85 | zpe(:,:,jpk) = 0._wp |
---|
| 86 | DO jk = 1, jpkm1 |
---|
| 87 | zpe(:,:,jk) = ( - ( rab_n(:,:,jk,jp_tem) + rab_pe(:,:,jk,jp_tem) ) * ptrdx(:,:,jk) & |
---|
| 88 | & + ( rab_n(:,:,jk,jp_sal) + rab_pe(:,:,jk,jp_sal) ) * ptrdy(:,:,jk) ) |
---|
| 89 | END DO |
---|
| 90 | |
---|
| 91 | SELECT CASE ( ktrd ) |
---|
| 92 | CASE ( jptra_xad ) ; CALL iom_put( "petrd_xad", zpe ) ! zonal advection |
---|
| 93 | CASE ( jptra_yad ) ; CALL iom_put( "petrd_yad", zpe ) ! merid. advection |
---|
| 94 | CASE ( jptra_zad ) ; CALL iom_put( "petrd_zad", zpe ) ! vertical advection |
---|
[6140] | 95 | IF( ln_linssh ) THEN ! cst volume : adv flux through z=0 surface |
---|
[9125] | 96 | ALLOCATE( z2d(jpi,jpj) ) |
---|
[4619] | 97 | z2d(:,:) = wn(:,:,1) * ( & |
---|
[5836] | 98 | & - ( rab_n(:,:,1,jp_tem) + rab_pe(:,:,1,jp_tem) ) * tsn(:,:,1,jp_tem) & |
---|
| 99 | & + ( rab_n(:,:,1,jp_sal) + rab_pe(:,:,1,jp_sal) ) * tsn(:,:,1,jp_sal) & |
---|
[6140] | 100 | & ) / e3t_n(:,:,1) |
---|
[4619] | 101 | CALL iom_put( "petrd_sad" , z2d ) |
---|
[9125] | 102 | DEALLOCATE( z2d ) |
---|
[4619] | 103 | ENDIF |
---|
| 104 | CASE ( jptra_ldf ) ; CALL iom_put( "petrd_ldf" , zpe ) ! lateral diffusion |
---|
| 105 | CASE ( jptra_zdf ) ; CALL iom_put( "petrd_zdf" , zpe ) ! lateral diffusion (K_z) |
---|
| 106 | CASE ( jptra_zdfp ) ; CALL iom_put( "petrd_zdfp", zpe ) ! vertical diffusion (K_z) |
---|
| 107 | CASE ( jptra_dmp ) ; CALL iom_put( "petrd_dmp" , zpe ) ! internal 3D restoring (tradmp) |
---|
| 108 | CASE ( jptra_bbl ) ; CALL iom_put( "petrd_bbl" , zpe ) ! bottom boundary layer |
---|
| 109 | CASE ( jptra_npc ) ; CALL iom_put( "petrd_npc" , zpe ) ! non penetr convect adjustment |
---|
| 110 | CASE ( jptra_nsr ) ; CALL iom_put( "petrd_nsr" , zpe ) ! surface forcing + runoff (ln_rnf=T) |
---|
| 111 | CASE ( jptra_qsr ) ; CALL iom_put( "petrd_qsr" , zpe ) ! air-sea : penetrative sol radiat |
---|
| 112 | CASE ( jptra_bbc ) ; CALL iom_put( "petrd_bbc" , zpe ) ! bottom bound cond (geoth flux) |
---|
| 113 | CASE ( jptra_atf ) ; CALL iom_put( "petrd_atf" , zpe ) ! asselin time filter (last trend) |
---|
[6140] | 114 | !IF( ln_linssh ) THEN ! cst volume : ssh term (otherwise include in e3t variation) |
---|
[9125] | 115 | ! ALLOCATE( z2d(jpi,jpj) ) |
---|
[4619] | 116 | ! z2d(:,:) = ( ssha(:,:) - sshb(:,:) ) & |
---|
| 117 | ! & * ( dPE_dt(:,:,1) * tsn(:,:,1,jp_tem) & |
---|
[6140] | 118 | ! & + dPE_ds(:,:,1) * tsn(:,:,1,jp_sal) ) / ( e3t_n(:,:,1) * pdt ) |
---|
[4619] | 119 | ! CALL iom_put( "petrd_sad" , z2d ) |
---|
[9125] | 120 | ! DEALLOCATE( z2d ) |
---|
[4619] | 121 | !ENDIF |
---|
| 122 | ! |
---|
| 123 | END SELECT |
---|
| 124 | ! |
---|
| 125 | ! |
---|
| 126 | END SUBROUTINE trd_pen |
---|
| 127 | |
---|
| 128 | |
---|
| 129 | SUBROUTINE trd_pen_init |
---|
| 130 | !!--------------------------------------------------------------------- |
---|
| 131 | !! *** ROUTINE trd_pen_init *** |
---|
| 132 | !! |
---|
| 133 | !! ** Purpose : initialisation of 3D Kinetic Energy trend diagnostic |
---|
| 134 | !!---------------------------------------------------------------------- |
---|
| 135 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
| 136 | !!---------------------------------------------------------------------- |
---|
| 137 | ! |
---|
| 138 | IF(lwp) THEN |
---|
| 139 | WRITE(numout,*) |
---|
| 140 | WRITE(numout,*) 'trd_pen_init : 3D Potential ENergy trends' |
---|
| 141 | WRITE(numout,*) '~~~~~~~~~~~~~' |
---|
| 142 | ENDIF |
---|
| 143 | ! ! allocate box volume arrays |
---|
| 144 | IF ( trd_pen_alloc() /= 0 ) CALL ctl_stop('trd_pen_alloc: failed to allocate arrays') |
---|
| 145 | ! |
---|
| 146 | rab_pe(:,:,:,:) = 0._wp |
---|
| 147 | ! |
---|
[6140] | 148 | IF( .NOT.ln_linssh ) CALL ctl_stop('trd_pen_init : PE trends not coded for variable volume') |
---|
[4619] | 149 | ! |
---|
| 150 | nkstp = nit000 - 1 |
---|
| 151 | ! |
---|
| 152 | END SUBROUTINE trd_pen_init |
---|
| 153 | |
---|
| 154 | !!====================================================================== |
---|
[5656] | 155 | END MODULE trdpen |
---|