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

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/OBS/obs_readmdt.F90 @ 2651

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

dynamic mem: #785 ; minor changes, style mainly
  • Property svn:keywords set to Id
File size: 10.8 KB
Line 
1MODULE obs_readmdt
2   !!======================================================================
3   !!                       ***  MODULE obs_readmdt  ***
4   !! Observation diagnostics: Read the MDT for SLA data (skeleton for now)
5   !!======================================================================
6   !! History :      ! 2007-03 (K. Mogensen) Initial skeleton version
7   !!                ! 2007-04 (E. Remy) migration and improvement from OPAVAR
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   obs_rea_mdt    : Driver for reading MDT
12   !!   obs_offset_mdt : Remove the offset between the model MDT and the used one
13   !!----------------------------------------------------------------------
14   USE par_kind         ! Precision variables
15   USE par_oce          ! Domain parameters
16   USE in_out_manager   ! I/O manager
17   USE obs_surf_def     ! Surface observation definitions
18   USE obs_inter_sup    ! Interpolation support routines
19   USE obs_inter_h2d    ! 2D interpolation
20   USE obs_utils        ! Various observation tools
21   USE iom_nf90         ! IOM NetCDF
22   USE netcdf           ! NetCDF library
23   USE lib_mpp          ! MPP library
24   USE dom_oce, ONLY : &                  ! Domain variables
25      &                    tmask, tmask_i, e1t, e2t, gphit, glamt
26   USE obs_const, ONLY :   obfillflt      ! Fillvalue
27   USE oce      , ONLY :   sshn           ! Model variables
28
29   IMPLICIT NONE
30   PRIVATE
31   
32   PUBLIC   obs_rea_mdt     ! called by ?
33   PUBLIC   obs_offset_mdt  ! called by ?
34
35   INTEGER , PUBLIC ::   nmsshc    = 1         ! MDT correction scheme
36   REAL(wp), PUBLIC ::   mdtcorr   = 1.61_wp   ! User specified MDT correction
37   REAL(wp), PUBLIC ::   mdtcutoff = 65.0_wp   ! MDT cutoff for computed correction
38
39   !!----------------------------------------------------------------------
40   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
41   !! $Id$
42   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44CONTAINS
45
46   SUBROUTINE obs_rea_mdt( kslano, sladata, k2dint )
47      !!---------------------------------------------------------------------
48      !!
49      !!                   *** ROUTINE obs_rea_mdt ***
50      !!
51      !! ** Purpose : Read from file the MDT data (skeleton)
52      !!
53      !! ** Method  :
54      !!
55      !! ** Action  :
56      !!----------------------------------------------------------------------
57      USE iom
58      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
59      USE wrk_nemo, ONLY:   z_mdt   => wrk_2d_1   ! Array to store the MDT values
60      USE wrk_nemo, ONLY:   mdtmask => wrk_2d_2   ! Array to store the mask for the MDT
61      !
62      INTEGER                          , INTENT(IN)    ::   kslano    ! Number of SLA Products
63      TYPE(obs_surf), DIMENSION(kslano), INTENT(inout) ::   sladata   ! SLA data
64      INTEGER                          , INTENT(in)    ::   k2dint    ! ?
65      !
66      CHARACTER(LEN=12), PARAMETER ::   cpname  = 'obs_rea_mdt'
67      CHARACTER(LEN=20), PARAMETER ::   mdtname = 'slaReferenceLevel.nc'
68
69      INTEGER ::   jslano              ! Data set loop variable
70      INTEGER ::   jobs                ! Obs loop variable
71      INTEGER ::   jpimdt, jpjmdt      ! Number of grid point in lat/lon for the MDT
72      INTEGER ::   iico, ijco          ! Grid point indicies
73      INTEGER ::   i_nx_id, i_ny_id, i_file_id, i_var_id, i_stat
74      INTEGER ::   nummdt
75      !
76      REAL(wp), DIMENSION(1)     ::   zext, zobsmask
77      REAL(wp), DIMENSION(2,2,1) ::   zweig
78      !
79      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::   zmask, zmdtl, zglam, zgphi
80      INTEGER , DIMENSION(:,:,:), ALLOCATABLE ::   igrdi, igrdj
81         
82      REAL(wp) :: zlam, zphi, zfill, zinfill    ! local scalar
83      !!----------------------------------------------------------------------
84
85      IF( wrk_in_use(2, 1,2) ) THEN
86         CALL ctl_stop('obs_rea_mdt : requested workspace array unavailable')   ;   RETURN
87      ENDIF
88
89      IF(lwp)WRITE(numout,*) 
90      IF(lwp)WRITE(numout,*) ' obs_rea_mdt : Read MDT for referencing altimeter anomalies'
91      IF(lwp)WRITE(numout,*) ' ------------- '
92
93      CALL iom_open( mdtname, nummdt )       ! Open the file
94      !                                      ! Get the MDT data
95      CALL iom_get ( nummdt, jpdom_data, 'sossheig', z_mdt(:,:), 1 )
96      CALL iom_close(nummdt)                 ! Close the file
97     
98      ! Read in the fill value
99      zinfill = 0.0
100      i_stat = nf90_open( mdtname, nf90_nowrite, nummdt )
101      i_stat = nf90_inq_varid( nummdt, 'sossheig', i_var_id )
102      i_stat = nf90_get_att( nummdt, i_var_id, "_FillValue",zinfill)
103      zfill = zinfill
104      i_stat = nf90_close( nummdt )
105
106      ! setup mask based on tmask and MDT mask
107      ! set mask to 0 where the MDT is set to fillvalue
108      WHERE(z_mdt(:,:) /= zfill)   ;   mdtmask(:,:) = tmask(:,:,1)
109      ELSE WHERE                   ;   mdtmask(:,:) = 0
110      END WHERE
111
112      ! Remove the offset between the MDT used with the sla and the model MDT
113      IF( nmsshc == 1 .OR. nmsshc == 2 )   CALL obs_offset_mdt( z_mdt, zfill )
114
115      ! Intepolate the MDT already on the model grid at the observation point
116 
117      DO jslano = 1, kslano
118         ALLOCATE( &
119            & igrdi(2,2,sladata(jslano)%nsurf), &
120            & igrdj(2,2,sladata(jslano)%nsurf), &
121            & zglam(2,2,sladata(jslano)%nsurf), &
122            & zgphi(2,2,sladata(jslano)%nsurf), &
123            & zmask(2,2,sladata(jslano)%nsurf), &
124            & zmdtl(2,2,sladata(jslano)%nsurf)  &
125            & )
126         
127         DO jobs = 1, sladata(jslano)%nsurf
128
129            igrdi(1,1,jobs) = sladata(jslano)%mi(jobs)-1
130            igrdj(1,1,jobs) = sladata(jslano)%mj(jobs)-1
131            igrdi(1,2,jobs) = sladata(jslano)%mi(jobs)-1
132            igrdj(1,2,jobs) = sladata(jslano)%mj(jobs)
133            igrdi(2,1,jobs) = sladata(jslano)%mi(jobs)
134            igrdj(2,1,jobs) = sladata(jslano)%mj(jobs)-1
135            igrdi(2,2,jobs) = sladata(jslano)%mi(jobs)
136            igrdj(2,2,jobs) = sladata(jslano)%mj(jobs)
137
138         END DO
139
140         CALL obs_int_comm_2d( 2, 2, sladata(jslano)%nsurf, igrdi, igrdj, glamt  , zglam )
141         CALL obs_int_comm_2d( 2, 2, sladata(jslano)%nsurf, igrdi, igrdj, gphit  , zgphi )
142         CALL obs_int_comm_2d( 2, 2, sladata(jslano)%nsurf, igrdi, igrdj, mdtmask, zmask )
143         CALL obs_int_comm_2d( 2, 2, sladata(jslano)%nsurf, igrdi, igrdj, z_mdt  , zmdtl )
144
145         DO jobs = 1, sladata(jslano)%nsurf
146           
147            zlam = sladata(jslano)%rlam(jobs)
148            zphi = sladata(jslano)%rphi(jobs)
149
150            CALL obs_int_h2d_init( 1, 1, k2dint, zlam, zphi,         &
151               &                   zglam(:,:,jobs), zgphi(:,:,jobs), &
152               &                   zmask(:,:,jobs), zweig, zobsmask )
153           
154            CALL obs_int_h2d( 1, 1, zweig, zmdtl(:,:,jobs),  zext )
155 
156            sladata(jslano)%rext(jobs,2) = zext(1)
157
158! mark any masked data with a QC flag
159            IF( zobsmask(1) == 0 )   sladata(jslano)%nqc(jobs) = 11
160
161         END DO
162         
163         DEALLOCATE( &
164            & igrdi, &
165            & igrdj, &
166            & zglam, &
167            & zgphi, &
168            & zmask, &
169            & zmdtl  &
170            & )
171
172      END DO
173
174      IF( wrk_not_released(2, 1,2) )   CALL ctl_stop('obs_rea_mdt: failed to release workspace arrays')
175      !
176   END SUBROUTINE obs_rea_mdt
177
178
179   SUBROUTINE obs_offset_mdt( mdt, zfill )
180      !!---------------------------------------------------------------------
181      !!
182      !!                   *** ROUTINE obs_offset_mdt ***
183      !!
184      !! ** Purpose : Compute a correction term for the MDT on the model grid
185      !!             !!!!! IF it is on the model grid
186      !!
187      !! ** Method  : Compute the mean difference between the model and the
188      !!              used MDT and remove the offset.
189      !!
190      !! ** Action  :
191      !!----------------------------------------------------------------------
192      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
193      USE wrk_nemo, ONLY:   zpromsk => wrk_2d_3
194      !
195      REAL(wp), DIMENSION(jpi,jpj), INTENT(inout) ::   mdt     ! MDT used on the model grid
196      REAL(wp)                    , INTENT(in   ) ::   zfill 
197      !
198      INTEGER  :: ji, jj
199      REAL(wp) :: zdxdy, zarea, zeta1, zeta2, zcorr_mdt, zcorr_bcketa, zcorr     ! local scalar
200      CHARACTER(LEN=14), PARAMETER ::   cpname = 'obs_offset_mdt'
201      !!----------------------------------------------------------------------
202
203      IF( wrk_in_use(2, 3) ) THEN
204         CALL ctl_stop('obs_offset_mdt: requested workspace array unavailable')   ;   RETURN
205      ENDIF
206
207      !  Initialize the local mask, for domain projection
208      !  Also exclude mdt points which are set to missing data
209
210      DO ji = 1, jpi
211        DO jj = 1, jpj
212           zpromsk(ji,jj) = tmask_i(ji,jj)
213           IF (    ( gphit(ji,jj) .GT.  mdtcutoff ) &
214              &.OR.( gphit(ji,jj) .LT. -mdtcutoff ) &
215              &.OR.( mdt(ji,jj) .EQ. zfill ) ) &
216              &        zpromsk(ji,jj) = 0.0
217        END DO
218      END DO 
219
220      ! Compute MSSH mean over [0,360] x [-mdtcutoff,mdtcutoff]
221
222      zarea = 0.0
223      zeta1 = 0.0
224      zeta2 = 0.0
225
226      DO jj = 1, jpj
227         DO ji = 1, jpi
228          zdxdy = e1t(ji,jj) * e2t(ji,jj) * zpromsk(ji,jj)
229          zarea = zarea + zdxdy
230          zeta1 = zeta1 + mdt(ji,jj) * zdxdy
231          zeta2 = zeta2 + sshn (ji,jj) * zdxdy
232        END DO     
233      END DO
234
235      IF( lk_mpp)   CALL mpp_sum( zeta1 )
236      IF( lk_mpp)   CALL mpp_sum( zeta2 )
237      IF( lk_mpp)   CALL mpp_sum( zarea )
238     
239      zcorr_mdt    = zeta1 / zarea
240      zcorr_bcketa = zeta2 / zarea
241
242      !  Define correction term
243
244      zcorr = zcorr_mdt - zcorr_bcketa
245
246      !  Correct spatial mean of the MSSH
247
248      IF( nmsshc == 1 )   mdt(:,:) = mdt(:,:) - zcorr 
249
250      ! User defined value : 1.6 m for the Rio MDT compared to ORCA2 MDT
251
252      IF( nmsshc == 2 )   mdt(:,:) = mdt(:,:) - mdtcorr
253
254      IF(lwp) THEN
255         WRITE(numout,*)
256         WRITE(numout,*) ' obs_readmdt : mdtcutoff     = ', mdtcutoff
257         WRITE(numout,*) ' -----------   zcorr_mdt     = ', zcorr_mdt
258         WRITE(numout,*) '               zcorr_bcketa  = ', zcorr_bcketa
259         WRITE(numout,*) '               zcorr         = ', zcorr
260         WRITE(numout,*) '               nmsshc        = ', nmsshc
261      ENDIF
262
263      IF ( nmsshc == 0 ) WRITE(numout,*) '           MSSH correction is not applied'
264      IF ( nmsshc == 1 ) WRITE(numout,*) '           MSSH correction is applied'
265      IF ( nmsshc == 2 ) WRITE(numout,*) '           User defined MSSH correction' 
266
267      IF( wrk_not_released(2, 3) )   CALL ctl_stop('obs_offset_mdt: failed to release workspace array')
268      !
269   END SUBROUTINE obs_offset_mdt
270 
271   !!======================================================================
272END MODULE obs_readmdt
Note: See TracBrowser for help on using the repository browser.