source: NEMO/trunk/src/SAS/step.F90

Last change on this file was 13970, checked in by andmirek, 2 days ago

Ticket #2462 into the trunk

  • Property svn:keywords set to Id
File size: 8.1 KB
Line 
1MODULE step
2   !!======================================================================
3   !!                       ***  MODULE step  ***
4   !! Time-stepping    : manager of the ocean, tracer and ice time stepping
5   !!                    version for standalone surface scheme
6   !!======================================================================
7   !! History :  OPA  !  1991-03  (G. Madec)  Original code
8   !!             .   !    .                                                     
9   !!             .   !    .                                                     
10   !!   NEMO     3.5  !  2012-03  (S. Alderson)
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   stp             : OPA system time-stepping
15   !!----------------------------------------------------------------------
16   USE oce              ! ocean dynamics and tracers variables
17   USE dom_oce          ! ocean space and time domain variables
18   USE daymod           ! calendar                         (day     routine)
19   USE sbc_oce          ! surface boundary condition: fields
20   USE sbcmod           ! surface boundary condition       (sbc     routine)
21   USE sbcrnf           ! surface boundary condition: runoff variables
22   USE sbccpl           ! surface boundary condition: coupled interface
23   USE eosbn2           ! equation of state                (eos_bn2 routine)
24   USE diawri           ! Standard run outputs             (dia_wri routine)
25   USE bdy_oce   , ONLY: ln_bdy
26   USE bdydta           ! mandatory for sea-ice
27   USE stpctl           ! time stepping control            (stp_ctl routine)
28   !
29   USE in_out_manager   ! I/O manager
30   USE prtctl           ! Print control                    (prt_ctl routine)
31   USE iom              !
32   USE lbclnk           !
33   USE timing           ! Timing           
34#if defined key_iomput
35   USE xios
36#endif
37
38#if defined key_agrif
39   USE agrif_oce, ONLY: lk_agrif_debug
40#if defined key_si3
41   USE agrif_ice_update
42#endif
43#endif
44   
45   IMPLICIT NONE
46   PRIVATE
47
48   PUBLIC   stp   ! called by nemogcm.F90
49
50   !!----------------------------------------------------------------------
51   !! time level indices
52   !!----------------------------------------------------------------------
53   INTEGER, PUBLIC :: Nbb, Nnn, Naa, Nrhs          !! used by nemo_init
54   !!----------------------------------------------------------------------
55   !! NEMO/SAS 4.0 , NEMO Consortium (2018)
56   !! $Id$
57   !! Software governed by the CeCILL license (see ./LICENSE)
58   !!----------------------------------------------------------------------
59CONTAINS
60
61#if defined key_agrif
62   RECURSIVE SUBROUTINE stp( )
63      INTEGER             ::   kstp   ! ocean time-step index
64#else
65   SUBROUTINE stp( kstp )
66      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
67#endif
68      !!----------------------------------------------------------------------
69      !!                     ***  ROUTINE stp  ***
70      !!                     
71      !! ** Purpose : - Time stepping of SBC (surface boundary)
72      !!
73      !! ** Method  : -1- Update forcings and data 
74      !!              -2- Outputs and diagnostics
75      !!----------------------------------------------------------------------
76
77#if defined key_agrif
78      IF( nstop > 0 ) RETURN   ! avoid to go further if an error was detected during previous time step (child grid)
79      kstp = nit000 + Agrif_Nb_Step()
80      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
81      IF( lk_agrif_debug ) THEN
82         IF( Agrif_Root() .and. lwp)   WRITE(*,*) '---'
83         IF(lwp)   WRITE(*,*) 'Grid Number', Agrif_Fixed(),' time step ', kstp, 'int tstep', Agrif_NbStepint()
84      ENDIF
85      IF( kstp == nit000 + 1 )   lk_agrif_fstep = .FALSE.
86# if defined key_iomput
87      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap( cxios_context )
88# endif   
89#endif   
90      IF( kstp == nit000 )   CALL iom_init( cxios_context ) ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
91                             CALL iom_setkt( kstp - nit000 + 1, cxios_context )   ! tell iom we are at time step kstp
92      IF((kstp == nitrst) .AND. lwxios) THEN
93         CALL iom_swap(      cw_ocerst_cxt          )
94         CALL iom_init_closedef(cw_ocerst_cxt)
95         CALL iom_setkt( kstp - nit000 + 1,      cw_ocerst_cxt          )
96#if defined key_top
97         CALL iom_swap(      cw_toprst_cxt          )
98         CALL iom_init_closedef(cw_toprst_cxt)
99         CALL iom_setkt( kstp - nit000 + 1,      cw_toprst_cxt          )
100#endif
101      ENDIF
102      IF( kstp /= nit000 )   CALL day( kstp )             ! Calendar (day was already called at nit000 in day_init)
103
104#if defined key_si3
105      IF(((kstp + nn_fsbc - 1) == nitrst) .AND. lwxios) THEN
106         CALL iom_swap(      cw_icerst_cxt          )
107         CALL iom_init_closedef(cw_icerst_cxt)
108         CALL iom_setkt( kstp - nit000 + 1,      cw_icerst_cxt          )
109      ENDIF
110#endif
111
112      ! ==> clem: open boundaries is mandatory for sea-ice because ice BDY is not decoupled from 
113      !           the environment of ocean BDY. Therefore bdy is called in both OPA and SAS modules.
114      !           From SAS: ocean bdy data are wrong  (but we do not care) and ice bdy data are OK. 
115      !           This is not clean and should be changed in the future.
116      ! ==>
117      IF( ln_bdy     )       CALL bdy_dta( kstp,      Nnn )                   ! update dynamic & tracer data at open boundaries
118                             CALL sbc    ( kstp, Nbb, Nnn )                   ! Sea Boundary Condition (including sea-ice)
119
120                             CALL dia_wri( kstp,      Nnn )                   ! ocean model: outputs
121
122#if defined key_agrif
123      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
124      ! AGRIF recursive integration
125      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
126                             CALL Agrif_Integrate_ChildGrids( stp )
127                             
128#endif                             
129      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
130      ! Control
131      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
132                             CALL stp_ctl( kstp, Nnn )
133
134#if defined key_agrif
135      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
136      ! AGRIF update
137      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
138      IF( Agrif_NbStepint() == 0 .AND. nstop == 0 ) THEN                       ! AGRIF Update from zoom N to zoom 1 then to Parent
139#if defined key_si3
140                             CALL Agrif_Update_ice( )   ! update sea-ice
141#endif
142      ENDIF
143
144#endif
145      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
146      ! File manipulation at the end of the first time step
147      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<                         
148      IF( kstp == nit000   ) THEN
149            CALL iom_close( numror )                          ! close input  ocean restart file
150            IF( lrxios )     CALL iom_context_finalize(      cr_ocerst_cxt      )
151      ENDIF
152     
153      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
154      ! Coupled mode
155      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
156      IF( lk_oasis .AND. nstop == 0 ) CALL sbc_cpl_snd( kstp, Nbb, Nnn )       ! coupled mode : field exchanges if OASIS-coupled ice
157
158#if defined key_iomput
159      IF( kstp == nitrst ) THEN
160         IF(.NOT.lwxios) THEN
161            CALL iom_close( numrow )     
162         ELSE
163            CALL iom_context_finalize( cw_ocerst_cxt )
164            iom_file(numrow)%nfid       = 0
165            numrow = 0
166         ENDIF
167         lrst_oce = .FALSE.
168      ENDIF
169      IF( kstp == nitend .OR. nstop > 0 ) THEN
170         CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF
171      ENDIF
172#endif
173      !
174      IF( ln_timing .AND.  kstp == nit000  )   CALL timing_reset
175      !
176   END SUBROUTINE stp
177
178   !!======================================================================
179END MODULE step
Note: See TracBrowser for help on using the repository browser.