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