| 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 | #if defined key_top |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| 12 | !! 'key_top' TOP models |
|---|
| 13 | !!---------------------------------------------------------------------- |
|---|
| 14 | USE par_oce |
|---|
| 15 | USE par_trc |
|---|
| 16 | #if defined key_bdy |
|---|
| 17 | USE bdy_oce, only: nb_bdy, OBC_DATA |
|---|
| 18 | #endif |
|---|
| 19 | |
|---|
| 20 | IMPLICIT NONE |
|---|
| 21 | PUBLIC |
|---|
| 22 | |
|---|
| 23 | PUBLIC trc_alloc ! called by nemogcm.F90 |
|---|
| 24 | |
|---|
| 25 | !! parameters for the control of passive tracers |
|---|
| 26 | !! --------------------------------------------- |
|---|
| 27 | INTEGER, PUBLIC :: numnat_ref = -1 !: logical unit for the reference passive tracer namelist_top_ref |
|---|
| 28 | INTEGER, PUBLIC :: numnat_cfg = -1 !: logical unit for the reference passive tracer namelist_top_cfg |
|---|
| 29 | INTEGER, PUBLIC :: numont = -1 !: logical unit for the reference passive tracer namelist output output.namelist.top |
|---|
| 30 | INTEGER, PUBLIC :: numtrc_ref = -1 !: logical unit for the reference passive tracer namelist_top_ref |
|---|
| 31 | INTEGER, PUBLIC :: numtrc_cfg = -1 !: logical unit for the reference passive tracer namelist_top_cfg |
|---|
| 32 | INTEGER, PUBLIC :: numonr = -1 !: logical unit for the reference passive tracer namelist output output.namelist.top |
|---|
| 33 | INTEGER, PUBLIC :: numstr !: logical unit for tracer statistics |
|---|
| 34 | INTEGER, PUBLIC :: numrtr !: logical unit for trc restart (read ) |
|---|
| 35 | INTEGER, PUBLIC :: numrtw !: logical unit for trc restart ( write ) |
|---|
| 36 | |
|---|
| 37 | !! passive tracers fields (before,now,after) |
|---|
| 38 | !! -------------------------------------------------- |
|---|
| 39 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trai !: initial total tracer |
|---|
| 40 | REAL(wp), PUBLIC :: areatot !: total volume |
|---|
| 41 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: cvol !: volume correction -degrad option- |
|---|
| 42 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trn !: tracer concentration for now time step |
|---|
| 43 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: tra !: tracer concentration for next time step |
|---|
| 44 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trb !: tracer concentration for before time step |
|---|
| 45 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: sbc_trc_b !: Before sbc fluxes for tracers |
|---|
| 46 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: sbc_trc !: Now sbc fluxes for tracers |
|---|
| 47 | |
|---|
| 48 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: trc_i !: prescribed tracer concentration in sea ice for SBC |
|---|
| 49 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,: ) :: trc_o !: prescribed tracer concentration in ocean for SBC |
|---|
| 50 | INTEGER , PUBLIC :: nn_ice_tr !: handling of sea ice tracers |
|---|
| 51 | |
|---|
| 52 | !! interpolated gradient |
|---|
| 53 | !!-------------------------------------------------- |
|---|
| 54 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtru !: hor. gradient at u-points at bottom ocean level |
|---|
| 55 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrv !: hor. gradient at v-points at bottom ocean level |
|---|
| 56 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrui !: hor. gradient at u-points at top ocean level |
|---|
| 57 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtrvi !: hor. gradient at v-points at top ocean level |
|---|
| 58 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr_mean !: daily mean qsr |
|---|
| 59 | |
|---|
| 60 | !! passive tracers (input and output) |
|---|
| 61 | !! ------------------------------------------ |
|---|
| 62 | LOGICAL , PUBLIC :: ln_rsttr !: boolean term for restart i/o for passive tracers (namelist) |
|---|
| 63 | LOGICAL , PUBLIC :: lrst_trc !: logical to control the trc restart write |
|---|
| 64 | INTEGER , PUBLIC :: nn_writetrc !: time step frequency for concentration outputs (namelist) |
|---|
| 65 | INTEGER , PUBLIC :: nutwrs !: output FILE for passive tracers restart |
|---|
| 66 | INTEGER , PUBLIC :: nutrst !: logical unit for restart FILE for passive tracers |
|---|
| 67 | INTEGER , PUBLIC :: nn_rsttr !: control of the time step ( 0 or 1 ) for pass. tr. |
|---|
| 68 | CHARACTER(len = 80) , PUBLIC :: cn_trcrst_in !: suffix of pass. tracer restart name (input) |
|---|
| 69 | CHARACTER(len = 256), PUBLIC :: cn_trcrst_indir !: restart input directory |
|---|
| 70 | CHARACTER(len = 80) , PUBLIC :: cn_trcrst_out !: suffix of pass. tracer restart name (output) |
|---|
| 71 | CHARACTER(len = 256), PUBLIC :: cn_trcrst_outdir !: restart output directory |
|---|
| 72 | REAL(wp) , PUBLIC :: rdttrc !: passive tracer time step |
|---|
| 73 | REAL(wp) , PUBLIC :: r2dttrc !: = 2*rdttrc except at nit000 (=rdttrc) if neuler=0 |
|---|
| 74 | LOGICAL , PUBLIC :: ln_top_euler !: boolean term for euler integration |
|---|
| 75 | LOGICAL , PUBLIC :: ln_trcdta !: Read inputs data from files |
|---|
| 76 | LOGICAL , PUBLIC :: ln_trcdmp !: internal damping flag |
|---|
| 77 | LOGICAL , PUBLIC :: ln_trcdmp_clo !: internal damping flag on closed seas |
|---|
| 78 | INTEGER , PUBLIC :: nittrc000 !: first time step of passive tracers model |
|---|
| 79 | LOGICAL , PUBLIC :: l_trcdm2dc !: Diurnal cycle for TOP |
|---|
| 80 | |
|---|
| 81 | !! Information for the ice module for tracers |
|---|
| 82 | !! ------------------------------------------ |
|---|
| 83 | TYPE TRC_I_NML !--- Ice tracer namelist structure |
|---|
| 84 | REAL(wp) :: trc_ratio ! ice-ocean trc ratio |
|---|
| 85 | REAL(wp) :: trc_prescr ! prescribed ice trc cc |
|---|
| 86 | CHARACTER(len=2) :: ctrc_o ! choice of ocean trc cc |
|---|
| 87 | END TYPE |
|---|
| 88 | |
|---|
| 89 | REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trc_ice_ratio ! ice-ocean tracer ratio |
|---|
| 90 | REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: trc_ice_prescr ! prescribed ice trc cc |
|---|
| 91 | CHARACTER(len=2), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: cn_trc_o ! choice of ocean tracer cc |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | !! information for outputs |
|---|
| 95 | !! -------------------------------------------------- |
|---|
| 96 | TYPE, PUBLIC :: PTRACER !: Passive tracer type |
|---|
| 97 | CHARACTER(len = 20) :: clsname !: short name |
|---|
| 98 | CHARACTER(len = 80) :: cllname !: long name |
|---|
| 99 | CHARACTER(len = 20) :: clunit !: unit |
|---|
| 100 | LOGICAL :: llinit !: read in a file or not |
|---|
| 101 | LOGICAL :: llsbc !: read in a file or not |
|---|
| 102 | LOGICAL :: llcbc !: read in a file or not |
|---|
| 103 | LOGICAL :: llobc !: read in a file or not |
|---|
| 104 | END TYPE PTRACER |
|---|
| 105 | |
|---|
| 106 | CHARACTER(len = 20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcnm !: tracer name |
|---|
| 107 | CHARACTER(len = 80), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcln !: trccer field long name |
|---|
| 108 | CHARACTER(len = 20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ctrcun !: tracer unit |
|---|
| 109 | |
|---|
| 110 | TYPE, PUBLIC :: DIAG !: passive trcacer ddditional diagnostic type |
|---|
| 111 | CHARACTER(len = 20) :: sname !: short name |
|---|
| 112 | CHARACTER(len = 80) :: lname !: long name |
|---|
| 113 | CHARACTER(len = 20) :: units !: unit |
|---|
| 114 | END TYPE DIAG |
|---|
| 115 | |
|---|
| 116 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trc3d !: 3D diagnostics for tracers |
|---|
| 117 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: trc2d !: 2D diagnostics for tracers |
|---|
| 118 | |
|---|
| 119 | !! information for inputs |
|---|
| 120 | !! -------------------------------------------------- |
|---|
| 121 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_ini !: Initialisation from data input file |
|---|
| 122 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_obc !: Use open boundary condition data |
|---|
| 123 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_sbc !: Use surface boundary condition data |
|---|
| 124 | LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ln_trc_cbc !: Use coastal boundary condition data |
|---|
| 125 | LOGICAL , PUBLIC :: ln_rnf_ctl !: remove runoff dilution on tracers |
|---|
| 126 | REAL(wp), PUBLIC :: rn_bc_time !: Time scaling factor for SBC and CBC data (seconds in a day) |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | !! variables to average over physics over passive tracer sub-steps. |
|---|
| 130 | !! ---------------------------------------------------------------- |
|---|
| 131 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: un_tm !: i-horizontal velocity average [m/s] |
|---|
| 132 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: vn_tm !: j-horizontal velocity average [m/s] |
|---|
| 133 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: tsn_tm !: t/s average [m/s] |
|---|
| 134 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: avt_tm !: vertical diffusivity coeff. at w-point [m2/s] |
|---|
| 135 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhop_tm !: |
|---|
| 136 | # if defined key_zdfddm |
|---|
| 137 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: avs_tm !: vertical double diffusivity coeff. at w-point [m/s] |
|---|
| 138 | # endif |
|---|
| 139 | #if defined key_trabbl |
|---|
| 140 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ahu_bbl_tm !: u-, w-points |
|---|
| 141 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ahv_bbl_tm !: j-direction slope at u-, w-points |
|---|
| 142 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: utr_bbl_tm !: j-direction slope at u-, w-points |
|---|
| 143 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vtr_bbl_tm !: j-direction slope at u-, w-points |
|---|
| 144 | #endif |
|---|
| 145 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshn_tm !: average ssh for the now step [m] |
|---|
| 146 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshb_hold !:hold sshb from the beginning of each sub-stepping[m] |
|---|
| 147 | |
|---|
| 148 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnf_tm !: river runoff |
|---|
| 149 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: h_rnf_tm !: depth in metres to the bottom of the relevant grid box |
|---|
| 150 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hmld_tm !: mixed layer depth average [m] |
|---|
| 151 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fr_i_tm !: average ice fraction [m/s] |
|---|
| 152 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp_tm !: freshwater budget: volume flux [Kg/m2/s] |
|---|
| 153 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fmmflx_tm !: freshwater budget: freezing/melting [Kg/m2/s] |
|---|
| 154 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp_b_hold !: hold emp from the beginning of each sub-stepping[m] |
|---|
| 155 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr_tm !: solar radiation average [m] |
|---|
| 156 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: wndm_tm !: 10m wind average [m] |
|---|
| 157 | ! |
|---|
| 158 | |
|---|
| 159 | ! Temporary physical arrays for sub_stepping |
|---|
| 160 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: tsn_temp |
|---|
| 161 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: un_temp,vn_temp,wn_temp !: hold current values of avt, un, vn, wn |
|---|
| 162 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: avt_temp, rhop_temp !: hold current values of avt, un, vn, wn |
|---|
| 163 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshn_temp, sshb_temp, ssha_temp, rnf_temp,h_rnf_temp |
|---|
| 164 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdivn_temp, rotn_temp |
|---|
| 165 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdivb_temp, rotb_temp |
|---|
| 166 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hmld_temp, qsr_temp, fr_i_temp,wndm_temp |
|---|
| 167 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp_temp, fmmflx_temp, emp_b_temp |
|---|
| 168 | ! |
|---|
| 169 | #if defined key_trabbl |
|---|
| 170 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ahu_bbl_temp, ahv_bbl_temp, utr_bbl_temp, vtr_bbl_temp !: hold current values |
|---|
| 171 | #endif |
|---|
| 172 | ! |
|---|
| 173 | # if defined key_zdfddm |
|---|
| 174 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: avs_temp !: salinity vertical diffusivity coeff. at w-point [m/s] |
|---|
| 175 | # endif |
|---|
| 176 | ! |
|---|
| 177 | #if defined key_bdy |
|---|
| 178 | CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: cn_trc_dflt ! Default OBC condition for all tracers |
|---|
| 179 | CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: cn_trc ! Choice of boundary condition for tracers |
|---|
| 180 | INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: nn_trcdmp_bdy !: =T Tracer damping |
|---|
| 181 | ! External data structure of BDY for TOP. Available elements: cn_obc, ll_trc, trcnow, dmp |
|---|
| 182 | TYPE(OBC_DATA), PUBLIC, ALLOCATABLE, DIMENSION(:,:), TARGET :: trcdta_bdy !: bdy external data (local process) |
|---|
| 183 | #endif |
|---|
| 184 | ! |
|---|
| 185 | |
|---|
| 186 | !!---------------------------------------------------------------------- |
|---|
| 187 | !! NEMO/TOP 3.3.1 , NEMO Consortium (2010) |
|---|
| 188 | !! $Id$ |
|---|
| 189 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 190 | !!---------------------------------------------------------------------- |
|---|
| 191 | CONTAINS |
|---|
| 192 | |
|---|
| 193 | INTEGER FUNCTION trc_alloc() |
|---|
| 194 | !!------------------------------------------------------------------- |
|---|
| 195 | !! *** ROUTINE trc_alloc *** |
|---|
| 196 | !!------------------------------------------------------------------- |
|---|
| 197 | USE lib_mpp, ONLY: ctl_warn |
|---|
| 198 | !!------------------------------------------------------------------- |
|---|
| 199 | INTEGER :: ierr(3) |
|---|
| 200 | !!------------------------------------------------------------------- |
|---|
| 201 | ierr(:) = 0 |
|---|
| 202 | ! |
|---|
| 203 | ALLOCATE( trn(jpi,jpj,jpk,jptra), trb(jpi,jpj,jpk,jptra), tra(jpi,jpj,jpk,jptra), & |
|---|
| 204 | & trc_i(jpi,jpj,jptra) , trc_o(jpi,jpj,jptra) , & |
|---|
| 205 | & gtru (jpi,jpj,jptra) , gtrv (jpi,jpj,jptra) , & |
|---|
| 206 | & gtrui(jpi,jpj,jptra) , gtrvi(jpi,jpj,jptra) , & |
|---|
| 207 | & trc_ice_ratio(jptra) , trc_ice_prescr(jptra) , cn_trc_o(jptra) , & |
|---|
| 208 | & sbc_trc_b(jpi,jpj,jptra), sbc_trc(jpi,jpj,jptra) , & |
|---|
| 209 | & cvol(jpi,jpj,jpk) , trai(jptra) , qsr_mean(jpi,jpj) , & |
|---|
| 210 | & ctrcnm(jptra) , ctrcln(jptra) , ctrcun(jptra) , & |
|---|
| 211 | & ln_trc_ini(jptra) , & |
|---|
| 212 | & ln_trc_sbc(jptra) , ln_trc_cbc(jptra) , ln_trc_obc(jptra) , & |
|---|
| 213 | #if defined key_bdy |
|---|
| 214 | & cn_trc_dflt(nb_bdy) , cn_trc(nb_bdy) , nn_trcdmp_bdy(nb_bdy) , & |
|---|
| 215 | & trcdta_bdy(jptra,nb_bdy) , & |
|---|
| 216 | #endif |
|---|
| 217 | & STAT = ierr(1) ) |
|---|
| 218 | ! |
|---|
| 219 | IF (jp_dia3d > 0 ) ALLOCATE( trc3d(jpi,jpj,jpk,jp_dia3d), STAT = ierr(2) ) |
|---|
| 220 | ! |
|---|
| 221 | IF (jp_dia2d > 0 ) ALLOCATE( trc2d(jpi,jpj,jpk,jp_dia2d), STAT = ierr(3) ) |
|---|
| 222 | ! |
|---|
| 223 | trc_alloc = MAXVAL( ierr ) |
|---|
| 224 | IF( trc_alloc /= 0 ) CALL ctl_warn('trc_alloc: failed to allocate arrays') |
|---|
| 225 | ! |
|---|
| 226 | END FUNCTION trc_alloc |
|---|
| 227 | |
|---|
| 228 | #else |
|---|
| 229 | !!---------------------------------------------------------------------- |
|---|
| 230 | !! Empty module : No passive tracer |
|---|
| 231 | !!---------------------------------------------------------------------- |
|---|
| 232 | #endif |
|---|
| 233 | |
|---|
| 234 | !!====================================================================== |
|---|
| 235 | END MODULE trc |
|---|
