ROMS
Loading...
Searching...
No Matches
Functions/Subroutines
rp_get_idata.F File Reference
#include "cppdefs.h"
Include dependency graph for rp_get_idata.F:

Go to the source code of this file.

Functions/Subroutines

subroutine rp_get_idata (ng)
 

Function/Subroutine Documentation

◆ rp_get_idata()

subroutine rp_get_idata ( integer, intent(in) ng)

Definition at line 3 of file rp_get_idata.F.

4!
5!git $Id$
6!================================================== Hernan G. Arango ===
7! Copyright (c) 2002-2025 The ROMS Group !
8! Licensed under a MIT/X style license !
9! See License_ROMS.md !
10!=======================================================================
11! !
12! This routine reads input data that needs to be obtained only once. !
13! !
14! Currently, this routine is only executed in serial mode by the !
15! main thread. !
16! !
17!=======================================================================
18!
19 USE mod_param
20 USE mod_grid
21 USE mod_iounits
22 USE mod_ncparam
23 USE mod_parallel
24 USE mod_scalars
25 USE mod_sources
26 USE mod_stepping
27# if defined SSH_TIDES_NOT_YET || defined UV_TIDES_NOT_YET
28 USE mod_tides
29# endif
30!
31 USE strings_mod, ONLY : founderror
32!
33 implicit none
34!
35! Imported variable declarations.
36!
37 integer, intent(in) :: ng
38!
39! Local variable declarations.
40!
41 logical, save :: recordless = .true.
42
43 logical, dimension(3) :: update = &
44 & (/ .FALSE., .FALSE., .FALSE. /)
45!
46 integer :: LBi, UBi, LBj, UBj
47 integer :: itrc, is
48!
49 real(r8) :: time_save = 0.0_r8
50!
51 character (len=*), parameter :: MyFile = &
52 & __FILE__
53!
54 sourcefile=myfile
55!
56! Lower and upper bounds for tiled arrays.
57!
58 lbi=lbound(grid(ng)%h,dim=1)
59 ubi=ubound(grid(ng)%h,dim=1)
60 lbj=lbound(grid(ng)%h,dim=2)
61 ubj=ubound(grid(ng)%h,dim=2)
62
63# ifdef PROFILE
64!
65!-----------------------------------------------------------------------
66! Turn on input data time wall clock.
67!-----------------------------------------------------------------------
68!
69 CALL wclock_on (ng, irpm, 3, __line__, myfile)
70# endif
71
72# if defined SSH_TIDES_NOT_YET || defined UV_TIDES_NOT_YET
73!
74!-----------------------------------------------------------------------
75! Tide period, amplitude, phase, and currents.
76!-----------------------------------------------------------------------
77!
78! Tidal Period.
79!
80 IF (lprocesstides(ng)) THEN
81 IF (iic(ng).eq.0) THEN
82 CALL get_ngfld (ng, irpm, idtper, tide(ng)%ncid, &
83# if defined PIO_LIB && defined DISTRIBUTE
84 & tide(ng)%pioFile, &
85# endif
86 & 1, tide(ng), recordless, update(1), &
87 & 1, mtc, 1, 1, 1, ntc(ng), 1, &
88 & tides(ng) % Tperiod)
89 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
90 END IF
91 END IF
92# endif
93
94# ifdef SSH_TIDES_NOT_YET
95!
96! Tidal elevation amplitude and phase. In order to read data as a
97! function of tidal period, we need to reset the model time variables
98! temporarily.
99!
100 IF (lprocesstides(ng)) THEN
101 IF (iic(ng).eq.0) THEN
102 time_save=time(ng)
103 time(ng)=8640000.0_r8
104 tdays(ng)=time(ng)*sec2day
105!
106 CALL get_2dfld (ng, irpm, idtzam, tide(ng)%ncid, &
107# if defined PIO_LIB && defined DISTRIBUTE
108 & tide(ng)%pioFile, &
109# endif
110 & 1, tide(ng), update(1), &
111 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
112# ifdef MASKING
113 & grid(ng) % rmask, &
114# endif
115 & tides(ng) % SSH_Tamp)
116 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
117!
118 CALL get_2dfld (ng, irpm, idtzph, tide(ng)%ncid, &
119# if defined PIO_LIB && defined DISTRIBUTE
120 & tide(ng)%pioFile, &
121# endif
122 & 1, tide(ng), update(1), &
123 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
124# ifdef MASKING
125 & grid(ng) % rmask, &
126# endif
127 & tides(ng) % SSH_Tphase)
128 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
129!
130 time(ng)=time_save
131 tdays(ng)=time(ng)*sec2day
132 END IF
133 END IF
134# endif
135
136# ifdef UV_TIDES_NOT_YET
137!
138! Tidal currents angle, phase, major and minor ellipse axis.
139!
140 IF (lprocesstides(ng)) THEN
141 IF (iic(ng).eq.0) THEN
142 time_save=time(ng)
143 time(ng)=8640000.0_r8
144 tdays(ng)=time(ng)*sec2day
145!
146 CALL get_2dfld (ng, irpm, idtvan, tide(ng)%ncid, &
147# if defined PIO_LIB && defined DISTRIBUTE
148 & tide(ng)%pioFile, &
149# endif
150 & 1, tide(ng), update(1), &
151 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
152# ifdef MASKING
153 & grid(ng) % rmask, &
154# endif
155 & tides(ng) % UV_Tangle)
156 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
157!
158 CALL get_2dfld (ng, irpm, idtvph, tide(ng)%ncid, &
159# if defined PIO_LIB && defined DISTRIBUTE
160 & tide(ng)%pioFile, &
161# endif
162 & 1, tide(ng), update(1), &
163 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
164# ifdef MASKING
165 & grid(ng) % rmask, &
166# endif
167 & tides(ng) % UV_Tphase)
168 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
169!
170 CALL get_2dfld (ng, irpm, idtvma, tide(ng)%ncid, &
171# if defined PIO_LIB && defined DISTRIBUTE
172 & tide(ng)%pioFile, &
173# endif
174 & 1, tide(ng), update(1), &
175 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
176# ifdef MASKING
177 & grid(ng) % rmask, &
178# endif
179 & tides(ng) % UV_Tmajor)
180 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
181!
182 CALL get_2dfld (ng, irpm, idtvmi, tide(ng)%ncid, &
183# if defined PIO_LIB && defined DISTRIBUTE
184 & tide(ng)%pioFile, &
185# endif
186 & 1, tide(ng), update(1), &
187 & lbi, ubi, lbj, ubj, mtc, ntc(ng), &
188# ifdef MASKING
189 & grid(ng) % rmask, &
190# endif
191 & tides(ng) % UV_Tminor)
192 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
193!
194 time(ng)=time_save
195 tdays(ng)=time(ng)*sec2day
196 END IF
197 END IF
198# endif
199
200# ifndef ANA_PSOURCE
201!
202!-----------------------------------------------------------------------
203! Read in point Sources/Sinks position, direction, special flag, and
204! mass transport nondimensional shape profile. Point sources are at
205! U- and V-points.
206!-----------------------------------------------------------------------
207!
208 IF ((iic(ng).eq.0).and. &
209 & (luvsrc(ng).or.lwsrc(ng).or.any(ltracersrc(:,ng)))) THEN
210 CALL get_ngfld (ng, irpm, idrxpo, ssf(ng)%ncid, &
211# if defined PIO_LIB && defined DISTRIBUTE
212 & ssf(ng)%pioFile, &
213# endif
214 & 1, ssf(ng), recordless, update(1), &
215 & 1, nsrc(ng), 1, 1, 1, nsrc(ng), 1, &
216 & sources(ng) % Xsrc)
217 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
218!
219 CALL get_ngfld (ng, irpm, idrepo, ssf(ng)%ncid, &
220# if defined PIO_LIB && defined DISTRIBUTE
221 & ssf(ng)%pioFile, &
222# endif
223 & 1, ssf(ng), recordless, update(1), &
224 & 1, nsrc(ng), 1, 1, 1, nsrc(ng), 1, &
225 & sources(ng) % Ysrc)
226 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
227!
228 CALL get_ngfld (ng, irpm, idrdir, ssf(ng)%ncid, &
229# if defined PIO_LIB && defined DISTRIBUTE
230 & ssf(ng)%pioFile, &
231# endif
232 & 1, ssf(ng), recordless, update(1), &
233 & 1, nsrc(ng), 1, 1, 1, nsrc(ng), 1, &
234 & sources(ng) % Dsrc)
235 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
236
237# ifdef SOLVE3D
238!
239 CALL get_ngfld (ng, irpm, idrvsh, ssf(ng)%ncid, &
240# if defined PIO_LIB && defined DISTRIBUTE
241 & ssf(ng)%pioFile, &
242# endif
243 & 1, ssf(ng), recordless, update(1), &
244 & 1, nsrc(ng), n(ng), 1, 1, nsrc(ng), n(ng), &
245 & sources(ng) % Qshape)
246 IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
247# endif
248!
249 DO is=1,nsrc(ng)
250 sources(ng)%Isrc(is)= &
251 & max(1,min(nint(sources(ng)%Xsrc(is)),lm(ng)+1))
252 sources(ng)%Jsrc(is)= &
253 & max(1,min(nint(sources(ng)%Ysrc(is)),mm(ng)+1))
254 END DO
255 END IF
256# endif
257
258# ifdef PROFILE
259!
260!-----------------------------------------------------------------------
261! Turn off input data time wall clock.
262!-----------------------------------------------------------------------
263!
264 CALL wclock_off (ng, irpm, 3, __line__, myfile)
265# endif
266
267 RETURN
get_2dfld
subroutine get_2dfld(ng, model, ifield, ncid, piofile, nfiles, s, update, lbi, ubi, lbj, ubj, iout, irec, fmask, fout)
Definition get_2dfld.F:12
get_ngfld
subroutine get_ngfld(ng, model, ifield, ncid, piofile, nfiles, s, recordless, update, lbi, ubi, ubj, ubk, istr, iend, jrec, fout)
Definition get_ngfld.F:9
mod_grid
Definition mod_grid.F:2
mod_grid::grid
type(t_grid), dimension(:), allocatable grid
Definition mod_grid.F:365
mod_iounits
Definition mod_iounits.F:2
mod_iounits::ssf
type(t_io), dimension(:), allocatable ssf
Definition mod_iounits.F:245
mod_iounits::tide
type(t_io), dimension(:), allocatable tide
Definition mod_iounits.F:248
mod_iounits::sourcefile
character(len=256) sourcefile
Definition mod_iounits.F:317
mod_ncparam
Definition mod_ncparam.F:2
mod_ncparam::idtzph
integer idtzph
Definition mod_ncparam.F:316
mod_ncparam::idtper
integer idtper
Definition mod_ncparam.F:310
mod_ncparam::idtvmi
integer idtvmi
Definition mod_ncparam.F:313
mod_ncparam::idrepo
integer idrepo
Definition mod_ncparam.F:274
mod_ncparam::idtzam
integer idtzam
Definition mod_ncparam.F:315
mod_ncparam::idtvph
integer idtvph
Definition mod_ncparam.F:314
mod_ncparam::idtvan
integer idtvan
Definition mod_ncparam.F:311
mod_ncparam::idrvsh
integer idrvsh
Definition mod_ncparam.F:284
mod_ncparam::idrxpo
integer idrxpo
Definition mod_ncparam.F:283
mod_ncparam::idtvma
integer idtvma
Definition mod_ncparam.F:312
mod_ncparam::idrdir
integer idrdir
Definition mod_ncparam.F:273
mod_parallel
Definition mod_parallel.F:2
mod_param
Definition mod_param.F:2
mod_param::irpm
integer, parameter irpm
Definition mod_param.F:664
mod_param::n
integer, dimension(:), allocatable n
Definition mod_param.F:479
mod_param::mtc
integer mtc
Definition mod_param.F:564
mod_param::lm
integer, dimension(:), allocatable lm
Definition mod_param.F:455
mod_param::mm
integer, dimension(:), allocatable mm
Definition mod_param.F:456
mod_scalars
Definition mod_scalars.F:2
mod_scalars::luvsrc
logical, dimension(:), allocatable luvsrc
Definition mod_scalars.F:542
mod_scalars::ltracersrc
logical, dimension(:,:), allocatable ltracersrc
Definition mod_scalars.F:544
mod_scalars::iic
integer, dimension(:), allocatable iic
Definition mod_scalars.F:249
mod_scalars::lprocesstides
logical, dimension(:), allocatable lprocesstides
Definition mod_scalars.F:1043
mod_scalars::tdays
real(dp), dimension(:), allocatable tdays
Definition mod_scalars.F:261
mod_scalars::lwsrc
logical, dimension(:), allocatable lwsrc
Definition mod_scalars.F:543
mod_scalars::sec2day
real(dp), parameter sec2day
Definition mod_scalars.F:817
mod_scalars::exit_flag
integer exit_flag
Definition mod_scalars.F:559
mod_scalars::time
real(dp), dimension(:), allocatable time
Definition mod_scalars.F:262
mod_scalars::noerror
integer noerror
Definition mod_scalars.F:561
mod_sources
Definition mod_sources.F:2
mod_sources::sources
type(t_sources), dimension(:), allocatable sources
Definition mod_sources.F:90
mod_sources::nsrc
integer, dimension(:), allocatable nsrc
Definition mod_sources.F:97
mod_stepping
Definition mod_stepping.F:2
mod_stepping::ntc
integer, dimension(:), allocatable ntc
Definition mod_stepping.F:110
mod_tides
Definition mod_tides.F:2
mod_tides::tides
type(t_tides), dimension(:), allocatable tides
Definition mod_tides.F:133
strings_mod
Definition strings.F:2
strings_mod::founderror
logical function, public founderror(flag, noerr, line, routine)
Definition strings.F:52
wclock_off
recursive subroutine wclock_off(ng, model, region, line, routine)
Definition timers.F:148
wclock_on
recursive subroutine wclock_on(ng, model, region, line, routine)
Definition timers.F:3

References mod_scalars::exit_flag, strings_mod::founderror(), get_2dfld(), get_ngfld(), mod_grid::grid, mod_ncparam::idrdir, mod_ncparam::idrepo, mod_ncparam::idrvsh, mod_ncparam::idrxpo, mod_ncparam::idtper, mod_ncparam::idtvan, mod_ncparam::idtvma, mod_ncparam::idtvmi, mod_ncparam::idtvph, mod_ncparam::idtzam, mod_ncparam::idtzph, mod_scalars::iic, mod_param::irpm, mod_param::lm, mod_scalars::lprocesstides, mod_scalars::ltracersrc, mod_scalars::luvsrc, mod_scalars::lwsrc, mod_param::mm, mod_param::mtc, mod_param::n, mod_scalars::noerror, mod_sources::nsrc, mod_stepping::ntc, mod_scalars::sec2day, mod_iounits::sourcefile, mod_sources::sources, mod_iounits::ssf, mod_scalars::tdays, mod_iounits::tide, mod_tides::tides, mod_scalars::time, wclock_off(), and wclock_on().

Referenced by rp_initial().

Here is the call graph for this function:
Here is the caller graph for this function: