New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
trc.F90 in NEMO/trunk/src/TOP – NEMO

source: NEMO/trunk/src/TOP/trc.F90 @ 12489

Last change on this file since 12489 was 12489, checked in by davestorkey, 4 years ago

Preparation for new timestepping scheme #2390.
Main changes:

  1. Initial euler timestep now handled in stp and not in TRA/DYN routines.
  2. Renaming of all timestep parameters. In summary, the namelist parameter is now rn_Dt and the current timestep is rDt (and rDt_ice, rDt_trc etc).
  3. Renaming of a few miscellaneous parameters, eg. atfp -> rn_atfp (namelist parameter used everywhere) and rau0 -> rho0.

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