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.
asmbkg.F90 in branches/UKMO/dev_r5518_nemovar_init_vvl/NEMOGCM/NEMO/OPA_SRC/ASM – NEMO

source: branches/UKMO/dev_r5518_nemovar_init_vvl/NEMOGCM/NEMO/OPA_SRC/ASM/asmbkg.F90 @ 6666

Last change on this file since 6666 was 6666, checked in by blemieux, 8 years ago

T/S profile assimilation on the Shelf

Updating the previous commit
File size: 8.8 KB
Line 
1MODULE asmbkg
2   !!======================================================================
3   !!                       ***  MODULE asmtrj -> asmbkg  ***
4   !! Assimilation trajectory interface: Write to file the background state and the model state trajectory
5   !!======================================================================
6   !! History :       ! 2007-03 (M. Martin)  Met. Office version
7   !!                 ! 2007-04 (A. Weaver)  asm_trj_wri, original code
8   !!                 ! 2007-03 (K. Mogensen)  Adapt to NEMOVAR and use IOM instead of IOIPSL
9   !!                 ! 2007-04 (A. Weaver)  Name change (formally asmbkg.F90). Distinguish
10   !!                                        background states in Jb term and at analysis time.
11   !!                                        Include state trajectory routine (currently empty)
12   !!                 ! 2007-07 (A. Weaver)  Add tke_rst and flt_rst for case nitbkg=0
13   !!                 ! 2009-03 (F. Vigilant)  Add hmlp (zdfmxl) for no tracer nmldp=2
14   !!                 ! 2009-06 (F. Vigilant) asm_trj_wri: special case when kt=nit000-1
15   !!                 ! 2009-07 (F. Vigilant) asm_trj_wri: add computation of eiv at restart
16   !!                 ! 2010-01 (A. Vidard) split asm_trj_wri into tam_trj_wri and asm_bkg_wri
17   !!----------------------------------------------------------------------
18
19   !!----------------------------------------------------------------------
20   !!   'key_asminc' : Switch on the assimilation increment interface
21   !!----------------------------------------------------------------------
22   !!   asm_bkg_wri  : Write out the background state
23   !!   asm_trj_wri  : Write out the model state trajectory (used with 4D-Var)
24   !!----------------------------------------------------------------------
25   USE oce                ! Dynamics and active tracers defined in memory
26   USE sbc_oce            ! Ocean surface boundary conditions
27   USE zdf_oce            ! Vertical mixing variables
28   USE zdfddm             ! Double diffusion mixing parameterization
29   USE ldftra_oce         ! Lateral tracer mixing coefficient defined in memory
30   USE ldfslp             ! Slopes of neutral surfaces
31   USE tradmp             ! Tracer damping
32#if defined key_zdftke
33   USE zdftke             ! TKE vertical physics
34#endif
35   USE eosbn2             ! Equation of state (eos_bn2 routine)
36   USE zdfmxl             ! Mixed layer depth
37   USE dom_oce, ONLY :   ndastp
38   USE sol_oce, ONLY :   gcx   ! Solver variables defined in memory
39   USE in_out_manager     ! I/O manager
40   USE iom                ! I/O module
41   USE asmpar             ! Parameters for the assmilation interface
42   USE zdfmxl             ! mixed layer depth
43#if defined key_traldf_c2d
44   USE ldfeiv             ! eddy induced velocity coef.      (ldf_eiv routine)
45#endif
46#if defined key_lim2
47   USE ice_2
48#endif
49#if defined key_lim3
50   USE ice
51#endif
52   IMPLICIT NONE
53   PRIVATE
54   
55   PUBLIC   asm_bkg_wri   !: Write out the background state
56
57   !! * Substitutions
58#  include "domzgr_substitute.h90"
59
60   !!----------------------------------------------------------------------
61   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
62   !! $Id$
63   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
64   !!----------------------------------------------------------------------
65CONTAINS
66
67   SUBROUTINE asm_bkg_wri( kt )
68      !!-----------------------------------------------------------------------
69      !!                  ***  ROUTINE asm_bkg_wri ***
70      !!
71      !! ** Purpose : Write to file the background state for later use in the
72      !!              inner loop of data assimilation or for direct initialization
73      !!              in the outer loop.
74      !!
75      !! ** Method  : Write out the background state for use in the Jb term
76      !!              in the cost function and for use with direct initialization
77      !!              at analysis time.
78      !!-----------------------------------------------------------------------
79      INTEGER, INTENT( IN ) :: kt               ! Current time-step
80      !
81      CHARACTER (LEN=50) :: cl_asmbkg
82      CHARACTER (LEN=50) :: cl_asmdin
83      LOGICAL :: llok          ! Check if file exists
84      INTEGER :: inum          ! File unit number
85      REAL(wp) :: zdate        ! Date
86      !!-----------------------------------------------------------------------
87
88      !                                !-------------------------------------------
89      IF( kt == nitbkg_r ) THEN        ! Write out background at time step nitbkg_r
90         !                             !-----------------------------------========
91         !
92         WRITE(cl_asmbkg, FMT='(A,".nc")' ) TRIM( c_asmbkg )
93         cl_asmbkg = TRIM( cl_asmbkg )
94         INQUIRE( FILE = cl_asmbkg, EXIST = llok )
95         !
96         IF( .NOT. llok ) THEN
97            IF(lwp) WRITE(numout,*) ' Setting up assimilation background file '// TRIM( c_asmbkg )
98            !
99            !                                      ! Define the output file       
100            CALL iom_open( c_asmbkg, inum, ldwrt = .TRUE., kiolib = jprstlib)
101            !
102            IF( nitbkg_r == nit000 - 1 ) THEN      ! Treat special case when nitbkg = 0
103               zdate = REAL( ndastp )
104#if defined key_zdftke
105               ! lk_zdftke=T :   Read turbulent kinetic energy ( en )
106               IF(lwp) WRITE(numout,*) ' Reading TKE (en) from restart...'
107               CALL tke_rst( nit000, 'READ' )               ! lk_zdftke=T :   Read turbulent kinetic energy ( en )
108
109#endif
110            ELSE
111               zdate = REAL( ndastp )
112            ENDIF
113            !
114            !                                      ! Write the information
115            CALL iom_rstput( kt, nitbkg_r, inum, 'rdastp' , zdate             )
116            CALL iom_rstput( kt, nitbkg_r, inum, 'un'     , un                )
117            CALL iom_rstput( kt, nitbkg_r, inum, 'vn'     , vn                )
118            CALL iom_rstput( kt, nitbkg_r, inum, 'tn'     , tsn(:,:,:,jp_tem) )
119            CALL iom_rstput( kt, nitbkg_r, inum, 'sn'     , tsn(:,:,:,jp_sal) )
120            CALL iom_rstput( kt, nitbkg_r, inum, 'sshn'   , sshn              )
121#if defined key_vvl                                                                                                                                                                                                                         
122            CALL iom_rstput( kt, nitbkg_r, inum, 'fse3t_n', e3t_n             )
123#endif
124#if defined key_zdftke
125            CALL iom_rstput( kt, nitbkg_r, inum, 'en'     , en                )
126#endif
127            CALL iom_rstput( kt, nitbkg_r, inum, 'gcx'    , gcx               )
128            !
129            CALL iom_close( inum )
130         ENDIF
131         !
132      ENDIF
133
134      !                                !-------------------------------------------
135      IF( kt == nitdin_r ) THEN        ! Write out background at time step nitdin_r
136         !                             !-----------------------------------========
137         !
138         WRITE(cl_asmdin, FMT='(A,".nc")' ) TRIM( c_asmdin )
139         cl_asmdin = TRIM( cl_asmdin )
140         INQUIRE( FILE = cl_asmdin, EXIST = llok )
141         !
142         IF( .NOT. llok ) THEN
143            IF(lwp) WRITE(numout,*) ' Setting up assimilation background file '// TRIM( c_asmdin )
144            !
145            !                                      ! Define the output file       
146            CALL iom_open( c_asmdin, inum, ldwrt = .TRUE., kiolib = jprstlib)
147            !
148            IF( nitdin_r == nit000 - 1 ) THEN      ! Treat special case when nitbkg = 0
149
150               zdate = REAL( ndastp )
151            ELSE
152               zdate = REAL( ndastp )
153            ENDIF
154            !
155            !                                      ! Write the information
156            CALL iom_rstput( kt, nitdin_r, inum, 'rdastp' , zdate             )
157            CALL iom_rstput( kt, nitdin_r, inum, 'un'     , un                )
158            CALL iom_rstput( kt, nitdin_r, inum, 'vn'     , vn                )
159            CALL iom_rstput( kt, nitdin_r, inum, 'tn'     , tsn(:,:,:,jp_tem) )
160            CALL iom_rstput( kt, nitdin_r, inum, 'sn'     , tsn(:,:,:,jp_sal) )
161            CALL iom_rstput( kt, nitdin_r, inum, 'sshn'   , sshn              )
162#if defined key_lim2 || defined key_lim3
163            IF(( nn_ice == 2 ) .OR. ( nn_ice == 3 )) THEN
164          IF(ALLOCATED(frld)) THEN
165                  CALL iom_rstput( kt, nitdin_r, inum, 'iceconc', 1.0 - frld(:,:)   )
166               ELSE
167        CALL ctl_warn('Ice concentration not written to background as ice variable frld not allocated on this timestep')
168          ENDIF
169            ENDIF
170#endif
171            !
172            CALL iom_close( inum )
173         ENDIF
174         !
175      ENDIF
176      !                   
177   END SUBROUTINE asm_bkg_wri
178
179   !!======================================================================
180END MODULE asmbkg
Note: See TracBrowser for help on using the repository browser.