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