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.
limcons.F90 in branches/2015/dev_r5044_CNRS_LIM3CLEAN/NEMOGCM/NEMO/LIM_SRC_3 – NEMO

source: branches/2015/dev_r5044_CNRS_LIM3CLEAN/NEMOGCM/NEMO/LIM_SRC_3/limcons.F90 @ 5070

Last change on this file since 5070 was 5070, checked in by clem, 9 years ago

LIM3 cosmetic changes
  • Property svn:keywords set to Id
File size: 11.7 KB
Line 
1MODULE limcons
2   !!======================================================================
3   !!                   ***  MODULE  limcons  ***
4   !! LIM-3 Sea Ice :   conservation check
5   !!======================================================================
6   !! History :   -   ! Original code from William H. Lipscomb, LANL
7   !!            3.0  ! 2004-06  (M. Vancoppenolle)   Energy Conservation
8   !!            3.5  ! 2011-02  (G. Madec)  add mpp considerations
9   !!             -   ! 2014-05  (C. Rousset) add lim_cons_hsm
10   !!----------------------------------------------------------------------
11#if defined key_lim3
12   !!----------------------------------------------------------------------
13   !!   'key_lim3'                                      LIM-3 sea-ice model
14   !!----------------------------------------------------------------------
15   !!    lim_cons     :   checks whether energy, mass and salt are conserved
16   !!----------------------------------------------------------------------
17   USE phycst         ! physical constants
18   USE ice            ! LIM-3 variables
19   USE dom_ice        ! LIM-3 domain
20   USE dom_oce        ! ocean domain
21   USE in_out_manager ! I/O manager
22   USE lib_mpp        ! MPP library
23   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   lim_column_sum
29   PUBLIC   lim_column_sum_energy
30   PUBLIC   lim_cons_check
31   PUBLIC   lim_cons_hsm
32
33   !!----------------------------------------------------------------------
34   !! NEMO/LIM3 4.0 , UCL - NEMO Consortium (2011)
35   !! $Id$
36   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
37   !!----------------------------------------------------------------------
38CONTAINS
39
40   SUBROUTINE lim_column_sum( ksum, pin, pout )
41      !!-------------------------------------------------------------------
42      !!               ***  ROUTINE lim_column_sum ***
43      !!
44      !! ** Purpose : Compute the sum of xin over nsum categories
45      !!
46      !! ** Method  : Arithmetics
47      !!
48      !! ** Action  : Gets xin(ji,jj,jl) and computes xout(ji,jj)
49      !!---------------------------------------------------------------------
50      INTEGER                   , INTENT(in   ) ::   ksum   ! number of categories/layers
51      REAL(wp), DIMENSION(:,:,:), INTENT(in   ) ::   pin    ! input field
52      REAL(wp), DIMENSION(:,:)  , INTENT(  out) ::   pout   ! output field
53      !
54      INTEGER ::   jl   ! dummy loop indices
55      !!---------------------------------------------------------------------
56      !
57      pout(:,:) = pin(:,:,1)
58      DO jl = 2, ksum
59         pout(:,:) = pout(:,:) + pin(:,:,jl)
60      END DO
61      !
62   END SUBROUTINE lim_column_sum
63
64
65   SUBROUTINE lim_column_sum_energy( ksum, klay, pin, pout)
66      !!-------------------------------------------------------------------
67      !!               ***  ROUTINE lim_column_sum_energy ***
68      !!
69      !! ** Purpose : Compute the sum of xin over nsum categories
70      !!              and nlay layers
71      !!
72      !! ** Method  : Arithmetics
73      !!---------------------------------------------------------------------
74      INTEGER                                  , INTENT(in   ) ::   ksum   !: number of categories
75      INTEGER                                  , INTENT(in   ) ::   klay   !: number of vertical layers
76      REAL(wp), DIMENSION(jpi,jpj,nlay_i+1,jpl), INTENT(in   ) ::   pin   !: input field
77      REAL(wp), DIMENSION(jpi,jpj)             , INTENT(  out) ::   pout   !: output field
78      !
79      INTEGER ::   jk, jl   ! dummy loop indices
80      !!---------------------------------------------------------------------
81      !
82      pout(:,:) = 0._wp
83      DO jl = 1, ksum
84         DO jk = 2, klay 
85            pout(:,:) = pout(:,:) + pin(:,:,jk,jl)
86         END DO
87      END DO
88      !
89   END SUBROUTINE lim_column_sum_energy
90
91
92   SUBROUTINE lim_cons_check( px1, px2, pmax_err, cd_fieldid )
93      !!-------------------------------------------------------------------
94      !!               ***  ROUTINE lim_cons_check ***
95      !!
96      !! ** Purpose : Test the conservation of a certain variable
97      !!              For each physical grid cell, check that initial
98      !!              and final values
99      !!              of a conserved field are equal to within a small value.
100      !!
101      !! ** Method  :
102      !!---------------------------------------------------------------------
103      REAL(wp), DIMENSION(:,:), INTENT(in   ) ::   px1          !: initial field
104      REAL(wp), DIMENSION(:,:), INTENT(in   ) ::   px2          !: final field
105      REAL(wp)                , INTENT(in   ) ::   pmax_err     !: max allowed error
106      CHARACTER(len=15)       , INTENT(in   ) ::   cd_fieldid   !: field identifyer
107      !
108      INTEGER  ::   ji, jj          ! dummy loop indices
109      INTEGER  ::   inb_error       ! number of g.c where there is a cons. error
110      LOGICAL  ::   llconserv_err   ! = .true. if conservation check failed
111      REAL(wp) ::   zmean_error     ! mean error on error points
112      !!---------------------------------------------------------------------
113      !
114      IF(lwp) WRITE(numout,*) ' lim_cons_check '
115      IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~~~~ '
116
117      llconserv_err = .FALSE.
118      inb_error     = 0
119      zmean_error   = 0._wp
120      IF( MAXVAL( px2(:,:) - px1(:,:) ) > pmax_err )   llconserv_err = .TRUE.
121
122      IF( llconserv_err ) THEN
123         DO jj = 1, jpj 
124            DO ji = 1, jpi
125               IF( ABS( px2(ji,jj) - px1(ji,jj) ) > pmax_err ) THEN
126                  inb_error   = inb_error + 1
127                  zmean_error = zmean_error + ABS( px2(ji,jj) - px1(ji,jj) )
128                  !
129                  IF(lwp) THEN
130                     WRITE (numout,*) ' ALERTE 99 '
131                     WRITE (numout,*) ' Conservation error: ', cd_fieldid
132                     WRITE (numout,*) ' Point             : ', ji, jj 
133                     WRITE (numout,*) ' lat, lon          : ', gphit(ji,jj), glamt(ji,jj)
134                     WRITE (numout,*) ' Initial value     : ', px1(ji,jj)
135                     WRITE (numout,*) ' Final value       : ', px2(ji,jj)
136                     WRITE (numout,*) ' Difference        : ', px2(ji,jj) - px1(ji,jj)
137                  ENDIF
138               ENDIF
139            END DO
140         END DO
141         !
142      ENDIF
143      IF(lk_mpp)   CALL mpp_sum( inb_error   )
144      IF(lk_mpp)   CALL mpp_sum( zmean_error )
145      !
146      IF( inb_error > 0 .AND. lwp ) THEN
147         zmean_error = zmean_error / REAL( inb_error, wp )
148         WRITE(numout,*) ' Conservation check for : ', cd_fieldid
149         WRITE(numout,*) ' Number of error points : ', inb_error
150         WRITE(numout,*) ' Mean error on these pts: ', zmean_error
151      ENDIF
152      !
153   END SUBROUTINE lim_cons_check
154
155
156   SUBROUTINE lim_cons_hsm( icount, cd_routine, zvi_b, zsmv_b, zei_b, zfw_b, zfs_b, zft_b )
157      !!-------------------------------------------------------------------
158      !!               ***  ROUTINE lim_cons_hsm ***
159      !!
160      !! ** Purpose : Test the conservation of heat, salt and mass for each routine
161      !!
162      !! ** Method  :
163      !!---------------------------------------------------------------------
164      INTEGER         , INTENT(in)    :: icount      ! determine wether this is the beggining of the routine (0) or the end (1)
165      CHARACTER(len=*), INTENT(in)    :: cd_routine  ! name of the routine
166      REAL(wp)        , INTENT(inout) :: zvi_b, zsmv_b, zei_b, zfs_b, zfw_b, zft_b 
167      REAL(wp)                        :: zvi,   zsmv,   zei,   zfs,   zfw,   zft
168      REAL(wp)                        :: zvmin, zamin, zamax 
169      REAL(wp)                        :: zconv
170
171      zconv = 1.e-9
172
173      IF( icount == 0 ) THEN
174
175         zfs_b  = glob_sum(  ( sfx_bri(:,:) + sfx_bog(:,:) + sfx_bom(:,:) + sfx_sum(:,:) + sfx_sni(:,:) +  &
176            &                  sfx_opw(:,:) + sfx_res(:,:) + sfx_dyn(:,:)                                  &
177            &                ) *  e12t(:,:) * tmask(:,:,1) )
178
179         zfw_b  = glob_sum( -( wfx_bog(:,:) + wfx_bom(:,:) + wfx_sum(:,:) + wfx_sni(:,:) + wfx_opw(:,:) +  &
180            &                  wfx_res(:,:) + wfx_dyn(:,:) + wfx_snw(:,:) + wfx_sub(:,:) + wfx_spr(:,:)    &
181            &                ) *  e12t(:,:) * tmask(:,:,1) )
182
183         zft_b  = glob_sum(  ( hfx_sum(:,:) + hfx_bom(:,:) + hfx_bog(:,:) + hfx_dif(:,:) + hfx_opw(:,:) + hfx_snw(:,:)  & 
184            &                - hfx_thd(:,:) - hfx_dyn(:,:) - hfx_res(:,:) - hfx_sub(:,:) - hfx_spr(:,:)   &
185            &                ) *  e12t(:,:) * tmask(:,:,1) * zconv )
186
187         zvi_b  = glob_sum( SUM( v_i(:,:,:)*rhoic + v_s(:,:,:)*rhosn, dim=3 ) * e12t(:,:) * tmask(:,:,1) )
188
189         zsmv_b = glob_sum( SUM( smv_i(:,:,:), dim=3 ) * e12t(:,:) * tmask(:,:,1) )
190
191         zei_b  = glob_sum( ( SUM( SUM( e_i(:,:,1:nlay_i,:), dim=4 ), dim=3 ) +  &
192            &                 SUM( SUM( e_s(:,:,1:nlay_s,:), dim=4 ), dim=3 )    &
193                            ) * e12t(:,:) * tmask(:,:,1) * zconv )
194
195      ELSEIF( icount == 1 ) THEN
196
197         zfs  = glob_sum(  ( sfx_bri(:,:) + sfx_bog(:,:) + sfx_bom(:,:) + sfx_sum(:,:) + sfx_sni(:,:) +  &
198            &                sfx_opw(:,:) + sfx_res(:,:) + sfx_dyn(:,:)                                  & 
199            &              ) * e12t(:,:) * tmask(:,:,1) ) - zfs_b
200
201         zfw  = glob_sum( -( wfx_bog(:,:) + wfx_bom(:,:) + wfx_sum(:,:) + wfx_sni(:,:) + wfx_opw(:,:) +  &
202            &                wfx_res(:,:) + wfx_dyn(:,:) + wfx_snw(:,:) + wfx_sub(:,:) + wfx_spr(:,:)    &
203            &              ) * e12t(:,:) * tmask(:,:,1) ) - zfw_b
204
205         zft  = glob_sum(  ( hfx_sum(:,:) + hfx_bom(:,:) + hfx_bog(:,:) + hfx_dif(:,:) + hfx_opw(:,:) + hfx_snw(:,:)  & 
206            &              - hfx_thd(:,:) - hfx_dyn(:,:) - hfx_res(:,:) - hfx_sub(:,:) - hfx_spr(:,:)   &
207            &              ) * e12t(:,:) * tmask(:,:,1) * zconv ) - zft_b
208 
209         zvi  = ( glob_sum( SUM( v_i(:,:,:)*rhoic + v_s(:,:,:)*rhosn, dim=3 )  &
210            &                    * e12t(:,:) * tmask(:,:,1) ) - zvi_b ) * r1_rdtice - zfw 
211
212         zsmv = ( glob_sum( SUM( smv_i(:,:,:), dim=3 ) * e12t(:,:) * tmask(:,:,1) ) - zsmv_b ) * r1_rdtice + ( zfs / rhoic )
213
214         zei  =   glob_sum( ( SUM( SUM( e_i(:,:,1:nlay_i,:), dim=4 ), dim=3 ) +  &
215            &                 SUM( SUM( e_s(:,:,1:nlay_s,:), dim=4 ), dim=3 )    &
216            &                ) * e12t(:,:) * tmask(:,:,1) * zconv ) * r1_rdtice - zei_b * r1_rdtice + zft
217
218         zvmin = glob_min( v_i )
219         zamax = glob_max( SUM( a_i, dim=3 ) )
220         zamin = glob_min( a_i )
221       
222         IF(lwp) THEN
223            IF ( ABS( zvi    ) >  1.e-4 ) WRITE(numout,*) 'violation volume [kg/day]     (',cd_routine,') = ',(zvi * rday)
224            IF ( ABS( zsmv   ) >  1.e-4 ) WRITE(numout,*) 'violation saline [psu*m3/day] (',cd_routine,') = ',(zsmv * rday)
225            IF ( ABS( zei    ) >  1     ) WRITE(numout,*) 'violation enthalpy [GW]       (',cd_routine,') = ',(zei)
226            IF ( zvmin <  -epsi10       ) WRITE(numout,*) 'violation v_i<0  [m]          (',cd_routine,') = ',(zvmin)
227            IF( cd_routine /= 'limtrp' .AND. cd_routine /= 'limitd_me' .AND. zamax > rn_amax+epsi10 ) THEN
228                                          WRITE(numout,*) 'violation a_i>amax            (',cd_routine,') = ',zamax
229            ENDIF
230            IF ( zamin <  -epsi10       ) WRITE(numout,*) 'violation a_i<0               (',cd_routine,') = ',zamin
231         ENDIF
232
233      ENDIF
234
235   END SUBROUTINE lim_cons_hsm
236
237#else
238   !!----------------------------------------------------------------------
239   !!   Default option         Empty module            NO LIM sea-ice model
240   !!----------------------------------------------------------------------
241#endif
242   !!======================================================================
243END MODULE limcons
Note: See TracBrowser for help on using the repository browser.