[643] | 1 | MODULE dynadv |
---|
| 2 | !!============================================================================== |
---|
| 3 | !! *** MODULE dynadv *** |
---|
| 4 | !! Ocean active tracers: advection scheme control |
---|
| 5 | !!============================================================================== |
---|
| 6 | !! History : 9.0 ! 06-11 (G. Madec) Original code |
---|
| 7 | !!---------------------------------------------------------------------- |
---|
| 8 | |
---|
| 9 | !!---------------------------------------------------------------------- |
---|
| 10 | !! dyn_adv : compute the momentum advection trend |
---|
| 11 | !! dyn_adv_ctl : control the different options of advection scheme |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
| 13 | USE dom_oce ! ocean space and time domain |
---|
| 14 | USE in_out_manager ! I/O manager |
---|
| 15 | |
---|
| 16 | USE dynadv_cen2 ! centred flux form advection (dyn_adv_cen2 routine) |
---|
| 17 | USE dynadv_ubs ! UBS flux form advection (dyn_adv_ubs routine) |
---|
| 18 | USE dynkeg ! kinetic energy gradient (dyn_keg routine) |
---|
| 19 | USE dynzad ! vertical advection (dyn_zad routine) |
---|
| 20 | |
---|
| 21 | IMPLICIT NONE |
---|
| 22 | PRIVATE |
---|
| 23 | |
---|
| 24 | PUBLIC dyn_adv ! routine called by step module |
---|
| 25 | |
---|
| 26 | LOGICAL, PUBLIC :: ln_dynadv_vec = .TRUE. ! vector form flag |
---|
| 27 | LOGICAL, PUBLIC :: ln_dynadv_cen2 = .FALSE. ! flux form - 2nd order centered scheme flag |
---|
| 28 | LOGICAL, PUBLIC :: ln_dynadv_ubs = .FALSE. ! flux form - 3rd order UBS scheme flag |
---|
| 29 | |
---|
| 30 | INTEGER :: nadv ! choice of the formulation and scheme for the advection |
---|
| 31 | |
---|
| 32 | !! * Substitutions |
---|
| 33 | # include "domzgr_substitute.h90" |
---|
| 34 | # include "vectopt_loop_substitute.h90" |
---|
| 35 | !!---------------------------------------------------------------------- |
---|
| 36 | !! OPA 9.0 , LOCEAN-IPSL (2006) |
---|
[1152] | 37 | !! $Id$ |
---|
[643] | 38 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
| 40 | |
---|
| 41 | CONTAINS |
---|
| 42 | |
---|
| 43 | SUBROUTINE dyn_adv( kt ) |
---|
| 44 | !!--------------------------------------------------------------------- |
---|
| 45 | !! *** ROUTINE dyn_adv *** |
---|
| 46 | !! |
---|
| 47 | !! ** Purpose : compute the ocean momentum advection trend. |
---|
| 48 | !! |
---|
| 49 | !! ** Method : - Update (ua,va) with the advection term following nadv |
---|
| 50 | !! NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T) |
---|
| 51 | !! a metric term is add to the coriolis term while in vector form |
---|
| 52 | !! it is the relative vorticity which is added to coriolis term |
---|
| 53 | !! (see dynvor module). |
---|
| 54 | !!---------------------------------------------------------------------- |
---|
| 55 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
| 56 | !!---------------------------------------------------------------------- |
---|
| 57 | ! |
---|
| 58 | IF( kt == nit000 ) CALL dyn_adv_ctl ! initialisation & control of options |
---|
| 59 | |
---|
[645] | 60 | SELECT CASE ( nadv ) ! compute advection trend and add it to general trend |
---|
| 61 | CASE ( 0 ) |
---|
| 62 | CALL dyn_keg ( kt ) ! vector form : horizontal gradient of kinetic energy |
---|
| 63 | CALL dyn_zad ( kt ) ! vector form : vertical advection |
---|
| 64 | CASE ( 1 ) |
---|
| 65 | CALL dyn_adv_cen2( kt ) ! 2nd order centered scheme |
---|
| 66 | CASE ( 2 ) |
---|
| 67 | CALL dyn_adv_ubs ( kt ) ! 3rd order UBS scheme |
---|
[643] | 68 | ! |
---|
[645] | 69 | CASE (-1 ) ! esopa: test all possibility with control print |
---|
| 70 | CALL dyn_keg ( kt ) |
---|
| 71 | CALL dyn_zad ( kt ) |
---|
| 72 | CALL dyn_adv_cen2( kt ) |
---|
| 73 | CALL dyn_adv_ubs ( kt ) |
---|
| 74 | END SELECT |
---|
| 75 | ! |
---|
[643] | 76 | END SUBROUTINE dyn_adv |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | SUBROUTINE dyn_adv_ctl |
---|
| 80 | !!--------------------------------------------------------------------- |
---|
| 81 | !! *** ROUTINE dyn_adv_ctl *** |
---|
| 82 | !! |
---|
| 83 | !! ** Purpose : Control the consistency between namelist options for |
---|
| 84 | !! momentum advection formulation & scheme and set nadv |
---|
| 85 | !!---------------------------------------------------------------------- |
---|
| 86 | INTEGER :: ioptio |
---|
| 87 | |
---|
[1601] | 88 | NAMELIST/namdyn_adv/ ln_dynadv_vec, ln_dynadv_cen2 , ln_dynadv_ubs |
---|
[643] | 89 | !!---------------------------------------------------------------------- |
---|
| 90 | |
---|
[1601] | 91 | REWIND ( numnam ) ! Read Namelist namdyn_adv : momentum advection scheme |
---|
| 92 | READ ( numnam, namdyn_adv ) |
---|
[643] | 93 | |
---|
| 94 | IF(lwp) THEN ! Namelist print |
---|
| 95 | WRITE(numout,*) |
---|
| 96 | WRITE(numout,*) 'dyn_adv_ctl : choice/control of the momentum advection scheme' |
---|
| 97 | WRITE(numout,*) '~~~~~~~~~~~' |
---|
[1601] | 98 | WRITE(numout,*) ' Namelist namdyn_adv : chose a advection formulation & scheme for momentum' |
---|
[643] | 99 | WRITE(numout,*) ' Vector/flux form (T/F) ln_dynadv_vec = ', ln_dynadv_vec |
---|
| 100 | WRITE(numout,*) ' 2nd order centred advection scheme ln_dynadv_cen2 = ', ln_dynadv_cen2 |
---|
| 101 | WRITE(numout,*) ' 3rd order UBS advection scheme ln_dynadv_ubs = ', ln_dynadv_ubs |
---|
| 102 | ENDIF |
---|
| 103 | |
---|
| 104 | ioptio = 0 ! Parameter control |
---|
| 105 | IF( ln_dynadv_vec ) ioptio = ioptio + 1 |
---|
| 106 | IF( ln_dynadv_cen2 ) ioptio = ioptio + 1 |
---|
| 107 | IF( ln_dynadv_ubs ) ioptio = ioptio + 1 |
---|
| 108 | IF( lk_esopa ) ioptio = 1 |
---|
| 109 | |
---|
[1601] | 110 | IF( ioptio /= 1 ) CALL ctl_stop( 'Choose ONE advection scheme in namelist namdyn_adv' ) |
---|
[643] | 111 | |
---|
| 112 | ! ! Set nadv |
---|
| 113 | IF( ln_dynadv_vec ) nadv = 0 |
---|
| 114 | IF( ln_dynadv_cen2 ) nadv = 1 |
---|
| 115 | IF( ln_dynadv_ubs ) nadv = 2 |
---|
| 116 | IF( lk_esopa ) nadv = -1 |
---|
| 117 | |
---|
| 118 | IF(lwp) THEN ! Print the choice |
---|
| 119 | WRITE(numout,*) |
---|
| 120 | IF( nadv == 0 ) WRITE(numout,*) ' vector form : keg + zad + vor is used' |
---|
| 121 | IF( nadv == 1 ) WRITE(numout,*) ' flux form : 2nd order scheme is used' |
---|
| 122 | IF( nadv == 2 ) WRITE(numout,*) ' flux form : UBS scheme is used' |
---|
| 123 | IF( nadv == -1 ) WRITE(numout,*) ' esopa test: use all advection formulation' |
---|
| 124 | ENDIF |
---|
| 125 | ! |
---|
| 126 | END SUBROUTINE dyn_adv_ctl |
---|
| 127 | |
---|
| 128 | !!====================================================================== |
---|
| 129 | END MODULE dynadv |
---|