source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/NST/agrif_oce.F90 @ 13219

Last change on this file since 13219 was 13219, checked in by smasson, 3 months ago

better e3: update with trunk@13218 see #2385

  • Property svn:keywords set to Id
File size: 6.1 KB
Line 
1MODULE agrif_oce
2   !!======================================================================
3   !!                       ***  MODULE agrif_oce  ***
4   !! AGRIF :   define in memory AGRIF variables
5   !!----------------------------------------------------------------------
6   !! History :  2.0  ! 2007-12  (R. Benshila)  Original code
7   !!----------------------------------------------------------------------
8#if defined key_agrif
9   !!----------------------------------------------------------------------
10   !!   'key_agrif'                                              AGRIF zoom
11   !!----------------------------------------------------------------------
12   USE par_oce      ! ocean parameters
13   USE dom_oce      ! domain parameters
14
15   IMPLICIT NONE
16   PRIVATE
17
18   PUBLIC agrif_oce_alloc ! routine called by nemo_init in nemogcm.F90
19 
20   !                                              !!* Namelist namagrif: AGRIF parameters
21   LOGICAL , PUBLIC ::   ln_init_chfrpar = .FALSE. !: set child grids initial state from parent
22   LOGICAL , PUBLIC ::   ln_agrif_2way = .TRUE.    !: activate two way nesting
23   LOGICAL , PUBLIC ::   ln_spc_dyn    = .FALSE.   !: use zeros (.false.) or not (.true.) in
24                                                   !: bdys dynamical fields interpolation
25   REAL(wp), PUBLIC ::   rn_sponge_tra = 2800.     !: sponge coeff. for tracers
26   REAL(wp), PUBLIC ::   rn_sponge_dyn = 2800.     !: sponge coeff. for dynamics
27   REAL(wp), PUBLIC ::   rn_trelax_tra = 0.01      !: time relaxation parameter for tracers
28   REAL(wp), PUBLIC ::   rn_trelax_dyn = 0.01      !: time relaxation parameter for momentum
29   LOGICAL , PUBLIC ::   ln_chk_bathy  = .FALSE.   !: check of parent bathymetry
30   !
31   INTEGER , PUBLIC, PARAMETER ::   nn_sponge_len = 2  !: Sponge width (in number of parent grid points)
32
33   LOGICAL , PUBLIC :: spongedoneT = .FALSE.       !: tracer   sponge layer indicator
34   LOGICAL , PUBLIC :: spongedoneU = .FALSE.       !: dynamics sponge layer indicator
35   LOGICAL , PUBLIC :: lk_agrif_fstep = .TRUE.     !: if true: first step
36   LOGICAL , PUBLIC :: lk_agrif_debug = .FALSE.    !: if true: print debugging info
37
38   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tabspongedone_tsn
39# if defined key_top
40   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tabspongedone_trn
41# endif
42   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tabspongedone_u
43   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tabspongedone_v
44   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: utint_stage
45   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vtint_stage
46   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fspu, fspv !: sponge arrays
47   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fspt, fspf !:   "      "
48
49   ! Barotropic arrays used to store open boundary data during time-splitting loop:
50   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::  ubdy, vbdy, hbdy
51   INTEGER , PUBLIC,              SAVE                 ::  Kbb_a, Kmm_a, Krhs_a   !: AGRIF module-specific copies of time-level indices
52
53   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ht0_parent, hu0_parent, hv0_parent
54   INTEGER,  PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: mbkt_parent, mbku_parent, mbkv_parent
55
56   INTEGER, PUBLIC :: tsn_id                                                  ! AGRIF profile for tracers interpolation and update
57   INTEGER, PUBLIC :: un_interp_id, vn_interp_id                              ! AGRIF profiles for interpolations
58   INTEGER, PUBLIC :: un_update_id, vn_update_id                              ! AGRIF profiles for udpates
59   INTEGER, PUBLIC :: tsn_sponge_id, un_sponge_id, vn_sponge_id               ! AGRIF profiles for sponge layers
60   INTEGER, PUBLIC :: tsini_id, uini_id, vini_id, sshini_id                   ! AGRIF profile for initialization
61# if defined key_top
62   INTEGER, PUBLIC :: trn_id, trn_sponge_id
63# endif 
64   INTEGER, PUBLIC :: unb_id, vnb_id, ub2b_interp_id, vb2b_interp_id
65   INTEGER, PUBLIC :: ub2b_update_id, vb2b_update_id
66   INTEGER, PUBLIC :: e3t_id, e1u_id, e2v_id, sshn_id
67   INTEGER, PUBLIC :: scales_t_id
68   INTEGER, PUBLIC :: avt_id, avm_id, en_id                ! TKE related identificators
69   INTEGER, PUBLIC :: mbkt_id, ht0_id
70   INTEGER, PUBLIC :: kindic_agr
71
72   ! North fold
73!$AGRIF_DO_NOT_TREAT
74   LOGICAL, PUBLIC :: use_sign_north
75   REAL, PUBLIC :: sign_north
76   LOGICAL, PUBLIC :: l_ini_child = .FALSE.
77# if defined key_vertical
78   LOGICAL, PUBLIC :: l_vremap    = .TRUE.
79# else
80   LOGICAL, PUBLIC :: l_vremap    = .FALSE.
81# endif
82!$AGRIF_END_DO_NOT_TREAT
83   
84   !!----------------------------------------------------------------------
85   !! NEMO/NST 4.0 , NEMO Consortium (2018)
86   !! $Id$
87   !! Software governed by the CeCILL license (see ./LICENSE)
88   !!----------------------------------------------------------------------
89CONTAINS
90
91   INTEGER FUNCTION agrif_oce_alloc()
92      !!----------------------------------------------------------------------
93      !!                ***  FUNCTION agrif_oce_alloc  ***
94      !!----------------------------------------------------------------------
95      INTEGER, DIMENSION(2) :: ierr
96      !!----------------------------------------------------------------------
97      ierr(:) = 0
98      !
99      ALLOCATE( fspu(jpi,jpj), fspv(jpi,jpj),          &
100         &      fspt(jpi,jpj), fspf(jpi,jpj),               &
101         &      tabspongedone_tsn(jpi,jpj),                 &
102         &      utint_stage(jpi,jpj), vtint_stage(jpi,jpj), &
103# if defined key_top         
104         &      tabspongedone_trn(jpi,jpj),           &
105# endif   
106         &      ht0_parent(jpi,jpj), mbkt_parent(jpi,jpj),  &
107         &      hu0_parent(jpi,jpj), mbku_parent(jpi,jpj),  &
108         &      hv0_parent(jpi,jpj), mbkv_parent(jpi,jpj),  &
109         &      tabspongedone_u  (jpi,jpj),           &
110         &      tabspongedone_v  (jpi,jpj), STAT = ierr(1) )
111
112      ALLOCATE( ubdy(jpi,jpj), vbdy(jpi,jpj), hbdy(jpi,jpj), STAT = ierr(2) )
113
114      agrif_oce_alloc = MAXVAL(ierr)
115      !
116   END FUNCTION agrif_oce_alloc
117
118#endif
119   !!======================================================================
120END MODULE agrif_oce
Note: See TracBrowser for help on using the repository browser.