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/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 6748

Last change on this file since 6748 was 6748, checked in by mocavero, 8 years ago

GYRE hybrid parallelization
  • Property svn:keywords set to Id
File size: 10.4 KB
Line 
1MODULE dynldf
2   !!======================================================================
3   !!                       ***  MODULE  dynldf  ***
4   !! Ocean physics:  lateral diffusivity trends
5   !!=====================================================================
6   !! History :  2.0  ! 2005-11  (G. Madec)  Original code (new step architecture)
7   !!            3.7  ! 2014-01  (F. Lemarie, G. Madec)  restructuration/simplification of ahm specification,
8   !!                 !                                  add velocity dependent coefficient and optional read in file
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   dyn_ldf      : update the dynamics trend with the lateral diffusion
13   !!   dyn_ldf_init : initialization, namelist read, and parameters control
14   !!----------------------------------------------------------------------
15   USE oce            ! ocean dynamics and tracers
16   USE dom_oce        ! ocean space and time domain
17   USE phycst         ! physical constants
18   USE ldfdyn         ! lateral diffusion: eddy viscosity coef.
19   USE ldfslp         ! lateral diffusion: slopes of mixing orientation
20   USE dynldf_lap_blp ! lateral mixing   (dyn_ldf_lap & dyn_ldf_blp routines)
21   USE dynldf_iso     ! lateral mixing                 (dyn_ldf_iso routine )
22   USE trd_oce        ! trends: ocean variables
23   USE trddyn         ! trend manager: dynamics   (trd_dyn      routine)
24   !
25   USE prtctl         ! Print control
26   USE in_out_manager ! I/O manager
27   USE lib_mpp        ! distribued memory computing library
28   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
29   USE wrk_nemo       ! Memory Allocation
30   USE timing         ! Timing
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   dyn_ldf       ! called by step module
36   PUBLIC   dyn_ldf_init  ! called by opa  module
37
38   !                      ! Parameter to control the type of lateral viscous operator
39   INTEGER, PARAMETER, PUBLIC ::   np_ERROR  =-10   ! error in setting the operator
40   INTEGER, PARAMETER, PUBLIC ::   np_no_ldf = 00   ! without operator (i.e. no lateral viscous trend)
41   !                          !!      laplacian     !    bilaplacian    !
42   INTEGER, PARAMETER, PUBLIC ::   np_lap    = 10   ,   np_blp    = 20  ! iso-level operator
43   INTEGER, PARAMETER, PUBLIC ::   np_lap_i  = 11                       ! iso-neutral or geopotential operator
44
45   INTEGER ::   nldf   ! type of lateral diffusion used defined from ln_dynldf_... (namlist logicals)
46
47   !! * Substitutions
48#  include "vectopt_loop_substitute.h90"
49   !!----------------------------------------------------------------------
50   !! NEMO/OPA 3.7 , NEMO Consortium (2015)
51   !! $Id$
52   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
53   !!----------------------------------------------------------------------
54CONTAINS
55
56   SUBROUTINE dyn_ldf( kt )
57      !!----------------------------------------------------------------------
58      !!                  ***  ROUTINE dyn_ldf  ***
59      !!
60      !! ** Purpose :   compute the lateral ocean dynamics physics.
61      !!----------------------------------------------------------------------
62      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
63      !
64      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
65      !!----------------------------------------------------------------------
66      !
67      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
68      !
69      IF( l_trddyn )   THEN                      ! temporary save of momentum trends
70         CALL wrk_alloc( jpi,jpj,jpk,   ztrdu, ztrdv )
71!$OMP PARALLEL WORKSHARE
72         ztrdu(:,:,:) = ua(:,:,:) 
73         ztrdv(:,:,:) = va(:,:,:) 
74!$OMP END PARALLEL WORKSHARE
75      ENDIF
76
77      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
78      !
79      CASE ( np_lap   )    ;   CALL dyn_ldf_lap  ( kt, ub, vb, ua, va, 1 )      ! iso-level    laplacian
80      CASE ( np_lap_i )    ;   CALL dyn_ldf_iso  ( kt )                         ! rotated      laplacian
81      CASE ( np_blp   )    ;   CALL dyn_ldf_blp  ( kt, ub, vb, ua, va    )      ! iso-level bi-laplacian
82      !
83      END SELECT
84
85      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
86!$OMP PARALLEL WORKSHARE
87         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
88         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
89!$OMP END PARALLEL WORKSHARE
90         CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
91         CALL wrk_dealloc( jpi,jpj,jpk,   ztrdu, ztrdv )
92      ENDIF
93      !                                          ! print sum trends (used for debugging)
94      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
95         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
96      !
97      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
98      !
99   END SUBROUTINE dyn_ldf
100
101
102   SUBROUTINE dyn_ldf_init
103      !!----------------------------------------------------------------------
104      !!                  ***  ROUTINE dyn_ldf_init  ***
105      !!
106      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
107      !!----------------------------------------------------------------------
108      INTEGER ::   ioptio, ierr         ! temporary integers
109      !!----------------------------------------------------------------------
110      !
111      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
112      !
113      IF(lwp) THEN                        ! Namelist print
114         WRITE(numout,*)
115         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
116         WRITE(numout,*) '~~~~~~~~~~~'
117         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
118         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap = ', ln_dynldf_lap
119         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_blp = ', ln_dynldf_blp
120         WRITE(numout,*) '          iso-level                   ln_dynldf_lev = ', ln_dynldf_lev
121         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor = ', ln_dynldf_hor
122         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso = ', ln_dynldf_iso
123      ENDIF
124      !                                   ! use of lateral operator or not
125      nldf = np_ERROR
126      ioptio = 0
127      IF( ln_dynldf_lap )   ioptio = ioptio + 1
128      IF( ln_dynldf_blp )   ioptio = ioptio + 1
129      IF( ioptio >  1   )   CALL ctl_stop( 'dyn_ldf_init: use ONE or NONE of the 2 lap/bilap operator type on momentum' )
130      IF( ioptio == 0   )   nldf = np_no_ldf     ! No lateral mixing operator
131      !
132      IF( nldf /= np_no_ldf ) THEN        ! direction ==>> type of operator 
133         ioptio = 0
134         IF( ln_dynldf_lev )   ioptio = ioptio + 1
135         IF( ln_dynldf_hor )   ioptio = ioptio + 1
136         IF( ln_dynldf_iso )   ioptio = ioptio + 1
137         IF( ioptio >  1   )   CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
138         IF( ioptio == 0   )   CALL ctl_stop( '          use at least ONE direction (level/hor/iso)' )
139         !
140         !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
141         ierr = 0
142         IF ( ln_dynldf_lap ) THEN      ! laplacian operator
143            IF ( ln_zco ) THEN                ! z-coordinate
144               IF ( ln_dynldf_lev )   nldf = np_lap     ! iso-level = horizontal (no rotation)
145               IF ( ln_dynldf_hor )   nldf = np_lap     ! iso-level = horizontal (no rotation)
146               IF ( ln_dynldf_iso )   nldf = np_lap_i   ! iso-neutral            (   rotation)
147            ENDIF
148            IF ( ln_zps ) THEN             ! z-coordinate with partial step
149               IF ( ln_dynldf_lev )   nldf = np_lap     ! iso-level              (no rotation)
150               IF ( ln_dynldf_hor )   nldf = np_lap     ! iso-level              (no rotation)
151               IF ( ln_dynldf_iso )   nldf = np_lap_i   ! iso-neutral            (   rotation)
152            ENDIF
153            IF ( ln_sco ) THEN             ! s-coordinate
154               IF ( ln_dynldf_lev )   nldf = np_lap     ! iso-level = horizontal (no rotation)
155               IF ( ln_dynldf_hor )   nldf = np_lap_i   ! horizontal             (   rotation)
156               IF ( ln_dynldf_iso )   nldf = np_lap_i   ! iso-neutral            (   rotation)
157            ENDIF
158         ENDIF
159         !
160         IF( ln_dynldf_blp ) THEN          ! bilaplacian operator
161            IF ( ln_zco ) THEN                ! z-coordinate
162               IF ( ln_dynldf_lev )   nldf = np_blp     ! iso-level = horizontal (no rotation)
163               IF ( ln_dynldf_hor )   nldf = np_blp     ! iso-level = horizontal (no rotation)
164               IF ( ln_dynldf_iso )   ierr = 2          ! iso-neutral            (   rotation)
165            ENDIF
166            IF ( ln_zps ) THEN             ! z-coordinate with partial step
167               IF ( ln_dynldf_lev )   nldf = np_blp     ! iso-level              (no rotation)
168               IF ( ln_dynldf_hor )   nldf = np_blp     ! iso-level              (no rotation)
169               IF ( ln_dynldf_iso )   ierr = 2          ! iso-neutral            (   rotation)
170            ENDIF
171            IF ( ln_sco ) THEN             ! s-coordinate
172               IF ( ln_dynldf_lev )   nldf = np_blp     ! iso-level              (no rotation)
173               IF ( ln_dynldf_hor )   ierr = 2          ! horizontal             (   rotation)
174               IF ( ln_dynldf_iso )   ierr = 2          ! iso-neutral            (   rotation)
175            ENDIF
176         ENDIF
177         !
178         IF( ierr == 2 )   CALL ctl_stop( 'rotated bi-laplacian operator does not exist' )
179         !
180         IF( nldf == np_lap_i )   l_ldfslp = .TRUE.      ! rotation require the computation of the slopes
181         !
182      ENDIF
183
184      IF(lwp) THEN
185         WRITE(numout,*)
186         IF( nldf == np_no_ldf )   WRITE(numout,*) '              NO lateral viscosity'
187         IF( nldf == np_lap    )   WRITE(numout,*) '              iso-level laplacian operator'
188         IF( nldf == np_lap_i  )   WRITE(numout,*) '              rotated laplacian operator with iso-level background'
189         IF( nldf == np_blp    )   WRITE(numout,*) '              iso-level bi-laplacian operator'
190      ENDIF
191      !
192   END SUBROUTINE dyn_ldf_init
193
194   !!======================================================================
195END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.