1 | MODULE trc |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE trc *** |
---|
4 | !! Passive tracers : module for tracers defined |
---|
5 | !!====================================================================== |
---|
6 | !! History : OPA ! 1996-01 (M. Levy) Original code |
---|
7 | !! - ! 2000-04 (O. Aumont, M.A. Foujols) HAMOCC3 and P3ZD |
---|
8 | !! NEMO 1.0 ! 2004-03 (C. Ethe) Free form and module |
---|
9 | !!---------------------------------------------------------------------- |
---|
10 | USE par_oce |
---|
11 | USE par_trc |
---|
12 | USE bdy_oce, only: jp_bdy, ln_bdy, nb_bdy, OBC_DATA |
---|
13 | |
---|
14 | IMPLICIT NONE |
---|
15 | PUBLIC |
---|
16 | |
---|
17 | PUBLIC trc_alloc ! called by nemogcm.F90 |
---|
18 | |
---|
19 | ! !!- logical units of passive tracers |
---|
20 | INTEGER, PUBLIC :: numont = -1 !: reference passive tracer namelist output output.namelist.top |
---|
21 | INTEGER, PUBLIC :: numonr = -1 !: reference passive tracer namelist output output.namelist.top |
---|
22 | INTEGER, PUBLIC :: numstr !: tracer statistics |
---|
23 | CHARACTER(:), ALLOCATABLE, PUBLIC :: numnat_ref !: character buffer for reference passive tracer namelist_top_ref |
---|
24 | CHARACTER(:), ALLOCATABLE, PUBLIC :: numnat_cfg !: character buffer for configuration specific passive tracer namelist_top_cfg |
---|
25 | CHARACTER(:), ALLOCATABLE, PUBLIC :: numtrc_ref !: character buffer for reference passive tracer namelist_trc_ref |
---|
26 | CHARACTER(:), ALLOCATABLE, PUBLIC :: numtrc_cfg !: character buffer for configuration specific passive tracer namelist_trc_cfg |
---|
27 | |
---|
28 | !! passive tracers fields (before,now,after) |
---|
29 | !! -------------------------------------------------- |
---|
30 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trai !: initial total tracer |
---|
31 | REAL(wp), PUBLIC :: areatot !: total volume |
---|
32 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: cvol !: volume correction -degrad option- |
---|
33 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:) :: tr !: tracer concentration |
---|
34 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: sbc_trc_b !: Before sbc fluxes for tracers |
---|
35 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: sbc_trc !: Now sbc fluxes for tracers |
---|
36 | |
---|
37 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: trc_i !: prescribed tracer concentration in sea ice for SBC |
---|
38 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: trc_o !: prescribed tracer concentration in ocean for SBC |
---|
39 | INTEGER , PUBLIC :: nn_ice_tr !: handling of sea ice tracers |
---|
40 | |
---|
41 | !! interpolated gradient |
---|
42 | !!-------------------------------------------------- |
---|
43 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtru !: hor. gradient at u-points at bottom ocean level |
---|
44 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrv !: hor. gradient at v-points at bottom ocean level |
---|
45 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrui !: hor. gradient at u-points at top ocean level |
---|
46 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrvi !: hor. gradient at v-points at top ocean level |
---|
47 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr_mean !: daily mean qsr |
---|
48 | |
---|
49 | !! passive tracers (input and output) |
---|
50 | !! ------------------------------------------ |
---|
51 | LOGICAL , PUBLIC :: ln_rsttr !: boolean term for restart i/o for passive tracers (namelist) |
---|
52 | LOGICAL , PUBLIC :: lrst_trc !: logical to control the trc restart write |
---|
53 | INTEGER , PUBLIC :: nn_writetrc !: time step frequency for concentration outputs (namelist) |
---|
54 | INTEGER , PUBLIC :: nutwrs !: output FILE for passive tracers restart |
---|
55 | INTEGER , PUBLIC :: nutrst !: logical unit for restart FILE for passive tracers |
---|
56 | INTEGER , PUBLIC :: nn_rsttr !: control of the time step ( 0 or 1 ) for pass. tr. |
---|
57 | CHARACTER(len = 80) , PUBLIC :: cn_trcrst_in !: suffix of pass. tracer restart name (input) |
---|
58 | CHARACTER(len = 256), PUBLIC :: cn_trcrst_indir !: restart input directory |
---|
59 | CHARACTER(len = 80) , PUBLIC :: cn_trcrst_out !: suffix of pass. tracer restart name (output) |
---|
60 | CHARACTER(len = 256), PUBLIC :: cn_trcrst_outdir !: restart output directory |
---|
61 | REAL(wp) , PUBLIC :: rDt_trc !: = 2*rn_Dt except at nit000 (=rn_Dt) if l_1st_euler=.true. |
---|
62 | LOGICAL , PUBLIC :: ln_top_euler !: boolean term for euler integration |
---|
63 | LOGICAL , PUBLIC :: ln_trcdta !: Read inputs data from files |
---|
64 | LOGICAL , PUBLIC :: ln_trcbc !: Enable surface, lateral or open boundaries conditions |
---|
65 | LOGICAL , PUBLIC :: ln_trcdmp !: internal damping flag |
---|
66 | LOGICAL , PUBLIC :: ln_trcdmp_clo !: internal damping flag on closed seas |
---|
67 | INTEGER , PUBLIC :: nittrc000 !: first time step of passive tracers model |
---|
68 | LOGICAL , PUBLIC :: l_trcdm2dc !: Diurnal cycle for TOP |
---|
69 | |
---|
70 | !! Information for the ice module for tracers |
---|
71 | !! ------------------------------------------ |
---|
72 | TYPE, PUBLIC :: TRC_I_NML !: Ice tracer namelist structure |
---|
73 | REAL(wp) :: trc_ratio ! ice-ocean trc ratio |
---|
74 | REAL(wp) :: trc_prescr ! prescribed ice trc cc |
---|
75 | CHARACTER(len=2) :: ctrc_o ! choice of ocean trc cc |
---|
76 | END TYPE |
---|
77 | ! |
---|
78 | REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trc_ice_ratio !: ice-ocean tracer ratio |
---|
79 | REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trc_ice_prescr !: prescribed ice trc cc |
---|
80 | CHARACTER(len=2), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: cn_trc_o !: choice of ocean tracer cc |
---|
81 | |
---|
82 | |
---|
83 | !! information for outputs |
---|
84 | !! -------------------------------------------------- |
---|
85 | TYPE, PUBLIC :: PTRACER !: Passive tracer type |
---|
86 | CHARACTER(len=20) :: clsname ! short name |
---|
87 | CHARACTER(len=80) :: cllname ! long name |
---|
88 | CHARACTER(len=20) :: clunit ! unit |
---|
89 | LOGICAL :: llinit ! read in a file or not |
---|
90 | LOGICAL :: llsbc ! read in a file or not |
---|
91 | LOGICAL :: llcbc ! read in a file or not |
---|
92 | LOGICAL :: llobc ! read in a file or not |
---|
93 | END TYPE PTRACER |
---|
94 | ! |
---|
95 | CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcnm !: tracer name |
---|
96 | CHARACTER(len=80), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcln !: trccer field long name |
---|
97 | CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcun !: tracer unit |
---|
98 | ! |
---|
99 | TYPE, PUBLIC :: DIAG !: Passive trcacer ddditional diagnostic type |
---|
100 | CHARACTER(len=20) :: sname ! short name |
---|
101 | CHARACTER(len=80) :: lname ! long name |
---|
102 | CHARACTER(len=20) :: units ! unit |
---|
103 | END TYPE DIAG |
---|
104 | ! |
---|
105 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trc3d !: 3D diagnostics for tracers |
---|
106 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trc2d !: 2D diagnostics for tracers |
---|
107 | |
---|
108 | !! information for inputs |
---|
109 | !! -------------------------------------------------- |
---|
110 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_ini !: Initialisation from data input file |
---|
111 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_obc !: Use open boundary condition data |
---|
112 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_sbc !: Use surface boundary condition data |
---|
113 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_cbc !: Use coastal boundary condition data |
---|
114 | LOGICAL , PUBLIC :: ln_rnf_ctl !: remove runoff dilution on tracers |
---|
115 | REAL(wp), PUBLIC :: rn_sbc_time !: Time scaling factor for SBC data (seconds in a day) |
---|
116 | REAL(wp), PUBLIC :: rn_cbc_time !: Time scaling factor for CBC data (seconds in a day) |
---|
117 | LOGICAL , PUBLIC :: lltrcbc !: Applying one of the boundary conditions |
---|
118 | ! |
---|
119 | CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc_dflt ! Default OBC condition for all tracers |
---|
120 | CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc ! Choice of boundary condition for tracers |
---|
121 | INTEGER, PUBLIC, DIMENSION(jp_bdy) :: nn_trcdmp_bdy !: =T Tracer damping |
---|
122 | ! |
---|
123 | ! Vertical axis used in the sediment module |
---|
124 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: profsed |
---|
125 | !$AGRIF_DO_NOT_TREAT |
---|
126 | ! External data structure of BDY for TOP. Available elements: cn_obc, ll_trc, trcnow, dmp |
---|
127 | TYPE(OBC_DATA), PUBLIC, ALLOCATABLE, DIMENSION(:,:), TARGET :: trcdta_bdy !: bdy external data (local process) |
---|
128 | !$AGRIF_END_DO_NOT_TREAT |
---|
129 | ! |
---|
130 | !! Substitutions |
---|
131 | #include "do_loop_substitute.h90" |
---|
132 | !!---------------------------------------------------------------------- |
---|
133 | !! NEMO/TOP 4.0 , NEMO Consortium (2018) |
---|
134 | !! $Id$ |
---|
135 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
136 | !!---------------------------------------------------------------------- |
---|
137 | CONTAINS |
---|
138 | |
---|
139 | INTEGER FUNCTION trc_alloc() |
---|
140 | !!------------------------------------------------------------------- |
---|
141 | !! *** ROUTINE trc_alloc *** |
---|
142 | !!------------------------------------------------------------------- |
---|
143 | USE lib_mpp, ONLY: ctl_stop |
---|
144 | !!------------------------------------------------------------------- |
---|
145 | INTEGER :: ierr(4) |
---|
146 | !!------------------------------------------------------------------- |
---|
147 | ierr(:) = 0 |
---|
148 | ! |
---|
149 | ALLOCATE( tr(jpi,jpj,jpk,jptra,jpt) , & |
---|
150 | & trc_i(jpi,jpj,jptra) , trc_o(jpi,jpj,jptra) , & |
---|
151 | & gtru (jpi,jpj,jptra) , gtrv (jpi,jpj,jptra) , & |
---|
152 | & gtrui(jpi,jpj,jptra) , gtrvi(jpi,jpj,jptra) , & |
---|
153 | & trc_ice_ratio(jptra) , trc_ice_prescr(jptra) , cn_trc_o(jptra) , & |
---|
154 | & sbc_trc_b(jpi,jpj,jptra), sbc_trc(jpi,jpj,jptra) , & |
---|
155 | & cvol(jpi,jpj,jpk) , trai(jptra) , qsr_mean(jpi,jpj) , & |
---|
156 | & ctrcnm(jptra) , ctrcln(jptra) , ctrcun(jptra) , & |
---|
157 | & ln_trc_ini(jptra) , & |
---|
158 | & ln_trc_sbc(jptra) , ln_trc_cbc(jptra) , ln_trc_obc(jptra) , & |
---|
159 | & STAT = ierr(1) ) |
---|
160 | ! |
---|
161 | IF( ln_bdy ) ALLOCATE( trcdta_bdy(jptra, jp_bdy) , STAT = ierr(2) ) |
---|
162 | ! |
---|
163 | IF (jp_dia3d > 0 ) ALLOCATE( trc3d(jpi,jpj,jpk,jp_dia3d), STAT = ierr(3) ) |
---|
164 | ! |
---|
165 | IF (jp_dia2d > 0 ) ALLOCATE( trc2d(jpi,jpj,jpk,jp_dia2d), STAT = ierr(4) ) |
---|
166 | ! |
---|
167 | trc_alloc = MAXVAL( ierr ) |
---|
168 | IF( trc_alloc /= 0 ) CALL ctl_stop( 'STOP', 'trc_alloc: failed to allocate arrays' ) |
---|
169 | ! |
---|
170 | END FUNCTION trc_alloc |
---|
171 | |
---|
172 | !!====================================================================== |
---|
173 | END MODULE trc |
---|