MODULE asmbkg !!====================================================================== !! *** MODULE asmtrj -> asmbkg *** !! Assimilation trajectory interface: Write to file the background state and the model state trajectory !!====================================================================== !! History : ! 2007-03 (M. Martin) Met. Office version !! ! 2007-04 (A. Weaver) asm_trj_wri, original code !! ! 2007-03 (K. Mogensen) Adapt to NEMOVAR and use IOM instead of IOIPSL !! ! 2007-04 (A. Weaver) Name change (formally asmbkg.F90). Distinguish !! background states in Jb term and at analysis time. !! Include state trajectory routine (currently empty) !! ! 2007-07 (A. Weaver) Add tke_rst and flt_rst for case nitbkg=0 !! ! 2009-03 (F. Vigilant) Add hmlp (zdfmxl) for no tracer nmldp=2 !! ! 2009-06 (F. Vigilant) asm_trj_wri: special case when kt=nit000-1 !! ! 2009-07 (F. Vigilant) asm_trj_wri: add computation of eiv at restart !! ! 2010-01 (A. Vidard) split asm_trj_wri into tam_trj_wri and asm_bkg_wri !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! 'key_asminc' : Switch on the assimilation increment interface !!---------------------------------------------------------------------- !! asm_bkg_wri : Write out the background state !! asm_trj_wri : Write out the model state trajectory (used with 4D-Var) !!---------------------------------------------------------------------- USE oce ! Dynamics and active tracers defined in memory USE sbc_oce ! Ocean surface boundary conditions USE zdf_oce ! Vertical mixing variables USE zdfddm ! Double diffusion mixing parameterization USE ldftra_oce ! Lateral tracer mixing coefficient defined in memory USE ldfslp ! Slopes of neutral surfaces USE tradmp ! Tracer damping #if defined key_zdftke USE zdftke ! TKE vertical physics #endif USE eosbn2 ! Equation of state (eos_bn2 routine) USE zdfmxl ! Mixed layer depth USE dom_oce, ONLY : ndastp USE sol_oce, ONLY : gcx ! Solver variables defined in memory USE in_out_manager ! I/O manager USE iom ! I/O module USE asmpar ! Parameters for the assmilation interface USE zdfmxl ! mixed layer depth #if defined key_traldf_c2d USE ldfeiv ! eddy induced velocity coef. (ldf_eiv routine) #endif #if defined key_lim2 USE ice_2 #endif #if defined key_lim3 USE ice #endif USE timing IMPLICIT NONE PRIVATE PUBLIC asm_bkg_wri !: Write out the background state !!---------------------------------------------------------------------- !! NEMO/OPA 3.3 , NEMO Consortium (2010) !! $Id$ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE asm_bkg_wri( kt ) !!----------------------------------------------------------------------- !! *** ROUTINE asm_bkg_wri *** !! !! ** Purpose : Write to file the background state for later use in the !! inner loop of data assimilation or for direct initialization !! in the outer loop. !! !! ** Method : Write out the background state for use in the Jb term !! in the cost function and for use with direct initialization !! at analysis time. !!----------------------------------------------------------------------- INTEGER, INTENT( IN ) :: kt ! Current time-step ! CHARACTER (LEN=50) :: cl_asmbkg CHARACTER (LEN=50) :: cl_asmdin LOGICAL :: llok ! Check if file exists INTEGER :: inum ! File unit number REAL(wp) :: zdate ! Date !!----------------------------------------------------------------------- ! !------------------------------------------- IF( kt == nitbkg_r ) THEN ! Write out background at time step nitbkg_r ! !-----------------------------------======== ! WRITE(cl_asmbkg, FMT='(A,".nc")' ) TRIM( c_asmbkg ) cl_asmbkg = TRIM( cl_asmbkg ) INQUIRE( FILE = cl_asmbkg, EXIST = llok ) ! IF( .NOT. llok ) THEN IF(lwp) WRITE(numout,*) ' Setting up assimilation background file '// TRIM( c_asmbkg ) ! ! ! Define the output file CALL iom_open( c_asmbkg, inum, ldwrt = .TRUE., kiolib = jprstlib) ! IF( nitbkg_r == nit000 - 1 ) THEN ! Treat special case when nitbkg = 0 zdate = REAL( ndastp ) #if defined key_zdftke ! lk_zdftke=T : Read turbulent kinetic energy ( en ) IF(lwp) WRITE(numout,*) ' Reading TKE (en) from restart...' CALL tke_rst( nit000, 'READ' ) ! lk_zdftke=T : Read turbulent kinetic energy ( en ) #endif ELSE zdate = REAL( ndastp ) ENDIF ! ! ! Write the information IF(nn_timing == 2) CALL timing_start('iom_rstput') CALL iom_rstput( kt, nitbkg_r, inum, 'rdastp' , zdate ) CALL iom_rstput( kt, nitbkg_r, inum, 'un' , un ) CALL iom_rstput( kt, nitbkg_r, inum, 'vn' , vn ) CALL iom_rstput( kt, nitbkg_r, inum, 'tn' , tsn(:,:,:,jp_tem) ) CALL iom_rstput( kt, nitbkg_r, inum, 'sn' , tsn(:,:,:,jp_sal) ) CALL iom_rstput( kt, nitbkg_r, inum, 'sshn' , sshn ) #if defined key_zdftke CALL iom_rstput( kt, nitbkg_r, inum, 'en' , en ) #endif CALL iom_rstput( kt, nitbkg_r, inum, 'gcx' , gcx ) IF(nn_timing == 2) CALL timing_stop('iom_rstput') ! CALL iom_close( inum ) ENDIF ! ENDIF ! !------------------------------------------- IF( kt == nitdin_r ) THEN ! Write out background at time step nitdin_r ! !-----------------------------------======== ! WRITE(cl_asmdin, FMT='(A,".nc")' ) TRIM( c_asmdin ) cl_asmdin = TRIM( cl_asmdin ) INQUIRE( FILE = cl_asmdin, EXIST = llok ) ! IF( .NOT. llok ) THEN IF(lwp) WRITE(numout,*) ' Setting up assimilation background file '// TRIM( c_asmdin ) ! ! ! Define the output file CALL iom_open( c_asmdin, inum, ldwrt = .TRUE., kiolib = jprstlib) ! IF( nitdin_r == nit000 - 1 ) THEN ! Treat special case when nitbkg = 0 zdate = REAL( ndastp ) ELSE zdate = REAL( ndastp ) ENDIF ! ! ! Write the information IF(nn_timing == 2) CALL timing_start('iom_rstput') CALL iom_rstput( kt, nitdin_r, inum, 'rdastp' , zdate ) CALL iom_rstput( kt, nitdin_r, inum, 'un' , un ) CALL iom_rstput( kt, nitdin_r, inum, 'vn' , vn ) CALL iom_rstput( kt, nitdin_r, inum, 'tn' , tsn(:,:,:,jp_tem) ) CALL iom_rstput( kt, nitdin_r, inum, 'sn' , tsn(:,:,:,jp_sal) ) CALL iom_rstput( kt, nitdin_r, inum, 'sshn' , sshn ) #if defined key_lim2 || defined key_lim3 IF(( nn_ice == 2 ) .OR. ( nn_ice == 3 )) THEN IF(ALLOCATED(frld)) THEN CALL iom_rstput( kt, nitdin_r, inum, 'iceconc', 1.0 - frld(:,:) ) ELSE CALL ctl_warn('Ice concentration not written to background as ice variable frld not allocated on this timestep') ENDIF ENDIF #endif IF(nn_timing == 2) CALL timing_stop('iom_rstput') ! CALL iom_close( inum ) ENDIF ! ENDIF ! END SUBROUTINE asm_bkg_wri !!====================================================================== END MODULE asmbkg