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.
dynldf.F90 in branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 2633

Last change on this file since 2633 was 2633, checked in by trackstand2, 13 years ago

Renamed wrk_use => wrk_in_use and wrk_release => wrk_not_released
  • Property svn:keywords set to Id
File size: 12.3 KB
Line 
1MODULE dynldf
2   !!======================================================================
3   !!                       ***  MODULE  dynldf  ***
4   !! Ocean physics:  lateral diffusivity trends
5   !!=====================================================================
6   !! History :  9.0  !  05-11  (G. Madec)  Original code (new step architecture)
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   dyn_ldf      : update the dynamics trend with the lateral diffusion
11   !!   dyn_ldf_init : initialization, namelist read, and parameters control
12   !!----------------------------------------------------------------------
13   USE oce            ! ocean dynamics and tracers
14   USE dom_oce        ! ocean space and time domain
15   USE phycst         ! physical constants
16   USE ldfdyn_oce     ! ocean dynamics lateral physics
17   USE ldfslp         ! lateral mixing: slopes of mixing orientation
18   USE dynldf_bilapg  ! lateral mixing            (dyn_ldf_bilapg routine)
19   USE dynldf_bilap   ! lateral mixing            (dyn_ldf_bilap  routine)
20   USE dynldf_iso     ! lateral mixing            (dyn_ldf_iso    routine)
21   USE dynldf_lap     ! lateral mixing            (dyn_ldf_lap    routine)
22   USE trdmod         ! ocean dynamics and tracer trends
23   USE trdmod_oce     ! ocean variables trends
24   USE prtctl         ! Print control
25   USE in_out_manager ! I/O manager
26   USE lib_mpp        ! distribued memory computing library
27   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   dyn_ldf       ! called by step module
33   PUBLIC   dyn_ldf_init  ! called by opa  module
34
35   INTEGER ::   nldf = -2   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
36
37   !! * Substitutions
38#  include "domzgr_substitute.h90"
39#  include "vectopt_loop_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
42   !! $Id$
43   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45
46CONTAINS
47
48   SUBROUTINE dyn_ldf( kt )
49      !!----------------------------------------------------------------------
50      !!                  ***  ROUTINE dyn_ldf  ***
51      !!
52      !! ** Purpose :   compute the lateral ocean dynamics physics.
53      !!----------------------------------------------------------------------
54      USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released
55      USE wrk_nemo, ONLY: ztrdu => wrk_3d_1, ztrdv => wrk_3d_2
56      !!
57      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
58      !!----------------------------------------------------------------------
59
60      IF(wrk_in_use(3, 1,2))THEN
61         CALL ctl_stop('dyn_ldf: requested workspace arrays unavailable.')
62         RETURN
63      END IF
64      !
65      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
66         ztrdu(:,:,:) = ua(:,:,:) 
67         ztrdv(:,:,:) = va(:,:,:) 
68      ENDIF
69
70      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
71      !
72      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
73      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
74      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
75      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
76      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
77         CALL dyn_ldf_lap    ( kt )
78         CALL dyn_ldf_bilap  ( kt )
79      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
80         CALL dyn_ldf_iso    ( kt )
81         CALL dyn_ldf_bilapg ( kt )
82      !
83      CASE ( -1 )                                       ! esopa: test all possibility with control print
84                        CALL dyn_ldf_lap    ( kt )
85                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
86            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
87                        CALL dyn_ldf_iso    ( kt )
88                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
89            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
90                        CALL dyn_ldf_bilap  ( kt )
91                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
92            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
93                        CALL dyn_ldf_bilapg ( kt )
94                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
95            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
96      !
97      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
98         IF( kt == nit000 ) THEN
99            IF(lwp) WRITE(numout,*)
100            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
101            IF(lwp) WRITE(numout,*) '~~~~~~~ '
102         ENDIF
103      END SELECT
104
105      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
106         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
107         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
108         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_ldf, 'DYN', kt )
109      ENDIF
110      !                                          ! print sum trends (used for debugging)
111      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
112         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
113      !
114      IF(wrk_not_released(3, 1,2))THEN
115         CALL ctl_stop('dyn_ldf: failed to release workspace arrays.')
116      END IF
117      !
118   END SUBROUTINE dyn_ldf
119
120
121   SUBROUTINE dyn_ldf_init
122      !!----------------------------------------------------------------------
123      !!                  ***  ROUTINE dyn_ldf_init  ***
124      !!
125      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
126      !!----------------------------------------------------------------------
127      INTEGER ::   ioptio, ierr         ! temporary integers
128      !!----------------------------------------------------------------------
129   
130      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
131
132      IF(lwp) THEN                        ! Namelist print
133         WRITE(numout,*)
134         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
135         WRITE(numout,*) '~~~~~~~~~~~'
136         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
137         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
138         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
139         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
140         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
141         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
142      ENDIF
143
144      !                                   ! control the consistency
145      ioptio = 0
146      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
147      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
148      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
149      ioptio = 0
150      IF( ln_dynldf_level )   ioptio = ioptio + 1
151      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
152      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
153      IF( ioptio /= 1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
154
155      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
156      ierr = 0
157      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
158         IF ( ln_zco ) THEN                ! z-coordinate
159            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
160            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
161            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
162         ENDIF
163         IF ( ln_zps ) THEN             ! z-coordinate
164            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
165            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
166            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
167         ENDIF
168         IF ( ln_sco ) THEN             ! s-coordinate
169            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
170            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
171            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
172         ENDIF
173      ENDIF
174
175      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
176         IF ( ln_zco ) THEN                ! z-coordinate
177            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
178            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
179            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
180         ENDIF
181         IF ( ln_zps ) THEN             ! z-coordinate
182            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
183            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
184            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
185         ENDIF
186         IF ( ln_sco ) THEN             ! s-coordinate
187            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
188            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
189            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
190         ENDIF
191      ENDIF
192     
193      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
194         IF ( ln_zco ) THEN                ! z-coordinate
195            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
196            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
197            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
198         ENDIF
199         IF ( ln_zps ) THEN             ! z-coordinate
200            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
201            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
202            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
203         ENDIF
204         IF ( ln_sco ) THEN             ! s-coordinate
205            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
206            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
207            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
208         ENDIF
209      ENDIF
210
211      IF( lk_esopa )                 nldf = -1     ! esopa test
212
213      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
214      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
215      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
216         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
217      ENDIF
218
219      IF(lwp) THEN
220         WRITE(numout,*)
221         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
222         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
223         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
224         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
225         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
226         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
227         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
228         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
229      ENDIF
230      !
231   END SUBROUTINE dyn_ldf_init
232
233   !!======================================================================
234END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.