[3331] | 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 |
---|
[3362] | 8 | !! . ! . |
---|
| 9 | !! . ! . |
---|
| 10 | !! NEMO 3.5 ! 2012-03 (S. Alderson) |
---|
[3331] | 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) |
---|
[6140] | 19 | USE sbc_oce ! surface boundary condition: fields |
---|
[3331] | 20 | USE sbcmod ! surface boundary condition (sbc routine) |
---|
| 21 | USE sbcrnf ! surface boundary condition: runoff variables |
---|
[6140] | 22 | USE sbccpl ! surface boundary condition: coupled interface |
---|
[3331] | 23 | USE eosbn2 ! equation of state (eos_bn2 routine) |
---|
| 24 | USE diawri ! Standard run outputs (dia_wri routine) |
---|
[7646] | 25 | USE bdy_oce , ONLY: ln_bdy |
---|
[9019] | 26 | USE bdydta ! mandatory for sea-ice |
---|
[6140] | 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 |
---|
[5510] | 37 | |
---|
[7646] | 38 | #if defined key_agrif |
---|
[9019] | 39 | USE agrif_oce, ONLY: lk_agrif_debug |
---|
[9570] | 40 | #if defined key_si3 |
---|
[9596] | 41 | USE agrif_ice_update |
---|
[7646] | 42 | #endif |
---|
[9510] | 43 | #endif |
---|
[7646] | 44 | |
---|
[3331] | 45 | IMPLICIT NONE |
---|
| 46 | PRIVATE |
---|
| 47 | |
---|
[6140] | 48 | PUBLIC stp ! called by nemogcm.F90 |
---|
[3331] | 49 | |
---|
| 50 | !!---------------------------------------------------------------------- |
---|
[12377] | 51 | !! time level indices |
---|
| 52 | !!---------------------------------------------------------------------- |
---|
| 53 | INTEGER, PUBLIC :: Nbb, Nnn, Naa, Nrhs !! used by nemo_init |
---|
| 54 | !!---------------------------------------------------------------------- |
---|
[10068] | 55 | !! NEMO/SAS 4.0 , NEMO Consortium (2018) |
---|
[5215] | 56 | !! $Id$ |
---|
[10068] | 57 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3331] | 58 | !!---------------------------------------------------------------------- |
---|
| 59 | CONTAINS |
---|
| 60 | |
---|
| 61 | #if defined key_agrif |
---|
[7761] | 62 | RECURSIVE SUBROUTINE stp( ) |
---|
[3331] | 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 | !! |
---|
[3358] | 71 | !! ** Purpose : - Time stepping of SBC (surface boundary) |
---|
[3331] | 72 | !! |
---|
| 73 | !! ** Method : -1- Update forcings and data |
---|
[3358] | 74 | !! -2- Outputs and diagnostics |
---|
[3331] | 75 | !!---------------------------------------------------------------------- |
---|
| 76 | INTEGER :: indic ! error indicator if < 0 |
---|
| 77 | !! --------------------------------------------------------------------- |
---|
| 78 | |
---|
| 79 | #if defined key_agrif |
---|
[12650] | 80 | IF( nstop > 0 ) return ! avoid to go further if an error was detected during previous time step |
---|
[3331] | 81 | kstp = nit000 + Agrif_Nb_Step() |
---|
[12377] | 82 | Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices |
---|
[7646] | 83 | IF ( lk_agrif_debug ) THEN |
---|
| 84 | IF ( Agrif_Root() .and. lwp) Write(*,*) '---' |
---|
| 85 | IF (lwp) Write(*,*) 'Grid Number',Agrif_Fixed(),' time step ',kstp, 'int tstep',Agrif_NbStepint() |
---|
| 86 | ENDIF |
---|
| 87 | |
---|
| 88 | IF ( kstp == (nit000 + 1) ) lk_agrif_fstep = .FALSE. |
---|
| 89 | |
---|
[3331] | 90 | # if defined key_iomput |
---|
[5407] | 91 | IF( Agrif_Nbstepint() == 0 ) CALL iom_swap( cxios_context ) |
---|
[3331] | 92 | # endif |
---|
| 93 | #endif |
---|
[7646] | 94 | indic = 0 ! although indic is not changed in stp_ctl |
---|
| 95 | ! need to keep the same interface |
---|
[5407] | 96 | IF( kstp == nit000 ) CALL iom_init( cxios_context ) ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS) |
---|
[3331] | 97 | IF( kstp /= nit000 ) CALL day( kstp ) ! Calendar (day was already called at nit000 in day_init) |
---|
[5407] | 98 | CALL iom_setkt( kstp - nit000 + 1, cxios_context ) ! tell iom we are at time step kstp |
---|
[3331] | 99 | |
---|
[9019] | 100 | ! ==> clem: open boundaries is mandatory for sea-ice because ice BDY is not decoupled from |
---|
[5510] | 101 | ! the environment of ocean BDY. Therefore bdy is called in both OPA and SAS modules. |
---|
| 102 | ! From SAS: ocean bdy data are wrong (but we do not care) and ice bdy data are OK. |
---|
| 103 | ! This is not clean and should be changed in the future. |
---|
| 104 | ! ==> |
---|
[12377] | 105 | IF( ln_bdy ) CALL bdy_dta( kstp, Nnn ) ! update dynamic & tracer data at open boundaries |
---|
| 106 | CALL sbc ( kstp, Nbb, Nnn ) ! Sea Boundary Condition (including sea-ice) |
---|
[3331] | 107 | |
---|
[12377] | 108 | CALL dia_wri( kstp, Nnn ) ! ocean model: outputs |
---|
[3331] | 109 | |
---|
[7646] | 110 | #if defined key_agrif |
---|
| 111 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
---|
[12650] | 112 | ! AGRIF recursive integration |
---|
[7646] | 113 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
---|
| 114 | CALL Agrif_Integrate_ChildGrids( stp ) |
---|
| 115 | #endif |
---|
| 116 | |
---|
| 117 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
---|
| 118 | ! Control |
---|
| 119 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
---|
[3331] | 120 | CALL stp_ctl( kstp, indic ) |
---|
[7646] | 121 | IF( indic < 0 ) THEN |
---|
| 122 | CALL ctl_stop( 'step: indic < 0' ) |
---|
[12633] | 123 | CALL dia_wri_state( Nnn, 'output.abort' ) |
---|
[7646] | 124 | ENDIF |
---|
[12650] | 125 | #if defined key_agrif |
---|
| 126 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
---|
| 127 | ! AGRIF update |
---|
| 128 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
---|
| 129 | IF( Agrif_NbStepint() == 0 .AND. nstop == 0 ) THEN ! AGRIF Update from zoom N to zoom 1 then to Parent |
---|
| 130 | #if defined key_si3 |
---|
| 131 | CALL Agrif_Update_ice( ) ! update sea-ice |
---|
| 132 | #endif |
---|
| 133 | ENDIF |
---|
| 134 | #endif |
---|
| 135 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
---|
| 136 | ! File manipulation at the end of the first time step |
---|
| 137 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
---|
| 138 | IF( kstp == nit000 ) CALL iom_close( numror ) ! close input ocean restart file |
---|
[7646] | 139 | |
---|
[5407] | 140 | !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> |
---|
| 141 | ! Coupled mode |
---|
| 142 | !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< |
---|
[12377] | 143 | IF( lk_oasis ) CALL sbc_cpl_snd( kstp, Nbb, Nnn ) ! coupled mode : field exchanges if OASIS-coupled ice |
---|
[5407] | 144 | |
---|
[3769] | 145 | #if defined key_iomput |
---|
[9367] | 146 | IF( kstp == nitrst ) THEN |
---|
| 147 | IF(.NOT.lwxios) THEN |
---|
| 148 | CALL iom_close( numrow ) |
---|
| 149 | ELSE |
---|
| 150 | CALL iom_context_finalize( cwxios_context ) |
---|
| 151 | ENDIF |
---|
| 152 | lrst_oce = .FALSE. |
---|
| 153 | ENDIF |
---|
| 154 | IF( kstp == nitend .OR. indic < 0 ) THEN |
---|
[5407] | 155 | CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF |
---|
| 156 | ENDIF |
---|
[3769] | 157 | #endif |
---|
[3331] | 158 | ! |
---|
[9019] | 159 | IF( ln_timing .AND. kstp == nit000 ) CALL timing_reset |
---|
[3331] | 160 | ! |
---|
| 161 | END SUBROUTINE stp |
---|
| 162 | |
---|
| 163 | !!====================================================================== |
---|
| 164 | END MODULE step |
---|