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.
sbcapr.F90 in branches/UKMO/test_moci_test_suite/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/test_moci_test_suite/NEMOGCM/NEMO/OPA_SRC/SBC/sbcapr.F90 @ 8243

Last change on this file since 8243 was 8243, checked in by andmirek, 7 years ago

#1914 working XIOS read, XIOS write and single processor read
File size: 9.4 KB
Line 
1MODULE sbcapr
2   !!======================================================================
3   !!                       ***  MODULE  sbcapr  ***
4   !! Surface module :   atmospheric pressure forcing
5   !!======================================================================
6   !! History :  3.3  !   2010-09  (J. Chanut, C. Bricaud, G. Madec)  Original code
7   !!----------------------------------------------------------------------
8   
9   !!----------------------------------------------------------------------
10   !!   sbc_apr        : read atmospheric pressure in netcdf files
11   !!----------------------------------------------------------------------
12   USE dom_oce         ! ocean space and time domain
13   USE sbc_oce         ! surface boundary condition
14   USE dynspg_oce      ! surface pressure gradient variables
15   USE phycst          ! physical constants
16   USE fldread         ! read input fields
17   USE in_out_manager  ! I/O manager
18   USE lib_fortran     ! distribued memory computing library
19   USE iom             ! IOM library
20   USE lib_mpp         ! MPP library
21   USE iom_def, ONLY : lwxios
22
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC   sbc_apr    ! routine called in sbcmod
27   
28   !                                !!* namsbc_apr namelist (Atmospheric PRessure) *
29   LOGICAL, PUBLIC ::   ln_apr_obc   !: inverse barometer added to OBC ssh data
30   LOGICAL, PUBLIC ::   ln_ref_apr   !: ref. pressure: global mean Patm (F) or a constant (F)
31   REAL(wp)        ::   rn_pref      !  reference atmospheric pressure   [N/m2]
32   LOGICAL         ::   ln_apr_sio   ! single processor read flag
33
34   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   ssh_ib    ! Inverse barometer now    sea surface height   [m]
35   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   ssh_ibb   ! Inverse barometer before sea surface height   [m]
36   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   apr       ! atmospheric pressure at kt                 [N/m2]
37   
38   REAL(wp) ::   tarea                ! whole domain mean masked ocean surface
39   REAL(wp) ::   r1_grau              ! = 1.e0 / (grav * rau0)
40   
41   TYPE(FLD), ALLOCATABLE, DIMENSION(:) ::   sf_apr   ! structure of input fields (file informations, fields read)
42
43   !! * Substitutions
44#  include "domzgr_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE sbc_apr( kt )
53      !!---------------------------------------------------------------------
54      !!                     ***  ROUTINE sbc_apr  ***
55      !!
56      !! ** Purpose :   read atmospheric pressure fields in netcdf files.
57      !!
58      !! ** Method  : - Read namelist namsbc_apr
59      !!              - Read Patm fields in netcdf files
60      !!              - Compute reference atmospheric pressure
61      !!              - Compute inverse barometer ssh
62      !! ** action  :   apr      : atmospheric pressure at kt
63      !!                ssh_ib   : inverse barometer ssh at kt
64      !!---------------------------------------------------------------------
65      INTEGER, INTENT(in)::   kt   ! ocean time step
66      !!
67      INTEGER            ::   ierror  ! local integer
68      INTEGER            ::   ios     ! Local integer output status for namelist read
69      !!
70      CHARACTER(len=100) ::  cn_dir   ! Root directory for location of ssr files
71      TYPE(FLD_N)        ::  sn_apr   ! informations about the fields to be read
72      LOGICAL            ::  lxios_read ! read restart using XIOS?
73      !!
74      NAMELIST/namsbc_apr/ cn_dir, sn_apr, ln_ref_apr, rn_pref, ln_apr_obc
75      !!----------------------------------------------------------------------
76      !
77      !
78      !                                         ! -------------------- !
79      IF( kt == nit000 ) THEN                   ! First call kt=nit000 !
80         !                                      ! -------------------- !
81         ln_apr_sio = .FALSE.
82         REWIND( numnam_ref )              ! Namelist namsbc_apr in reference namelist : File for atmospheric pressure forcing
83         READ  ( numnam_ref, namsbc_apr, IOSTAT = ios, ERR = 901)
84901      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_apr in reference namelist', lwp )
85
86         REWIND( numnam_cfg )              ! Namelist namsbc_apr in configuration namelist : File for atmospheric pressure forcing
87         READ  ( numnam_cfg, namsbc_apr, IOSTAT = ios, ERR = 902 )
88902      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_apr in configuration namelist', lwp )
89         IF(lwm) WRITE ( numond, namsbc_apr )
90         !
91         ALLOCATE( sf_apr(1), STAT=ierror )           !* allocate and fill sf_sst (forcing structure) with sn_sst
92         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_apr: unable to allocate sf_apr structure' )
93         !
94         CALL fld_fill( sf_apr, (/ sn_apr /), cn_dir, 'sbc_apr', 'Atmospheric pressure ', 'namsbc_apr' )
95                                ALLOCATE( sf_apr(1)%fnow(jpi,jpj,1)   )
96         IF( sn_apr%ln_tint )   ALLOCATE( sf_apr(1)%fdta(jpi,jpj,1,2) )
97                                ALLOCATE( ssh_ib(jpi,jpj) , ssh_ibb(jpi,jpj) )
98                                ALLOCATE( apr (jpi,jpj) )
99         !
100         IF(lwp) THEN                                 !* control print
101            WRITE(numout,*)
102            WRITE(numout,*) '   Namelist namsbc_apr : Atmospheric PRessure as extrenal forcing'
103            WRITE(numout,*) '      ref. pressure: global mean Patm (T) or a constant (F)  ln_ref_apr = ', ln_ref_apr
104         ENDIF
105         !
106         IF( ln_ref_apr ) THEN                        !* Compute whole inner domain mean masked ocean surface
107            tarea = glob_sum( e1e2t(:,:) )
108            IF(lwp) WRITE(numout,*) '         Variable ref. Patm computed over a ocean surface of ', tarea*1e-6, 'km2'
109         ELSE
110            IF(lwp) WRITE(numout,*) '         Reference Patm used : ', rn_pref, ' N/m2'
111         ENDIF
112         !
113         r1_grau = 1.e0 / (grav * rau0)               !* constant for optimization
114         !
115         !                                            !* control check
116         IF ( ln_apr_obc  ) THEN
117            IF(lwp) WRITE(numout,*) '         Inverse barometer added to OBC ssh data'
118         ENDIF
119         IF( ( ln_apr_obc ) .AND. .NOT. lk_dynspg_ts )   &
120            CALL ctl_stop( 'sbc_apr: use inverse barometer ssh at open boundary ONLY possible with time-splitting' )
121         IF( ( ln_apr_obc ) .AND. .NOT. ln_apr_dyn   )   &
122            CALL ctl_stop( 'sbc_apr: use inverse barometer ssh at open boundary ONLY requires ln_apr_dyn=T' )
123      ENDIF
124
125      !                                         ! ========================== !
126      IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN      !    At each sbc time-step   !
127         !                                      ! ===========+++============ !
128         !
129         IF( kt /= nit000 )   ssh_ibb(:,:) = ssh_ib(:,:)    !* Swap of ssh_ib fields
130         !
131         lspr = ln_apr_sio
132         CALL fld_read( kt, nn_fsbc, sf_apr )               !* input Patm provided at kt + nn_fsbc/2
133         lspr = .false.
134         !
135         !                                                  !* update the reference atmospheric pressure (if necessary)
136         IF( ln_ref_apr )   rn_pref = glob_sum( sf_apr(1)%fnow(:,:,1) * e1e2t(:,:) ) / tarea
137         !
138         !                                                  !* Patm related forcing at kt
139         ssh_ib(:,:) = - ( sf_apr(1)%fnow(:,:,1) - rn_pref ) * r1_grau    ! equivalent ssh (inverse barometer)
140         apr   (:,:) =     sf_apr(1)%fnow(:,:,1)                        ! atmospheric pressure
141         !
142         CALL iom_put( "ssh_ib", ssh_ib )                   !* output the inverse barometer ssh
143      ENDIF
144
145      !                                         ! ---------------------------------------- !
146      IF( kt == nit000 ) THEN                   !   set the forcing field at nit000 - 1    !
147         !                                      ! ---------------------------------------- !
148         !                                            !* Restart: read in restart file
149         IF( ln_rstart .AND. iom_varid( numror, 'ssh_ibb', ldstop = .FALSE. ) > 0 ) THEN
150            IF(lwp) WRITE(numout,*) 'sbc_apr:   ssh_ibb read in the restart file'
151            CALL iom_get( numror, jpdom_autoglo, 'ssh_ibb', ssh_ibb, lrxios = lxios_read )   ! before inv. barometer ssh
152            !
153         ELSE                                         !* no restart: set from nit000 values
154            IF(lwp) WRITE(numout,*) 'sbc_apr:   ssh_ibb set to nit000 values'
155            ssh_ibb(:,:) = ssh_ib(:,:)
156         ENDIF
157      ENDIF
158      !                                         ! ---------------------------------------- !
159      IF( lrst_oce ) THEN                       !      Write in the ocean restart file     !
160         !                                      ! ---------------------------------------- !
161         IF(lwp) WRITE(numout,*)
162         IF(lwp) WRITE(numout,*) 'sbc_apr : ssh_ib written in ocean restart file at it= ', kt,' date= ', ndastp
163         IF(lwp) WRITE(numout,*) '~~~~'
164         IF( lwxios ) CALL iom_swap(      wxios_context          )
165         CALL iom_rstput( kt, nitrst, numrow, 'ssh_ibb' , ssh_ib, lxios = lwxios )
166         IF( lwxios ) CALL iom_swap(      cxios_context          )
167      ENDIF
168      !
169   END SUBROUTINE sbc_apr
170     
171   !!======================================================================
172END MODULE sbcapr
Note: See TracBrowser for help on using the repository browser.