[643] | 1 | MODULE dynadv |
---|
| 2 | !!============================================================================== |
---|
| 3 | !! *** MODULE dynadv *** |
---|
| 4 | !! Ocean active tracers: advection scheme control |
---|
| 5 | !!============================================================================== |
---|
[2528] | 6 | !! History : 1.0 ! 2006-11 (G. Madec) Original code |
---|
[5322] | 7 | !! 3.3 ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase |
---|
| 8 | !! 3.6 ! 2015-05 (N. Ducousso, G. Madec) add Hollingsworth scheme as an option |
---|
[9019] | 9 | !! 4.0 ! 2017-07 (G. Madec) add a linear dynamics option |
---|
[643] | 10 | !!---------------------------------------------------------------------- |
---|
| 11 | |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
| 13 | !! dyn_adv : compute the momentum advection trend |
---|
[2528] | 14 | !! dyn_adv_init : control the different options of advection scheme |
---|
[643] | 15 | !!---------------------------------------------------------------------- |
---|
| 16 | USE dom_oce ! ocean space and time domain |
---|
| 17 | USE dynadv_cen2 ! centred flux form advection (dyn_adv_cen2 routine) |
---|
| 18 | USE dynadv_ubs ! UBS flux form advection (dyn_adv_ubs routine) |
---|
| 19 | USE dynkeg ! kinetic energy gradient (dyn_keg routine) |
---|
| 20 | USE dynzad ! vertical advection (dyn_zad routine) |
---|
[5322] | 21 | ! |
---|
[2715] | 22 | USE in_out_manager ! I/O manager |
---|
| 23 | USE lib_mpp ! MPP library |
---|
[3294] | 24 | USE timing ! Timing |
---|
[643] | 25 | |
---|
| 26 | IMPLICIT NONE |
---|
| 27 | PRIVATE |
---|
| 28 | |
---|
[2528] | 29 | PUBLIC dyn_adv ! routine called by step module |
---|
[5322] | 30 | PUBLIC dyn_adv_init ! routine called by opa module |
---|
[643] | 31 | |
---|
[9526] | 32 | ! !!* namdyn_adv namelist * |
---|
| 33 | LOGICAL, PUBLIC :: ln_dynadv_OFF !: linear dynamics (no momentum advection) |
---|
[9019] | 34 | LOGICAL, PUBLIC :: ln_dynadv_vec !: vector form |
---|
| 35 | INTEGER, PUBLIC :: nn_dynkeg !: scheme of grad(KE): =0 C2 ; =1 Hollingsworth |
---|
[4147] | 36 | LOGICAL, PUBLIC :: ln_dynadv_cen2 !: flux form - 2nd order centered scheme flag |
---|
| 37 | LOGICAL, PUBLIC :: ln_dynadv_ubs !: flux form - 3rd order UBS scheme flag |
---|
[643] | 38 | |
---|
[9019] | 39 | INTEGER, PUBLIC :: n_dynadv !: choice of the formulation and scheme for momentum advection |
---|
| 40 | ! ! associated indices: |
---|
| 41 | INTEGER, PUBLIC, PARAMETER :: np_LIN_dyn = 0 ! no advection: linear dynamics |
---|
| 42 | INTEGER, PUBLIC, PARAMETER :: np_VEC_c2 = 1 ! vector form : 2nd order centered scheme |
---|
| 43 | INTEGER, PUBLIC, PARAMETER :: np_FLX_c2 = 2 ! flux form : 2nd order centered scheme |
---|
| 44 | INTEGER, PUBLIC, PARAMETER :: np_FLX_ubs = 3 ! flux form : 3rd order Upstream Biased Scheme |
---|
[643] | 45 | |
---|
| 46 | !! * Substitutions |
---|
| 47 | # include "vectopt_loop_substitute.h90" |
---|
| 48 | !!---------------------------------------------------------------------- |
---|
[9598] | 49 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[2528] | 50 | !! $Id$ |
---|
[10068] | 51 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[643] | 52 | !!---------------------------------------------------------------------- |
---|
| 53 | CONTAINS |
---|
| 54 | |
---|
| 55 | SUBROUTINE dyn_adv( kt ) |
---|
| 56 | !!--------------------------------------------------------------------- |
---|
| 57 | !! *** ROUTINE dyn_adv *** |
---|
| 58 | !! |
---|
| 59 | !! ** Purpose : compute the ocean momentum advection trend. |
---|
| 60 | !! |
---|
[9019] | 61 | !! ** Method : - Update (ua,va) with the advection term following n_dynadv |
---|
| 62 | !! |
---|
[643] | 63 | !! NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T) |
---|
| 64 | !! a metric term is add to the coriolis term while in vector form |
---|
| 65 | !! it is the relative vorticity which is added to coriolis term |
---|
| 66 | !! (see dynvor module). |
---|
| 67 | !!---------------------------------------------------------------------- |
---|
| 68 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
| 69 | !!---------------------------------------------------------------------- |
---|
| 70 | ! |
---|
[9019] | 71 | IF( ln_timing ) CALL timing_start( 'dyn_adv' ) |
---|
[3294] | 72 | ! |
---|
[9019] | 73 | SELECT CASE( n_dynadv ) !== compute advection trend and add it to general trend ==! |
---|
| 74 | CASE( np_VEC_c2 ) |
---|
| 75 | CALL dyn_keg ( kt, nn_dynkeg ) ! vector form : horizontal gradient of kinetic energy |
---|
| 76 | CALL dyn_zad ( kt ) ! vector form : vertical advection |
---|
| 77 | CASE( np_FLX_c2 ) |
---|
| 78 | CALL dyn_adv_cen2( kt ) ! 2nd order centered scheme |
---|
| 79 | CASE( np_FLX_ubs ) |
---|
| 80 | CALL dyn_adv_ubs ( kt ) ! 3rd order UBS scheme (UP3) |
---|
[645] | 81 | END SELECT |
---|
| 82 | ! |
---|
[9019] | 83 | IF( ln_timing ) CALL timing_stop( 'dyn_adv' ) |
---|
[3294] | 84 | ! |
---|
[643] | 85 | END SUBROUTINE dyn_adv |
---|
| 86 | |
---|
| 87 | |
---|
[2528] | 88 | SUBROUTINE dyn_adv_init |
---|
[643] | 89 | !!--------------------------------------------------------------------- |
---|
[2528] | 90 | !! *** ROUTINE dyn_adv_init *** |
---|
[643] | 91 | !! |
---|
| 92 | !! ** Purpose : Control the consistency between namelist options for |
---|
[9019] | 93 | !! momentum advection formulation & scheme and set n_dynadv |
---|
[643] | 94 | !!---------------------------------------------------------------------- |
---|
[5322] | 95 | INTEGER :: ioptio, ios ! Local integer |
---|
| 96 | ! |
---|
[9526] | 97 | NAMELIST/namdyn_adv/ ln_dynadv_OFF, ln_dynadv_vec, nn_dynkeg, ln_dynadv_cen2, ln_dynadv_ubs |
---|
[643] | 98 | !!---------------------------------------------------------------------- |
---|
[5322] | 99 | ! |
---|
[9490] | 100 | IF(lwp) THEN |
---|
| 101 | WRITE(numout,*) |
---|
| 102 | WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme' |
---|
| 103 | WRITE(numout,*) '~~~~~~~~~~~~' |
---|
| 104 | ENDIF |
---|
| 105 | ! |
---|
[4147] | 106 | REWIND( numnam_ref ) ! Namelist namdyn_adv in reference namelist : Momentum advection scheme |
---|
| 107 | READ ( numnam_ref, namdyn_adv, IOSTAT = ios, ERR = 901) |
---|
[11536] | 108 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_adv in reference namelist' ) |
---|
[4147] | 109 | REWIND( numnam_cfg ) ! Namelist namdyn_adv in configuration namelist : Momentum advection scheme |
---|
| 110 | READ ( numnam_cfg, namdyn_adv, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 111 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namdyn_adv in configuration namelist' ) |
---|
[4624] | 112 | IF(lwm) WRITE ( numond, namdyn_adv ) |
---|
[4147] | 113 | |
---|
[643] | 114 | IF(lwp) THEN ! Namelist print |
---|
[7646] | 115 | WRITE(numout,*) ' Namelist namdyn_adv : chose a advection formulation & scheme for momentum' |
---|
[9526] | 116 | WRITE(numout,*) ' linear dynamics : no momentum advection ln_dynadv_OFF = ', ln_dynadv_OFF |
---|
[9019] | 117 | WRITE(numout,*) ' Vector form: 2nd order centered scheme ln_dynadv_vec = ', ln_dynadv_vec |
---|
| 118 | WRITE(numout,*) ' with Hollingsworth scheme (=1) or not (=0) nn_dynkeg = ', nn_dynkeg |
---|
| 119 | WRITE(numout,*) ' flux form: 2nd order centred scheme ln_dynadv_cen2 = ', ln_dynadv_cen2 |
---|
| 120 | WRITE(numout,*) ' 3rd order UBS scheme ln_dynadv_ubs = ', ln_dynadv_ubs |
---|
[643] | 121 | ENDIF |
---|
| 122 | |
---|
[9019] | 123 | ioptio = 0 ! parameter control and set n_dynadv |
---|
[9526] | 124 | IF( ln_dynadv_OFF ) THEN ; ioptio = ioptio + 1 ; n_dynadv = np_LIN_dyn ; ENDIF |
---|
[9019] | 125 | IF( ln_dynadv_vec ) THEN ; ioptio = ioptio + 1 ; n_dynadv = np_VEC_c2 ; ENDIF |
---|
| 126 | IF( ln_dynadv_cen2 ) THEN ; ioptio = ioptio + 1 ; n_dynadv = np_FLX_c2 ; ENDIF |
---|
| 127 | IF( ln_dynadv_ubs ) THEN ; ioptio = ioptio + 1 ; n_dynadv = np_FLX_ubs ; ENDIF |
---|
[643] | 128 | |
---|
[9019] | 129 | IF( ioptio /= 1 ) CALL ctl_stop( 'choose ONE and only ONE advection scheme' ) |
---|
| 130 | IF( nn_dynkeg /= nkeg_C2 .AND. nn_dynkeg /= nkeg_HW ) CALL ctl_stop( 'KEG scheme wrong value of nn_dynkeg' ) |
---|
[643] | 131 | |
---|
| 132 | |
---|
| 133 | IF(lwp) THEN ! Print the choice |
---|
| 134 | WRITE(numout,*) |
---|
[9019] | 135 | SELECT CASE( n_dynadv ) |
---|
[9190] | 136 | CASE( np_LIN_dyn ) ; WRITE(numout,*) ' ==>>> linear dynamics : no momentum advection used' |
---|
| 137 | CASE( np_VEC_c2 ) ; WRITE(numout,*) ' ==>>> vector form : keg + zad + vor is used' |
---|
[7646] | 138 | IF( nn_dynkeg == nkeg_C2 ) WRITE(numout,*) ' with Centered standard keg scheme' |
---|
| 139 | IF( nn_dynkeg == nkeg_HW ) WRITE(numout,*) ' with Hollingsworth keg scheme' |
---|
[9190] | 140 | CASE( np_FLX_c2 ) ; WRITE(numout,*) ' ==>>> flux form : 2nd order scheme is used' |
---|
| 141 | CASE( np_FLX_ubs ) ; WRITE(numout,*) ' ==>>> flux form : UBS scheme is used' |
---|
[9019] | 142 | END SELECT |
---|
[643] | 143 | ENDIF |
---|
| 144 | ! |
---|
[2528] | 145 | END SUBROUTINE dyn_adv_init |
---|
[643] | 146 | |
---|
| 147 | !!====================================================================== |
---|
| 148 | END MODULE dynadv |
---|