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.
isf_oce.F90 in NEMO/trunk/tests/ISOMIP+/MY_SRC – NEMO

source: NEMO/trunk/tests/ISOMIP+/MY_SRC/isf_oce.F90

Last change on this file was 14995, checked in by mathiot, 3 years ago

ticket #2669 : merge ticket2669_isf_fluxes into trunk
File size: 13.2 KB
Line 
1MODULE isf_oce
2   !!======================================================================
3   !!                       ***  MODULE  isf_oce  ***
4   !! Ice shelves :  ice shelves variables defined in memory
5   !!======================================================================
6   !! History :  3.2  !  2011-02  (C.Harris  ) Original code isf cav
7   !!            X.X  !  2006-02  (C. Wang   ) Original code bg03
8   !!            3.4  !  2013-03  (P. Mathiot) Merging + parametrization
9   !!            4.1  !  2019-09  (P. Mathiot) Split param/explicit ice shelf and re-organisation
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   isf          : define and allocate ice shelf variables
14   !!----------------------------------------------------------------------
15
16   USE par_oce       , ONLY: jpi, jpj, jpk
17   USE in_out_manager, ONLY: wp, jpts ! I/O manager
18   USE lib_mpp       , ONLY: ctl_stop, mpp_sum      ! MPP library
19   USE fldread        ! read input fields
20
21   IMPLICIT NONE
22
23   PRIVATE
24
25   PUBLIC   isf_alloc, isf_alloc_par, isf_alloc_cav, isf_alloc_cpl, isf_dealloc_cpl
26   !
27   !-------------------------------------------------------
28   ! 0 :              namelist parameter
29   !-------------------------------------------------------
30   !
31   ! 0.1 -------- ice shelf cavity parameter --------------
32   CHARACTER(LEN=256), PUBLIC :: cn_isfdir
33   LOGICAL           , PUBLIC :: ln_isf
34   LOGICAL           , PUBLIC :: ln_isfdebug
35   !
36   ! 0.2 -------- ice shelf cavity opened namelist parameter -------------
37   LOGICAL           , PUBLIC :: ln_isfcav_mlt   !: logical for the use of ice shelf parametrisation
38   REAL(wp)          , PUBLIC :: rn_gammat0      !: temperature exchange coeficient    []
39   REAL(wp)          , PUBLIC :: rn_gammas0      !: salinity    exchange coeficient    []
40   REAL(wp)          , PUBLIC :: rn_vtide        !: tidal background velocity (can be different to what is used in the
41   REAL(wp)          , PUBLIC :: rn_htbl         !: Losch top boundary layer thickness [m]
42   REAL(wp)          , PUBLIC :: rn_isfload_T    !:
43   REAL(wp)          , PUBLIC :: rn_isfload_S    !:
44   CHARACTER(LEN=256), PUBLIC :: cn_gammablk     !: gamma formulation
45   CHARACTER(LEN=256), PUBLIC :: cn_isfcav_mlt   !: melt formulation (cavity/param)
46   CHARACTER(LEN=256), PUBLIC :: cn_isfload      !: ice shelf load computation method
47   TYPE(FLD_N)       , PUBLIC :: sn_isfcav_fwf   !: information about the isf melting file to be read
48   !
49   ! 0.3 -------- ice shelf cavity parametrised namelist parameter -------------
50   LOGICAL           , PUBLIC :: ln_isfpar_mlt      !: logical for the computation of melt inside the cavity
51   REAL(wp)          , PUBLIC :: rn_isfpar_bg03_gt0 !: temperature exchange coeficient [m/s]
52   CHARACTER(LEN=256), PUBLIC :: cn_isfpar_mlt      !: melt formulation (cavity/param)
53   TYPE(FLD_N)       , PUBLIC :: sn_isfpar_fwf      !: information about the isf melting file to be read
54   TYPE(FLD_N)       , PUBLIC :: sn_isfpar_zmax     !: information about the grounding line depth file to be read
55   TYPE(FLD_N)       , PUBLIC :: sn_isfpar_zmin     !: information about the calving   line depth file to be read
56   TYPE(FLD_N)       , PUBLIC :: sn_isfpar_Leff     !: information about the effective length     file to be read
57   !
58   ! 0.4 -------- coupling namelist parameter -------------
59   LOGICAL, PUBLIC :: ln_isfcpl      !:
60   LOGICAL, PUBLIC :: ln_isfcpl_cons !:
61   INTEGER, PUBLIC :: nn_drown       !:
62   !
63   !-------------------------------------------------------
64   ! 1 :              ice shelf parameter
65   !-------------------------------------------------------
66   !
67   REAL(wp), PARAMETER, PUBLIC :: rLfusisf = 0.334e6_wp    !: latent heat of fusion of ice shelf     [J/kg]
68   REAL(wp), PARAMETER, PUBLIC :: rcpisf = 2000.0_wp       !: specific heat of ice shelf             [J/kg/K]
69   REAL(wp), PARAMETER, PUBLIC :: rkappa = 0.0_wp          !: ISOMIP+ no heat diffusivity through the ice-shelf [m2/s]
70   REAL(wp), PARAMETER, PUBLIC :: rhoisf = 920.0_wp        !: volumic mass of ice shelf              [kg/m3]
71   REAL(wp), PARAMETER, PUBLIC :: rtsurf = -20.0           !: surface temperature                    [C]
72   !
73   !-------------------------------------------------------
74   ! 2 :              ice shelf global variables
75   !-------------------------------------------------------
76   !
77   ! 2.1 -------- ice shelf cavity parameter --------------
78   LOGICAL , PUBLIC            :: l_isfoasis = .FALSE.
79   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)    ::   risfload                    !: ice shelf load
80   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)    ::   fwfisf_oasis
81   !
82   ! 2.2 -------- ice shelf cavity melt namelist parameter -------------
83   INTEGER  , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: mskisf_cav                    !:
84   INTEGER  , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: misfkt_cav   , misfkb_cav     !:
85   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: rhisf_tbl_cav, rfrac_tbl_cav  !:
86   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: fwfisf_cav   , fwfisf_cav_b   !: before and now net fwf from the ice shelf        [kg/m2/s]
87   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: risf_cav_tsc , risf_cav_tsc_b !: before and now T & S isf contents [K.m/s & PSU.m/s] 
88   TYPE(FLD), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)     :: sf_isfcav_fwf                 !:
89   !
90   REAL(wp) , PUBLIC                                      :: risf_lamb1, risf_lamb2, risf_lamb3  ! freezing point linearization coeficient
91   !
92   ! 2.3 -------- ice shelf param. melt namelist parameter -------------
93   INTEGER  , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: mskisf_par                    !:
94   INTEGER  , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: misfkt_par   , misfkb_par     !:
95   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: rhisf_tbl_par, rfrac_tbl_par  !:
96   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: fwfisf_par   , fwfisf_par_b   !: before and now net fwf from the ice shelf        [kg/m2/s]
97   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: risf_par_tsc , risf_par_tsc_b !: before and now T & S isf contents [K.m/s & PSU.m/s] 
98   TYPE(FLD), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)     :: sf_isfpar_fwf                 !:
99   !
100   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: rhisf0_tbl_par                !: thickness of tbl (initial value)  [m]
101   REAL(wp) , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: risfLeff                      !:
102   !
103   ! 2.4 -------- coupling namelist parameter -------------
104   INTEGER , PUBLIC                                        ::   nstp_iscpl   !:
105   REAL(wp), PUBLIC                                        ::   rdt_iscpl    !:
106   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   risfcpl_ssh, risfcpl_cons_ssh, risfcpl_cons_ssh_b               !:
107   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::   risfcpl_vol, risfcpl_cons_vol, risfcpl_cons_vol_b  !:
108   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   risfcpl_tsc, risfcpl_cons_tsc, risfcpl_cons_tsc_b  !:
109   !
110   !!----------------------------------------------------------------------
111   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
112   !! $Id: sbcisf.F90 10536 2019-01-16 19:21:09Z mathiot $
113   !! Software governed by the CeCILL license (see ./LICENSE)
114   !!----------------------------------------------------------------------
115CONTAINS
116
117   SUBROUTINE isf_alloc_par()
118      !!---------------------------------------------------------------------
119      !!                  ***  ROUTINE isf_alloc_par  ***
120      !!
121      !! ** Purpose :
122      !!
123      !! ** Method  :
124      !!
125      !!----------------------------------------------------------------------
126      INTEGER :: ierr, ialloc
127      !!----------------------------------------------------------------------
128      ierr = 0       ! set to zero if no array to be allocated
129      !
130      ALLOCATE(risfLeff(jpi,jpj), STAT=ialloc)
131      ierr = ierr + ialloc
132      !
133      ALLOCATE(misfkt_par(jpi,jpj), misfkb_par(jpi,jpj), STAT=ialloc )
134      ierr = ierr + ialloc
135      !
136      ALLOCATE( rfrac_tbl_par(jpi,jpj), STAT=ialloc)
137      ierr = ierr + ialloc
138      !
139      ALLOCATE( rhisf_tbl_par(jpi,jpj), rhisf0_tbl_par(jpi,jpj), STAT=ialloc)
140      ierr = ierr + ialloc
141      !
142      ALLOCATE( mskisf_par(jpi,jpj), STAT=ialloc)
143      ierr = ierr + ialloc
144      !
145      CALL mpp_sum ( 'isf', ierr )
146      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'isf: failed to allocate arrays.' )
147      !
148   END SUBROUTINE isf_alloc_par
149
150   
151   SUBROUTINE isf_alloc_cav()
152      !!---------------------------------------------------------------------
153      !!                  ***  ROUTINE isf_alloc_cav  ***
154      !!
155      !! ** Purpose :
156      !!
157      !! ** Method  :
158      !!
159      !!----------------------------------------------------------------------
160      INTEGER :: ierr, ialloc
161      !!----------------------------------------------------------------------
162      ierr = 0       ! set to zero if no array to be allocated
163      !
164      ALLOCATE(misfkt_cav(jpi,jpj), misfkb_cav(jpi,jpj), STAT=ialloc )
165      ierr = ierr + ialloc
166      !
167      ALLOCATE( rfrac_tbl_cav(jpi,jpj), STAT=ialloc)
168      ierr = ierr + ialloc
169      !
170      ALLOCATE( rhisf_tbl_cav(jpi,jpj), STAT=ialloc)
171      ierr = ierr + ialloc
172      !
173      CALL mpp_sum ( 'isf', ierr )
174      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'isf: failed to allocate arrays.' )
175      !
176   END SUBROUTINE isf_alloc_cav
177
178   
179   SUBROUTINE isf_alloc_cpl()
180      !!---------------------------------------------------------------------
181      !!                  ***  ROUTINE isf_alloc_cpl  ***
182      !!
183      !! ** Purpose : allocate array use for the ice sheet coupling
184      !!
185      !!----------------------------------------------------------------------
186      INTEGER :: ierr, ialloc
187      !!----------------------------------------------------------------------
188      ierr = 0
189      !
190      ALLOCATE( risfcpl_ssh(jpi,jpj) , risfcpl_tsc(jpi,jpj,jpk,jpts) , risfcpl_vol(jpi,jpj,jpk) , STAT=ialloc )
191      ierr = ierr + ialloc
192      !
193      risfcpl_tsc(:,:,:,:) = 0._wp ; risfcpl_vol(:,:,:) = 0._wp ; risfcpl_ssh(:,:) = 0._wp
194
195      IF ( ln_isfcpl_cons ) THEN
196         ALLOCATE( risfcpl_cons_tsc(jpi,jpj,jpk,jpts) , risfcpl_cons_vol(jpi,jpj,jpk) , risfcpl_cons_ssh(jpi,jpj) , STAT=ialloc )
197         ierr = ierr + ialloc
198         !
199         risfcpl_cons_tsc(:,:,:,:) = 0._wp ; risfcpl_cons_vol(:,:,:) = 0._wp ; risfcpl_cons_ssh(:,:) = 0._wp
200         !
201      END IF
202      !
203      CALL mpp_sum ( 'isf', ierr )
204      IF( ierr /= 0 )   CALL ctl_stop('STOP','isfcpl: failed to allocate arrays.')
205      !
206   END SUBROUTINE isf_alloc_cpl
207
208   
209   SUBROUTINE isf_dealloc_cpl()
210      !!---------------------------------------------------------------------
211      !!                  ***  ROUTINE isf_dealloc_cpl  ***
212      !!
213      !! ** Purpose : de-allocate useless public 3d array used for ice sheet coupling
214      !!
215      !!----------------------------------------------------------------------
216      INTEGER :: ierr, ialloc
217      !!----------------------------------------------------------------------
218      ierr = 0
219      !
220      DEALLOCATE( risfcpl_ssh , risfcpl_tsc , risfcpl_vol , STAT=ialloc )
221      ierr = ierr + ialloc
222      !
223      CALL mpp_sum ( 'isf', ierr )
224      IF( ierr /= 0 )   CALL ctl_stop('STOP','isfcpl: failed to deallocate arrays.')
225      !
226   END SUBROUTINE isf_dealloc_cpl
227
228   
229   SUBROUTINE isf_alloc()
230      !!---------------------------------------------------------------------
231      !!                  ***  ROUTINE isf_alloc  ***
232      !!
233      !! ** Purpose : allocate array used for the ice shelf cavity (cav and par)
234      !!
235      !!----------------------------------------------------------------------
236      INTEGER :: ierr, ialloc
237      !!----------------------------------------------------------------------
238      !
239      ierr = 0       ! set to zero if no array to be allocated
240      !
241      ALLOCATE( fwfisf_par  (jpi,jpj) , fwfisf_par_b(jpi,jpj) ,     &
242         &      fwfisf_cav  (jpi,jpj) , fwfisf_cav_b(jpi,jpj) ,     &
243         &      fwfisf_oasis(jpi,jpj)                         , STAT=ialloc )
244      ierr = ierr + ialloc
245      !
246      ALLOCATE( risf_par_tsc(jpi,jpj,jpts) , risf_par_tsc_b(jpi,jpj,jpts) , STAT=ialloc )
247      ierr = ierr + ialloc
248      !
249      ALLOCATE( risf_cav_tsc(jpi,jpj,jpts) , risf_cav_tsc_b(jpi,jpj,jpts) , STAT=ialloc )
250      ierr = ierr + ialloc
251      !
252      ALLOCATE( risfload(jpi,jpj) , STAT=ialloc )
253      ierr = ierr + ialloc
254      !
255      ALLOCATE( mskisf_cav(jpi,jpj) , STAT=ialloc )
256      ierr = ierr + ialloc
257      !
258      CALL mpp_sum ( 'isf', ierr )
259      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'isf: failed to allocate arrays.' )
260      !
261      ! initalisation of fwf and tsc array to 0
262      risfload    (:,:)   = 0._wp
263      fwfisf_oasis(:,:)   = 0._wp
264      fwfisf_par  (:,:)   = 0._wp   ;   fwfisf_par_b  (:,:)   = 0._wp
265      fwfisf_cav  (:,:)   = 0._wp   ;   fwfisf_cav_b  (:,:)   = 0._wp
266      risf_cav_tsc(:,:,:) = 0._wp   ;   risf_cav_tsc_b(:,:,:) = 0._wp
267      risf_par_tsc(:,:,:) = 0._wp   ;   risf_par_tsc_b(:,:,:) = 0._wp
268      !
269   END SUBROUTINE isf_alloc
270   
271   !!======================================================================
272END MODULE isf_oce
Note: See TracBrowser for help on using the repository browser.