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.
step.F90 in branches/DEV_r2106_LOCEAN2010/NEMO/OPA_SRC – NEMO

source: branches/DEV_r2106_LOCEAN2010/NEMO/OPA_SRC/step.F90 @ 2245

Last change on this file since 2245 was 2239, checked in by rblod, 14 years ago

First commit to compile ORCA2_LIM for next nemo v3.3

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 16.3 KB
RevLine 
[3]1MODULE step
2   !!======================================================================
3   !!                       ***  MODULE step  ***
4   !! Time-stepping    : manager of the ocean, tracer and ice time stepping
5   !!======================================================================
[1438]6   !! History :  OPA  !  1991-03  (G. Madec)  Original code
[1492]7   !!             -   !  1991-11  (G. Madec)
8   !!             -   !  1992-06  (M. Imbard)  add a first output record
9   !!             -   !  1996-04  (G. Madec)  introduction of dynspg
10   !!             -   !  1996-04  (M.A. Foujols)  introduction of passive tracer
[1438]11   !!            8.0  !  1997-06  (G. Madec)  new architecture of call
12   !!            8.2  !  1997-06  (G. Madec, M. Imbard, G. Roullet)  free surface
13   !!             -   !  1999-02  (G. Madec, N. Grima)  hpg implicit
14   !!             -   !  2000-07  (J-M Molines, M. Imbard)  Open Bondary Conditions
15   !!   NEMO     1.0  !  2002-06  (G. Madec)  free form, suppress macro-tasking
16   !!             -   !  2004-08  (C. Talandier) New trends organization
[1492]17   !!             -   !  2005-01  (C. Ethe) Add the KPP closure scheme
18   !!             -   !  2005-11  (G. Madec)  Reorganisation of tra and dyn calls
19   !!             -   !  2006-01  (L. Debreu, C. Mazauric)  Agrif implementation
20   !!             -   !  2006-07  (S. Masson)  restart using iom
[1438]21   !!            3.2  !  2009-02  (G. Madec, R. Benshila)  reintroduicing z*-coordinate
[1533]22   !!             -   !  2009-06  (S. Masson, G. Madec)  TKE restart compatible with key_cpl
[2236]23   !!            3.3  !  2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
24   !!             -   !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase + merge TRC-TRA
[3]25   !!----------------------------------------------------------------------
[888]26
27   !!----------------------------------------------------------------------
[3]28   !!   stp            : OPA system time-stepping
29   !!----------------------------------------------------------------------
[2027]30   USE step_oce         ! time stepping definition modules
[2104]31#if defined key_top
32   USE trcstp          ! passive tracer time-stepping      (trc_stp routine)
33#endif
[3]34
[2239]35   USE zdfgls          ! generic length scale case
[2236]36   USE asminc          ! assimilation increments    (tra_asm_inc, dyn_asm_inc routines)
37   USE stpctl          ! time stepping control            (stp_ctl routine)
38   USE restart         ! ocean restart                    (rst_wri routine)
39   USE prtctl          ! Print control                    (prt_ctl routine)
40
41#if defined key_agrif
42   USE agrif_opa_sponge ! Momemtum and tracers sponges
43#endif
44
[3]45   IMPLICIT NONE
46   PRIVATE
47
[1492]48   PUBLIC   stp        ! called by opa.F90
[3]49
50   !! * Substitutions
51#  include "domzgr_substitute.h90"
52#  include "zdfddm_substitute.h90"
53   !!----------------------------------------------------------------------
[2104]54   !! NEMO/OPA 3.3 , LOCEAN-IPSL (2010)
[888]55   !! $Id$
[2236]56   !! Software governed by the CeCILL licence  (NEMOGCM/License_CeCILL.txt)
[3]57   !!----------------------------------------------------------------------
58
59CONTAINS
60
[508]61#if defined key_agrif
62   SUBROUTINE stp( )
[1438]63      INTEGER             ::   kstp   ! ocean time-step index
[508]64#else
[467]65   SUBROUTINE stp( kstp )
[1438]66      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
[467]67#endif
68      !!----------------------------------------------------------------------
[3]69      !!                     ***  ROUTINE stp  ***
70      !!                     
71      !! ** Purpose : - Time stepping of OPA (momentum and active tracer eqs.)
72      !!              - Time stepping of LIM (dynamic and thermodynamic eqs.)
73      !!              - Tme stepping  of TRC (passive tracer eqs.)
74      !!
75      !! ** Method  : -1- Update forcings and data 
76      !!              -2- Update ocean physics
77      !!              -3- Compute the t and s trends
78      !!              -4- Update t and s
79      !!              -5- Compute the momentum trends
80      !!              -6- Update the horizontal velocity
81      !!              -7- Compute the diagnostics variables (rd,N2, div,cur,w)
82      !!              -8- Outputs and diagnostics
83      !!----------------------------------------------------------------------
[888]84      INTEGER ::   jk       ! dummy loop indice
[3]85      INTEGER ::   indic    ! error indicator if < 0
86      !! ---------------------------------------------------------------------
87
[392]88#if defined key_agrif
[389]89      kstp = nit000 + Agrif_Nb_Step()
[1953]90# if defined key_iomput
[2104]91      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap
[1953]92# endif   
[389]93#endif   
[2104]94                             indic = 0                ! reset to no error condition
[2200]95      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
[2104]96                             CALL iom_setkt( kstp )   ! say to iom that we are at time step kstp
[508]97
[3]98      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[888]99      ! Update data, open boundaries, surface boundary condition (including sea-ice)
[3]100      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
101      IF( lk_dtatem  )   CALL dta_tem( kstp )         ! update 3D temperature data
[888]102      IF( lk_dtasal  )   CALL dta_sal( kstp )         ! update 3D salinity data
103                         CALL sbc    ( kstp )         ! Sea Boundary Condition (including sea-ice)
[35]104      IF( lk_obc     )   CALL obc_dta( kstp )         ! update dynamic and tracer data at open boundaries
[3]105      IF( lk_obc     )   CALL obc_rad( kstp )         ! compute phase velocities at open boundaries
[911]106      IF( lk_bdy     )   CALL bdy_dta( kstp )         ! update dynamic and tracer data at unstructured open boundary
107
[1438]108      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]109      !  Ocean dynamics : ssh, wn, hdiv, rot                                 !
[1438]110      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]111                         CALL ssh_wzv( kstp )         ! after ssh & vertical velocity
[3]112
113      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]114      ! Ocean physics update                (ua, va, ta, sa used as workspace)
[3]115      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[2082]116                         CALL bn2( tsb, rn2b )        ! before Brunt-Vaisala frequency
117                         CALL bn2( tsn, rn2  )        ! now    Brunt-Vaisala frequency
[1492]118      !
119      !  VERTICAL PHYSICS   
[1662]120                         CALL zdf_bfr( kstp )         ! bottom friction
[1492]121      !                                               ! Vertical eddy viscosity and diffusivity coefficients
[1531]122      IF( lk_zdfric     )   CALL zdf_ric    ( kstp )  ! Richardson number dependent Kz
123      IF( lk_zdftke_old )   CALL zdf_tke_old( kstp )  ! TKE closure scheme for Kz (old scheme)
124      IF( lk_zdftke     )   CALL zdf_tke    ( kstp )  ! TKE closure scheme for Kz
[2236]125      IF( lk_zdfgls     )   CALL zdf_gls    ( kstp )  ! GLS closure scheme for Kz
[1531]126      IF( lk_zdfkpp     )   CALL zdf_kpp    ( kstp )  ! KPP closure scheme for Kz
127      IF( lk_zdfcst     )   THEN                      ! Constant Kz (reset avt, avm[uv] to the background value)
[1537]128         avt (:,:,:) = rn_avt0 * tmask(:,:,:)
129         avmu(:,:,:) = rn_avm0 * umask(:,:,:)
130         avmv(:,:,:) = rn_avm0 * vmask(:,:,:)
[677]131      ENDIF
[1492]132      IF( ln_rnf_mouth ) THEN                         ! increase diffusivity at rivers mouths
[1246]133         DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:) * tmask(:,:,jk)   ;   END DO
[3]134      ENDIF
[1492]135      IF( ln_zdfevd  )   CALL zdf_evd( kstp )         ! enhanced vertical eddy diffusivity
[3]136
[1492]137      IF( lk_zdftmx  )   CALL zdf_tmx( kstp )         ! tidal vertical mixing
[3]138
[888]139      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
[1492]140         &               CALL zdf_ddm( kstp )         ! double diffusive mixing
141                         CALL zdf_mxl( kstp )         ! mixed layer depth
[3]142
[1531]143                                                      ! write tke information in the restart file
144      IF( lrst_oce .AND. lk_zdftke )   CALL tke_rst( kstp, 'WRITE' )
[2236]145                                                      ! write gls information in the restart file
146      IF( lrst_oce .AND. lk_zdfgls )   CALL gls_rst( kstp, 'WRITE' )
[1492]147      !
148      !  LATERAL  PHYSICS
149      !
150      IF( lk_ldfslp ) THEN                            ! slope of lateral mixing
[2082]151                         CALL eos( tsb, rhd )                ! before in situ density
152         IF( ln_zps )    CALL zps_hde( kstp, jpts, tsb, gtsu, gtsv,  &    ! Partial steps: before horizontal gradient
153            &                                      rhd, gru , grv  )      ! of t, s, rd at the last ocean level
[2236]154         IF ( .NOT. ln_traldf_grif ) THEN
[1492]155                         CALL ldf_slp( kstp, rhd, rn2b )        ! before slope of the lateral mixing
[2236]156         ELSE
157                         CALL ldf_slp_grif( kstp )
158                         IF ( ln_dynldf_bilap .OR. ln_dynldf_iso ) CALL ldf_slp( kstp, rhd, rn2b )
[1481]159      ENDIF
[2236]160      ENDIF
[3]161#if defined key_traldf_c2d
[1492]162      IF( lk_traldf_eiv )   CALL ldf_eiv( kstp )      ! eddy induced velocity coefficient
[1239]163#  endif
[3]164
[1482]165      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]166      ! diagnostics and outputs             (ua, va, ta, sa used as workspace)
[1482]167      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]168      IF( lk_floats  )   CALL flo_stp( kstp )         ! drifting Floats
169      IF( lk_diahth  )   CALL dia_hth( kstp )         ! Thermocline depth (20 degres isotherm depth)
170      IF( lk_diagap  )   CALL dia_gap( kstp )         ! basin averaged diagnostics
171      IF( lk_diahdy  )   CALL dia_hdy( kstp )         ! dynamical heigh diagnostics
172      IF( lk_diafwb  )   CALL dia_fwb( kstp )         ! Fresh water budget diagnostics
[2236]173      IF( lk_diaobs  )   CALL dia_obs( kstp )         ! obs-minus-model (assimilation) diagnostics
[1492]174      IF( ln_diaptr  )   CALL dia_ptr( kstp )         ! Poleward TRansports diagnostics
[1756]175      IF( lk_diaar5  )   CALL dia_ar5( kstp )         ! ar5 diag
[1635]176                         CALL dia_wri( kstp )         ! ocean model: outputs
[1482]177
[923]178#if defined key_top
[3]179      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
180      ! Passive Tracer Model
181      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]182                         CALL trc_stp( kstp )         ! time-stepping
[3]183#endif
184
185      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]186      ! Active tracers                              (ua, va used as workspace)
[3]187      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[2082]188                             tsa(:,:,:,:) = 0.e0               ! set tracer trends to zero
[3]189
[2236]190      IF(  ln_asmiau .AND. &
191         & ln_trainc     )   CALL tra_asm_inc( kstp )       ! apply tracer assimilation increment
[467]192                             CALL tra_sbc    ( kstp )       ! surface boundary condition
193      IF( ln_traqsr      )   CALL tra_qsr    ( kstp )       ! penetrative solar radiation qsr
194      IF( lk_trabbc      )   CALL tra_bbc    ( kstp )       ! bottom heat flux
[2027]195      IF( lk_trabbl      )   CALL tra_bbl    ( kstp )       ! advective (and/or diffusive) bottom boundary layer scheme
[467]196      IF( lk_tradmp      )   CALL tra_dmp    ( kstp )       ! internal damping trends
197                             CALL tra_adv    ( kstp )       ! horizontal & vertical advection
198      IF( n_cla == 1     )   CALL tra_cla    ( kstp )       ! Cross Land Advection (Update Hor. advection)
199      IF( lk_zdfkpp )        CALL tra_kpp    ( kstp )       ! KPP non-local tracer fluxes
200                             CALL tra_ldf    ( kstp )       ! lateral mixing
[392]201#if defined key_agrif
[2027]202                             CALL tra_unswap
[782]203      IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra          ! tracers sponge
[2027]204                             CALL tra_swap
[389]205#endif
[1111]206                             CALL tra_zdf    ( kstp )       ! vertical mixing and after tracer fields
[1239]207
[1492]208      IF( ln_dynhpg_imp  ) THEN                             ! semi-implicit hpg (time stepping then eos)
209         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )            ! update after fields by non-penetrative convection
210                             CALL tra_nxt    ( kstp )            ! tracer fields at next time step
[2082]211                             CALL eos( tsa, rhd, rhop )       ! Time-filtered in situ density for hpg computation
[2104]212         IF( ln_zps      )   CALL zps_hde( kstp, jpts, tsa, gtsu, gtsv,  &    ! zps: time filtered hor. derivative
[2082]213            &                                          rhd, gru , grv  )      ! of t, s, rd at the last ocean level
[1492]214         
215      ELSE                                                  ! centered hpg  (eos then time stepping)
[2082]216                             CALL eos( tsn, rhd, rhop )       ! now in situ density for hpg computation
[2104]217         IF( ln_zps      )   CALL zps_hde( kstp, jpts, tsn, gtsu, gtsv,  &    ! zps: now hor. derivative
[2082]218            &                                          rhd, gru , grv  )      ! of t, s, rd at the last ocean level
[1492]219         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )       ! update after fields by non-penetrative convection
220                             CALL tra_nxt    ( kstp )       ! tracer fields at next time step
[2082]221      ENDIF
[2027]222                             CALL tra_unswap
[1481]223
[3]224      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]225      ! Dynamics                                    (ta, sa used as workspace)
[3]226      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]227                               ua(:,:,:) = 0.e0             ! set dynamics trends to zero
[75]228                               va(:,:,:) = 0.e0
[3]229
[2236]230      IF(  ln_asmiau .AND. &
231         & ln_dyninc     )     CALL dyn_asm_inc( kstp )       ! apply dynamics assimilation increment
[1492]232                               CALL dyn_adv( kstp )         ! advection (vector or flux form)
233                               CALL dyn_vor( kstp )         ! vorticity term including Coriolis
234                               CALL dyn_ldf( kstp )         ! lateral mixing
[392]235#if defined key_agrif
[1492]236      IF(.NOT. Agrif_Root())   CALL Agrif_Sponge_dyn        ! momemtum sponge
[389]237#endif
[1492]238                               CALL dyn_hpg( kstp )         ! horizontal gradient of Hydrostatic pressure
[1662]239                               CALL dyn_bfr( kstp )           ! bottom friction   
[1492]240                               CALL dyn_zdf( kstp )         ! vertical diffusion
241                               CALL dyn_spg( kstp, indic )  ! surface pressure gradient
242                               CALL dyn_nxt( kstp )         ! lateral velocity at next time step
[3]243
[1492]244                               CALL ssh_nxt( kstp )         ! sea surface height at next time step
[593]245
[2148]246      IF( ln_diahsb        )   CALL dia_hsb( kstp )         ! - ML - global conservation diagnostics
247
[3]248      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[888]249      ! Control and restarts
[3]250      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]251                               CALL stp_ctl( kstp, indic )
252      IF( indic < 0        )   THEN
253                               CALL ctl_stop( 'step: indic < 0' )
254                               CALL dia_wri_state( 'output.abort', kstp )
[1482]255      ENDIF
[1492]256      IF( kstp == nit000   )   CALL iom_close( numror )     ! close input  ocean restart file
257      IF( lrst_oce         )   CALL rst_write    ( kstp )   ! write output ocean restart file
258      IF( lk_obc           )   CALL obc_rst_write( kstp )   ! write open boundary restart file
[3]259
[508]260      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]261      ! Trends                              (ua, va, ta, sa used as workspace)
[508]262      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]263      IF( nstop == 0 ) THEN                         
264         IF( lk_trddyn     )   CALL trd_dwr( kstp )         ! trends: dynamics
265         IF( lk_trdtra     )   CALL trd_twr( kstp )         ! trends: active tracers
266         IF( lk_trdmld     )   CALL trd_mld( kstp )         ! trends: Mixed-layer
267         IF( lk_trdvor     )   CALL trd_vor( kstp )         ! trends: vorticity budget
[75]268      ENDIF
[3]269
[75]270      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
271      ! Coupled mode
272      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]273      IF( lk_cpl           )   CALL sbc_cpl_snd( kstp )     ! coupled mode : field exchanges
[508]274      !
[1481]275      !
[3]276   END SUBROUTINE stp
277
278   !!======================================================================
279END MODULE step
Note: See TracBrowser for help on using the repository browser.