| 1 | MODULE oce |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE oce *** |
|---|
| 4 | !! Ocean : dynamics and active tracers defined in memory |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 1.0 ! 2002-11 (G. Madec) F90: Free form and module |
|---|
| 7 | !! 3.1 ! 2009-02 (G. Madec, M. Leclair) pure z* coordinate |
|---|
| 8 | !! 3.3 ! 2010-09 (C. Ethe) TRA-TRC merge: add ts, gtsu, gtsv 4D arrays |
|---|
| 9 | !!---------------------------------------------------------------------- |
|---|
| 10 | USE par_oce ! ocean parameters |
|---|
| 11 | USE lib_mpp ! MPP library |
|---|
| 12 | |
|---|
| 13 | IMPLICIT NONE |
|---|
| 14 | PRIVATE |
|---|
| 15 | |
|---|
| 16 | PUBLIC oce_alloc ! routine called by nemo_init in nemogcm.F90 |
|---|
| 17 | |
|---|
| 18 | LOGICAL, PUBLIC :: l_traldf_rot = .FALSE. !: rotated laplacian operator for lateral diffusion |
|---|
| 19 | |
|---|
| 20 | !! dynamics and tracer fields ! before ! now ! after ! the after trends becomes the fields |
|---|
| 21 | !! -------------------------- ! fields ! fields ! trends ! only after tra_zdf and dyn_spg |
|---|
| 22 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ub , un , ua !: i-horizontal velocity [m/s] |
|---|
| 23 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: vb , vn , va !: j-horizontal velocity [m/s] |
|---|
| 24 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: wn !: vertical velocity [m/s] |
|---|
| 25 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rotb , rotn !: relative vorticity [s-1] |
|---|
| 26 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdivb, hdivn !: horizontal divergence [s-1] |
|---|
| 27 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tb , tn , ta !: potential temperature [Celcius] |
|---|
| 28 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sb , sn , sa !: salinity [psu] |
|---|
| 29 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: tsb , tsn , tsa !: 4D T-S fields [Celcius,psu] |
|---|
| 30 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rn2b , rn2 !: brunt-vaisala frequency**2 [s-2] |
|---|
| 31 | ! |
|---|
| 32 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhd !: in situ density anomalie rhd=(rho-rau0)/rau0 [no units] |
|---|
| 33 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rhop !: potential volumic mass [kg/m3] |
|---|
| 34 | |
|---|
| 35 | !! free surface ! before ! now ! after ! |
|---|
| 36 | !! ------------ ! fields ! fields ! trends ! |
|---|
| 37 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshb , sshn , ssha !: sea surface height at t-point [m] |
|---|
| 38 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshu_b , sshu_n , sshu_a !: sea surface height at u-point [m] |
|---|
| 39 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshv_b , sshv_n , sshv_a !: sea surface height at u-point [m] |
|---|
| 40 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sshf_n !: sea surface height at f-point [m] |
|---|
| 41 | ! |
|---|
| 42 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: spgu, spgv !: horizontal surface pressure gradient |
|---|
| 43 | |
|---|
| 44 | !! interpolated gradient (only used in zps case) |
|---|
| 45 | !! --------------------- |
|---|
| 46 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: gtsu, gtsv !: horizontal gradient of T, S bottom u-point |
|---|
| 47 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: gru , grv !: horizontal gradient of rd at bottom u-point |
|---|
| 48 | |
|---|
| 49 | !! * Control permutation of array indices |
|---|
| 50 | # include "oce_ftrans.h90" |
|---|
| 51 | |
|---|
| 52 | !!---------------------------------------------------------------------- |
|---|
| 53 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
|---|
| 54 | !! $Id$ |
|---|
| 55 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 56 | !!---------------------------------------------------------------------- |
|---|
| 57 | CONTAINS |
|---|
| 58 | |
|---|
| 59 | INTEGER FUNCTION oce_alloc() |
|---|
| 60 | !!---------------------------------------------------------------------- |
|---|
| 61 | !! *** FUNCTION oce_alloc *** |
|---|
| 62 | !!---------------------------------------------------------------------- |
|---|
| 63 | INTEGER :: ierr(2) |
|---|
| 64 | !!---------------------------------------------------------------------- |
|---|
| 65 | ! |
|---|
| 66 | ALLOCATE( ub (jpi,jpj,jpk) , un (jpi,jpj,jpk) , ua(jpi,jpj,jpk) , & |
|---|
| 67 | & vb (jpi,jpj,jpk) , vn (jpi,jpj,jpk) , va(jpi,jpj,jpk) , & |
|---|
| 68 | & wn (jpi,jpj,jpk) , & |
|---|
| 69 | & rotb (jpi,jpj,jpk) , rotn (jpi,jpj,jpk) , & |
|---|
| 70 | & hdivb(jpi,jpj,jpk) , hdivn(jpi,jpj,jpk) , & |
|---|
| 71 | & tb (jpi,jpj,jpk) , tn (jpi,jpj,jpk) , ta(jpi,jpj,jpk) , & |
|---|
| 72 | & sb (jpi,jpj,jpk) , sn (jpi,jpj,jpk) , sa (jpi,jpj,jpk) , & |
|---|
| 73 | & tsb (jpi,jpj,jpk,jpts) , tsn (jpi,jpj,jpk,jpts) , tsa(jpi,jpj,jpk,jpts) , & |
|---|
| 74 | & rn2b (jpi,jpj,jpk) , rn2 (jpi,jpj,jpk) , STAT=ierr(1) ) |
|---|
| 75 | ! |
|---|
| 76 | ALLOCATE(rhd (jpi,jpj,jpk) , & |
|---|
| 77 | & rhop(jpi,jpj,jpk) , & |
|---|
| 78 | & sshb (jpi,jpj) , sshn (jpi,jpj) , ssha (jpi,jpj) , & |
|---|
| 79 | & sshu_b(jpi,jpj) , sshu_n(jpi,jpj) , sshu_a(jpi,jpj) , & |
|---|
| 80 | & sshv_b(jpi,jpj) , sshv_n(jpi,jpj) , sshv_a(jpi,jpj) , & |
|---|
| 81 | & sshf_n(jpi,jpj) , & |
|---|
| 82 | & spgu (jpi,jpj) , spgv(jpi,jpj) , & |
|---|
| 83 | & gtsu(jpi,jpj,jpts), gtsv(jpi,jpj,jpts), & |
|---|
| 84 | & gru(jpi,jpj) , grv(jpi,jpj) , STAT=ierr(2) ) |
|---|
| 85 | ! |
|---|
| 86 | oce_alloc = MAXVAL( ierr ) |
|---|
| 87 | IF( oce_alloc /= 0 ) CALL ctl_warn('oce_alloc: failed to allocate arrays') |
|---|
| 88 | ! |
|---|
| 89 | END FUNCTION oce_alloc |
|---|
| 90 | |
|---|
| 91 | !!====================================================================== |
|---|
| 92 | END MODULE oce |
|---|
