[3] | 1 | MODULE ldftra_oce |
---|
| 2 | !!===================================================================== |
---|
| 3 | !! *** MODULE ldftra_oce *** |
---|
| 4 | !! Ocean physics : lateral tracer mixing coefficient defined in memory |
---|
| 5 | !!===================================================================== |
---|
[2715] | 6 | !! History : 9.0 ! 2002-11 (G. Madec) Original code |
---|
[3] | 7 | !!---------------------------------------------------------------------- |
---|
[2715] | 8 | USE par_oce ! ocean parameters |
---|
| 9 | USE in_out_manager ! I/O manager |
---|
| 10 | USE lib_mpp ! MPP library |
---|
[3] | 11 | |
---|
| 12 | IMPLICIT NONE |
---|
| 13 | PRIVATE |
---|
| 14 | |
---|
[2715] | 15 | PUBLIC ldftra_oce_alloc ! called by nemo_init->nemo_alloc, nemogcm.F90 |
---|
| 16 | |
---|
[3] | 17 | !!---------------------------------------------------------------------- |
---|
| 18 | !! Lateral eddy diffusivity coefficients (tracers) |
---|
| 19 | !!---------------------------------------------------------------------- |
---|
[1601] | 20 | ! !!* Namelist namtra_ldf : lateral mixing * |
---|
| 21 | LOGICAL , PUBLIC :: ln_traldf_lap = .TRUE. !: laplacian operator |
---|
| 22 | LOGICAL , PUBLIC :: ln_traldf_bilap = .FALSE. !: bilaplacian operator |
---|
| 23 | LOGICAL , PUBLIC :: ln_traldf_level = .FALSE. !: iso-level direction |
---|
| 24 | LOGICAL , PUBLIC :: ln_traldf_hor = .FALSE. !: horizontal (geopotential) direction |
---|
| 25 | LOGICAL , PUBLIC :: ln_traldf_iso = .TRUE. !: iso-neutral direction |
---|
[2528] | 26 | LOGICAL , PUBLIC :: ln_traldf_grif = .FALSE. !: griffies skew flux |
---|
| 27 | LOGICAL , PUBLIC :: ln_traldf_gdia = .FALSE. !: griffies skew flux streamfunction diagnostics |
---|
[1601] | 28 | REAL(wp), PUBLIC :: rn_aht_0 = 2000._wp !: lateral eddy diffusivity (m2/s) |
---|
| 29 | REAL(wp), PUBLIC :: rn_ahtb_0 = 0._wp !: lateral background eddy diffusivity (m2/s) |
---|
| 30 | REAL(wp), PUBLIC :: rn_aeiv_0 = 2000._wp !: eddy induced velocity coefficient (m2/s) |
---|
[2528] | 31 | REAL(wp), PUBLIC :: rn_slpmax = 0.01_wp !: slope limit |
---|
[3] | 32 | |
---|
[1601] | 33 | REAL(wp), PUBLIC :: aht0, ahtb0, aeiv0 !!: OLD namelist names |
---|
[2528] | 34 | LOGICAL , PUBLIC :: l_triad_iso = .FALSE. !: calculate triads twice |
---|
| 35 | LOGICAL , PUBLIC :: l_no_smooth = .FALSE. !: no Shapiro smoothing |
---|
[3] | 36 | |
---|
| 37 | #if defined key_traldf_c3d |
---|
[2715] | 38 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ahtt, ahtu, ahtv, ahtw !: ** 3D coefficients ** at T-,U-,V-,W-points |
---|
[3] | 39 | #elif defined key_traldf_c2d |
---|
[2715] | 40 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ahtt, ahtu, ahtv, ahtw !: ** 2D coefficients ** at T-,U-,V-,W-points |
---|
[3] | 41 | #elif defined key_traldf_c1d |
---|
[2715] | 42 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: ahtt, ahtu, ahtv, ahtw !: ** 1D coefficients ** at T-,U-,V-,W-points |
---|
[3] | 43 | #else |
---|
[2715] | 44 | REAL(wp), PUBLIC :: ahtt, ahtu, ahtv, ahtw !: ** 0D coefficients ** at T-,U-,V-,W-points |
---|
[3] | 45 | #endif |
---|
| 46 | |
---|
| 47 | #if defined key_traldf_eiv |
---|
| 48 | !!---------------------------------------------------------------------- |
---|
| 49 | !! 'key_traldf_eiv' eddy induced velocity |
---|
| 50 | !!---------------------------------------------------------------------- |
---|
[2528] | 51 | LOGICAL, PUBLIC, PARAMETER :: lk_traldf_eiv = .TRUE. !: eddy induced velocity flag |
---|
[2715] | 52 | |
---|
| 53 | ! !!! eddy coefficients at U-, V-, W-points [m2/s] |
---|
[3] | 54 | # if defined key_traldf_c3d |
---|
[2715] | 55 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: aeiu , aeiv , aeiw !: ** 3D coefficients ** |
---|
[3] | 56 | # elif defined key_traldf_c2d |
---|
[2715] | 57 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: aeiu , aeiv , aeiw !: ** 2D coefficients ** |
---|
[3] | 58 | # elif defined key_traldf_c1d |
---|
[2715] | 59 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: aeiu , aeiv , aeiw !: ** 1D coefficients ** |
---|
[3] | 60 | # else |
---|
[2715] | 61 | REAL(wp), PUBLIC :: aeiu , aeiv , aeiw !: ** 0D coefficients ** |
---|
[3] | 62 | # endif |
---|
| 63 | # if defined key_diaeiv |
---|
[2715] | 64 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: u_eiv, v_eiv, w_eiv !: eddy induced velocity [m/s] |
---|
[3] | 65 | # endif |
---|
| 66 | |
---|
| 67 | #else |
---|
| 68 | !!---------------------------------------------------------------------- |
---|
| 69 | !! Default option : NO eddy induced velocity |
---|
| 70 | !!---------------------------------------------------------------------- |
---|
[32] | 71 | LOGICAL , PUBLIC, PARAMETER :: lk_traldf_eiv = .FALSE. !: eddy induced velocity flag |
---|
[1601] | 72 | REAL(wp), PUBLIC :: aeiu, aeiv, aeiw !: eddy induced coef. (not used) |
---|
[3] | 73 | #endif |
---|
| 74 | |
---|
| 75 | !!---------------------------------------------------------------------- |
---|
[2528] | 76 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[1601] | 77 | !! $Id$ |
---|
[2528] | 78 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[2715] | 79 | !!---------------------------------------------------------------------- |
---|
| 80 | CONTAINS |
---|
| 81 | |
---|
| 82 | INTEGER FUNCTION ldftra_oce_alloc() |
---|
| 83 | !!---------------------------------------------------------------------- |
---|
| 84 | !! *** FUNCTION ldftra_oce_alloc *** |
---|
| 85 | !!---------------------------------------------------------------------- |
---|
| 86 | INTEGER, DIMENSION(3) :: ierr |
---|
| 87 | !!---------------------------------------------------------------------- |
---|
| 88 | ierr(:) = 0 |
---|
| 89 | |
---|
| 90 | #if defined key_traldf_c3d |
---|
| 91 | ALLOCATE( ahtt(jpi,jpj,jpk) , ahtu(jpi,jpj,jpk) , ahtv(jpi,jpj,jpk) , ahtw(jpi,jpj,jpk) , STAT=ierr(1) ) |
---|
| 92 | #elif defined key_traldf_c2d |
---|
| 93 | ALLOCATE( ahtt(jpi,jpj ) , ahtu(jpi,jpj ) , ahtv(jpi,jpj ) , ahtw(jpi,jpj ) , STAT=ierr(1) ) |
---|
| 94 | #elif defined key_traldf_c1d |
---|
| 95 | ALLOCATE( ahtt( jpk) , ahtu( jpk) , ahtv( jpk) , ahtw( jpk) , STAT=ierr(1) ) |
---|
| 96 | #endif |
---|
| 97 | ! |
---|
| 98 | #if defined key_traldf_eiv |
---|
| 99 | # if defined key_traldf_c3d |
---|
| 100 | ALLOCATE( aeiu(jpi,jpj,jpk) , aeiv(jpi,jpj,jpk) , aeiw(jpi,jpj,jpk) , STAT=ierr(2) ) |
---|
| 101 | # elif defined key_traldf_c2d |
---|
| 102 | ALLOCATE( aeiu(jpi,jpj ) , aeiv(jpi,jpj ) , aeiw(jpi,jpj ) , STAT=ierr(2) ) |
---|
| 103 | # elif defined key_traldf_c1d |
---|
| 104 | ALLOCATE( aeiu( jpk) , aeiv( jpk) , aeiw( jpk) , STAT=ierr(2) ) |
---|
| 105 | # endif |
---|
| 106 | # if defined key_diaeiv |
---|
| 107 | ALLOCATE( u_eiv(jpi,jpj,jpk), v_eiv(jpi,jpj,jpk), w_eiv(jpi,jpj,jpk), STAT=ierr(3)) |
---|
| 108 | # endif |
---|
| 109 | #endif |
---|
| 110 | ldftra_oce_alloc = MAXVAL( ierr ) |
---|
| 111 | IF( ldftra_oce_alloc /= 0 ) CALL ctl_warn('ldftra_oce_alloc: failed to allocate arrays') |
---|
| 112 | ! |
---|
| 113 | END FUNCTION ldftra_oce_alloc |
---|
| 114 | |
---|
[1601] | 115 | !!===================================================================== |
---|
[3] | 116 | END MODULE ldftra_oce |
---|