Home

Context Navigation

source: palm/trunk/UTIL/inifor/src/inifor_types.f90 @ 4659

Last change on this file since 4659 was 4659, checked in by eckhard, 4 years ago
inifor: Support for COSMO cloud water and precipitation
Property svn:keywords set to `Id`
File size: 19.8 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |