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 @ 2636

Last change on this file since 2636 was 2636, checked in by gm, 13 years ago

dynamic mem: #785 ; move ctl_stop & warn in lib_mpp to avoid a circular dependency + ctl_stop improvment
  • Property svn:keywords set to Id
File size: 12.2 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   !!----------------------------------------------------------------------
45CONTAINS
46
47   SUBROUTINE dyn_ldf( kt )
48      !!----------------------------------------------------------------------
49      !!                  ***  ROUTINE dyn_ldf  ***
50      !!
51      !! ** Purpose :   compute the lateral ocean dynamics physics.
52      !!----------------------------------------------------------------------
53      USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released
54      USE wrk_nemo, ONLY: ztrdu => wrk_3d_1, ztrdv => wrk_3d_2
55      !!
56      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
57      !!----------------------------------------------------------------------
58
59      IF( wrk_in_use(3, 1,2) ) THEN
60         CALL ctl_stop('dyn_ldf: requested workspace arrays unavailable.')   ;   RETURN
61      ENDIF
62      !
63      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
64         ztrdu(:,:,:) = ua(:,:,:) 
65         ztrdv(:,:,:) = va(:,:,:) 
66      ENDIF
67
68      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
69      !
70      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
71      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
72      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
73      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
74      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
75         CALL dyn_ldf_lap    ( kt )
76         CALL dyn_ldf_bilap  ( kt )
77      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
78         CALL dyn_ldf_iso    ( kt )
79         CALL dyn_ldf_bilapg ( kt )
80      !
81      CASE ( -1 )                                       ! esopa: test all possibility with control print
82                        CALL dyn_ldf_lap    ( kt )
83                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
84            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
85                        CALL dyn_ldf_iso    ( kt )
86                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
87            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
88                        CALL dyn_ldf_bilap  ( kt )
89                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
90            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
91                        CALL dyn_ldf_bilapg ( kt )
92                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
93            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
94      !
95      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
96         IF( kt == nit000 ) THEN
97            IF(lwp) WRITE(numout,*)
98            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
99            IF(lwp) WRITE(numout,*) '~~~~~~~ '
100         ENDIF
101      END SELECT
102
103      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
104         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
105         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
106         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_ldf, 'DYN', kt )
107      ENDIF
108      !                                          ! print sum trends (used for debugging)
109      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
110         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
111      !
112      IF( wrk_not_released(3, 1,2) )   CALL ctl_stop('dyn_ldf: failed to release workspace arrays.')
113      !
114   END SUBROUTINE dyn_ldf
115
116
117   SUBROUTINE dyn_ldf_init
118      !!----------------------------------------------------------------------
119      !!                  ***  ROUTINE dyn_ldf_init  ***
120      !!
121      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
122      !!----------------------------------------------------------------------
123      INTEGER ::   ioptio, ierr         ! temporary integers
124      !!----------------------------------------------------------------------
125   
126      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
127
128      IF(lwp) THEN                        ! Namelist print
129         WRITE(numout,*)
130         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
131         WRITE(numout,*) '~~~~~~~~~~~'
132         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
133         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
134         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
135         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
136         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
137         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
138      ENDIF
139
140      !                                   ! control the consistency
141      ioptio = 0
142      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
143      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
144      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
145      ioptio = 0
146      IF( ln_dynldf_level )   ioptio = ioptio + 1
147      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
148      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
149      IF( ioptio /= 1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
150
151      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
152      ierr = 0
153      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
154         IF ( ln_zco ) THEN                ! z-coordinate
155            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
156            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
157            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
158         ENDIF
159         IF ( ln_zps ) THEN             ! z-coordinate
160            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
161            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
162            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
163         ENDIF
164         IF ( ln_sco ) THEN             ! s-coordinate
165            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
166            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
167            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
168         ENDIF
169      ENDIF
170
171      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
172         IF ( ln_zco ) THEN                ! z-coordinate
173            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
174            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
175            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
176         ENDIF
177         IF ( ln_zps ) THEN             ! z-coordinate
178            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
179            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
180            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
181         ENDIF
182         IF ( ln_sco ) THEN             ! s-coordinate
183            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
184            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
185            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
186         ENDIF
187      ENDIF
188     
189      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
190         IF ( ln_zco ) THEN                ! z-coordinate
191            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
192            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
193            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
194         ENDIF
195         IF ( ln_zps ) THEN             ! z-coordinate
196            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
197            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
198            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
199         ENDIF
200         IF ( ln_sco ) THEN             ! s-coordinate
201            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
202            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
203            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
204         ENDIF
205      ENDIF
206
207      IF( lk_esopa )                 nldf = -1     ! esopa test
208
209      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
210      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
211      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
212         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
213      ENDIF
214
215      IF(lwp) THEN
216         WRITE(numout,*)
217         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
218         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
219         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
220         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
221         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
222         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
223         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
224         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
225      ENDIF
226      !
227   END SUBROUTINE dyn_ldf_init
228
229   !!======================================================================
230END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.