| 1 | MODULE 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 | !!---------------------------------------------------------------------- |
|---|
| 59 | CONTAINS |
|---|
| 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 | IF( kstp /= nit000 ) CALL day( kstp ) ! Calendar (day was already called at nit000 in day_init) |
|---|
| 92 | CALL iom_setkt( kstp - nit000 + 1, cxios_context ) ! tell iom we are at time step kstp |
|---|
| 93 | |
|---|
| 94 | ! ==> clem: open boundaries is mandatory for sea-ice because ice BDY is not decoupled from |
|---|
| 95 | ! the environment of ocean BDY. Therefore bdy is called in both OPA and SAS modules. |
|---|
| 96 | ! From SAS: ocean bdy data are wrong (but we do not care) and ice bdy data are OK. |
|---|
| 97 | ! This is not clean and should be changed in the future. |
|---|
| 98 | ! ==> |
|---|
| 99 | IF( ln_bdy ) CALL bdy_dta( kstp, Nnn ) ! update dynamic & tracer data at open boundaries |
|---|
| 100 | CALL sbc ( kstp, Nbb, Nnn ) ! Sea Boundary Condition (including sea-ice) |
|---|
| 101 | |
|---|
| 102 | CALL dia_wri( kstp, Nnn ) ! ocean model: outputs |
|---|
| 103 | |
|---|
| 104 | #if defined key_agrif |
|---|
| 105 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
|---|
| 106 | ! AGRIF recursive integration |
|---|
| 107 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
|---|
| 108 | CALL Agrif_Integrate_ChildGrids( stp ) |
|---|
| 109 | |
|---|
| 110 | #endif |
|---|
| 111 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
|---|
| 112 | ! Control |
|---|
| 113 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
|---|
| 114 | CALL stp_ctl( kstp, Nnn ) |
|---|
| 115 | |
|---|
| 116 | #if defined key_agrif |
|---|
| 117 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
|---|
| 118 | ! AGRIF update |
|---|
| 119 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
|---|
| 120 | IF( Agrif_NbStepint() == 0 .AND. nstop == 0 ) THEN ! AGRIF Update from zoom N to zoom 1 then to Parent |
|---|
| 121 | #if defined key_si3 |
|---|
| 122 | CALL Agrif_Update_ice( ) ! update sea-ice |
|---|
| 123 | #endif |
|---|
| 124 | ENDIF |
|---|
| 125 | |
|---|
| 126 | #endif |
|---|
| 127 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
|---|
| 128 | ! File manipulation at the end of the first time step |
|---|
| 129 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
|---|
| 130 | IF( kstp == nit000 ) CALL iom_close( numror ) ! close input ocean restart file |
|---|
| 131 | |
|---|
| 132 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
|---|
| 133 | ! Coupled mode |
|---|
| 134 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
|---|
| 135 | IF( lk_oasis .AND. nstop == 0 ) CALL sbc_cpl_snd( kstp, Nbb, Nnn ) ! coupled mode : field exchanges if OASIS-coupled ice |
|---|
| 136 | |
|---|
| 137 | #if defined key_iomput |
|---|
| 138 | IF( kstp == nitrst ) THEN |
|---|
| 139 | IF(.NOT.lwxios) THEN |
|---|
| 140 | CALL iom_close( numrow ) |
|---|
| 141 | ELSE |
|---|
| 142 | CALL iom_context_finalize( cwxios_context ) |
|---|
| 143 | ENDIF |
|---|
| 144 | lrst_oce = .FALSE. |
|---|
| 145 | ENDIF |
|---|
| 146 | IF( kstp == nitend .OR. nstop > 0 ) THEN |
|---|
| 147 | CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF |
|---|
| 148 | ENDIF |
|---|
| 149 | #endif |
|---|
| 150 | ! |
|---|
| 151 | IF( ln_timing .AND. kstp == nit000 ) CALL timing_reset |
|---|
| 152 | ! |
|---|
| 153 | END SUBROUTINE stp |
|---|
| 154 | |
|---|
| 155 | !!====================================================================== |
|---|
| 156 | END MODULE step |
|---|
