Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
MODULE icbtrj
!!======================================================================
!! *** MODULE icbtrj ***
!! Ocean physics: trajectory I/O routines
!!======================================================================
!! History : 3.3 ! 2010-01 (Martin&Adcroft) Original code
!! - ! 2011-03 (Madec) Part conversion to NEMO form
!! - ! Removal of mapping from another grid
!! - ! 2011-05 (Alderson) New module to handle trajectory output
!!----------------------------------------------------------------------
!!----------------------------------------------------------------------
!! icb_trj_init : initialise iceberg trajectory output files
!! icb_trj_write :
!! icb_trj_sync :
!! icb_trj_end :
!!----------------------------------------------------------------------
USE par_oce ! NEMO parameters
USE dom_oce ! NEMO ocean domain
USE phycst ! NEMO physical constants
USE icb_oce ! define iceberg arrays
USE icbutl ! iceberg utility routines
!
USE lib_mpp ! NEMO MPI library, lk_mpp in particular
USE in_out_manager ! NEMO IO, numout in particular
USE ioipsl , ONLY : ju2ymds ! for calendar
USE netcdf
IMPLICIT NONE
PRIVATE
PUBLIC icb_trj_init ! routine called in icbini.F90 module
PUBLIC icb_trj_write ! routine called in icbstp.F90 module
PUBLIC icb_trj_sync ! routine called in icbstp.F90 module
PUBLIC icb_trj_end ! routine called in icbstp.F90 module
INTEGER :: num_traj = 0
INTEGER :: n_dim, m_dim
INTEGER :: ntrajid
INTEGER :: numberid, nstepid, nscaling_id
INTEGER :: nlonid, nlatid, nxid, nyid, nuvelid, nvvelid, nmassid
INTEGER :: nssuid, nssvid, nuaid, nvaid, nuiid, nviid
INTEGER :: nsshxid, nsshyid, nsstid, ncntid, nthkid
INTEGER :: nthicknessid, nwidthid, nlengthid
INTEGER :: nyearid, ndayid
INTEGER :: nmass_of_bits_id, nheat_density_id
!!----------------------------------------------------------------------
!! NEMO/OCE 4.0 , NEMO Consortium (2018)
!! $Id: icbtrj.F90 14030 2020-12-03 09:26:33Z mathiot $
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE icb_trj_init( ktend )
!!----------------------------------------------------------------------
!! *** ROUTINE icb_trj_init ***
!!
!! ** Purpose : initialise iceberg trajectory output files
!!----------------------------------------------------------------------
INTEGER, INTENT(in) :: ktend ! time step index
!
INTEGER :: iret, iyear, imonth, iday
INTEGER :: idg ! number of digits
sparonuz
committed
REAL(dp) :: zfjulday, zsec
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
CHARACTER(len=80) :: cl_filename
CHARACTER(LEN=12) :: clfmt ! writing format
CHARACTER(LEN=8 ) :: cldate_ini, cldate_end
TYPE(iceberg), POINTER :: this
TYPE(point) , POINTER :: pt
!!----------------------------------------------------------------------
! compute initial time step date
CALL ju2ymds( fjulday, iyear, imonth, iday, zsec )
WRITE(cldate_ini, '(i4.4,2i2.2)') iyear, imonth, iday
! compute end time step date
zfjulday = fjulday + rn_Dt / rday * REAL( nitend - nit000 + 1 , wp)
IF( ABS(zfjulday - REAL(NINT(zfjulday),wp)) < 0.1 / rday ) zfjulday = REAL(NINT(zfjulday),wp) ! avoid truncation error
CALL ju2ymds( zfjulday, iyear, imonth, iday, zsec )
WRITE(cldate_end, '(i4.4,2i2.2)') iyear, imonth, iday
! define trajectory output name
cl_filename = 'trajectory_icebergs_'//cldate_ini//'-'//cldate_end
IF ( lk_mpp ) THEN
idg = MAX( INT(LOG10(REAL(MAX(1,jpnij-1),wp))) + 1, 4 ) ! how many digits to we need to write? min=4, max=9
WRITE(clfmt, "('(a,a,i', i1, '.', i1, ',a)')") idg, idg ! '(a,a,ix.x,a)'
WRITE(cl_filename, clfmt) TRIM(cl_filename), '_', narea-1, '.nc'
ELSE
WRITE(cl_filename,'(a,a)') TRIM(cl_filename), '.nc'
ENDIF
IF( lwp .AND. nn_verbose_level >= 0 ) WRITE(numout,'(2a)') 'icebergs, icb_trj_init: creating ',TRIM(cl_filename)
iret = NF90_CREATE( TRIM(cl_filename), NF90_CLOBBER, ntrajid )
IF (iret .NE. NF90_NOERR) CALL ctl_stop('icebergs, icb_trj_init: nf_create failed')
! Dimensions
iret = NF90_DEF_DIM( ntrajid, 'n', NF90_UNLIMITED, n_dim )
IF ( iret /= NF90_NOERR ) CALL ctl_stop('icebergs, icb_trj_init: nf_def_dim n failed')
iret = NF90_DEF_DIM( ntrajid, 'k', nkounts, m_dim )
IF ( iret /= NF90_NOERR ) CALL ctl_stop('icebergs, icb_trj_init: nf_def_dim k failed')
! Variables
iret = NF90_DEF_VAR( ntrajid, 'iceberg_number', NF90_INT , (/m_dim,n_dim/), numberid )
iret = NF90_DEF_VAR( ntrajid, 'timestep' , NF90_INT , n_dim , nstepid )
iret = NF90_DEF_VAR( ntrajid, 'mass_scaling' , NF90_DOUBLE, n_dim , nscaling_id )
iret = NF90_DEF_VAR( ntrajid, 'lon' , NF90_DOUBLE, n_dim , nlonid )
iret = NF90_DEF_VAR( ntrajid, 'lat' , NF90_DOUBLE, n_dim , nlatid )
iret = NF90_DEF_VAR( ntrajid, 'xi' , NF90_DOUBLE, n_dim , nxid )
iret = NF90_DEF_VAR( ntrajid, 'yj' , NF90_DOUBLE, n_dim , nyid )
iret = NF90_DEF_VAR( ntrajid, 'uvel' , NF90_DOUBLE, n_dim , nuvelid )
iret = NF90_DEF_VAR( ntrajid, 'vvel' , NF90_DOUBLE, n_dim , nvvelid )
iret = NF90_DEF_VAR( ntrajid, 'ssu' , NF90_DOUBLE, n_dim , nssuid )
iret = NF90_DEF_VAR( ntrajid, 'ssv' , NF90_DOUBLE, n_dim , nssvid )
iret = NF90_DEF_VAR( ntrajid, 'uta' , NF90_DOUBLE, n_dim , nuaid )
iret = NF90_DEF_VAR( ntrajid, 'vta' , NF90_DOUBLE, n_dim , nvaid )
iret = NF90_DEF_VAR( ntrajid, 'uti' , NF90_DOUBLE, n_dim , nuiid )
iret = NF90_DEF_VAR( ntrajid, 'vti' , NF90_DOUBLE, n_dim , nviid )
iret = NF90_DEF_VAR( ntrajid, 'ssh_x' , NF90_DOUBLE, n_dim , nsshxid )
iret = NF90_DEF_VAR( ntrajid, 'ssh_y' , NF90_DOUBLE, n_dim , nsshyid )
iret = NF90_DEF_VAR( ntrajid, 'sst' , NF90_DOUBLE, n_dim , nsstid )
iret = NF90_DEF_VAR( ntrajid, 'icnt' , NF90_DOUBLE, n_dim , ncntid )
iret = NF90_DEF_VAR( ntrajid, 'ithk' , NF90_DOUBLE, n_dim , nthkid )
iret = NF90_DEF_VAR( ntrajid, 'mass' , NF90_DOUBLE, n_dim , nmassid )
iret = NF90_DEF_VAR( ntrajid, 'thickness' , NF90_DOUBLE, n_dim , nthicknessid )
iret = NF90_DEF_VAR( ntrajid, 'width' , NF90_DOUBLE, n_dim , nwidthid )
iret = NF90_DEF_VAR( ntrajid, 'length' , NF90_DOUBLE, n_dim , nlengthid )
iret = NF90_DEF_VAR( ntrajid, 'year' , NF90_INT , n_dim , nyearid )
iret = NF90_DEF_VAR( ntrajid, 'day' , NF90_DOUBLE, n_dim , ndayid )
iret = NF90_DEF_VAR( ntrajid, 'mass_of_bits' , NF90_DOUBLE, n_dim , nmass_of_bits_id )
iret = NF90_DEF_VAR( ntrajid, 'heat_density' , NF90_DOUBLE, n_dim , nheat_density_id )
! Attributes
iret = NF90_PUT_ATT( ntrajid, numberid , 'long_name', 'iceberg number on this processor' )
iret = NF90_PUT_ATT( ntrajid, numberid , 'units' , 'count' )
iret = NF90_PUT_ATT( ntrajid, nstepid , 'long_name', 'timestep number kt' )
iret = NF90_PUT_ATT( ntrajid, nstepid , 'units' , 'count' )
iret = NF90_PUT_ATT( ntrajid, nlonid , 'long_name', 'longitude' )
iret = NF90_PUT_ATT( ntrajid, nlonid , 'units' , 'degrees_E')
iret = NF90_PUT_ATT( ntrajid, nlatid , 'long_name', 'latitude' )
iret = NF90_PUT_ATT( ntrajid, nlatid , 'units' , 'degrees_N' )
iret = NF90_PUT_ATT( ntrajid, nxid , 'long_name', 'x grid box position' )
iret = NF90_PUT_ATT( ntrajid, nxid , 'units' , 'fractional' )
iret = NF90_PUT_ATT( ntrajid, nyid , 'long_name', 'y grid box position' )
iret = NF90_PUT_ATT( ntrajid, nyid , 'units' , 'fractional' )
iret = NF90_PUT_ATT( ntrajid, nuvelid , 'long_name', 'zonal velocity' )
iret = NF90_PUT_ATT( ntrajid, nuvelid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nvvelid , 'long_name', 'meridional velocity' )
iret = NF90_PUT_ATT( ntrajid, nvvelid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nssuid , 'long_name', 'ocean u component' )
iret = NF90_PUT_ATT( ntrajid, nssuid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nssvid , 'long_name', 'ocean v component' )
iret = NF90_PUT_ATT( ntrajid, nssvid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nuaid , 'long_name', 'atmosphere u component' )
iret = NF90_PUT_ATT( ntrajid, nuaid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nvaid , 'long_name', 'atmosphere v component' )
iret = NF90_PUT_ATT( ntrajid, nvaid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nuiid , 'long_name', 'sea ice u component' )
iret = NF90_PUT_ATT( ntrajid, nuiid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nviid , 'long_name', 'sea ice v component' )
iret = NF90_PUT_ATT( ntrajid, nviid , 'units' , 'm/s' )
iret = NF90_PUT_ATT( ntrajid, nsshxid , 'long_name', 'sea surface height gradient from x points' )
iret = NF90_PUT_ATT( ntrajid, nsshxid , 'units' , 'm/m' )
iret = NF90_PUT_ATT( ntrajid, nsshyid , 'long_name', 'sea surface height gradient from y points' )
iret = NF90_PUT_ATT( ntrajid, nsshyid , 'units' , 'm/m' )
iret = NF90_PUT_ATT( ntrajid, nsstid , 'long_name', 'sea surface temperature' )
iret = NF90_PUT_ATT( ntrajid, nsstid , 'units' , 'degC')
iret = NF90_PUT_ATT( ntrajid, ncntid , 'long_name', 'sea ice concentration' )
iret = NF90_PUT_ATT( ntrajid, ncntid , 'units' , 'degC')
iret = NF90_PUT_ATT( ntrajid, nthkid , 'long_name', 'sea ice thickness' )
iret = NF90_PUT_ATT( ntrajid, nthkid , 'units' , 'm' )
iret = NF90_PUT_ATT( ntrajid, nmassid , 'long_name', 'mass')
iret = NF90_PUT_ATT( ntrajid, nmassid , 'units' , 'kg' )
iret = NF90_PUT_ATT( ntrajid, nthicknessid , 'long_name', 'thickness' )
iret = NF90_PUT_ATT( ntrajid, nthicknessid , 'units' , 'm' )
iret = NF90_PUT_ATT( ntrajid, nwidthid , 'long_name', 'width' )
iret = NF90_PUT_ATT( ntrajid, nwidthid , 'units' , 'm' )
iret = NF90_PUT_ATT( ntrajid, nlengthid , 'long_name', 'length' )
iret = NF90_PUT_ATT( ntrajid, nlengthid , 'units' , 'm' )
iret = NF90_PUT_ATT( ntrajid, nyearid , 'long_name', 'calendar year' )
iret = NF90_PUT_ATT( ntrajid, nyearid , 'units' , 'years' )
iret = NF90_PUT_ATT( ntrajid, ndayid , 'long_name', 'day of year' )
iret = NF90_PUT_ATT( ntrajid, ndayid , 'units' , 'days' )
iret = NF90_PUT_ATT( ntrajid, nscaling_id , 'long_name', 'scaling factor for mass of berg' )
iret = NF90_PUT_ATT( ntrajid, nscaling_id , 'units' , 'none' )
iret = NF90_PUT_ATT( ntrajid, nmass_of_bits_id, 'long_name', 'mass of bergy bits' )
iret = NF90_PUT_ATT( ntrajid, nmass_of_bits_id, 'units' , 'kg' )
iret = NF90_PUT_ATT( ntrajid, nheat_density_id, 'long_name', 'heat density' )
iret = NF90_PUT_ATT( ntrajid, nheat_density_id, 'units' , 'J/kg' )
!
! End define mode
iret = NF90_ENDDEF( ntrajid )
!
END SUBROUTINE icb_trj_init
SUBROUTINE icb_trj_write( kt )
!!----------------------------------------------------------------------
!! *** ROUTINE icb_trj_write ***
!!
!! ** Purpose : write out iceberg trajectories
!!
!! ** Method : - for the moment write out each snapshot of positions later
!! can rewrite so that it is buffered and written out more efficiently
!!----------------------------------------------------------------------
INTEGER, INTENT( in ) :: kt ! time-step index
!
INTEGER :: iret, jn
CHARACTER(len=80) :: cl_filename
TYPE(iceberg), POINTER :: this
TYPE(point ), POINTER :: pt
!!----------------------------------------------------------------------
! Write variables
! sga - just write out the current point of the trajectory
this => first_berg
jn = num_traj
DO WHILE( ASSOCIATED(this) )
pt => this%current_point
jn = jn + 1
!
iret = NF90_PUT_VAR( ntrajid, numberid , this%number , (/1,jn/) , (/nkounts,1/) )
iret = NF90_PUT_VAR( ntrajid, nstepid , kt , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nscaling_id , this%mass_scaling, (/ jn /) )
!
iret = NF90_PUT_VAR( ntrajid, nlonid , pt%lon , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nlatid , pt%lat , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nxid , pt%xi , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nyid , pt%yj , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nuvelid , pt%uvel , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nvvelid , pt%vvel , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nssuid , pt%ssu , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nssvid , pt%ssv , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nuaid , pt%ua , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nvaid , pt%va , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nuiid , pt%ui , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nviid , pt%vi , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nsshxid , pt%ssh_x , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nsshyid , pt%ssh_y , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nsstid , pt%sst , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, ncntid , pt%cn , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nthkid , pt%hi , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nmassid , pt%mass , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nthicknessid , pt%thickness , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nwidthid , pt%width , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nlengthid , pt%length , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nyearid , pt%year , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, ndayid , pt%day , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nmass_of_bits_id, pt%mass_of_bits , (/ jn /) )
iret = NF90_PUT_VAR( ntrajid, nheat_density_id, pt%heat_density , (/ jn /) )
!
this => this%next
END DO
IF( lwp .AND. nn_verbose_level > 0 ) WRITE(numout,*) 'trajectory write to frame ', jn
num_traj = jn
!
END SUBROUTINE icb_trj_write
SUBROUTINE icb_trj_sync()
!!----------------------------------------------------------------------
!! *** ROUTINE icb_trj_sync ***
!!
!! ** Purpose :
!!----------------------------------------------------------------------
INTEGER :: iret
!!----------------------------------------------------------------------
! flush to file
iret = NF90_SYNC( ntrajid )
IF ( iret /= NF90_NOERR ) CALL ctl_stop( 'icebergs, icb_trj_sync: nf_sync failed' )
!
END SUBROUTINE icb_trj_sync
SUBROUTINE icb_trj_end()
!!----------------------------------------------------------------------
INTEGER :: iret
!!----------------------------------------------------------------------
! Finish up
iret = NF90_CLOSE( ntrajid )
IF ( iret /= NF90_NOERR ) CALL ctl_stop( 'icebergs, icb_trj_end: nf_close failed' )
!
END SUBROUTINE icb_trj_end
!!======================================================================
END MODULE icbtrj