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.
trddyn.F90 in branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/OPA_SRC/TRD – NEMO

source: branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/OPA_SRC/TRD/trddyn.F90 @ 7910

Last change on this file since 7910 was 7910, checked in by timgraham, 7 years ago

All wrk_alloc removed
  • Property svn:keywords set to Id
File size: 9.5 KB
Line 
1MODULE trddyn
2   !!======================================================================
3   !!                       ***  MODULE  trddyn  ***
4   !! Ocean diagnostics:  ocean dynamic trends
5   !!=====================================================================
6   !! History :  3.5  !  2012-02  (G. Madec) creation from trdmod: split DYN and TRA trends
7   !!                                        and manage  3D trends output for U, V, and KE
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   trd_dyn       : manage the type of momentum trend diagnostics (3D I/O, domain averaged, KE)
12   !!   trd_dyn_iom   : output 3D momentum and/or tracer trends using IOM
13   !!   trd_dyn_init  : initialization step
14   !!----------------------------------------------------------------------
15   USE oce            ! ocean dynamics and tracers variables
16   USE dom_oce        ! ocean space and time domain variables
17   USE zdf_oce        ! ocean vertical physics variables
18   USE trd_oce        ! trends: ocean variables
19   USE zdfbfr         ! bottom friction
20   USE sbc_oce        ! surface boundary condition: ocean
21   USE phycst         ! physical constants
22   USE trdken         ! trends: Kinetic ENergy
23   USE trdglo         ! trends: global domain averaged
24   USE trdvor         ! trends: vertical averaged vorticity
25   USE trdmxl         ! trends: mixed layer averaged
26   USE in_out_manager ! I/O manager
27   USE lbclnk         ! lateral boundary condition
28   USE iom            ! I/O manager library
29   USE lib_mpp        ! MPP library
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC trd_dyn        ! called by all dynXX modules
35
36   !! * Substitutions
37#  include "vectopt_loop_substitute.h90"
38   !!----------------------------------------------------------------------
39   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
40   !! $Id$
41   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
42   !!----------------------------------------------------------------------
43CONTAINS
44
45   SUBROUTINE trd_dyn( putrd, pvtrd, ktrd, kt )
46      !!---------------------------------------------------------------------
47      !!                  ***  ROUTINE trd_mod  ***
48      !!
49      !! ** Purpose :   Dispatch momentum trend computation, e.g. 3D output,
50      !!              integral constraints, barotropic vorticity, kinetic enrgy,
51      !!              and/or mixed layer budget.
52      !!----------------------------------------------------------------------
53      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   putrd, pvtrd   ! U and V trends
54      INTEGER                   , INTENT(in   ) ::   ktrd           ! trend index
55      INTEGER                   , INTENT(in   ) ::   kt             ! time step
56      !!----------------------------------------------------------------------
57      !
58      putrd(:,:,:) = putrd(:,:,:) * umask(:,:,:)                       ! mask the trends
59      pvtrd(:,:,:) = pvtrd(:,:,:) * vmask(:,:,:)
60      !
61
62!!gm NB : here a lbc_lnk should probably be added
63
64      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
65      !   3D output of momentum and/or tracers trends using IOM interface
66      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
67      IF( ln_dyn_trd )   CALL trd_dyn_iom( putrd, pvtrd, ktrd, kt )
68         
69      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
70      !  Integral Constraints Properties for momentum and/or tracers trends
71      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
72      IF( ln_glo_trd )   CALL trd_glo( putrd, pvtrd, ktrd, 'DYN', kt )
73
74      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
75      !  Kinetic Energy trends
76      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
77      IF( ln_KE_trd  )   CALL trd_ken( putrd, pvtrd, ktrd, kt )
78
79      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
80      !  Vorticity trends
81      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
82      IF( ln_vor_trd )   CALL trd_vor( putrd, pvtrd, ktrd, kt )
83
84      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
85      !  Mixed layer trends for active tracers
86      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
87!!gm      IF( ln_dyn_mxl )   CALL trd_mxl_dyn   
88      !
89   END SUBROUTINE trd_dyn
90
91
92   SUBROUTINE trd_dyn_iom( putrd, pvtrd, ktrd, kt )
93      !!---------------------------------------------------------------------
94      !!                  ***  ROUTINE trd_dyn_iom  ***
95      !!
96      !! ** Purpose :   output 3D trends using IOM
97      !!----------------------------------------------------------------------
98      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   putrd, pvtrd   ! U and V trends
99      INTEGER                   , INTENT(in   ) ::   ktrd           ! trend index
100      INTEGER                   , INTENT(in   ) ::   kt             ! time step
101      !
102      INTEGER ::   ji, jj, jk   ! dummy loop indices
103      INTEGER ::   ikbu, ikbv   ! local integers
104      REAL(wp), DIMENSION(jpi,jpj)   ::   z2dx, z2dy   ! 2D workspace
105      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   z3dx, z3dy   ! 3D workspace
106      !!----------------------------------------------------------------------
107      !
108      SELECT CASE( ktrd )
109      CASE( jpdyn_hpg )   ;   CALL iom_put( "utrd_hpg", putrd )    ! hydrostatic pressure gradient
110                              CALL iom_put( "vtrd_hpg", pvtrd )
111      CASE( jpdyn_spg )   ;   CALL iom_put( "utrd_spg", putrd )    ! surface pressure gradient
112                              CALL iom_put( "vtrd_spg", pvtrd )
113      CASE( jpdyn_pvo )   ;   CALL iom_put( "utrd_pvo", putrd )    ! planetary vorticity
114                              CALL iom_put( "vtrd_pvo", pvtrd )
115      CASE( jpdyn_rvo )   ;   CALL iom_put( "utrd_rvo", putrd )    ! relative  vorticity     (or metric term)
116                              CALL iom_put( "vtrd_rvo", pvtrd )
117      CASE( jpdyn_keg )   ;   CALL iom_put( "utrd_keg", putrd )    ! Kinetic Energy gradient (or had)
118                              CALL iom_put( "vtrd_keg", pvtrd )
119                              z3dx(:,:,:) = 0._wp                  ! U.dxU & V.dyV (approximation)
120                              z3dy(:,:,:) = 0._wp
121                              DO jk = 1, jpkm1                 ! no mask as un,vn are masked
122                                 DO jj = 2, jpjm1
123                                    DO ji = 2, jpim1
124                                       z3dx(ji,jj,jk) = un(ji,jj,jk) * ( un(ji+1,jj,jk) - un(ji-1,jj,jk) ) / ( 2._wp * e1u(ji,jj) )
125                                       z3dy(ji,jj,jk) = vn(ji,jj,jk) * ( vn(ji,jj+1,jk) - vn(ji,jj-1,jk) ) / ( 2._wp * e2v(ji,jj) )
126                                    END DO
127                                 END DO
128                              END DO
129                              CALL lbc_lnk( z3dx, 'U', -1. )
130                              CALL lbc_lnk( z3dy, 'V', -1. )
131                              CALL iom_put( "utrd_udx", z3dx  )
132                              CALL iom_put( "vtrd_vdy", z3dy  )
133      CASE( jpdyn_zad )   ;   CALL iom_put( "utrd_zad", putrd )    ! vertical   advection
134                              CALL iom_put( "vtrd_zad", pvtrd )
135      CASE( jpdyn_ldf )   ;   CALL iom_put( "utrd_ldf", putrd )    ! lateral diffusion
136                              CALL iom_put( "vtrd_ldf", pvtrd )
137      CASE( jpdyn_zdf )   ;   CALL iom_put( "utrd_zdf", putrd )    ! vertical diffusion
138                              CALL iom_put( "vtrd_zdf", pvtrd )
139                              !                                    ! wind stress trends
140                              z2dx(:,:) = ( utau_b(:,:) + utau(:,:) ) / ( e3u_n(:,:,1) * rau0 )
141                              z2dy(:,:) = ( vtau_b(:,:) + vtau(:,:) ) / ( e3v_n(:,:,1) * rau0 )
142                              CALL iom_put( "utrd_tau", z2dx )
143                              CALL iom_put( "vtrd_tau", z2dy )
144      CASE( jpdyn_bfr )       ! called if ln_bfrimp=T
145                              CALL iom_put( "utrd_bfr", putrd )    ! bottom friction (explicit case)
146                              CALL iom_put( "vtrd_bfr", pvtrd )
147      CASE( jpdyn_atf )   ;   CALL iom_put( "utrd_atf", putrd )        ! asselin filter trends
148                              CALL iom_put( "vtrd_atf", pvtrd )
149      CASE( jpdyn_bfri )  ;   IF( ln_bfrimp ) THEN                     ! bottom friction (implicit case)
150                                 z3dx(:,:,:) = 0._wp   ;   z3dy(:,:,:) = 0._wp  ! after velocity known (now filed at this stage)
151                                 DO jk = 1, jpkm1
152                                    DO jj = 2, jpjm1
153                                       DO ji = 2, jpim1
154                                          ikbu = mbku(ji,jj)          ! deepest ocean u- & v-levels
155                                          ikbv = mbkv(ji,jj)
156                                          z3dx(ji,jj,jk) = bfrua(ji,jj) * un(ji,jj,ikbu) / e3u_n(ji,jj,ikbu)
157                                          z3dy(ji,jj,jk) = bfrva(ji,jj) * vn(ji,jj,ikbv) / e3v_n(ji,jj,ikbv)
158                                       END DO
159                                    END DO
160                                 END DO
161                                 CALL lbc_lnk( z3dx, 'U', -1. ) ; CALL lbc_lnk( z3dy, 'V', -1. )
162                                 CALL iom_put( "utrd_bfri", z3dx )
163                                 CALL iom_put( "vtrd_bfri", z3dy )
164                              ENDIF
165      END SELECT
166      !
167   END SUBROUTINE trd_dyn_iom
168
169   !!======================================================================
170END MODULE trddyn
Note: See TracBrowser for help on using the repository browser.