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.
icbtrj.F90 in branches/2012/dev_r3337_NOCS10_ICB/NEMOGCM/NEMO/OPA_SRC/ICB – NEMO

source: branches/2012/dev_r3337_NOCS10_ICB/NEMOGCM/NEMO/OPA_SRC/ICB/icbtrj.F90 @ 3372

Last change on this file since 3372 was 3372, checked in by sga, 12 years ago

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