source: NEMO/branches/2019/fix_ticket2238_solution2/src/OCE/ICB/icb_oce.F90 @ 10679

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

branch for solution 2 of ticket #2238

  • Property svn:keywords set to Id
File size: 13.0 KB
Line 
1MODULE icb_oce
2   !!======================================================================
3   !!                       ***  MODULE  icb_oce  ***
4   !! Icebergs:  declare variables for iceberg tracking
5   !!======================================================================
6   !! History :  3.3  !  2010-01  (T. Martin & A. Adcroft)  Original code
7   !!             -   !  2011-03  (G. Madec)  Part conversion to NEMO form
8   !!             -   !                       Removal of mapping from another grid
9   !!             -   !  2011-04  (S. Alderson) Extensive rewrite ; Split into separate modules
10   !!----------------------------------------------------------------------
11   !!
12   !! Track Icebergs as Lagrangian objects within the model domain
13   !! Interaction with the other model variables through 'icebergs_gridded'
14   !!
15   !! A single iceberg is held as an instance of type 'iceberg'
16   !! This type defines a linked list, so each instance contains a pointer
17   !! to the previous and next icebergs in the list
18   !!
19   !! Type 'icebergs' is a convenience container for all relevant arrays
20   !! It contains one pointer to an 'iceberg' instance representing all icebergs in the processor
21   !!
22   !! Each iceberg has a position represented as a real cartesian coordinate which is
23   !! fractional grid cell, centred on T-points; so an iceberg position of (1.0,1.0) lies
24   !! exactly on the first T-point and the T-cell spans 0.5 to 1.5 in each direction
25   !!
26   !! Each iceberg is assigned a unique id even in MPI
27   !! This consists of an array of integers: the first element is used to label, the second
28   !! and subsequent elements are used to count the number of times the first element wraps
29   !! around all possible values within the valid size for this datatype.
30   !! Labelling is done by starting the first label in each processor (even when only one)
31   !! as narea, and then incrementing by jpnij (i.e. the total number of processors.
32   !! This means that the source processor for each iceberg can be identified by arithmetic
33   !! modulo jpnij.
34   !!
35   !!----------------------------------------------------------------------
36   USE par_oce   ! ocean parameters
37   USE lib_mpp   ! MPP library
38
39   IMPLICIT NONE
40   PUBLIC
41
42   PUBLIC   icb_alloc   ! routine called by icb_init in icbini.F90 module
43
44   INTEGER, PUBLIC, PARAMETER ::   nclasses = 10   !: Number of icebergs classes   
45   INTEGER, PUBLIC, PARAMETER ::   nkounts  =  3   !: Number of integers combined for unique naming
46
47   TYPE, PUBLIC ::   icebergs_gridded   !: various icebergs properties on model grid
48      REAL(wp), DIMENSION(:,:)  , ALLOCATABLE ::   calving         ! Calving mass rate  (into stored ice)         [kg/s]
49      REAL(wp), DIMENSION(:,:)  , ALLOCATABLE ::   calving_hflx    ! Calving heat flux [heat content of calving]  [W/m2]
50      REAL(wp), DIMENSION(:,:)  , ALLOCATABLE ::   floating_melt   ! Net melting rate to icebergs + bits      [kg/s/m^2]
51      INTEGER , DIMENSION(:,:)  , ALLOCATABLE ::   maxclass        ! maximum class number at calving source point
52      REAL(wp), DIMENSION(:,:)  , ALLOCATABLE ::   tmp             ! Temporary work space
53      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::   stored_ice      ! Accumulated ice mass flux at calving locations [kg]
54      REAL(wp), DIMENSION(:,:)  , ALLOCATABLE ::   stored_heat     ! Heat content of stored ice                      [J]
55   END TYPE icebergs_gridded
56
57   TYPE, PUBLIC ::   point              !: properties of an individual iceberg (position, mass, size, etc...)
58      INTEGER  ::   year
59      REAL(wp) ::   xi , yj                                              ! iceberg coordinates in the (i,j) referential (global)
60      REAL(wp) ::   e1 , e2                                              ! horizontal scale factors at the iceberg position
61      REAL(wp) ::   lon, lat, day                                        ! geographic position
62      REAL(wp) ::   mass, thickness, width, length, uvel, vvel           ! iceberg physical properties
63      REAL(wp) ::   uo, vo, ui, vi, ua, va, ssh_x, ssh_y, sst, cn, hi    ! properties of iceberg environment
64      REAL(wp) ::   mass_of_bits, heat_density
65      REAL(wp), DIMENSION(4) :: xRK1, xRK2, xRK3, xRK4
66      REAL(wp), DIMENSION(4) :: yRK1, yRK2, yRK3, yRK4
67   END TYPE point
68
69   TYPE, PUBLIC ::   iceberg            !: linked list defining all the icebergs present in the model domain
70      TYPE(iceberg), POINTER      ::   prev=>NULL(), next=>NULL()   ! pointers to previous and next unique icebergs in linked list
71      INTEGER, DIMENSION(nkounts) ::   number                       ! variables which do not change for this iceberg
72      REAL(wp)                    ::   mass_scaling                 !    -        -            -                - 
73      TYPE(point), POINTER        ::   current_point => NULL()      ! variables which change with time are held in a separate type
74   END TYPE iceberg
75
76
77   TYPE(icebergs_gridded), POINTER ::   berg_grid                 !: master instance of gridded iceberg type
78   TYPE(iceberg)         , POINTER ::   first_berg => NULL()      !: master instance of linked list iceberg type
79
80   !                                                             !!! parameters controlling iceberg characteristics and modelling
81   REAL(wp)                            ::   berg_dt                   !: Time-step between iceberg CALLs (should make adaptive?)
82   REAL(wp), DIMENSION(:), ALLOCATABLE ::   first_width, first_length !:
83   LOGICAL                             ::   l_restarted_bergs=.FALSE.  ! Indicate whether we read state from a restart or not
84   !                                                               ! arbitrary numbers for diawri entry
85   REAL(wp), DIMENSION(nclasses), PUBLIC ::   class_num=(/ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 /)
86
87   ! Extra arrays with bigger halo, needed when interpolating forcing onto iceberg position
88   ! particularly for MPP when iceberg can lie inside T grid but outside U, V, or f grid
89   REAL(wp), PUBLIC, DIMENSION(:,:), ALLOCATABLE :: hicth
90
91   !!gm almost all those PARAM ARE defined in NEMO
92   REAL(wp), PUBLIC, PARAMETER :: pp_rho_ice      = 916.7_wp   !: Density of fresh ice   @ 0oC [kg/m^3]
93   REAL(wp), PUBLIC, PARAMETER :: pp_rho_water    = 999.8_wp   !: Density of fresh water @ 0oC [kg/m^3]
94   REAL(wp), PUBLIC, PARAMETER :: pp_rho_air      = 1.1_wp     !: Density of air         @ 0oC [kg/m^3]
95   REAL(wp), PUBLIC, PARAMETER :: pp_rho_seawater = 1025._wp   !: Approx. density of surface sea water @ 0oC [kg/m^3]
96   !!gm end
97   REAL(wp), PUBLIC, PARAMETER :: pp_Cd_av = 1.3_wp      !: (Vertical) Drag coefficient between bergs and atmos
98   REAL(wp), PUBLIC, PARAMETER :: pp_Cd_ah = 0.0055_wp   !: (lateral ) Drag coefficient between bergs and atmos
99   REAL(wp), PUBLIC, PARAMETER :: pp_Cd_wv = 0.9_wp      !: (Vertical) Drag coefficient between bergs and ocean
100   REAL(wp), PUBLIC, PARAMETER :: pp_Cd_wh = 0.0012_wp   !: (lateral ) Drag coefficient between bergs and ocean
101   REAL(wp), PUBLIC, PARAMETER :: pp_Cd_iv = 0.9_wp      !: (Vertical) Drag coefficient between bergs and sea-ice
102!TOM> no horizontal drag for sea ice! real, PARAMETER :: pp_Cd_ih=0.0012 ! (lateral) Drag coeff. between bergs and sea-ice
103
104   !                                                         !!* namberg namelist parameters (and defaults) **
105   LOGICAL , PUBLIC ::   ln_bergdia                      !: Calculate budgets
106   INTEGER , PUBLIC ::   nn_verbose_level                !: Turn on debugging when level > 0
107   INTEGER , PUBLIC ::   nn_test_icebergs                !: Create icebergs in absence of a restart file from the supplied class nb
108   REAL(wp), PUBLIC, DIMENSION(4) ::   rn_test_box       !: lon1,lon2,lat1,lat2 box to create them in
109   LOGICAL , PUBLIC ::   ln_use_calving                  !: Force use of calving data even with nn_test_icebergs > 0
110                                                         !  (default is not to use calving data with test bergs)
111   INTEGER , PUBLIC ::   nn_sample_rate                  !: Timesteps between sampling of position for trajectory storage
112   INTEGER , PUBLIC ::   nn_verbose_write                !: timesteps between verbose messages
113   REAL(wp), PUBLIC ::   rn_rho_bergs                    !: Density of icebergs
114   REAL(wp), PUBLIC ::   rn_LoW_ratio                    !: Initial ratio L/W for newly calved icebergs
115   REAL(wp), PUBLIC ::   rn_bits_erosion_fraction        !: Fraction of erosion melt flux to divert to bergy bits
116   REAL(wp), PUBLIC ::   rn_sicn_shift                   !: Shift of sea-ice concentration in erosion flux modulation (0<sicn_shift<1)
117   LOGICAL , PUBLIC ::   ln_operator_splitting           !: Use first order operator splitting for thermodynamics
118   LOGICAL , PUBLIC ::   ln_passive_mode                 !: iceberg - ocean decoupling
119   LOGICAL , PUBLIC ::   ln_time_average_weight          !: Time average the weight on the ocean    !!gm I don't understand that !
120   REAL(wp), PUBLIC ::   rn_speed_limit                  !: CFL speed limit for a berg
121   !
122   !                                     ! Mass thresholds between iceberg classes [kg]
123   REAL(wp), DIMENSION(nclasses), PUBLIC ::   rn_initial_mass      ! Fraction of calving to apply to this class [non-dim]
124   REAL(wp), DIMENSION(nclasses), PUBLIC ::   rn_distribution      ! Ratio between effective and real iceberg mass (non-dim)
125   REAL(wp), DIMENSION(nclasses), PUBLIC ::   rn_mass_scaling      ! Total thickness of newly calved bergs [m]
126   REAL(wp), DIMENSION(nclasses), PUBLIC ::   rn_initial_thickness !  Single instance of an icebergs type initialised in icebergs_init and updated in icebergs_run
127   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::   src_calving, src_calving_hflx    !: accumulate input ice
128   INTEGER , PUBLIC             , SAVE                     ::   numicb                           !: iceberg IO
129   INTEGER , PUBLIC             , SAVE, DIMENSION(nkounts) ::   num_bergs                        !: iceberg counter
130   INTEGER , PUBLIC             , SAVE                     ::   nicbdi, nicbei, nicbdj, nicbej   !: processor bounds
131   REAL(wp), PUBLIC             , SAVE                     ::   ricb_left, ricb_right            !: cyclical bounds
132   INTEGER , PUBLIC             , SAVE                     ::   nicbpack                         !: packing integer
133   INTEGER , PUBLIC             , SAVE                     ::   nktberg, nknberg                 !: helpers
134   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbfldpts                       !: nfold packed points
135   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbflddest                      !: nfold destination proc
136   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbfldproc                      !: nfold destination proc
137   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbfldnsend                     !: nfold number of bergs to send to nfold neighbour
138   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbfldexpect                    !: nfold expected number of bergs
139   INTEGER , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::   nicbfldreq                       !: nfold message handle (immediate send)
140
141   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   :: griddata                           !: work array for icbrst
142
143   !!----------------------------------------------------------------------
144   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
145   !! $Id$
146   !! Software governed by the CeCILL license (see ./LICENSE)
147   !!----------------------------------------------------------------------
148CONTAINS
149   
150   INTEGER FUNCTION icb_alloc()
151      !!----------------------------------------------------------------------
152      !!                ***  ROUTINE icb_alloc  ***
153      !!----------------------------------------------------------------------
154      INTEGER ::   ill
155      !!----------------------------------------------------------------------
156      !
157      icb_alloc = 0
158      ALLOCATE( berg_grid, STAT=ill )
159      icb_alloc = icb_alloc + ill
160      ALLOCATE( berg_grid%calving    (jpi,jpj) , berg_grid%calving_hflx (jpi,jpj)          ,   &
161         &      berg_grid%stored_heat(jpi,jpj) , berg_grid%floating_melt(jpi,jpj)          ,   &
162         &      berg_grid%maxclass   (jpi,jpj) , berg_grid%stored_ice   (jpi,jpj,nclasses) ,   &
163         &      berg_grid%tmp        (jpi,jpj) , STAT=ill)
164      icb_alloc = icb_alloc + ill
165      !
166      ALLOCATE( first_width(nclasses) , first_length(nclasses) ,   &
167         &      src_calving (jpi,jpj) ,                            &
168         &      src_calving_hflx(jpi,jpj) , STAT=ill)
169      icb_alloc = icb_alloc + ill
170
171      ALLOCATE( nicbfldpts(jpi) , nicbflddest(jpi) , nicbfldproc(jpni) , &
172         &      nicbfldnsend(jpni), nicbfldexpect(jpni) , nicbfldreq(jpni), STAT=ill)
173      icb_alloc = icb_alloc + ill
174
175      ALLOCATE( griddata(jpi,jpj,1), STAT=ill )
176      icb_alloc = icb_alloc + ill
177
178      CALL mpp_sum ( 'icb_oce', icb_alloc )
179      IF( icb_alloc > 0 )   CALL ctl_warn('icb_alloc: allocation of arrays failed')
180      !
181   END FUNCTION icb_alloc
182
183   !!======================================================================
184END MODULE icb_oce
Note: See TracBrowser for help on using the repository browser.