ROMS
Loading...
Searching...
No Matches
Data Types | Functions/Subroutines | Variables
mod_diags Module Reference

Data Types

type  t_diags
 

Functions/Subroutines

subroutine, public allocate_diags (ng, lbi, ubi, lbj, ubj)
 
subroutine, public deallocate_diags (ng)
 
subroutine, public initialize_diags (ng, tile)
 

Variables

type(t_diags), dimension(:), allocatable diags
 

Function/Subroutine Documentation

◆ allocate_diags()

subroutine, public mod_diags::allocate_diags ( integer, intent(in) ng,
integer, intent(in) lbi,
integer, intent(in) ubi,
integer, intent(in) lbj,
integer, intent(in) ubj )

Definition at line 104 of file mod_diags.F.

105!
106!=======================================================================
107! !
108! This routine allocates all variables in the module for all nested !
109! grids. !
110! !
111!=======================================================================
112!
113 USE mod_param
114# if defined DIAGNOSTICS_BIO && defined ECOSIM
115 USE mod_biology
116# endif
117!
118! Imported variable declarations.
119!
120 integer, intent(in) :: ng, LBi, UBi, LBj, UBj
121!
122! Local variable declarations.
123!
124 real(r8) :: size2d
125!
126!-----------------------------------------------------------------------
127! Allocate module variables.
128!-----------------------------------------------------------------------
129!
130 IF (ng.eq.1 ) allocate ( diags(ngrids) )
131!
132! Set horizontal array size.
133!
134 size2d=real((ubi-lbi+1)*(ubj-lbj+1),r8)
135!
136! Diagnostic arrays.
137!
138 allocate ( diags(ng) % avgzeta(lbi:ubi,lbj:ubj) )
139 dmem(ng)=dmem(ng)+size2d
140
141# ifdef DIAGNOSTICS_BIO
142# if defined BIO_FENNEL
143 IF (ndbio2d.gt.0) THEN
144 allocate ( diags(ng) % DiaBio2d(lbi:ubi,lbj:ubj,ndbio2d) )
145 dmem(ng)=dmem(ng)+real(ndbio2d,r8)*size2d
146 END IF
147 IF (ndbio3d.gt.0) THEN
148 allocate ( diags(ng) % DiaBio3d(lbi:ubi,lbj:ubj,n(ng),ndbio3d) )
149 dmem(ng)=dmem(ng)+real(n(ng)*ndbio3d,r8)*size2d
150 END IF
151# elif defined ECOSIM
152 IF (ndbio3d.gt.0) THEN
153 allocate ( diags(ng) % DiaBio3d(lbi:ubi,lbj:ubj, &
154 & ndbands,ndbio3d) )
155 dmem(ng)=dmem(ng)+real(ndbands*ndbio3d,r8)*size2d
156 END IF
157 IF (ndbio4d.gt.0) THEN
158 allocate ( diags(ng) % DiaBio4d(lbi:ubi,lbj:ubj,n(ng), &
159 & ndbands,ndbio4d) )
160 dmem(ng)=dmem(ng)+real(n(ng)*ndbands*ndbio4d,r8)*size2d
161 END IF
162# endif
163# endif
164
165# ifdef DIAGNOSTICS_TS
166 allocate ( diags(ng) % DiaTrc(lbi:ubi,lbj:ubj,n(ng),nt(ng),ndt) )
167 dmem(ng)=dmem(ng)+real(n(ng)*nt(ng)*ndt,r8)*size2d
168
169 allocate ( diags(ng) % DiaTwrk(lbi:ubi,lbj:ubj,n(ng),nt(ng),ndt) )
170 dmem(ng)=dmem(ng)+real(n(ng)*nt(ng)*ndt,r8)*size2d
171# endif
172
173# ifdef DIAGNOSTICS_UV
174 allocate ( diags(ng) % DiaU2d(lbi:ubi,lbj:ubj,ndm2d) )
175 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
176
177 allocate ( diags(ng) % DiaV2d(lbi:ubi,lbj:ubj,ndm2d) )
178 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
179
180 allocate ( diags(ng) % DiaU2wrk(lbi:ubi,lbj:ubj,ndm2d) )
181 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
182
183 allocate ( diags(ng) % DiaV2wrk(lbi:ubi,lbj:ubj,ndm2d) )
184 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
185
186 allocate ( diags(ng) % DiaRUbar(lbi:ubi,lbj:ubj,2,ndm2d-1) )
187 dmem(ng)=dmem(ng)+2.0_r8*real(ndm2d-1,r8)*size2d
188
189 allocate ( diags(ng) % DiaRVbar(lbi:ubi,lbj:ubj,2,ndm2d-1) )
190 dmem(ng)=dmem(ng)+2.0_r8*real(ndm2d-1,r8)*size2d
191
192# ifdef SOLVE3D
193 allocate ( diags(ng) % DiaU2int(lbi:ubi,lbj:ubj,ndm2d) )
194 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
195
196 allocate ( diags(ng) % DiaV2int(lbi:ubi,lbj:ubj,ndm2d) )
197 dmem(ng)=dmem(ng)+real(ndm2d,r8)*size2d
198
199 allocate ( diags(ng) % DiaRUfrc(lbi:ubi,lbj:ubj,3,ndm2d-1) )
200 dmem(ng)=dmem(ng)+3.0_r8*real(ndm2d-1,r8)*size2d
201
202 allocate ( diags(ng) % DiaRVfrc(lbi:ubi,lbj:ubj,3,ndm2d-1) )
203 dmem(ng)=dmem(ng)+3.0_r8*real(ndm2d-1,r8)*size2d
204
205 allocate ( diags(ng) % DiaU3d(lbi:ubi,lbj:ubj,n(ng),ndm3d) )
206 dmem(ng)=dmem(ng)+real(n(ng)*ndm3d,r8)*size2d
207
208 allocate ( diags(ng) % DiaV3d(lbi:ubi,lbj:ubj,n(ng),ndm3d) )
209 dmem(ng)=dmem(ng)+real(n(ng)*ndm3d,r8)*size2d
210
211 allocate ( diags(ng) % DiaU3wrk(lbi:ubi,lbj:ubj,n(ng),ndm3d) )
212 dmem(ng)=dmem(ng)+real(n(ng)*ndm3d,r8)*size2d
213
214 allocate ( diags(ng) % DiaV3wrk(lbi:ubi,lbj:ubj,n(ng),ndm3d) )
215 dmem(ng)=dmem(ng)+real(n(ng)*ndm3d,r8)*size2d
216
217 allocate ( diags(ng) % DiaRU(lbi:ubi,lbj:ubj,n(ng),2,ndrhs) )
218 dmem(ng)=dmem(ng)+2.0_r8*real(n(ng)*ndrhs,r8)*size2d
219
220 allocate ( diags(ng) % DiaRV(lbi:ubi,lbj:ubj,n(ng),2,ndrhs) )
221 dmem(ng)=dmem(ng)+2.0_r8*real(n(ng)*ndrhs,r8)*size2d
222
223# endif
224
225# endif
226!
227 RETURN
mod_biology
Definition ecosim_mod.h:1
mod_biology::ndbands
integer ndbands
Definition ecosim_mod.h:212
mod_param
Definition mod_param.F:2
mod_param::ndrhs
integer ndrhs
Definition mod_param.F:590
mod_param::ndbio2d
integer ndbio2d
Definition mod_param.F:584
mod_param::n
integer, dimension(:), allocatable n
Definition mod_param.F:479
mod_param::dmem
real(r8), dimension(:), allocatable dmem
Definition mod_param.F:137
mod_param::ndbio4d
integer ndbio4d
Definition mod_param.F:586
mod_param::ndm3d
integer ndm3d
Definition mod_param.F:579
mod_param::ngrids
integer ngrids
Definition mod_param.F:113
mod_param::ndt
integer ndt
Definition mod_param.F:574
mod_param::nt
integer, dimension(:), allocatable nt
Definition mod_param.F:489
mod_param::ndbio3d
integer ndbio3d
Definition mod_param.F:585
mod_param::ndm2d
integer ndm2d
Definition mod_param.F:578

References diags, mod_param::dmem, mod_param::n, mod_biology::ndbands, mod_param::ndbio2d, mod_param::ndbio3d, mod_param::ndbio4d, mod_param::ndm2d, mod_param::ndm3d, mod_param::ndrhs, mod_param::ndt, mod_param::ngrids, mod_param::nt, and mod_kinds::r8.

Referenced by mod_arrays::roms_allocate_arrays().

Here is the caller graph for this function:

◆ deallocate_diags()

subroutine, public mod_diags::deallocate_diags ( integer, intent(in) ng)

Definition at line 230 of file mod_diags.F.

231!
232!=======================================================================
233! !
234! This routine deallocates all variables in the module for all nested !
235! grids. !
236! !
237!=======================================================================
238!
239 USE mod_param
240
241# ifdef SUBOBJECT_DEALLOCATION
242!
243 USE destroy_mod, ONLY : destroy
244# endif
245!
246! Imported variable declarations.
247!
248 integer, intent(in) :: ng
249!
250! Local variable declarations.
251!
252 character (len=*), parameter :: MyFile = &
253 & __FILE__//", deallocate_diags"
254
255# ifdef SUBOBJECT_DEALLOCATION
256!
257!-----------------------------------------------------------------------
258! Deallocate each variable in the derived-type T_DIAGS structure
259! separately.
260!-----------------------------------------------------------------------
261!
262! Diagnostic arrays.
263!
264 IF (.not.destroy(ng, diags(ng)%avgzeta, myfile, &
265 & __line__, 'DIAGS(ng)%DiaBio2d')) RETURN
266
267# ifdef DIAGNOSTICS_BIO
268# if defined BIO_FENNEL
269 IF (ndbio2d.gt.0) THEN
270 IF (.not.destroy(ng, diags(ng)%DiaBio2d, myfile, &
271 & __line__, 'DIAGS(ng)%DiaBio2d')) RETURN
272 END IF
273
274 IF (ndbio3d.gt.0) THEN
275 IF (.not.destroy(ng, diags(ng)%DiaBio3d, myfile, &
276 & __line__, 'DIAGS(ng)%DiaBio3d')) RETURN
277 END IF
278# elif defined ECOSIM
279 IF (ndbio3d.gt.0) THEN
280 IF (.not.destroy(ng, diags(ng)%DiaBio3d, myfile, &
281 & __line__, 'DIAGS(ng)%DiaBio3d')) RETURN
282 END IF
283
284 IF (ndbio4d.gt.0) THEN
285 IF (.not.destroy(ng, diags(ng)%DiaBio4d, myfile, &
286 & __line__, 'DIAGS(ng)%DiaBio4d')) RETURN
287 END IF
288# endif
289# endif
290
291# ifdef DIAGNOSTICS_TS
292 IF (.not.destroy(ng, diags(ng)%DiaTrc, myfile, &
293 & __line__, 'DIAGS(ng)%DiaTrc')) RETURN
294
295 IF (.not.destroy(ng, diags(ng)%DiaTwrk, myfile, &
296 & __line__, 'DIAGS(ng)%DiaTwrk')) RETURN
297# endif
298
299# ifdef DIAGNOSTICS_UV
300 IF (.not.destroy(ng, diags(ng)%DiaU2d, myfile, &
301 & __line__, 'DIAGS(ng)%DiaU2d')) RETURN
302
303 IF (.not.destroy(ng, diags(ng)%DiaV2d, myfile, &
304 & __line__, 'DIAGS(ng)%DiaV2d')) RETURN
305
306 IF (.not.destroy(ng, diags(ng)%DiaU2wrk, myfile, &
307 & __line__, 'DIAGS(ng)%DiaU2wrk')) RETURN
308
309 IF (.not.destroy(ng, diags(ng)%DiaV2wrk, myfile, &
310 & __line__, 'DIAGS(ng)%DiaV2wrk')) RETURN
311
312 IF (.not.destroy(ng, diags(ng)%DiaRUbar, myfile, &
313 & __line__, 'DIAGS(ng)%DiaRUbar')) RETURN
314
315 IF (.not.destroy(ng, diags(ng)%DiaRVbar, myfile, &
316 & __line__, 'DIAGS(ng)%DiaRVbar')) RETURN
317
318# ifdef SOLVE3D
319 IF (.not.destroy(ng, diags(ng)%DiaU2int, myfile, &
320 & __line__, 'DIAGS(ng)%DiaU2int')) RETURN
321
322 IF (.not.destroy(ng, diags(ng)%DiaV2int, myfile, &
323 & __line__, 'DIAGS(ng)%DiaV2int')) RETURN
324
325 IF (.not.destroy(ng, diags(ng)%DiaRUfrc, myfile, &
326 & __line__, 'DIAGS(ng)%DiaRUfrc')) RETURN
327
328 IF (.not.destroy(ng, diags(ng)%DiaRVfrc, myfile, &
329 & __line__, 'DIAGS(ng)%DiaRVfrc')) RETURN
330
331 IF (.not.destroy(ng, diags(ng)%DiaU3d, myfile, &
332 & __line__, 'DIAGS(ng)%DiaU3d')) RETURN
333
334 IF (.not.destroy(ng, diags(ng)%DiaV3d, myfile, &
335 & __line__, 'DIAGS(ng)%DiaV3d')) RETURN
336
337 IF (.not.destroy(ng, diags(ng)%DiaU3wrk, myfile, &
338 & __line__, 'DIAGS(ng)%DiaU3wrk')) RETURN
339
340 IF (.not.destroy(ng, diags(ng)%DiaV3wrk, myfile, &
341 & __line__, 'DIAGS(ng)%DiaV3wrk')) RETURN
342
343 IF (.not.destroy(ng, diags(ng)%DiaRU, myfile, &
344 & __line__, 'DIAGS(ng)%DiaRU')) RETURN
345
346 IF (.not.destroy(ng, diags(ng)%DiaRV, myfile, &
347 & __line__, 'DIAGS(ng)%DiaRV')) RETURN
348# endif
349# endif
350# endif
351!
352!-----------------------------------------------------------------------
353! Deallocate derived-type DIAGS structure.
354!-----------------------------------------------------------------------
355!
356 IF (ng.eq.ngrids) THEN
357 IF (allocated(diags)) deallocate ( diags )
358 END IF
359!
360 RETURN
destroy_mod::destroy
Definition destroy.F:36
destroy_mod
Definition destroy.F:2

References diags, mod_param::ndbio2d, mod_param::ndbio3d, mod_param::ndbio4d, and mod_param::ngrids.

Referenced by mod_arrays::roms_deallocate_arrays().

Here is the caller graph for this function:

◆ initialize_diags()

subroutine, public mod_diags::initialize_diags ( integer, intent(in) ng,
integer, intent(in) tile )

Definition at line 363 of file mod_diags.F.

364!
365!=======================================================================
366! !
367! This routine initialize all variables in the module using first !
368! touch distribution policy. In shared-memory configuration, this !
369! operation actually performs propagation of the "shared arrays" !
370! across the cluster, unless another policy is specified to !
371! override the default. !
372! !
373!=======================================================================
374!
375 USE mod_param
376# if defined DIAGNOSTICS_BIO && defined ECOSIM
377 USE mod_biology
378# endif
379!
380! Imported variable declarations.
381!
382 integer, intent(in) :: ng, tile
383!
384! Local variable declarations.
385!
386 integer :: Imin, Imax, Jmin, Jmax
387 integer :: i, idiag, j
388# ifdef SOLVE3D
389 integer :: itrc, iband, k
390# endif
391
392 real(r8), parameter :: IniVal = 0.0_r8
393
394# include "set_bounds.h"
395!
396! Set array initialization range.
397!
398# ifdef DISTRIBUTE
399 imin=bounds(ng)%LBi(tile)
400 imax=bounds(ng)%UBi(tile)
401 jmin=bounds(ng)%LBj(tile)
402 jmax=bounds(ng)%UBj(tile)
403# else
404 IF (domain(ng)%Western_Edge(tile)) THEN
405 imin=bounds(ng)%LBi(tile)
406 ELSE
407 imin=istr
408 END IF
409 IF (domain(ng)%Eastern_Edge(tile)) THEN
410 imax=bounds(ng)%UBi(tile)
411 ELSE
412 imax=iend
413 END IF
414 IF (domain(ng)%Southern_Edge(tile)) THEN
415 jmin=bounds(ng)%LBj(tile)
416 ELSE
417 jmin=jstr
418 END IF
419 IF (domain(ng)%Northern_Edge(tile)) THEN
420 jmax=bounds(ng)%UBj(tile)
421 ELSE
422 jmax=jend
423 END IF
424# endif
425!
426!-----------------------------------------------------------------------
427! Initialize module variables.
428!-----------------------------------------------------------------------
429!
430 DO j=jmin,jmax
431 DO i=imin,imax
432 diags(ng) % avgzeta(i,j) = inival
433 END DO
434
435# ifdef DIAGNOSTICS_BIO
436# if defined BIO_FENNEL
437 IF (ndbio2d.gt.0) THEN
438 DO idiag=1,ndbio2d
439 DO i=imin,imax
440 diags(ng) % DiaBio2d(i,j,idiag) = inival
441 END DO
442 END DO
443 END IF
444 IF (ndbio3d.gt.0) THEN
445 DO idiag=1,ndbio3d
446 DO k=1,n(ng)
447 DO i=imin,imax
448 diags(ng) % DiaBio3d(i,j,k,idiag) = inival
449 END DO
450 END DO
451 END DO
452 END IF
453# elif defined ECOSIM
454 IF (ndbio3d.gt.0) THEN
455 DO idiag=1,ndbio3d
456 DO k=1,ndbands
457 DO i=imin,imax
458 diags(ng) % DiaBio3d(i,j,k,idiag) = inival
459 END DO
460 END DO
461 END DO
462 END IF
463 IF (ndbio4d.gt.0) THEN
464 DO idiag=1,ndbio4d
465 DO iband=1,ndbands
466 DO k=1,n(ng)
467 DO i=imin,imax
468 diags(ng) % DiaBio4d(i,j,k,iband,idiag) = inival
469 END DO
470 END DO
471 END DO
472 END DO
473 END IF
474# endif
475# endif
476# ifdef DIAGNOSTICS_TS
477 DO idiag=1,ndt
478 DO itrc=1,nt(ng)
479 DO k=1,n(ng)
480 DO i=imin,imax
481 diags(ng) % DiaTrc(i,j,k,itrc,idiag) = inival
482 diags(ng) % DiaTwrk(i,j,k,itrc,idiag) = inival
483 END DO
484 END DO
485 END DO
486 END DO
487# endif
488# ifdef DIAGNOSTICS_UV
489 DO idiag=1,ndm2d
490 DO i=imin,imax
491 diags(ng) % DiaU2d(i,j,idiag) = inival
492 diags(ng) % DiaV2d(i,j,idiag) = inival
493 diags(ng) % DiaU2wrk(i,j,idiag) = inival
494 diags(ng) % DiaV2wrk(i,j,idiag) = inival
495# ifdef SOLVE3D
496 diags(ng) % DiaU2int(i,j,idiag) = inival
497 diags(ng) % DiaV2int(i,j,idiag) = inival
498# endif
499 END DO
500 END DO
501 DO idiag=1,ndm2d-1
502 DO i=imin,imax
503 diags(ng) % DiaRUbar(i,j,1,idiag) = inival
504 diags(ng) % DiaRUbar(i,j,2,idiag) = inival
505 diags(ng) % DiaRVbar(i,j,1,idiag) = inival
506 diags(ng) % DiaRVbar(i,j,2,idiag) = inival
507# ifdef SOLVE3D
508 diags(ng) % DiaRUfrc(i,j,1,idiag) = inival
509 diags(ng) % DiaRUfrc(i,j,2,idiag) = inival
510 diags(ng) % DiaRUfrc(i,j,3,idiag) = inival
511 diags(ng) % DiaRVfrc(i,j,1,idiag) = inival
512 diags(ng) % DiaRVfrc(i,j,2,idiag) = inival
513 diags(ng) % DiaRVfrc(i,j,3,idiag) = inival
514# endif
515 END DO
516 END DO
517# ifdef SOLVE3D
518 DO idiag=1,ndm3d
519 DO k=1,n(ng)
520 DO i=imin,imax
521 diags(ng) % DiaU3d(i,j,k,idiag) = inival
522 diags(ng) % DiaV3d(i,j,k,idiag) = inival
523 diags(ng) % DiaU3wrk(i,j,k,idiag) = inival
524 diags(ng) % DiaV3wrk(i,j,k,idiag) = inival
525 END DO
526 END DO
527 END DO
528 DO idiag=1,ndrhs
529 DO k=1,n(ng)
530 DO i=imin,imax
531 diags(ng) % DiaRU(i,j,k,1,idiag) = inival
532 diags(ng) % DiaRU(i,j,k,2,idiag) = inival
533 diags(ng) % DiaRV(i,j,k,1,idiag) = inival
534 diags(ng) % DiaRV(i,j,k,2,idiag) = inival
535 END DO
536 END DO
537 END DO
538# endif
539# endif
540 END DO
541!
542 RETURN
mod_param::bounds
type(t_bounds), dimension(:), allocatable bounds
Definition mod_param.F:232
mod_param::domain
type(t_domain), dimension(:), allocatable domain
Definition mod_param.F:329

References mod_param::bounds, diags, mod_param::domain, mod_param::n, mod_biology::ndbands, mod_param::ndbio2d, mod_param::ndbio3d, mod_param::ndbio4d, mod_param::ndm2d, mod_param::ndm3d, mod_param::ndrhs, mod_param::ndt, and mod_param::nt.

Referenced by mod_arrays::roms_initialize_arrays().

Here is the caller graph for this function:

Variable Documentation

◆ diags

type (t_diags), dimension(:), allocatable mod_diags::diags

Definition at line 100 of file mod_diags.F.

100 TYPE (T_DIAGS), allocatable :: DIAGS(:)

Referenced by allocate_diags(), biology_mod::biology(), deallocate_diags(), initialize_diags(), pre_step3d_mod::pre_step3d(), prsgrd_mod::prsgrd(), rhs3d_mod::rhs3d(), set_diags_tile(), step3d_t_mod::step3d_t(), step3d_uv_mod::step3d_uv(), t3dmix2_mod::t3dmix2(), t3dmix4_mod::t3dmix4(), uv3dmix2_mod::uv3dmix2(), uv3dmix4_mod::uv3dmix4(), wrt_diags_mod::wrt_diags_nf90(), and wrt_diags_mod::wrt_diags_pio().