source: NEMO/branches/2020/dev_r12740_TOP-01_rlod_Antarctic_ice_Sheet_Fe_Source/src/TOP/trc.F90 @ 13524

Last change on this file since 13524 was 13524, checked in by rlod, 7 months ago

First step of nutrient sources from Antarctic Ice Sheet

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