[3] | 1 | MODULE oce |
---|
| 2 | !!====================================================================== |
---|
[15] | 3 | !! *** MODULE oce *** |
---|
[3] | 4 | !! Ocean : dynamics and active tracers defined in memory |
---|
| 5 | !!====================================================================== |
---|
[2528] | 6 | !! History : 1.0 ! 2002-11 (G. Madec) F90: Free form and module |
---|
[1438] | 7 | !! 3.1 ! 2009-02 (G. Madec, M. Leclair) pure z* coordinate |
---|
[2528] | 8 | !! 3.3 ! 2010-09 (C. Ethe) TRA-TRC merge: add ts, gtsu, gtsv 4D arrays |
---|
[5836] | 9 | !! 3.7 ! 2014-01 (G. Madec) suppression of curl and before hdiv from in-core memory |
---|
[12377] | 10 | !! 4.1 ! 2019-08 (A. Coward, D. Storkey) rename prognostic variables in preparation for new time scheme |
---|
[3] | 11 | !!---------------------------------------------------------------------- |
---|
[2715] | 12 | USE par_oce ! ocean parameters |
---|
| 13 | USE lib_mpp ! MPP library |
---|
[3] | 14 | |
---|
| 15 | IMPLICIT NONE |
---|
[15] | 16 | PRIVATE |
---|
[3] | 17 | |
---|
[14063] | 18 | PUBLIC oce_alloc ! routine called by nemo_init in nemogcm.F90 |
---|
| 19 | PUBLIC oce_SWE_alloc ! routine called by nemo_init in SWE/nemogcm.F90 (Shallow Water Eq. case) |
---|
[3] | 20 | |
---|
[12377] | 21 | !! dynamics and tracer fields |
---|
| 22 | !! -------------------------- |
---|
| 23 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: uu , vv !: horizontal velocities [m/s] |
---|
| 24 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ww !: vertical velocity [m/s] |
---|
| 25 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: wi !: vertical vel. (adaptive-implicit) [m/s] |
---|
| 26 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdiv !: horizontal divergence [s-1] |
---|
| 27 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:) :: ts !: 4D T-S fields [Celsius,psu] |
---|
| 28 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: rab_b, rab_n !: thermal/haline expansion coef. [Celsius-1,psu-1] |
---|
| 29 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rn2b , rn2 !: brunt-vaisala frequency**2 [s-2] |
---|
[1438] | 30 | ! |
---|
[12489] | 31 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhd !: in situ density anomalie rhd=(rho-rho0)/rho0 [no units] |
---|
[2715] | 32 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhop !: potential volumic mass [kg/m3] |
---|
[10364] | 33 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: Cu_adv !: vertical Courant number (adaptive-implicit) |
---|
[3] | 34 | |
---|
[13237] | 35 | !! free surface |
---|
| 36 | !! ------------ |
---|
[12377] | 37 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ssh, uu_b, vv_b !: SSH [m] and barotropic velocities [m/s] |
---|
[359] | 38 | |
---|
[6140] | 39 | !! Arrays at barotropic time step: ! befbefore! before ! now ! after ! |
---|
| 40 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ubb_e , ub_e , un_e , ua_e !: u-external velocity |
---|
| 41 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vbb_e , vb_e , vn_e , va_e !: v-external velocity |
---|
| 42 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshbb_e, sshb_e, sshn_e, ssha_e !: external ssh |
---|
| 43 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hu_e !: external u-depth |
---|
| 44 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hv_e !: external v-depth |
---|
| 45 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hur_e !: inverse of u-depth |
---|
| 46 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: hvr_e !: inverse of v-depth |
---|
| 47 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ub2_b , vb2_b !: Half step fluxes (ln_bt_fw=T) |
---|
[9023] | 48 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: un_bf , vn_bf !: Asselin filtered half step fluxes (ln_bt_fw=T) |
---|
[5930] | 49 | #if defined key_agrif |
---|
[6140] | 50 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ub2_i_b, vb2_i_b !: Half step time integrated fluxes |
---|
[5930] | 51 | #endif |
---|
| 52 | |
---|
[2528] | 53 | !! interpolated gradient (only used in zps case) |
---|
| 54 | !! --------------------- |
---|
[2715] | 55 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtsu, gtsv !: horizontal gradient of T, S bottom u-point |
---|
| 56 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: gru , grv !: horizontal gradient of rd at bottom u-point |
---|
[2528] | 57 | |
---|
[4990] | 58 | !! (ISF) interpolated gradient (only used for ice shelf case) |
---|
| 59 | !! --------------------- |
---|
| 60 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtui, gtvi !: horizontal gradient of T, S and rd at top u-point |
---|
| 61 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: grui, grvi !: horizontal gradient of T, S and rd at top v-point |
---|
| 62 | !! (ISF) ice load |
---|
| 63 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: riceload |
---|
| 64 | |
---|
| 65 | !! Energy budget of the leads (open water embedded in sea ice) |
---|
[12377] | 66 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fraqsr_1lev !: fraction of solar net radiation absorbed in the first ocean level [-] |
---|
| 67 | INTEGER, PUBLIC, DIMENSION(2) :: noce_array !: unused array but seems to be needed to prevent agrif from creating an empty module |
---|
[4205] | 68 | |
---|
[14063] | 69 | !! Shallow Water Eq. case (SWE) |
---|
| 70 | LOGICAL, PUBLIC :: lk_SWE = .FALSE. !: shallow water flag =T in SWE configurations only |
---|
| 71 | |
---|
| 72 | !! Stand-Alone Surface module (SAS) |
---|
| 73 | LOGICAL, PUBLIC :: l_SAS = .FALSE. !: SAS flag =T in SAS configurations only |
---|
| 74 | |
---|
| 75 | |
---|
[3] | 76 | !!---------------------------------------------------------------------- |
---|
[9598] | 77 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[1438] | 78 | !! $Id$ |
---|
[10068] | 79 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[2715] | 80 | !!---------------------------------------------------------------------- |
---|
| 81 | CONTAINS |
---|
| 82 | |
---|
| 83 | INTEGER FUNCTION oce_alloc() |
---|
| 84 | !!---------------------------------------------------------------------- |
---|
| 85 | !! *** FUNCTION oce_alloc *** |
---|
| 86 | !!---------------------------------------------------------------------- |
---|
[9019] | 87 | INTEGER :: ierr(6) |
---|
[2715] | 88 | !!---------------------------------------------------------------------- |
---|
| 89 | ! |
---|
[6140] | 90 | ierr(:) = 0 |
---|
[14065] | 91 | ALLOCATE( uu (jpi,jpj,jpk,jpt) , vv (jpi,jpj,jpk,jpt) , & |
---|
| 92 | & ww (jpi,jpj,jpk) , hdiv(jpi,jpj,jpk) , & |
---|
| 93 | & ts (jpi,jpj,jpk,jpts,jpt) , & |
---|
| 94 | & rab_b(jpi,jpj,jpk,jpts) , rab_n(jpi,jpj,jpk,jpts) , & |
---|
| 95 | & rn2b (jpi,jpj,jpk) , rn2 (jpi,jpj,jpk) , & |
---|
| 96 | & rhd (jpi,jpj,jpk) , rhop (jpi,jpj,jpk) , STAT=ierr(1) ) |
---|
[2715] | 97 | ! |
---|
[14065] | 98 | ALLOCATE( ssh (jpi,jpj,jpt) , uu_b(jpi,jpj,jpt) , vv_b(jpi,jpj,jpt) , & |
---|
| 99 | & gtsu(jpi,jpj,jpts) , gtsv(jpi,jpj,jpts) , & |
---|
| 100 | & gru (jpi,jpj) , grv (jpi,jpj) , & |
---|
| 101 | & gtui(jpi,jpj,jpts) , gtvi(jpi,jpj,jpts) , & |
---|
| 102 | & grui(jpi,jpj) , grvi(jpi,jpj) , & |
---|
| 103 | & riceload(jpi,jpj) , STAT=ierr(2) ) |
---|
[2715] | 104 | ! |
---|
[9019] | 105 | ALLOCATE( fraqsr_1lev(jpi,jpj) , STAT=ierr(3) ) |
---|
[3625] | 106 | ! |
---|
[6140] | 107 | ALLOCATE( ssha_e(jpi,jpj), sshn_e(jpi,jpj), sshb_e(jpi,jpj), sshbb_e(jpi,jpj), & |
---|
| 108 | & ua_e(jpi,jpj), un_e(jpi,jpj), ub_e(jpi,jpj), ubb_e(jpi,jpj), & |
---|
| 109 | & va_e(jpi,jpj), vn_e(jpi,jpj), vb_e(jpi,jpj), vbb_e(jpi,jpj), & |
---|
[9019] | 110 | & hu_e(jpi,jpj), hur_e(jpi,jpj), hv_e(jpi,jpj), hvr_e(jpi,jpj), STAT=ierr(4) ) |
---|
[6140] | 111 | ! |
---|
[9023] | 112 | ALLOCATE( ub2_b(jpi,jpj), vb2_b(jpi,jpj), un_bf(jpi,jpj), vn_bf(jpi,jpj) , STAT=ierr(6) ) |
---|
[6140] | 113 | #if defined key_agrif |
---|
[9019] | 114 | ALLOCATE( ub2_i_b(jpi,jpj), vb2_i_b(jpi,jpj) , STAT=ierr(6) ) |
---|
[6140] | 115 | #endif |
---|
| 116 | ! |
---|
[2715] | 117 | oce_alloc = MAXVAL( ierr ) |
---|
[10425] | 118 | IF( oce_alloc /= 0 ) CALL ctl_stop( 'STOP', 'oce_alloc: failed to allocate arrays' ) |
---|
[2715] | 119 | ! |
---|
| 120 | END FUNCTION oce_alloc |
---|
| 121 | |
---|
[14063] | 122 | |
---|
| 123 | INTEGER FUNCTION oce_SWE_alloc() |
---|
| 124 | !!---------------------------------------------------------------------- |
---|
| 125 | !! *** FUNCTION oce_SWE_alloc *** |
---|
| 126 | !!---------------------------------------------------------------------- |
---|
| 127 | INTEGER :: ierr(2) |
---|
| 128 | !!---------------------------------------------------------------------- |
---|
| 129 | ! |
---|
| 130 | lk_SWE = .TRUE. ! =T SWE case |
---|
| 131 | ! |
---|
| 132 | ierr(:) = 0 |
---|
| 133 | ALLOCATE( uu(jpi,jpj,jpk,jpt) , vv (jpi,jpj,jpk,jpt) , & |
---|
| 134 | & ww(jpi,jpj,jpk) , hdiv(jpi,jpj,jpk) , ssh(jpi,jpj,jpt) , STAT=ierr(1) ) |
---|
| 135 | ! |
---|
| 136 | ALLOCATE( ts(jpi,jpj,jpk,jpts,jpt) , fraqsr_1lev(jpi,jpj) , & |
---|
| 137 | & uu_b(jpi,jpj,jpt) , vv_b(jpi,jpj,jpt) , rn2(jpi,jpj,jpk) , STAT=ierr(2) ) |
---|
| 138 | ! |
---|
| 139 | oce_SWE_alloc = MAXVAL( ierr ) |
---|
| 140 | IF( oce_SWE_alloc /= 0 ) CALL ctl_stop( 'STOP', 'oce_SWE_alloc: failed to allocate arrays' ) |
---|
| 141 | ! |
---|
| 142 | END FUNCTION oce_SWE_alloc |
---|
| 143 | |
---|
[1438] | 144 | !!====================================================================== |
---|
[3] | 145 | END MODULE oce |
---|