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

Last change on this file since 3557 was 3557, checked in by eckhard, 3 years ago

inifor: Updated documentation

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