1 | !> @file src/inifor_types.f90 |
---|
2 | !------------------------------------------------------------------------------! |
---|
3 | ! This file is part of the PALM model system. |
---|
4 | ! |
---|
5 | ! PALM is free software: you can redistribute it and/or modify it under the |
---|
6 | ! terms of the GNU General Public License as published by the Free Software |
---|
7 | ! Foundation, either version 3 of the License, or (at your option) any later |
---|
8 | ! version. |
---|
9 | ! |
---|
10 | ! PALM is distributed in the hope that it will be useful, but WITHOUT ANY |
---|
11 | ! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR |
---|
12 | ! A PARTICULAR PURPOSE. See the GNU General Public License for more details. |
---|
13 | ! |
---|
14 | ! You should have received a copy of the GNU General Public License along with |
---|
15 | ! PALM. If not, see <http://www.gnu.org/licenses/>. |
---|
16 | ! |
---|
17 | ! Copyright 2017-2020 Leibniz Universitaet Hannover |
---|
18 | ! Copyright 2017-2020 Deutscher Wetterdienst Offenbach |
---|
19 | !------------------------------------------------------------------------------! |
---|
20 | ! |
---|
21 | ! Current revisions: |
---|
22 | ! ----------------- |
---|
23 | ! |
---|
24 | ! |
---|
25 | ! Former revisions: |
---|
26 | ! ----------------- |
---|
27 | ! $Id: inifor_types.f90 4538 2020-05-18 13:45:35Z raasch $ |
---|
28 | ! Added boolean indicator for --static-driver option invocation |
---|
29 | ! |
---|
30 | ! |
---|
31 | ! 4523 2020-05-07 15:58:16Z eckhard |
---|
32 | ! respect integer working precision (iwp) specified in inifor_defs.f90 |
---|
33 | ! |
---|
34 | ! |
---|
35 | ! 4481 2020-03-31 18:55:54Z maronga |
---|
36 | ! Added boolean indicator for --elevation option invocation, sorted varibles |
---|
37 | ! |
---|
38 | ! |
---|
39 | ! 3866 2019-04-05 14:25:01Z eckhard |
---|
40 | ! Use PALM's working precision |
---|
41 | ! |
---|
42 | ! |
---|
43 | ! 3779 2019-03-05 11:13:35Z eckhard |
---|
44 | ! Improved variable naming |
---|
45 | ! |
---|
46 | ! 3680 2019-01-18 14:54:12Z knoop |
---|
47 | ! Prefixed all INIFOR modules with inifor_ |
---|
48 | ! |
---|
49 | ! |
---|
50 | ! 3557 2018-11-22 16:01:22Z eckhard |
---|
51 | ! Updated documentation |
---|
52 | ! |
---|
53 | ! |
---|
54 | ! 3447 2018-10-29 15:52:54Z eckhard |
---|
55 | ! Renamed source files for compatibilty with PALM build system |
---|
56 | ! |
---|
57 | ! |
---|
58 | ! 3395 2018-10-22 17:32:49Z eckhard |
---|
59 | ! Added *_is_set LOGICALs to inifor_config type to indicate option invocation |
---|
60 | ! from the command-line |
---|
61 | ! Added 1D index vertical weights lists to support addressing averaging regions |
---|
62 | ! by list of columns instead of index bounds |
---|
63 | ! |
---|
64 | ! |
---|
65 | ! 3183 2018-07-27 14:25:55Z suehring |
---|
66 | ! Introduced new PALM grid stretching: |
---|
67 | ! - Converted vertical grid_definition coordinte variables to pointers |
---|
68 | ! Improved command line interface: |
---|
69 | ! - Moved INIFOR configuration into a new derived data type |
---|
70 | ! Removed unnecessary variables |
---|
71 | ! |
---|
72 | ! |
---|
73 | ! 3182 2018-07-27 13:36:03Z suehring |
---|
74 | ! Initial revision |
---|
75 | ! |
---|
76 | ! |
---|
77 | ! |
---|
78 | ! Authors: |
---|
79 | ! -------- |
---|
80 | !> @author Eckhard Kadasch (Deutscher Wetterdienst, Offenbach) |
---|
81 | ! |
---|
82 | ! Description: |
---|
83 | ! ------------ |
---|
84 | !> The types module provides derived data types used in INIFOR. |
---|
85 | !------------------------------------------------------------------------------! |
---|
86 | MODULE inifor_types |
---|
87 | |
---|
88 | USE inifor_defs, & |
---|
89 | ONLY: DATE, PATH, SNAME, LNAME, iwp, wp |
---|
90 | |
---|
91 | #if defined ( __netcdf ) |
---|
92 | USE netcdf, & |
---|
93 | ONLY: NF90_MAX_VAR_DIMS, NF90_MAX_NAME |
---|
94 | #endif |
---|
95 | |
---|
96 | IMPLICIT NONE |
---|
97 | |
---|
98 | !------------------------------------------------------------------------------! |
---|
99 | ! Description: |
---|
100 | ! ------------ |
---|
101 | !> Contaner for the INIFOR command-line configuration |
---|
102 | !------------------------------------------------------------------------------! |
---|
103 | TYPE inifor_config |
---|
104 | CHARACTER(LEN=DATE) :: start_date !< String of the FORMAT YYYYMMDDHH indicating the start of the intended PALM-4U simulation |
---|
105 | |
---|
106 | CHARACTER(LEN=PATH) :: input_path !< Path to the input data file directory |
---|
107 | CHARACTER(LEN=PATH) :: hhl_file !< Path to the file containing the COSMO-DE HHL variable (height of half layers, i.e. vertical cell faces) |
---|
108 | CHARACTER(LEN=PATH) :: namelist_file !< Path to the PALM-4U namelist file |
---|
109 | CHARACTER(LEN=PATH) :: output_file !< Path to the INIFOR output file (i.e. PALM-4U dynamic driver') |
---|
110 | CHARACTER(LEN=PATH) :: soiltyp_file !< Path to the file containing the COSMO-DE SOILTYP variable (map of COSMO-DE soil types) |
---|
111 | CHARACTER(LEN=PATH) :: static_driver_file !< Path to the file containing the COSMO-DE SOILTYP variable (map of COSMO-DE soil types) |
---|
112 | |
---|
113 | CHARACTER(LEN=SNAME) :: flow_prefix !< Prefix of flow input files, e.g. 'laf' for COSMO-DE analyses |
---|
114 | CHARACTER(LEN=SNAME) :: input_prefix !< Prefix of all input files, e.g. 'laf' for COSMO-DE analyses |
---|
115 | CHARACTER(LEN=SNAME) :: radiation_prefix !< Prefix of radiation input files, e.g 'laf' for COSMO-DE analyses |
---|
116 | CHARACTER(LEN=SNAME) :: soil_prefix !< Prefix of soil input files, e.g. 'laf' for COSMO-DE analyses |
---|
117 | CHARACTER(LEN=SNAME) :: soilmoisture_prefix !< Prefix of input files for soil moisture spin-up, e.g 'laf' for COSMO-DE analyses |
---|
118 | |
---|
119 | CHARACTER(LEN=SNAME) :: averaging_mode !< destinguishes between level-based and heigh-based averaging |
---|
120 | CHARACTER(LEN=SNAME) :: bc_mode !< destinguishes realistic and idealistic forcing |
---|
121 | CHARACTER(LEN=SNAME) :: ic_mode !< destinguishes volume and profile initialization |
---|
122 | CHARACTER(LEN=SNAME) :: rotation_method !< selects method for velocity rotation |
---|
123 | |
---|
124 | REAL(wp) :: p0 !< manually specified surface pressure [Pa] |
---|
125 | REAL(wp) :: ug !< manually spefied geostrophic wind component in x direction [m/s] |
---|
126 | REAL(wp) :: vg !< manually spefied geostrophic wind component in y direction [m/s] |
---|
127 | REAL(wp) :: z0 !< elevation of the PALM-4U domain above sea level [m] |
---|
128 | REAL(wp) :: averaging_angle !< latitudal and longitudal width of averaging regions [deg] |
---|
129 | |
---|
130 | LOGICAL :: debug !< indicates whether --debug option was given |
---|
131 | LOGICAL :: flow_prefix_is_set !< indicates whether the flow prefix was set manually |
---|
132 | LOGICAL :: input_prefix_is_set !< indicates whether the input prefix was set manually |
---|
133 | LOGICAL :: p0_is_set !< indicates whether p0 was set manually |
---|
134 | LOGICAL :: radiation_prefix_is_set !< indicates whether the radiation prefix was set manually |
---|
135 | LOGICAL :: soil_prefix_is_set !< indicates whether the soil prefix was set manually |
---|
136 | LOGICAL :: soilmoisture_prefix_is_set !< indicates whether the soilmoisture prefix was set manually |
---|
137 | LOGICAL :: static_driver_is_set !< indicates whether a static driver was given |
---|
138 | LOGICAL :: ug_defined_by_user !< indicates whether ug was set manually |
---|
139 | LOGICAL :: vg_defined_by_user !< indicates whether vg was set manually |
---|
140 | LOGICAL :: z0_is_set !< indicates whether z0 was set manually |
---|
141 | END TYPE inifor_config |
---|
142 | |
---|
143 | |
---|
144 | !------------------------------------------------------------------------------! |
---|
145 | ! Description: |
---|
146 | ! ------------ |
---|
147 | !> Container for grid data, in partucular coordinates, interpolation neighbours |
---|
148 | !> and weights |
---|
149 | !------------------------------------------------------------------------------! |
---|
150 | TYPE grid_definition |
---|
151 | CHARACTER(LEN=SNAME) :: name(3) !< names of the grid dimensions, e.g. (/'x', 'y', 'z'/) or (/'latitude', 'longitude', 'height'/) |
---|
152 | CHARACTER(LEN=SNAME) :: kind !< names of the grid dimensions, e.g. (/'x', 'y', 'z'/) or (/'latitude', 'longitude', 'height'/) |
---|
153 | INTEGER(iwp) :: k_min !< Index of lowest PALM grid level that is not cut by local COSMO orography; vertically separates interpolation and extrapolation region. |
---|
154 | INTEGER(iwp) :: nx !< number of gridpoints in the first dimension |
---|
155 | INTEGER(iwp) :: ny !< number of gridpoints in the second dimension |
---|
156 | INTEGER(iwp) :: nz !< number of gridpoints in the third dimension, used for PALM points |
---|
157 | INTEGER(iwp) :: nlev !< number of COSMO grid levels |
---|
158 | INTEGER(iwp) :: n_columns !< number of averaging columns of the source grid |
---|
159 | INTEGER(iwp), ALLOCATABLE :: ii(:,:,:) !< Given a point (i,j,k) in the PALM-4U grid, ii(i,j,l) gives the x index of the l'th horizontl neighbour on the COSMO-DE grid. |
---|
160 | INTEGER(iwp), ALLOCATABLE :: jj(:,:,:) !< Given a point (i,j,k) in the PALM-4U grid, jj(i,j,l) gives the y index of the l'th horizontl neighbour on the COSMO-DE grid. |
---|
161 | INTEGER(iwp), ALLOCATABLE :: kk(:,:,:,:) !< Given a point (i,j,k) in the PALM-4U grid, kk(i,j,k,l) gives the z index of the l'th vertical neighbour in the intermediate grid. |
---|
162 | INTEGER(iwp), ALLOCATABLE :: iii(:) !< profile averaging neighbour indices |
---|
163 | INTEGER(iwp), ALLOCATABLE :: jjj(:) !< profile averaging neighbour indices |
---|
164 | INTEGER(iwp), ALLOCATABLE :: kkk(:,:,:) !< indices of vertical interpolation neightbours, kkk(<source column>, <PALM k level>, <neighbour index>) |
---|
165 | REAL(wp) :: lx !< domain length in the first dimension [m] |
---|
166 | REAL(wp) :: ly !< domain length in the second dimension [m] |
---|
167 | REAL(wp) :: x0 !< x coordinate of PALM-4U domain projection centre, i.e. location of zero distortion |
---|
168 | REAL(wp) :: y0 !< y coordinate of PALM-4U domain projection centre, i.e. location of zwro distortion |
---|
169 | REAL(wp) :: z0 !< displacement of the coordinate origin above sea level [m] |
---|
170 | REAL(wp), ALLOCATABLE :: x(:) !< coordinates of cell centers in x direction [m] |
---|
171 | REAL(wp), ALLOCATABLE :: y(:) !< coordinates of cell centers in y direction [m] |
---|
172 | REAL(wp), POINTER :: z(:) !< coordinates of cell centers in z direction [m] |
---|
173 | REAL(wp), ALLOCATABLE :: h(:,:,:) !< heights grid point for intermediate grids [m] |
---|
174 | REAL(wp), POINTER :: cosmo_h(:,:,:)!< pointer to appropriate COSMO level heights (scalar/w) [m] |
---|
175 | REAL(wp), POINTER :: hhl(:,:,:) !< heights of half layers (cell faces) above sea level in COSMO-DE, read in from |
---|
176 | REAL(wp), POINTER :: hfl(:,:,:) !< heights of full layers (cell centres) above sea level in COSMO-DE, computed as arithmetic average of hhl |
---|
177 | REAL(wp), POINTER :: depths(:) !< depths of output soil layers, equal the depths of the source model (e.g. COSMO-DE) |
---|
178 | REAL(wp), ALLOCATABLE :: xu(:) !< coordinates of cell faces in x direction [m] |
---|
179 | REAL(wp), ALLOCATABLE :: yv(:) !< coordinates of cell faces in y direction [m] |
---|
180 | REAL(wp), POINTER :: zw(:) !< coordinates of cell faces in z direction [m] |
---|
181 | REAL(wp), ALLOCATABLE :: lat(:) !< rotated-pole latitudes of scalars (cell centers) of the COSMO-DE grid [rad] |
---|
182 | REAL(wp), ALLOCATABLE :: lon(:) !< rotated-pole longitudes of scalars (cell centres) of the COSMO-DE grid [rad] |
---|
183 | REAL(wp), ALLOCATABLE :: latv(:) !< rotated-pole latitudes of v winds (face centres in latitudal/y direction) [rad] |
---|
184 | REAL(wp), ALLOCATABLE :: lonu(:) !< rotated-pole latitudes of u winds (face centres in longitudal/x direction) [rad] |
---|
185 | REAL(wp), ALLOCATABLE :: clat(:,:) !< latitudes of PALM-4U cell centres in COSMO-DE's rotated-pole grid [rad] |
---|
186 | REAL(wp), ALLOCATABLE :: clon(:,:) !< longitudes of PALM-4U scalars (cell centres) in COSMO-DE's rotated-pole grid [rad] |
---|
187 | REAL(wp), ALLOCATABLE :: clatu(:,:) !< latitudes of PALM-4U u winds (cell faces in u direction) in COSMO-DE's rotated-pole grid [rad] |
---|
188 | REAL(wp), ALLOCATABLE :: clonu(:,:) !< longitudes of PALM-4U u winds (cell faces in u direction) in COSMO-DE's rotated-pole grid [rad] |
---|
189 | REAL(wp), ALLOCATABLE :: clatv(:,:) !< latitudes of PALM-4U v winds (cell faces in v direction) in COSMO-DE's rotated-pole grid [rad] |
---|
190 | REAL(wp), ALLOCATABLE :: clonv(:,:) !< longitudes of PALM-4U v winds (cell faces in v direction) in COSMO-DE's rotated-pole grid [rad] |
---|
191 | REAL(wp), ALLOCATABLE :: w_horiz(:,:,:) !< weights for bilinear horizontal interpolation |
---|
192 | REAL(wp), ALLOCATABLE :: w_verti(:,:,:,:) !< weights for linear vertical interpolation |
---|
193 | REAL(wp), ALLOCATABLE :: w(:,:,:) !< vertical interpolation weights, w(<source_column>, <PALM k level>, <neighbour index>) [-] |
---|
194 | END TYPE grid_definition |
---|
195 | |
---|
196 | |
---|
197 | !------------------------------------------------------------------------------! |
---|
198 | ! Description: |
---|
199 | ! ------------ |
---|
200 | !> Container for name and dimensions of the netCDF output file |
---|
201 | !------------------------------------------------------------------------------! |
---|
202 | TYPE nc_file |
---|
203 | CHARACTER(LEN=PATH) :: name !< file name |
---|
204 | INTEGER :: dimid_time !< NetCDF IDs of the time dimension |
---|
205 | INTEGER :: dimids_scl(3) !< NetCDF IDs of the grid dimensions for scalar points x, y, z |
---|
206 | INTEGER :: dimids_vel(3) !< NetCDF IDs of the grid dimensions for velocity points xu, yu, zu |
---|
207 | INTEGER :: dimids_soil(3) !< NetCDF IDs of the grid dimensions for soil points x, y, depth |
---|
208 | INTEGER :: dimvarid_time !< NetCDF IDs of the time variable |
---|
209 | INTEGER :: dimvarids_scl(3) !< NetCDF IDs of the grid coordinates of scalars x, y, z |
---|
210 | INTEGER :: dimvarids_vel(3) !< NetCDF IDs of the grid coordinates of velocities xu, yu, zu. Note that velocities are located at mix of both coordinates, e.g. u(xu, y, z). |
---|
211 | INTEGER :: dimvarids_soil(3) !< NetCDF IDs of the grid coordinates for soil points x, y, depth |
---|
212 | REAL(wp), POINTER :: time(:) !< vector of output time steps |
---|
213 | END TYPE nc_file |
---|
214 | |
---|
215 | |
---|
216 | !------------------------------------------------------------------------------! |
---|
217 | ! Description: |
---|
218 | ! ------------ |
---|
219 | !> Metadata container for netCDF variables |
---|
220 | !------------------------------------------------------------------------------! |
---|
221 | #if defined ( __netcdf ) |
---|
222 | TYPE nc_var |
---|
223 | INTEGER :: varid !< NetCDF ID of the variable |
---|
224 | INTEGER :: input_id !< ID of the correpsonding input variables, only valid for output variables |
---|
225 | INTEGER :: ndim !< number of NetCDF dimensions |
---|
226 | INTEGER(iwp) :: nt !< number of output time steps |
---|
227 | INTEGER :: lod !< NetCDF attribute indicating the PALM-4U level of detail |
---|
228 | INTEGER, DIMENSION(NF90_MAX_VAR_DIMS) :: dimids !< NetCDF IDs of the dimensions |
---|
229 | INTEGER, DIMENSION(NF90_MAX_VAR_DIMS) :: dimvarids !< IDs of NetCDF dimension variables |
---|
230 | INTEGER, DIMENSION(NF90_MAX_VAR_DIMS) :: dimlen !< length of NetCDF dimensions |
---|
231 | CHARACTER(LEN=NF90_MAX_NAME), DIMENSION(NF90_MAX_VAR_DIMS) :: dimname !< names of NetCDF dimensions |
---|
232 | CHARACTER(LEN=SNAME) :: name !< NetCDF short name of the variable |
---|
233 | CHARACTER(LEN=LNAME) :: standard_name !< NetCDF standard name of the variable |
---|
234 | CHARACTER(LEN=LNAME) :: long_name !< NetCDF long name of the variable |
---|
235 | CHARACTER(LEN=LNAME) :: source !< NetCDF attribute indicating the data source for the output |
---|
236 | CHARACTER(LEN=SNAME) :: units !< NetCDF units of the variable |
---|
237 | CHARACTER(LEN=SNAME) :: kind !< Kind of grid |
---|
238 | CHARACTER(LEN=SNAME) :: task !< Processing task that generates this variable, e.g. 'interpolate_2d' or 'average profile' |
---|
239 | LOGICAL :: to_be_processed = .FALSE. !< INIFOR flag indicating whether variable shall be processed |
---|
240 | LOGICAL :: is_internal = .FALSE. !< INIFOR flag indicating whether variable shall be written to netCDF file (.FALSE.) or kept for later (.TRUE.) |
---|
241 | LOGICAL :: is_read = .FALSE. !< INIFOR flag indicating whether variable has been read |
---|
242 | LOGICAL :: is_upside_down = .FALSE. !< INIFOR flag indicating whether vertical dimension is reversed (typically the case with COSMO-DE atmospheric fields) |
---|
243 | TYPE(grid_definition), POINTER :: grid !< Pointer to the corresponding output grid |
---|
244 | TYPE(grid_definition), POINTER :: intermediate_grid !< Pointer to the corresponding intermediate grid |
---|
245 | TYPE(grid_definition), POINTER :: averaging_grid !< Pointer to the corresponding intermediate grid |
---|
246 | END TYPE nc_var |
---|
247 | |
---|
248 | |
---|
249 | !------------------------------------------------------------------------------! |
---|
250 | ! Description: |
---|
251 | ! ------------ |
---|
252 | !> Input/Output group, groups together nc_var-type output variabels that share |
---|
253 | !> input variables as well as lists of the netCDF files they are stored in. |
---|
254 | !> For instance, all boundary surfaces and initialization fields of the |
---|
255 | !> potential temperature are base on the input netCDF variables T and P. |
---|
256 | !------------------------------------------------------------------------------! |
---|
257 | TYPE io_group |
---|
258 | INTEGER(iwp) :: nt !< maximum number of output time steps across all output variables |
---|
259 | INTEGER(iwp) :: nv !< number of netCDF output variables |
---|
260 | INTEGER(iwp) :: n_inputs !< number of input variables |
---|
261 | INTEGER(iwp) :: n_output_quantities !< number of physical quantities required for computing netCDF output variables |
---|
262 | CHARACTER(LEN=SNAME) :: kind !< kind of I/O group |
---|
263 | CHARACTER(LEN=PATH), ALLOCATABLE :: in_files(:) !< list of nt input files |
---|
264 | TYPE(nc_var), ALLOCATABLE :: out_vars(:) !< list of output variables |
---|
265 | TYPE(nc_var), ALLOCATABLE :: in_var_list(:) !< list of input variables |
---|
266 | LOGICAL :: to_be_processed = .FALSE. !< Inifor flag indicating whether I/O group shall be processed |
---|
267 | LOGICAL :: is_accumulated = .FALSE. !< Flag indicating whether this I/O group contains accumulated variables |
---|
268 | LOGICAL :: is_preprocessed = .FALSE. !< Inifor flag indicating whether the I/O group has been preprocessed |
---|
269 | END TYPE io_group |
---|
270 | #endif |
---|
271 | |
---|
272 | !------------------------------------------------------------------------------! |
---|
273 | ! Description: |
---|
274 | ! ------------ |
---|
275 | !> Container for input data arrays. read_input_variables() allocates a |
---|
276 | !> one-dimensional array of containers, to accomodate all inputs of the given |
---|
277 | !> IO group in one variable. |
---|
278 | !------------------------------------------------------------------------------! |
---|
279 | TYPE container |
---|
280 | REAL(wp), ALLOCATABLE :: array(:,:,:) !< generic data array |
---|
281 | LOGICAL :: is_preprocessed = .FALSE. !< flag indicating whether input array has been preprocessed |
---|
282 | END TYPE container |
---|
283 | |
---|
284 | END MODULE inifor_types |
---|