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_c1d.F90 in branches/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/OPA_SRC/C1D – NEMO

source: branches/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/OPA_SRC/C1D/step_c1d.F90 @ 5845

Last change on this file since 5845 was 5845, checked in by gm, 9 years ago

#1613: vvl by default: suppression of domzgr_substitute.h90

  • Property svn:keywords set to Id
File size: 9.2 KB
Line 
1MODULE step_c1d
2   !!======================================================================
3   !!                       ***  MODULE step_c1d  ***
4   !! Time-stepping    : manager of the ocean, tracer and ice time stepping - c1d case
5   !!======================================================================
6   !! History :   2.0  !  2004-04  (C. Ethe)  adapted from step.F90 for C1D
7   !!             3.0  !  2008-04  (G. Madec)  redo the adaptation to include SBC
8   !!----------------------------------------------------------------------
9#if defined key_c1d
10   !!----------------------------------------------------------------------
11   !!   'key_c1d'                                       1D Configuration
12   !!---------------------------------------------------------------------- 
13   !!   stp_c1d        : NEMO system time-stepping in c1d case
14   !!----------------------------------------------------------------------
15   USE step_oce        ! time stepping definition modules
16#if defined key_top
17   USE trcstp          ! passive tracer time-stepping      (trc_stp routine)
18#endif
19   USE dyncor_c1d      ! Coriolis term (c1d case)         (dyn_cor_1d     )
20   USE dynnxt_c1d      ! time-stepping                    (dyn_nxt routine)
21   USE dyndmp          ! U & V momentum damping           (dyn_dmp routine)
22   USE restart         ! restart
23
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC stp_c1d      ! called by opa.F90
28
29   !! * Substitutions
30#  include "zdfddm_substitute.h90"
31   !!----------------------------------------------------------------------
32   !! NEMO/C1D 3.3 , NEMO Consortium (2010)
33   !! $Id$
34   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
35   !!----------------------------------------------------------------------
36CONTAINS
37
38   SUBROUTINE stp_c1d( kstp )
39      !!----------------------------------------------------------------------
40      !!                     ***  ROUTINE stp_c1d  ***
41      !!                     
42      !! ** Purpose :  - Time stepping of SBC including LIM (dynamic and thermodynamic eqs.)
43      !!               - Time stepping of OPA (momentum and active tracer eqs.)
44      !!               - Time stepping of TOP (passive tracer eqs.)
45      !!
46      !! ** Method  : -1- Update forcings and data 
47      !!              -2- Update vertical ocean physics
48      !!              -3- Compute the t and s trends
49      !!              -4- Update t and s
50      !!              -5- Compute the momentum trends
51      !!              -6- Update the horizontal velocity
52      !!              -7- Compute the diagnostics variables (rd,N2, div,cur,w)
53      !!              -8- Outputs and diagnostics
54      !!----------------------------------------------------------------------
55      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
56      INTEGER ::   jk       ! dummy loop indice
57      INTEGER ::   indic    ! error indicator if < 0
58      !! ---------------------------------------------------------------------
59
60                             indic = 0                ! reset to no error condition
61      IF( kstp == nit000 )   CALL iom_init( "nemo")   ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
62      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
63                             CALL iom_setkt( kstp - nit000 + 1, "nemo" )   ! say to iom that we are at time step kstp
64
65      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
66      ! Update data, open boundaries, surface boundary condition (including sea-ice)
67      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
68                         CALL sbc    ( kstp )         ! Sea Boundary Condition (including sea-ice)
69
70      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
71      ! Ocean physics update                (ua, va, ta, sa used as workspace)
72      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
73                         CALL eos_rab( tsb, rab_b )   ! before local thermal/haline expension ratio at T-points
74                         CALL eos_rab( tsn, rab_n )   ! now    local thermal/haline expension ratio at T-points
75                         CALL bn2( tsb, rab_b, rn2b ) ! before Brunt-Vaisala frequency
76                         CALL bn2( tsn, rab_n, rn2  ) ! now    Brunt-Vaisala frequency
77      !  VERTICAL PHYSICS   
78                         CALL zdf_bfr( kstp )         ! bottom friction
79      !                                               ! Vertical eddy viscosity and diffusivity coefficients
80      IF( lk_zdfric  )   CALL zdf_ric( kstp )            ! Richardson number dependent Kz
81      IF( lk_zdftke  )   CALL zdf_tke( kstp )            ! TKE closure scheme for Kz
82      IF( lk_zdfgls  )   CALL zdf_gls( kstp )            ! GLS closure scheme for Kz
83      IF( lk_zdfcst  )   THEN                            ! Constant Kz (reset avt, avm[uv] to the background value)
84         avt (:,:,:) = rn_avt0 * tmask(:,:,:)
85         avmu(:,:,:) = rn_avm0 * umask(:,:,:)
86         avmv(:,:,:) = rn_avm0 * vmask(:,:,:)
87      ENDIF
88
89      IF( ln_rnf_mouth ) THEN                         ! increase diffusivity at rivers mouths
90         DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:)   ;   END DO
91      ENDIF
92      IF( ln_zdfevd  )   CALL zdf_evd( kstp )         ! enhanced vertical eddy diffusivity
93      IF( lk_zdftmx  )   CALL zdf_tmx( kstp )         ! tidal vertical mixing
94      IF( lk_zdfddm  )   CALL zdf_ddm( kstp )         ! double diffusive mixing
95                         CALL zdf_mxl( kstp )         ! mixed layer depth
96
97                                                      ! write tke information in the restart file
98      IF( lrst_oce .AND. lk_zdftke )   CALL tke_rst( kstp, 'WRITE' )
99                                                      ! write gls information in the restart file
100      IF( lrst_oce .AND. lk_zdfgls )   CALL gls_rst( kstp, 'WRITE' )
101
102      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
103      ! diagnostics and outputs             (ua, va, ta, sa used as workspace)
104      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
105                         CALL dia_wri( kstp )       ! ocean model: outputs
106      IF( lk_diahth  )   CALL dia_hth( kstp )       ! Thermocline depth (20°C)
107
108
109#if defined key_top
110      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
111      ! Passive Tracer Model
112      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
113                        CALL trc_stp( kstp )       ! time-stepping
114#endif
115
116      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
117      ! Active tracers                              (ua, va used as workspace)
118      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
119                        tsa(:,:,:,:) = 0._wp       ! set tracer trends to zero
120
121                        CALL tra_sbc( kstp )       ! surface boundary condition
122      IF( ln_traqsr )   CALL tra_qsr( kstp )       ! penetrative solar radiation qsr
123      IF( ln_tradmp )   CALL tra_dmp( kstp )       ! internal damping trends- tracers
124                        CALL tra_zdf( kstp )       ! vertical mixing
125                        CALL eos( tsn, rhd, rhop, gdept_0(:,:,:) )   ! now potential density for zdfmxl
126      IF( ln_zdfnpc )   CALL tra_npc( kstp )       ! applied non penetrative convective adjustment on (t,s)
127                        CALL tra_nxt( kstp )       ! tracer fields at next time step
128
129
130
131      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
132      ! Dynamics                                    (ta, sa used as workspace)
133      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
134                        ua(:,:,:) = 0._wp          ! set dynamics trends to zero
135                        va(:,:,:) = 0._wp
136
137      IF( ln_dyndmp )   CALL dyn_dmp    ( kstp )   ! internal damping trends- momentum
138                        CALL dyn_cor_c1d( kstp )   ! vorticity term including Coriolis
139                        CALL dyn_zdf    ( kstp )   ! vertical diffusion
140                        CALL dyn_nxt_c1d( kstp )   ! lateral velocity at next time step
141
142      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
143      ! Control and restarts
144      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
145                             CALL stp_ctl( kstp, indic )
146      IF( kstp == nit000 )   CALL iom_close( numror )      ! close input  ocean restart file
147      IF( lrst_oce       )   CALL rst_write( kstp )        ! write output ocean restart file
148      !
149#if defined key_iomput
150      IF( kstp == nitend .OR. indic < 0 )   CALL xios_context_finalize()   ! needed for XIOS
151      !
152#endif
153   END SUBROUTINE stp_c1d
154
155#else
156   !!----------------------------------------------------------------------
157   !!   Default key                                            NO 1D Config
158   !!----------------------------------------------------------------------
159CONTAINS
160   SUBROUTINE stp_c1d ( kt )      ! dummy routine
161      WRITE(*,*) 'stp_c1d: You should not have seen this print! error?', kt
162   END SUBROUTINE stp_c1d
163#endif
164
165   !!======================================================================
166END MODULE step_c1d
Note: See TracBrowser for help on using the repository browser.