source: palm/trunk/SOURCE/biometeorology_mod.f90 @ 4495

Last change on this file since 4495 was 4495, checked in by raasch, 16 months ago

restart data handling with MPI-IO added, first part

  • Property svn:keywords set to Id
  • Property svn:mergeinfo set to (toggle deleted branches)
    /palm/branches/chemistry/SOURCE/biometeorology_mod.f902047-3190,​3218-3297
    /palm/branches/resler/SOURCE/biometeorology_mod.f902023-4492
    /palm/branches/salsa/SOURCE/biometeorology_mod.f902503-3581
    /palm/trunk/SOURCE/biometeorology_mod.f90mergedeligible
    /palm/branches/forwind/SOURCE/biometeorology_mod.f901564-1913
    /palm/branches/fricke/SOURCE/biometeorology_mod.f90942-977
    /palm/branches/hoffmann/SOURCE/biometeorology_mod.f90989-1052
    /palm/branches/letzel/masked_output/SOURCE/biometeorology_mod.f90296-409
    /palm/branches/palm4u/SOURCE/biometeorology_mod.f902540-2692
    /palm/branches/rans/SOURCE/biometeorology_mod.f902078-3128
    /palm/branches/suehring/biometeorology_mod.f90423-666
File size: 184.1 KB
RevLine 
[3448]1!> @file biometeorology_mod.f90
2!--------------------------------------------------------------------------------!
[3321]3! This file is part of PALM-4U.
4!
5! PALM-4U 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-4U 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!
[4481]17! Copyright 2018-2020 Deutscher Wetterdienst (DWD)
18! Copyright 2018-2020 Institute of Computer Science, Academy of Sciences, Prague
19! Copyright 2018-2020 Leibniz Universitaet Hannover
[3448]20!--------------------------------------------------------------------------------!
[3321]21!
[3337]22! Current revisions:
[3569]23! ------------------
[3337]24!
25!
26! Former revisions:
[3321]27! -----------------
28! $Id: biometeorology_mod.f90 4495 2020-04-13 20:11:20Z raasch $
[4495]29! restart data handling with MPI-IO added
30!
31! 4493 2020-04-10 09:49:43Z pavelkrc
[4382]32! Revise bad formatting
33!
34! 4286 2019-10-30 16:01:14Z resler
[4227]35! implement new palm_date_time_mod
36!
37! 4223 2019-09-10 09:20:47Z gronemeier
[4182]38! Corrected "Former revisions" section
39!
40! 4168 2019-08-16 13:50:17Z suehring
[4168]41! Replace function get_topography_top_index by topo_top_ind
42!
43! 4144 2019-08-06 09:11:47Z raasch
[4144]44! relational operators .EQ., .NE., etc. replaced by ==, /=, etc.
45!
46! 4127 2019-07-30 14:47:10Z suehring
[4127]47! Output for bio_mrt added (merge from branch resler)
48!
49! 4126 2019-07-30 11:09:11Z gronemeier
[4126]50! renamed vitd3_exposure_av into vitd3_dose,
51! renamed uvem_calc_exposure into bio_calculate_uv_exposure
52!
53! 3885 2019-04-11 11:29:34Z kanani
[3885]54! Changes related to global restructuring of location messages and introduction
55! of additional debug messages
56!
57! 3753 2019-02-19 14:48:54Z dom_dwd_user
[3753]58! - Added automatic setting of mrt_nlevels in case it was not part of
59! radiation_parameters namelist (or set to 0 accidentially).
60! - Minor speed improvoemnts in perceived temperature calculations.
61! - Perceived temperature regression arrays now declared as PARAMETERs.
62!
63! 3750 2019-02-19 07:29:39Z dom_dwd_user
[3749]64! - Added addittional safety meassures to bio_calculate_thermal_index_maps.
65! - Replaced several REAL (un-)equality comparisons.
66!
67! 3742 2019-02-14 11:25:22Z dom_dwd_user
[3742]68! - Allocation of the input _av grids was moved to the "sum" section of
69! bio_3d_data_averaging to make sure averaging is only done once!
70! - Moved call of bio_calculate_thermal_index_maps from biometeorology module to
71! time_integration to make sure averaged input is updated before calculating.
72!
73! 3740 2019-02-13 12:35:12Z dom_dwd_user
[3740]74! - Added safety-meassure to catch the case that 'bio_mrt_av' is stated after
75! 'bio_<index>' in the output section of the p3d file.
76!
77! 3739 2019-02-13 08:05:17Z dom_dwd_user
[3739]78! - Auto-adjusting thermal_comfort flag if not set by user, but thermal_indices
79! set as output quantities.
80! - Renamed flags "bio_<index>" to "do_calculate_<index>" for better readability
81! - Removed everything related to "time_bio_results" as this is never used.
82! - Moved humidity warning to check_data_output
83! - Fixed bug in mrt calculation introduced with my commit yesterday.
84!
85! 3735 2019-02-12 09:52:40Z dom_dwd_user
[3735]86! - Fixed auto-setting of thermal index calculation flags by output
87!  as originally proposed by resler.
88! - removed bio_pet and outher configuration variables.
89! - Updated namelist.
90!
91! 3711 2019-01-31 13:44:26Z knoop
[3711]92! Introduced interface routine bio_init_checks + small error message changes
93!
94! 3693 2019-01-23 15:20:53Z dom_dwd_user
[3693]95! Added usage of time_averaged mean radiant temperature, together with calculation,
96! grid and restart routines. General cleanup and commenting.
97!
98! 3685 2019-01-21 01:02:11Z knoop
[3685]99! Some interface calls moved to module_interface + cleanup
100!
101! 3650 2019-01-04 13:01:33Z kanani
[4182]102! Bugfixes and additions for enabling restarts with biometeorology
[3650]103!
[4182]104! 3448 2018-10-29 18:14:31Z kanani
105! Initial revision
[3569]106!
[4182]107!
108!
109! Authors:
110! --------
111! @author Dominik Froehlich <dominik.froehlich@dwd.de>, thermal indices
112! @author Jaroslav Resler <resler@cs.cas.cz>, mean radiant temperature
113! @author Michael Schrempf <schrempf@muk.uni-hannover.de>, uv exposure
114!
115!
[3448]116! Description:
117! ------------
[3569]118!> Biometeorology module consisting of two parts:
119!> 1.: Human thermal comfort module calculating thermal perception of a sample
[3448]120!> human being under the current meteorological conditions.
[3569]121!> 2.: Calculation of vitamin-D weighted UV exposure
[3448]122!>
123!> @todo Alphabetical sorting of "USE ..." lists, "ONLY" list, variable declarations
124!>       (per subroutine: first all CHARACTERs, then INTEGERs, LOGICALs, REALs, )
125!> @todo Comments start with capital letter --> "!-- Include..."
[3569]126!> @todo uv_vitd3dose-->new output type necessary (cumulative)
127!> @todo consider upwelling radiation in UV
[3448]128!>
129!> @note nothing now
130!>
131!> @bug  no known bugs by now
[3321]132!------------------------------------------------------------------------------!
[3448]133 MODULE biometeorology_mod
[3321]134
135    USE arrays_3d,                                                             &
[3742]136        ONLY:  pt, p, u, v, w, q
[3321]137
[3448]138    USE averaging,                                                             &
[3742]139        ONLY:  pt_av, q_av, u_av, v_av, w_av
[3448]140
[3361]141    USE basic_constants_and_equations_mod,                                     &
[3742]142        ONLY:  c_p, degc_to_k, l_v, magnus, sigma_sb, pi
[3361]143
[3448]144    USE control_parameters,                                                    &
[3885]145        ONLY:  average_count_3d, biometeorology,                               &
146               debug_output,                                                   &
147               dz, dz_stretch_factor,                                          &
[3742]148               dz_stretch_level, humidity, initializing_actions, nz_do3d,      &
[4495]149               restart_data_format_output, surface_pressure
[3321]150
[3448]151    USE grid_variables,                                                        &
[3742]152        ONLY:  ddx, dx, ddy, dy
[3321]153
[3448]154    USE indices,                                                               &
[3742]155        ONLY:  nxl, nxr, nys, nyn, nzb, nzt, nys, nyn, nxl, nxr, nxlg, nxrg,   &
[4168]156               nysg, nyng, topo_top_ind
[3321]157
[3448]158    USE kinds  !< Set precision of INTEGER and REAL arrays according to PALM
[3321]159
[3693]160    USE netcdf_data_input_mod,                                                 &
161        ONLY:  netcdf_data_input_uvem, uvem_projarea_f, uvem_radiance_f,       &
[3569]162               uvem_irradiance_f, uvem_integration_f, building_obstruction_f
[4227]163
164    USE palm_date_time_mod,                                                    &
165        ONLY:  get_date_time
[3569]166!
[3448]167!-- Import radiation model to obtain input for mean radiant temperature
168    USE radiation_model_mod,                                                   &
[3742]169        ONLY:  ix, iy, iz, id, mrt_nlevels, mrt_include_sw,                    &
170               mrtinsw, mrtinlw, mrtbl, nmrtbl, radiation,                     &
171               radiation_interactions, rad_sw_in,                              &
172               rad_sw_out, rad_lw_in, rad_lw_out
[3321]173
[4495]174    USE restart_data_mpi_io_mod,                                                                   &
175        ONLY:  rrd_mpi_io, wrd_mpi_io
176
177
[3448]178    IMPLICIT NONE
[3321]179
[3448]180    PRIVATE
[3321]181
[3569]182!
[3448]183!-- Declare all global variables within the module (alphabetical order)
[3593]184    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  tmrt_grid  !< tmrt results (degree_C)
185    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  perct      !< PT results   (degree_C)
186    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  utci       !< UTCI results (degree_C)
187    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pet        !< PET results  (degree_C)
[3569]188!
[3525]189!-- Grids for averaged thermal indices
190    REAL(wp), DIMENSION(:), ALLOCATABLE   ::  mrt_av_grid   !< time average mean
[3693]191    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  tmrt_av_grid  !< tmrt results (degree_C)
[3593]192    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  perct_av      !< PT results (aver. input)   (degree_C)
193    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  utci_av       !< UTCI results (aver. input) (degree_C)
194    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pet_av        !< PET results (aver. input)  (degree_C)
[3321]195
[3525]196
197    INTEGER( iwp ) ::  bio_cell_level     !< cell level biom calculates for
198    REAL ( wp )    ::  bio_output_height  !< height output is calculated in m
[3448]199    REAL ( wp ), PARAMETER ::  human_absorb = 0.7_wp  !< SW absorbtivity of a human body (Fanger 1972)
200    REAL ( wp ), PARAMETER ::  human_emiss = 0.97_wp  !< LW emissivity of a human body after (Fanger 1972)
[3569]201    REAL ( wp ), PARAMETER ::  bio_fill_value = -9999._wp  !< set module fill value, replace by global fill value as soon as available
202!
[3448]203!--
[3742]204    LOGICAL ::  thermal_comfort  = .FALSE.  !< Enables or disables the entire thermal comfort part
[3693]205    LOGICAL ::  do_average_theta = .FALSE.  !< switch: do theta averaging in this module? (if .FALSE. this is done globally)
206    LOGICAL ::  do_average_q     = .FALSE.  !< switch: do e averaging in this module?
207    LOGICAL ::  do_average_u     = .FALSE.  !< switch: do u averaging in this module?
208    LOGICAL ::  do_average_v     = .FALSE.  !< switch: do v averaging in this module?
209    LOGICAL ::  do_average_w     = .FALSE.  !< switch: do w averaging in this module?
210    LOGICAL ::  do_average_mrt   = .FALSE.  !< switch: do mrt averaging in this module?
[3742]211    LOGICAL ::  average_trigger_perct  = .FALSE.  !< update averaged input on call to bio_perct?
212    LOGICAL ::  average_trigger_utci   = .FALSE.  !< update averaged input on call to bio_utci?
213    LOGICAL ::  average_trigger_pet    = .FALSE.  !< update averaged input on call to bio_pet?
[4127]214    LOGICAL ::  average_trigger_mrt    = .FALSE.  !< update averaged input on call to bio_pet?
[3742]215    LOGICAL ::  do_calculate_perct     = .FALSE.  !< Turn index PT (instant. input) on or off
216    LOGICAL ::  do_calculate_perct_av  = .FALSE.  !< Turn index PT (averaged input) on or off
217    LOGICAL ::  do_calculate_pet       = .FALSE.  !< Turn index PET (instant. input) on or off
218    LOGICAL ::  do_calculate_pet_av    = .FALSE.  !< Turn index PET (averaged input) on or off
219    LOGICAL ::  do_calculate_utci      = .FALSE.  !< Turn index UTCI (instant. input) on or off
220    LOGICAL ::  do_calculate_utci_av   = .FALSE.  !< Turn index UTCI (averaged input) on or off
[4127]221    LOGICAL ::  do_calculate_mrt2d     = .FALSE.  !< Turn index MRT 2D (averaged or inst) on or off
[3321]222
[3569]223!
224!-- UVEM parameters from here
225!
226!-- Declare all global variables within the module (alphabetical order)
[3650]227    INTEGER(iwp) ::  bio_nmrtbl
[3569]228    INTEGER(iwp) ::  ai                      = 0  !< loop index in azimuth direction
229    INTEGER(iwp) ::  bi                      = 0  !< loop index of bit location within an 8bit-integer (one Byte)
230    INTEGER(iwp) ::  clothing                = 1  !< clothing (0=unclothed, 1=Arms,Hands,Face free, 3=Hand,Face free)
231    INTEGER(iwp) ::  iq                      = 0  !< loop index of irradiance quantity
232    INTEGER(iwp) ::  pobi                    = 0  !< loop index of the position of corresponding byte within ibset byte vektor
233    INTEGER(iwp) ::  obstruction_direct_beam = 0  !< Obstruction information for direct beam   
234    INTEGER(iwp) ::  zi                      = 0  !< loop index in zenith direction
[3321]235
[3569]236    INTEGER(KIND=1), DIMENSION(0:44)  ::  obstruction_temp1 = 0  !< temporary obstruction information stored with ibset
237    INTEGER(iwp),    DIMENSION(0:359) ::  obstruction_temp2 = 0  !< restored temporary obstruction information from ibset file
238
239    INTEGER(iwp), DIMENSION(0:35,0:9) ::  obstruction       = 1  !< final 2D obstruction information array
240
241    LOGICAL ::  consider_obstructions = .TRUE.   !< namelist parameter (see documentation)
242    LOGICAL ::  sun_in_south          = .FALSE.  !< namelist parameter (see documentation)
243    LOGICAL ::  turn_to_sun           = .TRUE.   !< namelist parameter (see documentation)
244    LOGICAL ::  uv_exposure           = .FALSE.  !< namelist parameter (see documentation)
245
246    REAL(wp) ::  diffuse_exposure            =   0.0_wp  !< calculated exposure by diffuse radiation
247    REAL(wp) ::  direct_exposure             =   0.0_wp  !< calculated exposure by direct solar beam   
248    REAL(wp) ::  orientation_angle           =   0.0_wp  !< orientation of front/face of the human model   
249    REAL(wp) ::  projection_area_direct_beam =   0.0_wp  !< projection area for direct solar beam
250    REAL(wp) ::  saa                         = 180.0_wp  !< solar azimuth angle
251    REAL(wp) ::  startpos_human              =   0.0_wp  !< start value for azimuth interpolation of human geometry array
252    REAL(wp) ::  startpos_saa_float          =   0.0_wp  !< start value for azimuth interpolation of radiance array
253    REAL(wp) ::  sza                         =  20.0_wp  !< solar zenith angle
254    REAL(wp) ::  xfactor                     =   0.0_wp  !< relative x-position used for interpolation
255    REAL(wp) ::  yfactor                     =   0.0_wp  !< relative y-position used for interpolation
256
257    REAL(wp), DIMENSION(0:2)  ::  irradiance =   0.0_wp  !< iradiance values extracted from irradiance lookup table 
258
259    REAL(wp), DIMENSION(0:2,0:90) ::  irradiance_lookup_table      = 0.0_wp  !< irradiance lookup table
260    REAL(wp), DIMENSION(0:35,0:9) ::  integration_array            = 0.0_wp  !< solid angle factors for hemispherical integration
261    REAL(wp), DIMENSION(0:35,0:9) ::  projection_area              = 0.0_wp  !< projection areas of a human (all directions)
262    REAL(wp), DIMENSION(0:35,0:9) ::  projection_area_lookup_table = 0.0_wp  !< human geometry lookup table (projection areas)
263    REAL(wp), DIMENSION(0:71,0:9) ::  projection_area_direct_temp  = 0.0_wp  !< temporary projection area for direct solar beam
264    REAL(wp), DIMENSION(0:71,0:9) ::  projection_area_temp         = 0.0_wp  !< temporary projection area for all directions
265    REAL(wp), DIMENSION(0:35,0:9) ::  radiance_array               = 0.0_wp  !< radiance extracted from radiance_lookup_table 
266    REAL(wp), DIMENSION(0:71,0:9) ::  radiance_array_temp          = 0.0_wp  !< temporary radiance data
267
[4126]268    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  vitd3_exposure  !< result variable for instantaneous vitamin-D weighted exposures
269    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  vitd3_dose      !< result variable for summation of vitamin-D weighted exposures
[3569]270
271    REAL(wp), DIMENSION(0:35,0:9,0:90) ::  radiance_lookup_table   = 0.0_wp  !< radiance lookup table
272
[3525]273!
274!-- INTERFACES that must be available to other modules (alphabetical order)
[3321]275
[3525]276    PUBLIC bio_3d_data_averaging, bio_check_data_output,                       &
277    bio_calculate_mrt_grid, bio_calculate_thermal_index_maps, bio_calc_ipt,    &
278    bio_check_parameters, bio_data_output_3d, bio_data_output_2d,              &
279    bio_define_netcdf_grid, bio_get_thermal_index_input_ij, bio_header,        &
[3739]280    bio_init, bio_init_checks, bio_parin, thermal_comfort,                     &
[3650]281    bio_nmrtbl, bio_wrd_local, bio_rrd_local, bio_wrd_global, bio_rrd_global
[3569]282!
283!-- UVEM PUBLIC variables and methods
[4126]284    PUBLIC bio_calculate_uv_exposure, uv_exposure
[3525]285
[3448]286!
287!-- PALM interfaces:
288!
289!-- 3D averaging for HTCM _INPUT_ variables
[3525]290    INTERFACE bio_3d_data_averaging
291       MODULE PROCEDURE bio_3d_data_averaging
292    END INTERFACE bio_3d_data_averaging
[3569]293!
[3525]294!-- Calculate mtr from rtm fluxes and assign into 2D grid
295    INTERFACE bio_calculate_mrt_grid
296       MODULE PROCEDURE bio_calculate_mrt_grid
297    END INTERFACE bio_calculate_mrt_grid
[3569]298!
[3448]299!-- Calculate static thermal indices PT, UTCI and/or PET
[3525]300    INTERFACE bio_calculate_thermal_index_maps
301       MODULE PROCEDURE bio_calculate_thermal_index_maps
302    END INTERFACE bio_calculate_thermal_index_maps
[3569]303!
[3448]304!-- Calculate the dynamic index iPT (to be caled by the agent model)
[3525]305    INTERFACE bio_calc_ipt
306       MODULE PROCEDURE bio_calc_ipt
307    END INTERFACE bio_calc_ipt
[3569]308!
[3448]309!-- Data output checks for 2D/3D data to be done in check_parameters
[3569]310    INTERFACE bio_check_data_output
311       MODULE PROCEDURE bio_check_data_output
312    END INTERFACE bio_check_data_output
313!
[3448]314!-- Input parameter checks to be done in check_parameters
[3525]315    INTERFACE bio_check_parameters
316       MODULE PROCEDURE bio_check_parameters
317    END INTERFACE bio_check_parameters
[3569]318!
[3448]319!-- Data output of 2D quantities
[3525]320    INTERFACE bio_data_output_2d
321       MODULE PROCEDURE bio_data_output_2d
322    END INTERFACE bio_data_output_2d
[3569]323!
[3448]324!-- no 3D data, thus, no averaging of 3D data, removed
[3525]325    INTERFACE bio_data_output_3d
326       MODULE PROCEDURE bio_data_output_3d
327    END INTERFACE bio_data_output_3d
[3569]328!
[3448]329!-- Definition of data output quantities
[3525]330    INTERFACE bio_define_netcdf_grid
331       MODULE PROCEDURE bio_define_netcdf_grid
332    END INTERFACE bio_define_netcdf_grid
[3569]333!
[3448]334!-- Obtains all relevant input values to estimate local thermal comfort/stress
[3525]335    INTERFACE bio_get_thermal_index_input_ij
336       MODULE PROCEDURE bio_get_thermal_index_input_ij
337    END INTERFACE bio_get_thermal_index_input_ij
[3569]338!
[3448]339!-- Output of information to the header file
[3525]340    INTERFACE bio_header
341       MODULE PROCEDURE bio_header
342    END INTERFACE bio_header
[3569]343!
[3448]344!-- Initialization actions
[3525]345    INTERFACE bio_init
346       MODULE PROCEDURE bio_init
347    END INTERFACE bio_init
[3569]348!
[3711]349!-- Initialization checks
350    INTERFACE bio_init_checks
351       MODULE PROCEDURE bio_init_checks
352    END INTERFACE bio_init_checks
353!
[3448]354!-- Reading of NAMELIST parameters
[3525]355    INTERFACE bio_parin
356       MODULE PROCEDURE bio_parin
357    END INTERFACE bio_parin
[3569]358!
[3650]359!-- Read global restart parameters
360    INTERFACE bio_rrd_global
[4495]361       MODULE PROCEDURE bio_rrd_global_ftn
362       MODULE PROCEDURE bio_rrd_global_mpi
[3650]363    END INTERFACE bio_rrd_global
364!
365!-- Read local restart parameters
366    INTERFACE bio_rrd_local
367       MODULE PROCEDURE bio_rrd_local
368    END INTERFACE bio_rrd_local
369!
370!-- Write global restart parameters
371    INTERFACE bio_wrd_global
372       MODULE PROCEDURE bio_wrd_global
373    END INTERFACE bio_wrd_global
374!
375!-- Write local restart parameters
376    INTERFACE bio_wrd_local
377       MODULE PROCEDURE bio_wrd_local
378    END INTERFACE bio_wrd_local
379!
[3569]380!-- Calculate UV exposure grid
[4126]381    INTERFACE bio_calculate_uv_exposure
382       MODULE PROCEDURE bio_calculate_uv_exposure
383    END INTERFACE bio_calculate_uv_exposure
[3525]384
[3448]385 CONTAINS
[3525]386
387
[3321]388!------------------------------------------------------------------------------!
389! Description:
390! ------------
[3448]391!> Sum up and time-average biom input quantities as well as allocate
392!> the array necessary for storing the average.
[3569]393!> There is a considerable difference to the 3d_data_averaging subroutines
394!> used by other modules:
395!> For the thermal indices, the module needs to average the input conditions
396!> not the result!
[3321]397!------------------------------------------------------------------------------!
[3525]398 SUBROUTINE bio_3d_data_averaging( mode, variable )
[3321]399
400    IMPLICIT NONE
401
[3525]402    CHARACTER (LEN=*) ::  mode     !< averaging mode: allocate, sum, or average
403    CHARACTER (LEN=*) ::  variable !< The variable in question
[3321]404
[3525]405    INTEGER(iwp) ::  i        !< Running index, x-dir
406    INTEGER(iwp) ::  j        !< Running index, y-dir
407    INTEGER(iwp) ::  k        !< Running index, z-dir
[3321]408
409
410    IF ( mode == 'allocate' )  THEN
411
412       SELECT CASE ( TRIM( variable ) )
[3448]413
[3525]414          CASE ( 'bio_mrt' )
[3742]415
416                IF ( .NOT. ALLOCATED( mrt_av_grid ) )  THEN
[3525]417                   ALLOCATE( mrt_av_grid(nmrtbl) )
[3321]418                ENDIF
[3525]419                mrt_av_grid = 0.0_wp
[3742]420                do_average_mrt = .FALSE.  !< overwrite if that was enabled somehow
[3321]421
[3740]422
[4127]423          CASE ( 'bio_perct*', 'bio_utci*', 'bio_pet*', 'bio_mrt*' )
[3448]424
[3569]425!
426!--          Averaging, as well as the allocation of the required grids must be
[3693]427!--          done only once, independent from for how many thermal indices
428!--          averaged output is desired.
429!--          Therefore wee need to memorize which index is the one that controls
430!--          the averaging (what must be the first thermal index called).
431!--          Indices are in unknown order as depending on the input file,
432!--          determine first index to average und update only once
[3740]433!
[3569]434!--          Only proceed here if this was not done for any index before. This
[3693]435!--          is done only once during the whole model run.
[3742]436             IF ( .NOT. average_trigger_perct  .AND.                           &
437                  .NOT. average_trigger_utci   .AND.                           &
[4127]438                  .NOT. average_trigger_pet    .AND.                           &
439                  .NOT. average_trigger_mrt )  THEN
[3569]440!
441!--             Memorize the first index called to control averaging
[3742]442                IF ( TRIM( variable ) == 'bio_perct*' )  THEN
[3525]443                    average_trigger_perct = .TRUE.
[3321]444                ENDIF
[3742]445                IF ( TRIM( variable ) == 'bio_utci*' )  THEN
[3448]446                    average_trigger_utci = .TRUE.
447                ENDIF
[3742]448                IF ( TRIM( variable ) == 'bio_pet*' )  THEN
[3448]449                    average_trigger_pet = .TRUE.
450                ENDIF
[4127]451                IF ( TRIM( variable ) == 'bio_mrt*' )  THEN
452                    average_trigger_mrt = .TRUE.
453                ENDIF
[3448]454             ENDIF
[3569]455!
[3742]456!--          Allocation of the input _av grids was moved to the "sum" section to
457!--          make sure averaging is only done once!
[3448]458
459
[3569]460          CASE ( 'uvem_vitd3dose*' )
[4126]461             IF ( .NOT. ALLOCATED( vitd3_dose ) )  THEN
462                ALLOCATE( vitd3_dose(nysg:nyng,nxlg:nxrg) )
[3569]463             ENDIF
[4126]464             vitd3_dose = 0.0_wp
[3569]465
[3321]466          CASE DEFAULT
467             CONTINUE
468
469       END SELECT
470
471    ELSEIF ( mode == 'sum' )  THEN
472
473       SELECT CASE ( TRIM( variable ) )
474
[3525]475          CASE ( 'bio_mrt' )
[3740]476!
477!--          Consider the case 'bio_mrt' is called after some thermal index. In
478!--          that case do_average_mrt will be .TRUE. leading to a double-
479!--          averaging.
[3742]480             IF ( .NOT. do_average_mrt  .AND.  ALLOCATED( mrt_av_grid ) )  THEN
[3321]481
[3525]482                IF ( mrt_include_sw )  THEN
483                   mrt_av_grid(:) = mrt_av_grid(:) +                           &
[3739]484                      ( ( human_absorb * mrtinsw(:) +                          &
[3740]485                      mrtinlw(:) ) /                                           &
[3742]486                      ( human_emiss * sigma_sb ) )**.25_wp - degc_to_k
[3525]487                ELSE
488                   mrt_av_grid(:) = mrt_av_grid(:) +                           &
[3740]489                      ( mrtinlw(:) /                                           &
[3742]490                      ( human_emiss * sigma_sb ) )**.25_wp - degc_to_k
[3525]491                ENDIF
[3321]492             ENDIF
493
[4127]494          CASE ( 'bio_perct*', 'bio_utci*', 'bio_pet*', 'bio_mrt*' )
[3569]495!
[3740]496!--          Only continue if the current index is the one to trigger the input
497!--          averaging, see above
[3742]498             IF ( average_trigger_perct  .AND.  TRIM( variable ) /=            &
499                'bio_perct*')  RETURN
500             IF ( average_trigger_utci   .AND.  TRIM( variable ) /=            &
501                'bio_utci*')   RETURN
502             IF ( average_trigger_pet    .AND.  TRIM( variable ) /=            &
503                'bio_pet*')    RETURN
[4127]504             IF ( average_trigger_mrt    .AND.  TRIM( variable ) /=            &
505                'bio_mrt*')    RETURN
[3742]506!
507!--          Now memorize which of the input grids are not averaged by other
508!--          modules. Set averaging switch to .TRUE. and allocate the respective
509!--          grid in that case.
510             IF ( .NOT. ALLOCATED( pt_av ) )  THEN  !< if not averaged by other module
511                ALLOCATE( pt_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
512                do_average_theta = .TRUE.  !< memorize, that bio is responsible
513                pt_av = 0.0_wp
514             ENDIF
515             IF ( ALLOCATED( pt_av )  .AND.  do_average_theta )  THEN
[3448]516                DO  i = nxl, nxr
517                   DO  j = nys, nyn
518                      DO  k = nzb, nzt+1
519                         pt_av(k,j,i) = pt_av(k,j,i) + pt(k,j,i)
520                      ENDDO
521                   ENDDO
522                ENDDO
523             ENDIF
[3321]524
[3742]525             IF ( .NOT. ALLOCATED( q_av ) )  THEN
526                ALLOCATE( q_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
527                do_average_q = .TRUE.
528                q_av = 0.0_wp
529             ENDIF
530             IF ( ALLOCATED( q_av )  .AND.  do_average_q )  THEN
[3448]531                DO  i = nxl, nxr
532                   DO  j = nys, nyn
533                      DO  k = nzb, nzt+1
534                         q_av(k,j,i) = q_av(k,j,i) + q(k,j,i)
535                      ENDDO
536                   ENDDO
[3321]537                ENDDO
538             ENDIF
539
[3749]540!
541!-- u_av, v_av and w_av are always allocated
[3742]542             IF ( .NOT. ALLOCATED( u_av ) )  THEN
543                ALLOCATE( u_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
544                do_average_u = .TRUE.
545                u_av = 0.0_wp
546             ENDIF
547             IF ( ALLOCATED( u_av )  .AND.  do_average_u )  THEN
[3525]548                DO  i = nxlg, nxrg       !< yes, ghost points are required here!
549                   DO  j = nysg, nyng
[3448]550                      DO  k = nzb, nzt+1
551                         u_av(k,j,i) = u_av(k,j,i) + u(k,j,i)
552                      ENDDO
553                   ENDDO
554                ENDDO
555             ENDIF
556
[3742]557             IF ( .NOT. ALLOCATED( v_av ) )  THEN
558                ALLOCATE( v_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
559                do_average_v = .TRUE.
560                v_av = 0.0_wp
561             ENDIF
562             IF ( ALLOCATED( v_av )  .AND.  do_average_v )  THEN
[3525]563                DO  i = nxlg, nxrg       !< yes, ghost points are required here!
564                   DO  j = nysg, nyng
[3448]565                      DO  k = nzb, nzt+1
566                         v_av(k,j,i) = v_av(k,j,i) + v(k,j,i)
567                      ENDDO
568                   ENDDO
569                ENDDO
570             ENDIF
571
[3742]572             IF ( .NOT. ALLOCATED( w_av ) )  THEN
573                ALLOCATE( w_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
574                do_average_w = .TRUE.
575                w_av = 0.0_wp
576             ENDIF
577             IF ( ALLOCATED( w_av )  .AND.  do_average_w )  THEN
[3525]578                DO  i = nxlg, nxrg       !< yes, ghost points are required here!
579                   DO  j = nysg, nyng
[3448]580                      DO  k = nzb, nzt+1
581                         w_av(k,j,i) = w_av(k,j,i) + w(k,j,i)
582                      ENDDO
583                   ENDDO
584                ENDDO
585             ENDIF
[3693]586
[3742]587             IF ( .NOT. ALLOCATED( mrt_av_grid ) )  THEN
588                ALLOCATE( mrt_av_grid(nmrtbl) )
589                do_average_mrt = .TRUE.
590                mrt_av_grid = 0.0_wp
591             ENDIF
592             IF ( ALLOCATED( mrt_av_grid )  .AND.  do_average_mrt )  THEN
[3693]593
594                IF ( mrt_include_sw )  THEN
595                   mrt_av_grid(:) = mrt_av_grid(:) +                           &
[3739]596                      ( ( human_absorb * mrtinsw(:) +                          &
[3742]597                      mrtinlw(:) ) /                                           &
598                      ( human_emiss * sigma_sb ) )**.25_wp - degc_to_k
[3693]599                ELSE
600                   mrt_av_grid(:) = mrt_av_grid(:) +                           &
[3742]601                      ( mrtinlw(:) /                                           &
602                      ( human_emiss * sigma_sb ) )**.25_wp - degc_to_k
[3693]603                ENDIF
604             ENDIF
[3569]605!
606!--       This is a cumulated dose. No mode == 'average' for this quantity.
607          CASE ( 'uvem_vitd3dose*' )
[4126]608             IF ( ALLOCATED( vitd3_dose ) )  THEN
[3569]609                DO  i = nxlg, nxrg
610                   DO  j = nysg, nyng
[4126]611                      vitd3_dose(j,i) = vitd3_dose(j,i) + vitd3_exposure(j,i)
[3569]612                   ENDDO
613                ENDDO
614             ENDIF
[3448]615
[3569]616          CASE DEFAULT
[3321]617             CONTINUE
618
619       END SELECT
620
621    ELSEIF ( mode == 'average' )  THEN
622
623       SELECT CASE ( TRIM( variable ) )
624
[3525]625          CASE ( 'bio_mrt' )
[3740]626!
627!--          Consider the case 'bio_mrt' is called after some thermal index. In
628!--          that case do_average_mrt will be .TRUE. leading to a double-
629!--          averaging.
[3742]630             IF ( .NOT. do_average_mrt  .AND.  ALLOCATED( mrt_av_grid ) )  THEN
[3525]631                mrt_av_grid(:) = mrt_av_grid(:) / REAL( average_count_3d, KIND=wp )
[3321]632             ENDIF
633
[4127]634          CASE ( 'bio_perct*', 'bio_utci*', 'bio_pet*', 'bio_mrt*' )
[3569]635!
636!--          Only continue if update index, see above
[3742]637             IF ( average_trigger_perct  .AND.                                 &
638                TRIM( variable ) /= 'bio_perct*' )  RETURN
639             IF ( average_trigger_utci  .AND.                                  &
640                TRIM( variable ) /= 'bio_utci*' )  RETURN
641             IF ( average_trigger_pet   .AND.                                  &
642                TRIM( variable ) /= 'bio_pet*' )  RETURN
[4127]643             IF ( average_trigger_mrt   .AND.                                  &
644                TRIM( variable ) /= 'bio_mrt*' )  RETURN
[3448]645
[3742]646             IF ( ALLOCATED( pt_av )  .AND.  do_average_theta )  THEN
[3448]647                DO  i = nxl, nxr
648                   DO  j = nys, nyn
649                      DO  k = nzb, nzt+1
[3569]650                         pt_av(k,j,i) = pt_av(k,j,i) /                         &
651                            REAL( average_count_3d, KIND=wp )
[3448]652                      ENDDO
653                   ENDDO
654                ENDDO
[3321]655             ENDIF
656
[3742]657             IF ( ALLOCATED( q_av )  .AND.  do_average_q )  THEN
[3448]658                DO  i = nxl, nxr
659                   DO  j = nys, nyn
660                      DO  k = nzb, nzt+1
[3569]661                         q_av(k,j,i) = q_av(k,j,i) /                           &
662                            REAL( average_count_3d, KIND=wp )
[3448]663                      ENDDO
664                   ENDDO
665                ENDDO
666             ENDIF
[3321]667
[3742]668             IF ( ALLOCATED( u_av )  .AND.  do_average_u )  THEN
[3525]669                DO  i = nxlg, nxrg       !< yes, ghost points are required here!
670                   DO  j = nysg, nyng
[3448]671                      DO  k = nzb, nzt+1
[3569]672                         u_av(k,j,i) = u_av(k,j,i) /                           &
673                            REAL( average_count_3d, KIND=wp )
[3448]674                      ENDDO
675                   ENDDO
676                ENDDO
677             ENDIF
678
[3742]679             IF ( ALLOCATED( v_av )  .AND.  do_average_v )  THEN
[3525]680                DO  i = nxlg, nxrg
681                   DO  j = nysg, nyng
[3448]682                      DO  k = nzb, nzt+1
[3569]683                         v_av(k,j,i) = v_av(k,j,i) /                           &
684                            REAL( average_count_3d, KIND=wp )
[3448]685                      ENDDO
686                   ENDDO
687                ENDDO
688             ENDIF
689
[3742]690             IF ( ALLOCATED( w_av )  .AND.  do_average_w )  THEN
[3525]691                DO  i = nxlg, nxrg
692                   DO  j = nysg, nyng
[3448]693                      DO  k = nzb, nzt+1
[3569]694                         w_av(k,j,i) = w_av(k,j,i) /                           &
695                            REAL( average_count_3d, KIND=wp )
[3448]696                      ENDDO
697                   ENDDO
698                ENDDO
699             ENDIF
[3693]700
[3742]701             IF ( ALLOCATED( mrt_av_grid )  .AND.  do_average_mrt )  THEN
702                mrt_av_grid(:) = mrt_av_grid(:) / REAL( average_count_3d,      &
703                KIND=wp )
[3693]704             ENDIF
705
[3569]706!
707!--     No averaging for UVEM since we are calculating a dose (only sum is
708!--     calculated and saved to av.nc file)
709
[3448]710        END SELECT
711
[3321]712    ENDIF
713
714
[3525]715 END SUBROUTINE bio_3d_data_averaging
[3321]716
[3448]717
718
[3321]719!------------------------------------------------------------------------------!
720! Description:
721! ------------
[3448]722!> Check data output for biometeorology model
[3321]723!------------------------------------------------------------------------------!
[3735]724 SUBROUTINE bio_check_data_output( var, unit, i, j, ilen, k )
[3321]725
[3479]726    USE control_parameters,                                                    &
727        ONLY: data_output, message_string
[3321]728
[3479]729    IMPLICIT NONE
[3321]730
[3479]731    CHARACTER (LEN=*) ::  unit     !< The unit for the variable var
732    CHARACTER (LEN=*) ::  var      !< The variable in question
[3321]733
[3739]734    INTEGER(iwp), INTENT(IN) ::  i     !< Current element of data_output
735    INTEGER(iwp), INTENT(IN) ::  j     !< Average quantity? 0 = no, 1 = yes
736    INTEGER(iwp), INTENT(IN) ::  ilen  !< Length of current entry in data_output
737    INTEGER(iwp), INTENT(IN) ::  k     !< Output is xy mode? 0 = no, 1 = yes
[3321]738
[3479]739    SELECT CASE ( TRIM( var ) )
[3569]740!
[3742]741!--    Allocate a temporary array with the desired output dimensions.
742!--    Arrays for time-averaged thermal indices are also allocated here because
743!--    they are not running through the standard averaging procedure in
744!--    bio_3d_data_averaging as the values of the averaged thermal indices are
745!--    derived in a single step based on priorly averaged arrays (see
746!--    bio_calculate_thermal_index_maps).
[4127]747       CASE ( 'bio_mrt', 'bio_mrt*' )
[3479]748          unit = 'degree_C'
[3739]749          thermal_comfort = .TRUE.  !< enable thermal_comfort if user forgot to do so
[3569]750          IF ( .NOT. ALLOCATED( tmrt_grid ) )  THEN
751             ALLOCATE( tmrt_grid (nys:nyn,nxl:nxr) )
[3650]752             tmrt_grid = REAL( bio_fill_value, KIND = wp )
[3569]753          ENDIF
[4127]754          IF ( TRIM( var ) == 'bio_mrt*' )  THEN
755             do_calculate_mrt2d = .TRUE.
756          END IF
[3321]757
[3569]758       CASE ( 'bio_perct*' )
759          unit = 'degree_C'
[3739]760          thermal_comfort = .TRUE.
[3742]761          IF ( j == 0 )  THEN                !< if instantaneous input
[3739]762             do_calculate_perct = .TRUE.
[3735]763             IF ( .NOT. ALLOCATED( perct ) )  THEN
764                ALLOCATE( perct (nys:nyn,nxl:nxr) )
765                perct = REAL( bio_fill_value, KIND = wp )
766             ENDIF
767          ELSE                              !< if averaged input
[3739]768             do_calculate_perct_av = .TRUE.
[3735]769             IF ( .NOT. ALLOCATED( perct_av ) )  THEN
770                ALLOCATE( perct_av (nys:nyn,nxl:nxr) )
771                perct_av = REAL( bio_fill_value, KIND = wp )
772             ENDIF
[3569]773          ENDIF
774
775       CASE ( 'bio_utci*' )
776          unit = 'degree_C'
[3739]777          thermal_comfort = .TRUE.
[3742]778          IF ( j == 0 )  THEN
[3739]779             do_calculate_utci = .TRUE.
[3735]780             IF ( .NOT. ALLOCATED( utci ) )  THEN
781                ALLOCATE( utci (nys:nyn,nxl:nxr) )
782                utci = REAL( bio_fill_value, KIND = wp )
783             ENDIF
784          ELSE
[3739]785             do_calculate_utci_av = .TRUE.
[3735]786             IF ( .NOT. ALLOCATED( utci_av ) )  THEN
787                ALLOCATE( utci_av (nys:nyn,nxl:nxr) )
788                utci_av = REAL( bio_fill_value, KIND = wp )
789             ENDIF
[3569]790          ENDIF
791
792       CASE ( 'bio_pet*' )
793          unit = 'degree_C'
[3739]794          thermal_comfort = .TRUE.
[3742]795          IF ( j == 0 )  THEN
[3739]796             do_calculate_pet = .TRUE.
[3735]797             IF ( .NOT. ALLOCATED( pet ) )  THEN
798                ALLOCATE( pet (nys:nyn,nxl:nxr) )
799                pet = REAL( bio_fill_value, KIND = wp )
800             ENDIF
801          ELSE
[3739]802             do_calculate_pet_av = .TRUE.
[3735]803             IF ( .NOT. ALLOCATED( pet_av ) )  THEN
804                ALLOCATE( pet_av (nys:nyn,nxl:nxr) )
805                pet_av = REAL( bio_fill_value, KIND = wp )
806             ENDIF
[3569]807          ENDIF
808
[3650]809
[3569]810       CASE ( 'uvem_vitd3*' )
[4126]811!           IF (  .NOT.  uv_exposure )  THEN
812!              message_string = 'output of "' // TRIM( var ) // '" requi' //     &
813!                       'res a namelist &uvexposure_par'
814!              CALL message( 'uvem_check_data_output', 'UV0001', 1, 2, 0, 6, 0 )
815!           ENDIF
[3569]816          IF ( k == 0  .OR.  data_output(i)(ilen-2:ilen) /= '_xy' )  THEN
817             message_string = 'illegal value for data_output: "' //            &
818                              TRIM( var ) // '" & only 2d-horizontal ' //      &
819                              'cross sections are allowed for this value'
820             CALL message( 'check_parameters', 'PA0111', 1, 2, 0, 6, 0 )
821          ENDIF
822          unit = 'IU/s'
823          IF ( .NOT. ALLOCATED( vitd3_exposure ) )  THEN
824             ALLOCATE( vitd3_exposure(nysg:nyng,nxlg:nxrg) )
825          ENDIF
826          vitd3_exposure = 0.0_wp
827
828       CASE ( 'uvem_vitd3dose*' )
[4126]829!           IF (  .NOT.  uv_exposure )  THEN
830!              message_string = 'output of "' // TRIM( var ) // '" requi' //     &
831!                       'res  a namelist &uvexposure_par'
832!              CALL message( 'uvem_check_data_output', 'UV0001', 1, 2, 0, 6, 0 )
833!           ENDIF
[3569]834          IF ( k == 0  .OR.  data_output(i)(ilen-2:ilen) /= '_xy' )  THEN
835             message_string = 'illegal value for data_output: "' //            &
836                              TRIM( var ) // '" & only 2d-horizontal ' //      &
837                              'cross sections are allowed for this value'
838             CALL message( 'check_parameters', 'PA0111', 1, 2, 0, 6, 0 )
839          ENDIF
840          unit = 'IU/av-h'
[4126]841          IF ( .NOT. ALLOCATED( vitd3_dose ) )  THEN
842             ALLOCATE( vitd3_dose(nysg:nyng,nxlg:nxrg) )
[3569]843          ENDIF
[4126]844          vitd3_dose = 0.0_wp
[3569]845
[3479]846       CASE DEFAULT
847          unit = 'illegal'
848
849    END SELECT
850
[3740]851!
852!--    Further checks if thermal comfort output is desired.
[3742]853    IF ( thermal_comfort  .AND.  unit == 'degree_C' )  THEN
[3479]854!
[3753]855!--    Break if required modules "radiation" is not avalable.
[3742]856       IF ( .NOT.  radiation )  THEN
[3525]857          message_string = 'output of "' // TRIM( var ) // '" require'         &
858                           // 's radiation = .TRUE.'
859          CALL message( 'check_parameters', 'PA0509', 1, 2, 0, 6, 0 )
860          unit = 'illegal'
[3479]861       ENDIF
[3753]862!
863!--    All "thermal_comfort" outputs except from 'bio_mrt' will also need
864!--    humidity input. Check also for that.
865       IF ( TRIM( var ) /= 'bio_mrt' )  THEN
866          IF ( .NOT.  humidity )  THEN
867             message_string = 'The estimation of thermal comfort '    //       &
868                              'requires air humidity information, but ' //     &
869                              'humidity module is disabled!'
870             CALL message( 'check_parameters', 'PA0561', 1, 2, 0, 6, 0 )
871             unit = 'illegal'
872          ENDIF
[3739]873       ENDIF
[3479]874
[3525]875
[3479]876    ENDIF
877
[3525]878 END SUBROUTINE bio_check_data_output
[3321]879
[3448]880!------------------------------------------------------------------------------!
881! Description:
882! ------------
883!> Check parameters routine for biom module
[3740]884!> Currently unused but might come in handy for future checks?
[3448]885!------------------------------------------------------------------------------!
[3525]886 SUBROUTINE bio_check_parameters
[3321]887
888
[3448]889    IMPLICIT NONE
[3321]890
[3448]891
892
[3525]893 END SUBROUTINE bio_check_parameters
[3448]894
895
[3321]896!------------------------------------------------------------------------------!
897! Description:
898! ------------
[3525]899!> Subroutine defining 2D output variables
900!> data_output_2d 1188ff
[3321]901!------------------------------------------------------------------------------!
[3525]902 SUBROUTINE bio_data_output_2d( av, variable, found, grid, local_pf,           &
[3569]903                                two_d, nzb_do, nzt_do )
[3321]904
905
906    USE kinds
907
908
909    IMPLICIT NONE
[3569]910!
[3448]911!-- Input variables
[3525]912    CHARACTER (LEN=*), INTENT(IN) ::  variable    !< Char identifier to select var for output
913    INTEGER(iwp), INTENT(IN)      ::  av          !< Use averaged data? 0 = no, 1 = yes?
914    INTEGER(iwp), INTENT(IN)      ::  nzb_do      !< Unused. 2D. nz bottom to nz top
915    INTEGER(iwp), INTENT(IN)      ::  nzt_do      !< Unused.
[3569]916!
[3448]917!-- Output variables
[3525]918    CHARACTER (LEN=*), INTENT(OUT) ::  grid   !< Grid type (always "zu1" for biom)
919    LOGICAL, INTENT(OUT)           ::  found  !< Output found?
[3693]920    LOGICAL, INTENT(OUT)           ::  two_d  !< Flag parameter that indicates 2D variables,
921                                              !< horizontal cross sections, must be .TRUE. for thermal indices and uv
[3525]922    REAL(wp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do) ::  local_pf  !< Temp. result grid to return
[3569]923!
[3448]924!-- Internal variables
[3525]925    INTEGER(iwp) ::  i        !< Running index, x-dir
926    INTEGER(iwp) ::  j        !< Running index, y-dir
927    INTEGER(iwp) ::  k        !< Running index, z-dir
928    INTEGER(iwp) ::  l        !< Running index, radiation grid
[3321]929
930
[3525]931    found = .TRUE.
[3569]932    local_pf = bio_fill_value
[3525]933
[3569]934    SELECT CASE ( TRIM( variable ) )
[3321]935
936
[3525]937        CASE ( 'bio_mrt_xy' )
[3569]938           grid = 'zu1'
939           two_d = .FALSE.  !< can be calculated for several levels
940           local_pf = REAL( bio_fill_value, KIND = wp )
941           DO  l = 1, nmrtbl
942              i = mrtbl(ix,l)
943              j = mrtbl(iy,l)
944              k = mrtbl(iz,l)
[3742]945              IF ( k < nzb_do  .OR.  k > nzt_do  .OR.  j < nys  .OR.           &
946                 j > nyn  .OR.  i < nxl  .OR.  i > nxr )  CYCLE
[3569]947              IF ( av == 0 )  THEN
948                 IF ( mrt_include_sw )  THEN
[3739]949                    local_pf(i,j,k) = ( ( human_absorb * mrtinsw(l) +          &
[3740]950                                    mrtinlw(l) ) /                             &
[3742]951                                    ( human_emiss * sigma_sb ) )**.25_wp -     &
[3739]952                                    degc_to_k
[3569]953                 ELSE
[3740]954                    local_pf(i,j,k) = ( mrtinlw(l)  /                          &
[3742]955                                    ( human_emiss * sigma_sb ) )**.25_wp -     &
[3739]956                                    degc_to_k
[3569]957                 ENDIF
958              ELSE
959                 local_pf(i,j,k) = mrt_av_grid(l)
960              ENDIF
961           ENDDO
[3321]962
[4127]963        CASE ( 'bio_mrt*_xy' )        ! 2d-array
964           grid = 'zu1'
965           two_d = .TRUE.
966           IF ( av == 0 )  THEN
967              DO  i = nxl, nxr
968                 DO  j = nys, nyn
969                    local_pf(i,j,nzb+1) = tmrt_grid(j,i)
970                 ENDDO
971              ENDDO
972           ELSE
973              DO  i = nxl, nxr
974                 DO  j = nys, nyn
975                    local_pf(i,j,nzb+1) = tmrt_av_grid(j,i)
976                 ENDDO
977              ENDDO
978           ENDIF
[3448]979
[4127]980
[3525]981        CASE ( 'bio_perct*_xy' )        ! 2d-array
[3569]982           grid = 'zu1'
983           two_d = .TRUE.
984           IF ( av == 0 )  THEN
[3448]985              DO  i = nxl, nxr
986                 DO  j = nys, nyn
[3525]987                    local_pf(i,j,nzb+1) = perct(j,i)
[3448]988                 ENDDO
989              ENDDO
[3569]990           ELSE
[3448]991              DO  i = nxl, nxr
992                 DO  j = nys, nyn
[3525]993                    local_pf(i,j,nzb+1) = perct_av(j,i)
[3448]994                 ENDDO
995              ENDDO
[3742]996           ENDIF
[3321]997
[3525]998
999        CASE ( 'bio_utci*_xy' )        ! 2d-array
[3569]1000           grid = 'zu1'
1001           two_d = .TRUE.
1002           IF ( av == 0 )  THEN
[3448]1003              DO  i = nxl, nxr
1004                 DO  j = nys, nyn
[3569]1005                    local_pf(i,j,nzb+1) = utci(j,i)
[3448]1006                 ENDDO
1007              ENDDO
[3569]1008           ELSE
[3448]1009              DO  i = nxl, nxr
1010                 DO  j = nys, nyn
[3569]1011                    local_pf(i,j,nzb+1) = utci_av(j,i)
[3448]1012                 ENDDO
1013              ENDDO
[3742]1014           ENDIF
[3321]1015
[3525]1016
1017        CASE ( 'bio_pet*_xy' )        ! 2d-array
[3569]1018           grid = 'zu1'
1019           two_d = .TRUE.
1020           IF ( av == 0 )  THEN
[3448]1021              DO  i = nxl, nxr
1022                 DO  j = nys, nyn
[3569]1023                    local_pf(i,j,nzb+1) = pet(j,i)
[3448]1024                 ENDDO
1025              ENDDO
[3569]1026           ELSE
[3448]1027              DO  i = nxl, nxr
1028                 DO  j = nys, nyn
[3569]1029                    local_pf(i,j,nzb+1) = pet_av(j,i)
[3448]1030                 ENDDO
1031              ENDDO
[3742]1032           ENDIF
[3321]1033
[3693]1034!
[3569]1035!--    Before data is transfered to local_pf, transfer is it 2D dummy variable and exchange ghost points therein.
1036!--    However, at this point this is only required for instantaneous arrays, time-averaged quantities are already exchanged.
1037       CASE ( 'uvem_vitd3*_xy' )        ! 2d-array
1038          IF ( av == 0 )  THEN
1039             DO  i = nxl, nxr
1040                DO  j = nys, nyn
1041                   local_pf(i,j,nzb+1) = vitd3_exposure(j,i)
1042                ENDDO
1043             ENDDO
1044          ENDIF
[3525]1045
[3569]1046          two_d = .TRUE.
1047          grid = 'zu1'
1048
1049       CASE ( 'uvem_vitd3dose*_xy' )        ! 2d-array
1050          IF ( av == 1 )  THEN
1051             DO  i = nxl, nxr
1052                DO  j = nys, nyn
[4126]1053                   local_pf(i,j,nzb+1) = vitd3_dose(j,i)
[3569]1054                ENDDO
1055             ENDDO
1056          ENDIF
1057
1058          two_d = .TRUE.
1059          grid = 'zu1'
1060
1061
[3448]1062       CASE DEFAULT
1063          found = .FALSE.
[3525]1064          grid  = 'none'
[3321]1065
[3448]1066    END SELECT
[3321]1067
[3448]1068
[3525]1069 END SUBROUTINE bio_data_output_2d
1070
1071
[3448]1072!------------------------------------------------------------------------------!
1073! Description:
1074! ------------
[3525]1075!> Subroutine defining 3D output variables (dummy, always 2d!)
1076!> data_output_3d 709ff
[3448]1077!------------------------------------------------------------------------------!
[3525]1078 SUBROUTINE bio_data_output_3d( av, variable, found, local_pf, nzb_do, nzt_do )
[3448]1079
[3525]1080    USE indices
[3448]1081
1082    USE kinds
1083
1084
1085    IMPLICIT NONE
[3569]1086!
[3448]1087!-- Input variables
[3525]1088    CHARACTER (LEN=*), INTENT(IN) ::  variable   !< Char identifier to select var for output
1089    INTEGER(iwp), INTENT(IN) ::  av       !< Use averaged data? 0 = no, 1 = yes?
1090    INTEGER(iwp), INTENT(IN) ::  nzb_do   !< Unused. 2D. nz bottom to nz top
1091    INTEGER(iwp), INTENT(IN) ::  nzt_do   !< Unused.
[3569]1092!
[3448]1093!-- Output variables
[3525]1094    LOGICAL, INTENT(OUT) ::  found   !< Output found?
1095    REAL(sp), DIMENSION(nxl:nxr,nys:nyn,nzb_do:nzt_do) ::  local_pf   !< Temp. result grid to return
[3569]1096!
[3448]1097!-- Internal variables
[3525]1098    INTEGER(iwp) ::  l    !< Running index, radiation grid
1099    INTEGER(iwp) ::  i    !< Running index, x-dir
1100    INTEGER(iwp) ::  j    !< Running index, y-dir
1101    INTEGER(iwp) ::  k    !< Running index, z-dir
1102
[3569]1103!     REAL(wp) ::  mrt  !< Buffer for mean radiant temperature
[3448]1104
1105    found = .TRUE.
[3525]1106
[3569]1107    SELECT CASE ( TRIM( variable ) )
[3448]1108
[3525]1109        CASE ( 'bio_mrt' )
[3569]1110            local_pf = REAL( bio_fill_value, KIND = sp )
[3525]1111            DO  l = 1, nmrtbl
1112               i = mrtbl(ix,l)
1113               j = mrtbl(iy,l)
1114               k = mrtbl(iz,l)
[3742]1115               IF ( k < nzb_do  .OR.  k > nzt_do  .OR.  j < nys  .OR.          &
1116                  j > nyn  .OR.  i < nxl  .OR.  i > nxr )  CYCLE
[3525]1117               IF ( av == 0 )  THEN
1118                  IF ( mrt_include_sw )  THEN
[3735]1119                     local_pf(i,j,k) = REAL( ( ( human_absorb * mrtinsw(l) +   &
[3740]1120                                    mrtinlw(l) ) /                             &
[3742]1121                                    ( human_emiss * sigma_sb ) )**.25_wp -     &
[3735]1122                                    degc_to_k, KIND = sp )
[3525]1123                  ELSE
[3740]1124                     local_pf(i,j,k) = REAL( ( mrtinlw(l) /                    &
[3742]1125                                    ( human_emiss * sigma_sb ) )**.25_wp -     &
[3735]1126                                    degc_to_k, KIND = sp )
[3525]1127                  ENDIF
1128               ELSE
[3735]1129                  local_pf(i,j,k) = REAL( mrt_av_grid(l), KIND = sp )
[3525]1130               ENDIF
1131            ENDDO
[3448]1132
[3321]1133       CASE DEFAULT
1134          found = .FALSE.
1135
1136    END SELECT
1137
[3525]1138 END SUBROUTINE bio_data_output_3d
[3321]1139
[3448]1140!------------------------------------------------------------------------------!
1141! Description:
1142! ------------
1143!> Subroutine defining appropriate grid for netcdf variables.
1144!> It is called out from subroutine netcdf_interface_mod.
1145!> netcdf_interface_mod 918ff
1146!------------------------------------------------------------------------------!
[3525]1147 SUBROUTINE bio_define_netcdf_grid( var, found, grid_x, grid_y, grid_z )
[3321]1148
[3448]1149    IMPLICIT NONE
[3569]1150!
[3448]1151!-- Input variables
1152    CHARACTER (LEN=*), INTENT(IN)  ::  var      !< Name of output variable
[3569]1153!
[3448]1154!-- Output variables
1155    CHARACTER (LEN=*), INTENT(OUT) ::  grid_x   !< x grid of output variable
1156    CHARACTER (LEN=*), INTENT(OUT) ::  grid_y   !< y grid of output variable
1157    CHARACTER (LEN=*), INTENT(OUT) ::  grid_z   !< z grid of output variable
1158
1159    LOGICAL, INTENT(OUT)           ::  found    !< Flag if output var is found
[3569]1160!
[3448]1161!-- Local variables
1162    LOGICAL      :: is2d  !< Var is 2d?
1163
1164    INTEGER(iwp) :: l     !< Length of the var array
1165
1166
1167    found  = .FALSE.
1168    grid_x = 'none'
1169    grid_y = 'none'
1170    grid_z = 'none'
1171
1172    l = MAX( 2, LEN_TRIM( var ) )
1173    is2d = ( var(l-1:l) == 'xy' )
1174
[3742]1175    IF ( var(1:4) == 'bio_' )  THEN
[3448]1176       found  = .TRUE.
1177       grid_x = 'x'
1178       grid_y = 'y'
1179       grid_z = 'zu'
[3742]1180       IF ( is2d  .AND.  var(1:7) /= 'bio_mrt' )  grid_z = 'zu1'
[3448]1181    ENDIF
1182
[3742]1183    IF ( is2d  .AND.  var(1:4) == 'uvem' )  THEN
[3569]1184       grid_x = 'x'
1185       grid_y = 'y'
1186       grid_z = 'zu1'
1187    ENDIF
1188
[3525]1189 END SUBROUTINE bio_define_netcdf_grid
[3448]1190
[3321]1191!------------------------------------------------------------------------------!
1192! Description:
1193! ------------
[3448]1194!> Header output for biom module
1195!> header 982
1196!------------------------------------------------------------------------------!
[3525]1197 SUBROUTINE bio_header( io )
[3448]1198
1199    IMPLICIT NONE
[3569]1200!
[3448]1201!-- Input variables
1202    INTEGER(iwp), INTENT(IN) ::  io           !< Unit of the output file
[3569]1203!
[3448]1204!-- Internal variables
1205    CHARACTER (LEN=86) ::  output_height_chr  !< String for output height
1206
[3525]1207    WRITE( output_height_chr, '(F8.1,7X)' )  bio_output_height
[3321]1208!
[3448]1209!-- Write biom header
1210    WRITE( io, 1 )
1211    WRITE( io, 2 )  TRIM( output_height_chr )
[3525]1212    WRITE( io, 3 )  TRIM( ACHAR( bio_cell_level ) )
[3448]1213
12141   FORMAT (//' Human thermal comfort module information:'/                    &
1215              ' ------------------------------'/)
12162   FORMAT ('    --> All indices calculated for a height of (m): ', A )
12173   FORMAT ('    --> This corresponds to cell level : ', A )
1218
[3525]1219 END SUBROUTINE bio_header
[3448]1220
1221
[3321]1222!------------------------------------------------------------------------------!
[3448]1223! Description:
1224! ------------
1225!> Initialization of the HTCM
1226!> init_3d_model 1987ff
1227!------------------------------------------------------------------------------!
[3525]1228 SUBROUTINE bio_init
[3321]1229
[3614]1230    USE netcdf_data_input_mod,                                                 &
1231        ONLY:  netcdf_data_input_uvem
[3569]1232
[3448]1233    IMPLICIT NONE
[3569]1234!
[3448]1235!-- Internal vriables
1236    REAL ( wp )  :: height  !< current height in meters
[3685]1237
[3885]1238    IF ( debug_output )  CALL debug_message( 'bio_init', 'start' )
[3569]1239!
[3448]1240!-- Determine cell level corresponding to 1.1 m above ground level
1241!   (gravimetric center of sample human)
[3321]1242
[3525]1243    bio_cell_level = 0_iwp
1244    bio_output_height = 0.5_wp * dz(1)
[3448]1245    height = 0.0_wp
[3321]1246
[3753]1247    bio_cell_level = INT( 1.099_wp / dz(1) )
[3525]1248    bio_output_height = bio_output_height + bio_cell_level * dz(1)
[3569]1249!
[3753]1250!-- Set radiation level if not done by user
1251    IF ( mrt_nlevels == 0 )  THEN
1252       mrt_nlevels = bio_cell_level + 1_iwp
1253    ENDIF
1254!
[3569]1255!-- Init UVEM and load lookup tables
[3650]1256    IF ( uv_exposure )  CALL netcdf_data_input_uvem
[3735]1257
[3885]1258    IF ( debug_output )  CALL debug_message( 'bio_init', 'end' )
[3569]1259
[3525]1260 END SUBROUTINE bio_init
[3321]1261
1262
[3448]1263!------------------------------------------------------------------------------!
1264! Description:
1265! ------------
[3711]1266!> Checks done after the Initialization
1267!------------------------------------------------------------------------------!
1268 SUBROUTINE bio_init_checks
1269
1270    USE control_parameters,                                                    &
1271        ONLY: message_string
1272
[4126]1273    IF ( (.NOT. radiation_interactions) .AND. ( thermal_comfort ) )  THEN
[3711]1274       message_string = 'The mrt calculation requires ' //                     &
1275                        'enabled radiation_interactions but it ' //            &
1276                        'is disabled!'
1277       CALL message( 'bio_init_checks', 'PAHU03', 1, 2, 0, 6, 0 )
1278    ENDIF
1279
1280
1281 END SUBROUTINE bio_init_checks
1282
1283
1284!------------------------------------------------------------------------------!
1285! Description:
1286! ------------
[3448]1287!> Parin for &biometeorology_parameters for reading biomet parameters
[3321]1288!------------------------------------------------------------------------------!
[3525]1289 SUBROUTINE bio_parin
[3321]1290
[3448]1291    IMPLICIT NONE
[3321]1292
[3448]1293!
1294!-- Internal variables
1295    CHARACTER (LEN=80) ::  line  !< Dummy string for current line in parameter file
[3321]1296
[3735]1297    NAMELIST /biometeorology_parameters/  thermal_comfort,                     &
[3569]1298                                          clothing,                            &
1299                                          consider_obstructions,               &
1300                                          orientation_angle,                   &
1301                                          sun_in_south,                        &
1302                                          turn_to_sun,                         &
1303                                          uv_exposure
[3321]1304
1305
[3448]1306!-- Try to find biometeorology_parameters namelist
1307    REWIND ( 11 )
1308    line = ' '
1309    DO WHILE ( INDEX( line, '&biometeorology_parameters' ) == 0 )
1310       READ ( 11, '(A)', END = 20 )  line
1311    ENDDO
1312    BACKSPACE ( 11 )
[3321]1313
[3448]1314!
1315!-- Read biometeorology_parameters namelist
1316    READ ( 11, biometeorology_parameters, ERR = 10, END = 20 )
[3321]1317
[3448]1318!
1319!-- Set flag that indicates that the biomet_module is switched on
1320    biometeorology = .TRUE.
[3321]1321
[3448]1322    GOTO 20
[3321]1323
[3448]1324!
1325!-- In case of error
1326 10 BACKSPACE( 11 )
1327    READ( 11 , '(A)') line
1328    CALL parin_fail_message( 'biometeorology_parameters', line )
[3321]1329
[3448]1330!
1331!-- Complete
1332 20 CONTINUE
[3321]1333
1334
[3525]1335 END SUBROUTINE bio_parin
[3321]1336
1337!------------------------------------------------------------------------------!
1338! Description:
1339! ------------
[4495]1340!> Read module-specific global restart data (Fortran binary format).
[3693]1341!------------------------------------------------------------------------------!
[4495]1342 SUBROUTINE bio_rrd_global_ftn( found )
[3693]1343
1344    USE control_parameters,                                                    &
1345        ONLY:  length, restart_string
1346
1347
1348    IMPLICIT NONE
1349
1350    LOGICAL, INTENT(OUT) ::  found      !< variable found? yes = .T., no = .F.
1351
1352    found = .TRUE.
1353
1354
1355    SELECT CASE ( restart_string(1:length) )
1356
1357!
1358!--    read control flags to determine if input grids need to be averaged
1359       CASE ( 'do_average_theta' )
1360          READ ( 13 )  do_average_theta
1361
1362       CASE ( 'do_average_q' )
1363          READ ( 13 )  do_average_q
1364
1365       CASE ( 'do_average_u' )
1366          READ ( 13 )  do_average_u
1367
1368       CASE ( 'do_average_v' )
1369          READ ( 13 )  do_average_v
1370
1371       CASE ( 'do_average_w' )
1372          READ ( 13 )  do_average_w
1373
1374       CASE ( 'do_average_mrt' )
1375          READ ( 13 )  do_average_mrt
1376
1377!
1378!--    read control flags to determine which thermal index needs to trigger averaging
1379       CASE ( 'average_trigger_perct' )
1380          READ ( 13 )  average_trigger_perct
1381
1382       CASE ( 'average_trigger_utci' )
1383          READ ( 13 )  average_trigger_utci
1384
1385       CASE ( 'average_trigger_pet' )
1386          READ ( 13 )  average_trigger_pet
1387
[4127]1388       CASE ( 'average_trigger_mrt' )
1389          READ ( 13 )  average_trigger_mrt
[3693]1390
[4127]1391
[3693]1392       CASE DEFAULT
1393
1394          found = .FALSE.
1395
1396    END SELECT
1397
1398
[4495]1399 END SUBROUTINE bio_rrd_global_ftn
[3693]1400
1401
1402!------------------------------------------------------------------------------!
1403! Description:
1404! ------------
[4495]1405!> Read module-specific global restart data (MPI-IO).
1406!------------------------------------------------------------------------------!
1407 SUBROUTINE bio_rrd_global_mpi
1408
1409
1410!
1411!--  Read control flags to determine if input grids need to be averaged
1412     CALL rrd_mpi_io( 'do_average_theta', do_average_theta )
1413     CALL rrd_mpi_io( 'do_average_q', do_average_q )
1414     CALL rrd_mpi_io( 'do_average_u', do_average_u )
1415     CALL rrd_mpi_io( 'do_average_v', do_average_v )
1416     CALL rrd_mpi_io( 'do_average_w', do_average_w )
1417     CALL rrd_mpi_io( 'do_average_mrt', do_average_mrt )
1418!
1419!--  Rad control flags to determine which thermal index needs to trigger averaging
1420     CALL rrd_mpi_io( 'average_trigger_perct', average_trigger_perct )
1421     CALL rrd_mpi_io( 'average_trigger_utci', average_trigger_utci )
1422     CALL rrd_mpi_io( 'average_trigger_pet', average_trigger_pet )
1423     CALL rrd_mpi_io( 'average_trigger_mrt', average_trigger_mrt )
1424
1425 END SUBROUTINE bio_rrd_global_mpi
1426
1427
1428!------------------------------------------------------------------------------!
1429! Description:
1430! ------------
[3693]1431!> Soubroutine reads local biometeorology configuration from restart file(s)
1432!------------------------------------------------------------------------------!
1433 SUBROUTINE bio_rrd_local( found )
1434
1435
1436    USE control_parameters,                                                    &
1437        ONLY:  length, restart_string
1438
1439
1440    IMPLICIT NONE
1441
1442
1443    LOGICAL, INTENT(OUT) ::  found      !< variable found? yes = .T., no = .F.
1444
1445    found = .TRUE.
1446
1447
1448    SELECT CASE ( restart_string(1:length) )
1449
1450       CASE ( 'nmrtbl' )
1451          READ ( 13 )  bio_nmrtbl
1452
1453       CASE ( 'mrt_av_grid' )
1454          IF ( .NOT. ALLOCATED( mrt_av_grid ) )  THEN
1455             ALLOCATE( mrt_av_grid(bio_nmrtbl) )
1456          ENDIF
1457          READ ( 13 )  mrt_av_grid
1458
1459
1460       CASE DEFAULT
1461
1462          found = .FALSE.
1463
1464    END SELECT
1465
1466
1467 END SUBROUTINE bio_rrd_local
1468
1469!------------------------------------------------------------------------------!
1470! Description:
1471! ------------
1472!> Write global restart data for the biometeorology module.
1473!------------------------------------------------------------------------------!
1474 SUBROUTINE bio_wrd_global
1475
1476    IMPLICIT NONE
1477
[4495]1478    IF ( TRIM( restart_data_format_output ) == 'fortran_binary' )  THEN
[3693]1479
[4495]1480       CALL wrd_write_string( 'do_average_theta' )
1481       WRITE ( 14 )  do_average_theta
1482       CALL wrd_write_string( 'do_average_q' )
1483       WRITE ( 14 )  do_average_q
1484       CALL wrd_write_string( 'do_average_u' )
1485       WRITE ( 14 )  do_average_u
1486       CALL wrd_write_string( 'do_average_v' )
1487       WRITE ( 14 )  do_average_v
1488       CALL wrd_write_string( 'do_average_w' )
1489       WRITE ( 14 )  do_average_w
1490       CALL wrd_write_string( 'do_average_mrt' )
1491       WRITE ( 14 )  do_average_mrt
1492       CALL wrd_write_string( 'average_trigger_perct' )
1493       WRITE ( 14 )  average_trigger_perct
1494       CALL wrd_write_string( 'average_trigger_utci' )
1495       WRITE ( 14 )  average_trigger_utci
1496       CALL wrd_write_string( 'average_trigger_pet' )
1497       WRITE ( 14 )  average_trigger_pet
1498       CALL wrd_write_string( 'average_trigger_mrt' )
1499       WRITE ( 14 )  average_trigger_mrt
1500
1501    ELSEIF ( TRIM( restart_data_format_output ) == 'mpi' )  THEN
1502
1503       CALL wrd_mpi_io( 'do_average_theta', do_average_theta )
1504       CALL wrd_mpi_io( 'do_average_q', do_average_q )
1505       CALL wrd_mpi_io( 'do_average_u', do_average_u )
1506       CALL wrd_mpi_io( 'do_average_v', do_average_v )
1507       CALL wrd_mpi_io( 'do_average_w', do_average_w )
1508       CALL wrd_mpi_io( 'do_average_mrt', do_average_mrt )
1509       CALL wrd_mpi_io( 'average_trigger_perct', average_trigger_perct )
1510       CALL wrd_mpi_io( 'average_trigger_utci', average_trigger_utci )
1511       CALL wrd_mpi_io( 'average_trigger_pet', average_trigger_pet )
1512       CALL wrd_mpi_io( 'average_trigger_mrt', average_trigger_mrt )
1513    ENDIF
1514
[3693]1515 END SUBROUTINE bio_wrd_global
1516
1517
1518!------------------------------------------------------------------------------!
1519! Description:
1520! ------------
1521!> Write local restart data for the biometeorology module.
1522!------------------------------------------------------------------------------!
1523 SUBROUTINE bio_wrd_local
1524
1525    IMPLICIT NONE
1526
[4495]1527
1528    IF ( TRIM( restart_data_format_output ) == 'fortran_binary' )  THEN
1529
[3693]1530!
[4495]1531!--    First nmrtbl has to be written/read, because it is the dimension of mrt_av_grid
1532       CALL wrd_write_string( 'nmrtbl' )
1533       WRITE ( 14 )  nmrtbl
[3693]1534
[4495]1535       IF ( ALLOCATED( mrt_av_grid ) )  THEN
1536          CALL wrd_write_string( 'mrt_av_grid' )
1537          WRITE ( 14 )  mrt_av_grid
1538       ENDIF
1539
1540    ELSEIF ( TRIM( restart_data_format_output ) == 'mpi' )  THEN
1541
1542!
1543!--   TODO: the mrt_av_grid is a 1-d array and its size depends on subdomain features. This does
1544!--         not work with the MPI-IO concept (nor with the restart I/O concept in general.
1545!--         I am not sure, if this data needs to be written to the restart file at all (Siggi, 13.4.20)
1546!       CALL wrd_mpi_io( 'nmrtbl', nmrtbl )
1547!       CALL wrd_mpi_io_..... 'mrt_av_grid'
1548       WRITE (6,*) '+++ biometeorology module does not work with MPI-IO for restart_data'
1549       STOP
1550
[3693]1551    ENDIF
1552
1553 END SUBROUTINE bio_wrd_local
1554
1555!------------------------------------------------------------------------------!
1556! Description:
1557! ------------
[3525]1558!> Calculate biometeorology MRT for all 2D grid
[3321]1559!------------------------------------------------------------------------------!
[3525]1560 SUBROUTINE bio_calculate_mrt_grid ( av )
[3321]1561
[3448]1562    IMPLICIT NONE
[3321]1563
[3525]1564    LOGICAL, INTENT(IN)         ::  av    !< use averaged input?
[3569]1565!
[3525]1566!-- Internal variables
1567    INTEGER(iwp)                ::  i     !< Running index, x-dir, radiation coordinates
1568    INTEGER(iwp)                ::  j     !< Running index, y-dir, radiation coordinates
1569    INTEGER(iwp)                ::  k     !< Running index, y-dir, radiation coordinates
1570    INTEGER(iwp)                ::  l     !< Running index, radiation coordinates
[3321]1571
[3693]1572
[3740]1573!
1574!-- We need to differentiate if averaged input is desired (av == .TRUE.) or not.
[3742]1575    IF ( av )  THEN
[3740]1576!
1577!-- Make sure tmrt_av_grid is present and initialize with the fill value
[3693]1578       IF ( .NOT. ALLOCATED( tmrt_av_grid ) )  THEN
1579          ALLOCATE( tmrt_av_grid (nys:nyn,nxl:nxr) )
1580       ENDIF
[3735]1581       tmrt_av_grid = REAL( bio_fill_value, KIND = wp )
[3693]1582
[3740]1583!
1584!-- mrt_av_grid should always be allcoated here, but better make sure ist actually is.
1585       IF ( ALLOCATED( mrt_av_grid ) )  THEN
1586!
1587!-- Iterate over the radiation grid (radiation coordinates) and fill the
1588!-- tmrt_av_grid (x, y coordinates) where appropriate:
1589!-- tmrt_av_grid is written for all i / j if level (k) matches output height.
1590          DO  l = 1, nmrtbl
1591             i = mrtbl(ix,l)
1592             j = mrtbl(iy,l)
1593             k = mrtbl(iz,l)
[4168]1594             IF ( k - topo_top_ind(j,i,0) == bio_cell_level + 1_iwp)  THEN
[3740]1595!
1596!-- Averaging was done before, so we can just copy the result here
1597                tmrt_av_grid(j,i) = mrt_av_grid(l)
[3693]1598
[3740]1599             ENDIF
1600          ENDDO
1601       ENDIF
[3693]1602
[3740]1603!
1604!-- In case instantaneous input is desired, mrt values will be re-calculated.
[3693]1605    ELSE
[3569]1606!
[3593]1607!-- Calculate biometeorology MRT from local radiation fluxes calculated by RTM and assign
1608!-- into 2D grid. Depending on selected output quantities, tmrt_grid might not have been
1609!-- allocated in bio_check_data_output yet.
[3693]1610       IF ( .NOT. ALLOCATED( tmrt_grid ) )  THEN
1611          ALLOCATE( tmrt_grid (nys:nyn,nxl:nxr) )
1612       ENDIF
1613       tmrt_grid = REAL( bio_fill_value, KIND = wp )
[3593]1614
[3693]1615       DO  l = 1, nmrtbl
1616          i = mrtbl(ix,l)
1617          j = mrtbl(iy,l)
1618          k = mrtbl(iz,l)
[4168]1619          IF ( k - topo_top_ind(j,i,0) == bio_cell_level + 1_iwp)  THEN
[3693]1620             IF ( mrt_include_sw )  THEN
[3735]1621                 tmrt_grid(j,i) = ( ( human_absorb * mrtinsw(l) +              &
[3740]1622                                  mrtinlw(l) )  /                              &
[3742]1623                                  ( human_emiss * sigma_sb ) )**.25_wp -       &
[3735]1624                                  degc_to_k
[3693]1625             ELSE
[3740]1626                 tmrt_grid(j,i) = ( mrtinlw(l)  /                              &
[3742]1627                                  ( human_emiss * sigma_sb ) )**.25_wp -       &
[3735]1628                                  degc_to_k
[3693]1629             ENDIF
[3525]1630          ENDIF
[3693]1631       ENDDO
1632    ENDIF
[3321]1633
[3525]1634END SUBROUTINE bio_calculate_mrt_grid
[3321]1635
1636
[3448]1637!------------------------------------------------------------------------------!
1638! Description:
1639! ------------
1640!> Calculate static thermal indices for 2D grid point i, j
1641!------------------------------------------------------------------------------!
[3525]1642 SUBROUTINE bio_get_thermal_index_input_ij( average_input, i, j, ta, vp, ws,   &
[4168]1643                                            pair, tmrt )
[3321]1644
[3448]1645    IMPLICIT NONE
[3569]1646!
[3448]1647!-- Input variables
1648    LOGICAL,      INTENT ( IN ) ::  average_input  !< Determine averaged input conditions?
1649    INTEGER(iwp), INTENT ( IN ) ::  i     !< Running index, x-dir
1650    INTEGER(iwp), INTENT ( IN ) ::  j     !< Running index, y-dir
[3569]1651!
[3448]1652!-- Output parameters
[3593]1653    REAL(wp), INTENT ( OUT )    ::  tmrt  !< Mean radiant temperature        (degree_C)
1654    REAL(wp), INTENT ( OUT )    ::  ta    !< Air temperature                 (degree_C)
[3448]1655    REAL(wp), INTENT ( OUT )    ::  vp    !< Vapour pressure                 (hPa)
1656    REAL(wp), INTENT ( OUT )    ::  ws    !< Wind speed    (local level)     (m/s)
1657    REAL(wp), INTENT ( OUT )    ::  pair  !< Air pressure                    (hPa)
[3569]1658!
[3448]1659!-- Internal variables
1660    INTEGER(iwp)                ::  k     !< Running index, z-dir
1661    INTEGER(iwp)                ::  k_wind  !< Running index, z-dir, wind speed only
[3321]1662
[3448]1663    REAL(wp)                    ::  vp_sat  !< Saturation vapor pressure     (hPa)
[3321]1664
[3569]1665!
[3448]1666!-- Determine cell level closest to 1.1m above ground
1667!   by making use of truncation due to int cast
[4168]1668    k = INT( topo_top_ind(j,i,0) + bio_cell_level )  !< Vertical cell center closest to 1.1m
[3525]1669
1670!
1671!-- Avoid non-representative horizontal u and v of 0.0 m/s too close to ground
[3448]1672    k_wind = k
[3742]1673    IF ( bio_cell_level < 1_iwp )  THEN
[3525]1674       k_wind = k + 1_iwp
[3448]1675    ENDIF
[3569]1676!
[3448]1677!-- Determine local values:
[3742]1678    IF ( average_input )  THEN
[3569]1679!
[3448]1680!--    Calculate ta from Tp assuming dry adiabatic laps rate
[3749]1681       ta = bio_fill_value
1682       IF ( ALLOCATED( pt_av ) )  THEN
[3753]1683          ta = pt_av(k,j,i) - ( 0.0098_wp * dz(1) * ( k + .5_wp ) ) - degc_to_k
[3749]1684       ENDIF
[3321]1685
[3569]1686       vp = bio_fill_value
[3742]1687       IF ( humidity  .AND.  ALLOCATED( q_av ) )  THEN
1688          vp = q_av(k,j,i)
[3448]1689       ENDIF
[3321]1690
[3749]1691       ws = bio_fill_value
1692       IF ( ALLOCATED( u_av )  .AND.  ALLOCATED( v_av )  .AND.                 &
1693          ALLOCATED( w_av ) )  THEN
1694             ws = ( 0.5_wp * ABS( u_av(k_wind,j,i) + u_av(k_wind,j,i+1) )  +   &
1695             0.5_wp * ABS( v_av(k_wind,j,i) + v_av(k_wind,j+1,i) )  +          &
1696             0.5_wp * ABS( w_av(k_wind,j,i) + w_av(k_wind+1,j,i) ) )
1697       ENDIF
[3448]1698    ELSE
[3569]1699!
[3448]1700!-- Calculate ta from Tp assuming dry adiabatic laps rate
[3742]1701       ta = pt(k,j,i) - ( 0.0098_wp * dz(1) * (  k + .5_wp ) ) - degc_to_k
[3321]1702
[3569]1703       vp = bio_fill_value
[3742]1704       IF ( humidity )  THEN
1705          vp = q(k,j,i)
[3525]1706       ENDIF
[3321]1707
[3749]1708       ws = ( 0.5_wp * ABS( u(k_wind,j,i) + u(k_wind,j,i+1) )  +               &
1709          0.5_wp * ABS( v(k_wind,j,i) + v(k_wind,j+1,i) )  +                   &
1710          0.5_wp * ABS( w(k_wind,j,i) + w(k_wind+1,j,i) ) )
[3321]1711
[3448]1712    ENDIF
[3569]1713!
[3448]1714!-- Local air pressure
1715    pair = surface_pressure
1716!
1717!-- Calculate water vapour pressure at saturation and convert to hPa
1718!-- The magnus formula is limited to temperatures up to 333.15 K to
1719!   avoid negative values of vp_sat
[3742]1720    IF ( vp > -998._wp )  THEN
[3525]1721       vp_sat = 0.01_wp * magnus( MIN( ta + degc_to_k, 333.15_wp ) )
1722       vp  = vp * pair / ( vp + 0.622_wp )
[3742]1723       IF ( vp > vp_sat )  vp = vp_sat
[3525]1724    ENDIF
[3569]1725!
[3525]1726!-- local mtr value at [i,j]
[3569]1727    tmrt = bio_fill_value  !< this can be a valid result (e.g. for inside some ostacle)
[3742]1728    IF ( .NOT. average_input )  THEN
[3569]1729!
[3525]1730!--    Use MRT from RTM precalculated in tmrt_grid
1731       tmrt = tmrt_grid(j,i)
[3693]1732    ELSE
1733       tmrt = tmrt_av_grid(j,i)
[3448]1734    ENDIF
1735
[3525]1736 END SUBROUTINE bio_get_thermal_index_input_ij
[3448]1737
1738
[3321]1739!------------------------------------------------------------------------------!
1740! Description:
1741! ------------
[3448]1742!> Calculate static thermal indices for any point within a 2D grid
1743!> time_integration.f90: 1065ff
[3321]1744!------------------------------------------------------------------------------!
[3749]1745 SUBROUTINE bio_calculate_thermal_index_maps( av )
[3321]1746
[3448]1747    IMPLICIT NONE
[3569]1748!
[3448]1749!-- Input attributes
[3525]1750    LOGICAL, INTENT ( IN ) ::  av  !< Calculate based on averaged input conditions?
[3569]1751!
[3448]1752!-- Internal variables
[3569]1753    INTEGER(iwp) ::  i, j     !< Running index
[3321]1754
[3569]1755    REAL(wp) ::  clo          !< Clothing index                (no dimension)
[3593]1756    REAL(wp) ::  ta           !< Air temperature                  (degree_C)
[3569]1757    REAL(wp) ::  vp           !< Vapour pressure                  (hPa)
1758    REAL(wp) ::  ws           !< Wind speed    (local level)      (m/s)
1759    REAL(wp) ::  pair         !< Air pressure                     (hPa)
[3593]1760    REAL(wp) ::  perct_ij     !< Perceived temperature            (degree_C)
1761    REAL(wp) ::  utci_ij      !< Universal thermal climate index  (degree_C)
1762    REAL(wp) ::  pet_ij       !< Physiologically equivalent temperature  (degree_C)
1763    REAL(wp) ::  tmrt_ij      !< Mean radiant temperature         (degree_C)
[3321]1764
[3569]1765!
[3749]1766!-- Check if some thermal index is desired. Don't do anything if, e.g. only
1767!-- bio_mrt is desired.
1768    IF ( do_calculate_perct  .OR.  do_calculate_perct_av  .OR.                 &
1769       do_calculate_utci  .OR.  do_calculate_utci_av  .OR.                     &
[4127]1770       do_calculate_pet  .OR.  do_calculate_pet_av  .OR.                       &
1771       do_calculate_mrt2d )  THEN
[3321]1772
[3569]1773!
[3749]1774!--    fill out the MRT 2D grid from appropriate source (RTM, RRTMG,...)
1775       CALL bio_calculate_mrt_grid ( av )
1776
1777       DO  i = nxl, nxr
1778          DO  j = nys, nyn
[3569]1779!
[3749]1780!--          Determine local input conditions
1781             tmrt_ij = bio_fill_value
1782             vp      = bio_fill_value
[3569]1783!
[3749]1784!--          Determine local meteorological conditions
1785             CALL bio_get_thermal_index_input_ij ( av, i, j, ta, vp,           &
1786                                                   ws, pair, tmrt_ij )
[3569]1787!
[3749]1788!--          Only proceed if input is available
1789             pet_ij   = bio_fill_value   !< set fail value, e.g. valid for
1790             perct_ij = bio_fill_value   !< within some obstacle
1791             utci_ij  = bio_fill_value
1792             IF ( .NOT. ( tmrt_ij <= -998._wp  .OR.  vp <= -998._wp  .OR.      &
1793                ws <= -998._wp  .OR.  ta <= -998._wp ) )  THEN
1794!
1795!--             Calculate static thermal indices based on local tmrt
1796                clo = bio_fill_value
[3569]1797
[3749]1798                IF ( do_calculate_perct  .OR.  do_calculate_perct_av )  THEN
[3569]1799!
[3749]1800!--                Estimate local perceived temperature
1801                   CALL calculate_perct_static( ta, vp, ws, tmrt_ij, pair,     &
1802                      clo, perct_ij )
1803                ENDIF
[3569]1804
[3749]1805                IF ( do_calculate_utci  .OR.  do_calculate_utci_av )  THEN
[3569]1806!
[3749]1807!--                Estimate local universal thermal climate index
1808                   CALL calculate_utci_static( ta, vp, ws, tmrt_ij,            &
1809                      bio_output_height, utci_ij )
1810                ENDIF
[3569]1811
[3749]1812                IF ( do_calculate_pet  .OR.  do_calculate_pet_av )  THEN
[3569]1813!
[3749]1814!--                Estimate local physiologically equivalent temperature
1815                   CALL calculate_pet_static( ta, vp, ws, tmrt_ij, pair,       &
1816                      pet_ij )
1817                ENDIF
[3525]1818             ENDIF
[3321]1819
1820
[3749]1821             IF ( av )  THEN
[3569]1822!
[3749]1823!--             Write results for selected averaged indices
1824                IF ( do_calculate_perct_av )  THEN
1825                   perct_av(j, i) = perct_ij
1826                ENDIF
1827                IF ( do_calculate_utci_av )  THEN
1828                   utci_av(j, i) = utci_ij
1829                ENDIF
1830                IF ( do_calculate_pet_av )  THEN
1831                   pet_av(j, i)  = pet_ij
1832                ENDIF
1833             ELSE
[3569]1834!
[3749]1835!--             Write result for selected indices
1836                IF ( do_calculate_perct )  THEN
1837                   perct(j, i) = perct_ij
1838                ENDIF
1839                IF ( do_calculate_utci )  THEN
1840                   utci(j, i) = utci_ij
1841                ENDIF
1842                IF ( do_calculate_pet )  THEN
1843                   pet(j, i)  = pet_ij
1844                ENDIF
[3742]1845             ENDIF
[3321]1846
[3749]1847          ENDDO
[3742]1848       ENDDO
[3749]1849    ENDIF
[3321]1850
[3525]1851 END SUBROUTINE bio_calculate_thermal_index_maps
[3321]1852
[3448]1853!------------------------------------------------------------------------------!
1854! Description:
1855! ------------
1856!> Calculate dynamic thermal indices (currently only iPT, but expandable)
1857!------------------------------------------------------------------------------!
[3525]1858 SUBROUTINE bio_calc_ipt( ta, vp, ws, pair, tmrt, dt, energy_storage,          &
[3448]1859    t_clo, clo, actlev, age, weight, height, work, sex, ipt )
[3321]1860
[3448]1861    IMPLICIT NONE
[3569]1862!
[3448]1863!-- Input parameters
[3593]1864    REAL(wp), INTENT ( IN )  ::  ta   !< Air temperature                  (degree_C)
[3448]1865    REAL(wp), INTENT ( IN )  ::  vp   !< Vapour pressure                  (hPa)
1866    REAL(wp), INTENT ( IN )  ::  ws   !< Wind speed    (local level)      (m/s)
1867    REAL(wp), INTENT ( IN )  ::  pair !< Air pressure                     (hPa)
[3593]1868    REAL(wp), INTENT ( IN )  ::  tmrt !< Mean radiant temperature         (degree_C)
[3448]1869    REAL(wp), INTENT ( IN )  ::  dt   !< Time past since last calculation (s)
1870    REAL(wp), INTENT ( IN )  ::  age  !< Age of agent                     (y)
1871    REAL(wp), INTENT ( IN )  ::  weight  !< Weight of agent               (Kg)
1872    REAL(wp), INTENT ( IN )  ::  height  !< Height of agent               (m)
1873    REAL(wp), INTENT ( IN )  ::  work    !< Mechanical workload of agent
1874                                         !  (without metabolism!)         (W)
1875    INTEGER(iwp), INTENT ( IN ) ::  sex  !< Sex of agent (1 = male, 2 = female)
[3569]1876!
[3448]1877!-- Both, input and output parameters
1878    Real(wp), INTENT ( INOUT )  ::  energy_storage    !< Energy storage   (W/m²)
[3593]1879    Real(wp), INTENT ( INOUT )  ::  t_clo   !< Clothing temperature       (degree_C)
[3448]1880    Real(wp), INTENT ( INOUT )  ::  clo     !< Current clothing in sulation
1881    Real(wp), INTENT ( INOUT )  ::  actlev  !< Individuals activity level
1882                                            !  per unit surface area      (W/m²)
[3569]1883!
[3448]1884!-- Output parameters
[3593]1885    REAL(wp), INTENT ( OUT ) ::  ipt    !< Instationary perceived temp.   (degree_C)
[3569]1886!
[3693]1887!-- return immediatelly if nothing to do!
[3742]1888    IF ( .NOT. thermal_comfort )  THEN
[3693]1889        RETURN
1890    ENDIF
1891!
[3448]1892!-- If clo equals the initial value, this is the initial call
[3742]1893    IF ( clo <= -998._wp )  THEN
[3569]1894!
[3448]1895!--    Initialize instationary perceived temperature with personalized
1896!      PT as an initial guess, set actlev and clo
[3749]1897       CALL ipt_init( age, weight, height, sex, work, actlev, clo,            &
[3448]1898          ta, vp, ws, tmrt, pair, dt, energy_storage, t_clo,                   &
1899          ipt )
1900    ELSE
[3569]1901!
[3448]1902!--    Estimate local instatinoary perceived temperature
1903       CALL ipt_cycle ( ta, vp, ws, tmrt, pair, dt, energy_storage, t_clo,     &
1904          clo, actlev, work, ipt )
1905    ENDIF
[3321]1906
[3525]1907 END SUBROUTINE bio_calc_ipt
[3448]1908
[3525]1909
[3650]1910
[3525]1911!------------------------------------------------------------------------------!
1912! Description:
1913! ------------
1914!> SUBROUTINE for calculating UTCI Temperature (UTCI)
1915!> computed by a 6th order approximation
[3693]1916!>
[3525]1917!> UTCI regression equation after
1918!> Bröde P, Fiala D, Blazejczyk K, Holmér I, Jendritzky G, Kampmann B, Tinz B,
1919!> Havenith G (2012) Deriving the operational procedure for the Universal Thermal
1920!> Climate Index (UTCI). International Journal of Biometeorology 56 (3):481-494.
1921!> doi:10.1007/s00484-011-0454-1
[3693]1922!>
[3525]1923!> original source available at:
1924!> www.utci.org
1925!------------------------------------------------------------------------------!
[3569]1926 SUBROUTINE calculate_utci_static( ta_in, vp, ws_hag, tmrt, hag, utci_ij )
[3525]1927
1928    IMPLICIT NONE
[3569]1929!
[3525]1930!-- Type of input of the argument list
[3593]1931    REAL(WP), INTENT ( IN )  ::  ta_in    !< Local air temperature (degree_C)
[3569]1932    REAL(WP), INTENT ( IN )  ::  vp       !< Loacl vapour pressure (hPa)
1933    REAL(WP), INTENT ( IN )  ::  ws_hag   !< Incident wind speed (m/s)
[3593]1934    REAL(WP), INTENT ( IN )  ::  tmrt     !< Local mean radiant temperature (degree_C)
[3569]1935    REAL(WP), INTENT ( IN )  ::  hag      !< Height of wind speed input (m)
1936!
[3525]1937!-- Type of output of the argument list
[3593]1938    REAL(wp), INTENT ( OUT ) ::  utci_ij  !< Universal Thermal Climate Index (degree_C)
[3525]1939
[3593]1940    REAL(WP) ::  ta           !< air temperature modified by offset (degree_C)
[3569]1941    REAL(WP) ::  pa           !< air pressure in kPa      (kPa)
[3593]1942    REAL(WP) ::  d_tmrt       !< delta-tmrt               (degree_C)
[3569]1943    REAL(WP) ::  va           !< wind speed at 10 m above ground level    (m/s)
[3593]1944    REAL(WP) ::  offset       !< utci deviation by ta cond. exceeded      (degree_C)
[3569]1945    REAL(WP) ::  part_ta      !< Air temperature related part of the regression
1946    REAL(WP) ::  ta2          !< 2 times ta
1947    REAL(WP) ::  ta3          !< 3 times ta
1948    REAL(WP) ::  ta4          !< 4 times ta
1949    REAL(WP) ::  ta5          !< 5 times ta
1950    REAL(WP) ::  ta6          !< 6 times ta
1951    REAL(WP) ::  part_va      !< Vapour pressure related part of the regression
1952    REAL(WP) ::  va2          !< 2 times va
1953    REAL(WP) ::  va3          !< 3 times va
1954    REAL(WP) ::  va4          !< 4 times va
1955    REAL(WP) ::  va5          !< 5 times va
1956    REAL(WP) ::  va6          !< 6 times va
1957    REAL(WP) ::  part_d_tmrt  !< Mean radiant temp. related part of the reg.
1958    REAL(WP) ::  d_tmrt2      !< 2 times d_tmrt
1959    REAL(WP) ::  d_tmrt3      !< 3 times d_tmrt
1960    REAL(WP) ::  d_tmrt4      !< 4 times d_tmrt
1961    REAL(WP) ::  d_tmrt5      !< 5 times d_tmrt
1962    REAL(WP) ::  d_tmrt6      !< 6 times d_tmrt
1963    REAL(WP) ::  part_pa      !< Air pressure related part of the regression
1964    REAL(WP) ::  pa2          !< 2 times pa
1965    REAL(WP) ::  pa3          !< 3 times pa
1966    REAL(WP) ::  pa4          !< 4 times pa
1967    REAL(WP) ::  pa5          !< 5 times pa
1968    REAL(WP) ::  pa6          !< 6 times pa
1969    REAL(WP) ::  part_pa2     !< Air pressure^2 related part of the regression
1970    REAL(WP) ::  part_pa3     !< Air pressure^3 related part of the regression
1971    REAL(WP) ::  part_pa46    !< Air pressure^4-6 related part of the regression
[3525]1972
[3569]1973!
[3525]1974!-- Initialize
1975    offset = 0._wp
1976    ta = ta_in
1977    d_tmrt = tmrt - ta_in
[3569]1978!
[3525]1979!-- Use vapour pressure in kpa
1980    pa = vp / 10.0_wp
[3569]1981!
[3525]1982!-- Wind altitude correction from hag to 10m after Broede et al. (2012), eq.3
[3693]1983!-- z(0) is set to 0.01 according to UTCI profile definition
[3525]1984    va = ws_hag *  log ( 10.0_wp / 0.01_wp ) / log ( hag / 0.01_wp )
[3569]1985!
[3525]1986!-- Check if input values in range after Broede et al. (2012)
[3742]1987    IF ( ( d_tmrt > 70._wp )  .OR.  ( d_tmrt < -30._wp )  .OR.                 &
1988       ( vp >= 50._wp ) )  THEN
[3569]1989       utci_ij = bio_fill_value
[3525]1990       RETURN
1991    ENDIF
[3569]1992!
[3525]1993!-- Apply eq. 2 in Broede et al. (2012) for ta out of bounds
[3742]1994    IF ( ta > 50._wp )  THEN
[3525]1995       offset = ta - 50._wp
1996       ta = 50._wp
1997    ENDIF
[3742]1998    IF ( ta < -50._wp )  THEN
[3525]1999       offset = ta + 50._wp
2000       ta = -50._wp
2001    ENDIF
[3569]2002!
[3525]2003!-- For routine application. For wind speeds and relative
[3693]2004!-- humidity values below 0.5 m/s or 5%, respectively, the
2005!-- user is advised to use the lower bounds for the calculations.
[3742]2006    IF ( va < 0.5_wp )  va = 0.5_wp
2007    IF ( va > 17._wp )  va = 17._wp
[3525]2008
[3569]2009!
2010!-- Pre-calculate multiples of input parameters to save time later
2011
2012    ta2 = ta  * ta
2013    ta3 = ta2 * ta
2014    ta4 = ta3 * ta
2015    ta5 = ta4 * ta
2016    ta6 = ta5 * ta
2017
2018    va2 = va  * va
2019    va3 = va2 * va
2020    va4 = va3 * va
2021    va5 = va4 * va
2022    va6 = va5 * va
2023
2024    d_tmrt2 = d_tmrt  * d_tmrt
2025    d_tmrt3 = d_tmrt2 * d_tmrt
2026    d_tmrt4 = d_tmrt3 * d_tmrt
2027    d_tmrt5 = d_tmrt4 * d_tmrt
2028    d_tmrt6 = d_tmrt5 * d_tmrt
2029
2030    pa2 = pa  * pa
2031    pa3 = pa2 * pa
2032    pa4 = pa3 * pa
2033    pa5 = pa4 * pa
2034    pa6 = pa5 * pa
2035
2036!
2037!-- Pre-calculate parts of the regression equation
2038    part_ta = (  6.07562052e-01_wp )       +                                   &
2039              ( -2.27712343e-02_wp ) * ta  +                                   &
2040              (  8.06470249e-04_wp ) * ta2 +                                   &
2041              ( -1.54271372e-04_wp ) * ta3 +                                   &
2042              ( -3.24651735e-06_wp ) * ta4 +                                   &
2043              (  7.32602852e-08_wp ) * ta5 +                                   &
2044              (  1.35959073e-09_wp ) * ta6
2045
2046    part_va = ( -2.25836520e+00_wp ) * va +                                    &
2047        (  8.80326035e-02_wp ) * ta  * va +                                    &
2048        (  2.16844454e-03_wp ) * ta2 * va +                                    &
2049        ( -1.53347087e-05_wp ) * ta3 * va +                                    &
2050        ( -5.72983704e-07_wp ) * ta4 * va +                                    &
2051        ( -2.55090145e-09_wp ) * ta5 * va +                                    &
2052        ( -7.51269505e-01_wp ) *       va2 +                                   &
2053        ( -4.08350271e-03_wp ) * ta  * va2 +                                   &
2054        ( -5.21670675e-05_wp ) * ta2 * va2 +                                   &
2055        (  1.94544667e-06_wp ) * ta3 * va2 +                                   &
2056        (  1.14099531e-08_wp ) * ta4 * va2 +                                   &
2057        (  1.58137256e-01_wp ) *       va3 +                                   &
2058        ( -6.57263143e-05_wp ) * ta  * va3 +                                   &
2059        (  2.22697524e-07_wp ) * ta2 * va3 +                                   &
2060        ( -4.16117031e-08_wp ) * ta3 * va3 +                                   &
2061        ( -1.27762753e-02_wp ) *       va4 +                                   &
2062        (  9.66891875e-06_wp ) * ta  * va4 +                                   &
2063        (  2.52785852e-09_wp ) * ta2 * va4 +                                   &
2064        (  4.56306672e-04_wp ) *       va5 +                                   &
2065        ( -1.74202546e-07_wp ) * ta  * va5 +                                   &
2066        ( -5.91491269e-06_wp ) * va6
2067
2068    part_d_tmrt = (  3.98374029e-01_wp ) *       d_tmrt +                      &
2069            (  1.83945314e-04_wp ) * ta  *       d_tmrt +                      &
2070            ( -1.73754510e-04_wp ) * ta2 *       d_tmrt +                      &
2071            ( -7.60781159e-07_wp ) * ta3 *       d_tmrt +                      &
2072            (  3.77830287e-08_wp ) * ta4 *       d_tmrt +                      &
2073            (  5.43079673e-10_wp ) * ta5 *       d_tmrt +                      &
2074            ( -2.00518269e-02_wp ) *       va  * d_tmrt +                      &
2075            (  8.92859837e-04_wp ) * ta  * va  * d_tmrt +                      &
2076            (  3.45433048e-06_wp ) * ta2 * va  * d_tmrt +                      &
2077            ( -3.77925774e-07_wp ) * ta3 * va  * d_tmrt +                      &
2078            ( -1.69699377e-09_wp ) * ta4 * va  * d_tmrt +                      &
2079            (  1.69992415e-04_wp ) *       va2 * d_tmrt +                      &
2080            ( -4.99204314e-05_wp ) * ta  * va2 * d_tmrt +                      &
2081            (  2.47417178e-07_wp ) * ta2 * va2 * d_tmrt +                      &
2082            (  1.07596466e-08_wp ) * ta3 * va2 * d_tmrt +                      &
2083            (  8.49242932e-05_wp ) *       va3 * d_tmrt +                      &
2084            (  1.35191328e-06_wp ) * ta  * va3 * d_tmrt +                      &
2085            ( -6.21531254e-09_wp ) * ta2 * va3 * d_tmrt +                      &
2086            ( -4.99410301e-06_wp ) * va4 *       d_tmrt +                      &
2087            ( -1.89489258e-08_wp ) * ta  * va4 * d_tmrt +                      &
2088            (  8.15300114e-08_wp ) *       va5 * d_tmrt +                      &
2089            (  7.55043090e-04_wp ) *             d_tmrt2 +                     &
2090            ( -5.65095215e-05_wp ) * ta  *       d_tmrt2 +                     &
2091            ( -4.52166564e-07_wp ) * ta2 *       d_tmrt2 +                     &
2092            (  2.46688878e-08_wp ) * ta3 *       d_tmrt2 +                     &
2093            (  2.42674348e-10_wp ) * ta4 *       d_tmrt2 +                     &
2094            (  1.54547250e-04_wp ) *       va  * d_tmrt2 +                     &
2095            (  5.24110970e-06_wp ) * ta  * va  * d_tmrt2 +                     &
2096            ( -8.75874982e-08_wp ) * ta2 * va  * d_tmrt2 +                     &
2097            ( -1.50743064e-09_wp ) * ta3 * va  * d_tmrt2 +                     &
2098            ( -1.56236307e-05_wp ) *       va2 * d_tmrt2 +                     &
2099            ( -1.33895614e-07_wp ) * ta  * va2 * d_tmrt2 +                     &
2100            (  2.49709824e-09_wp ) * ta2 * va2 * d_tmrt2 +                     &
2101            (  6.51711721e-07_wp ) *       va3 * d_tmrt2 +                     &
2102            (  1.94960053e-09_wp ) * ta  * va3 * d_tmrt2 +                     &
2103            ( -1.00361113e-08_wp ) *       va4 * d_tmrt2 +                     &
2104            ( -1.21206673e-05_wp ) *             d_tmrt3 +                     &
2105            ( -2.18203660e-07_wp ) * ta  *       d_tmrt3 +                     &
2106            (  7.51269482e-09_wp ) * ta2 *       d_tmrt3 +                     &
2107            (  9.79063848e-11_wp ) * ta3 *       d_tmrt3 +                     &
2108            (  1.25006734e-06_wp ) *       va  * d_tmrt3 +                     &
2109            ( -1.81584736e-09_wp ) * ta  * va  * d_tmrt3 +                     &
2110            ( -3.52197671e-10_wp ) * ta2 * va  * d_tmrt3 +                     &
2111            ( -3.36514630e-08_wp ) *       va2 * d_tmrt3 +                     &
2112            (  1.35908359e-10_wp ) * ta  * va2 * d_tmrt3 +                     &
2113            (  4.17032620e-10_wp ) *       va3 * d_tmrt3 +                     &
2114            ( -1.30369025e-09_wp ) *             d_tmrt4 +                     &
2115            (  4.13908461e-10_wp ) * ta  *       d_tmrt4 +                     &
2116            (  9.22652254e-12_wp ) * ta2 *       d_tmrt4 +                     &
2117            ( -5.08220384e-09_wp ) *       va  * d_tmrt4 +                     &
2118            ( -2.24730961e-11_wp ) * ta  * va  * d_tmrt4 +                     &
2119            (  1.17139133e-10_wp ) *       va2 * d_tmrt4 +                     &
2120            (  6.62154879e-10_wp ) *             d_tmrt5 +                     &
2121            (  4.03863260e-13_wp ) * ta  *       d_tmrt5 +                     &
2122            (  1.95087203e-12_wp ) *       va  * d_tmrt5 +                     &
2123            ( -4.73602469e-12_wp ) *             d_tmrt6
2124
2125    part_pa = (  5.12733497e+00_wp ) *                pa +                     &
2126       ( -3.12788561e-01_wp ) * ta  *                 pa +                     &
2127       ( -1.96701861e-02_wp ) * ta2 *                 pa +                     &
2128       (  9.99690870e-04_wp ) * ta3 *                 pa +                     &
2129       (  9.51738512e-06_wp ) * ta4 *                 pa +                     &
2130       ( -4.66426341e-07_wp ) * ta5 *                 pa +                     &
2131       (  5.48050612e-01_wp ) *       va  *           pa +                     &
2132       ( -3.30552823e-03_wp ) * ta  * va  *           pa +                     &
2133       ( -1.64119440e-03_wp ) * ta2 * va  *           pa +                     &
2134       ( -5.16670694e-06_wp ) * ta3 * va  *           pa +                     &
2135       (  9.52692432e-07_wp ) * ta4 * va  *           pa +                     &
2136       ( -4.29223622e-02_wp ) *       va2 *           pa +                     &
2137       (  5.00845667e-03_wp ) * ta  * va2 *           pa +                     &
2138       (  1.00601257e-06_wp ) * ta2 * va2 *           pa +                     &
2139       ( -1.81748644e-06_wp ) * ta3 * va2 *           pa +                     &
2140       ( -1.25813502e-03_wp ) *       va3 *           pa +                     &
2141       ( -1.79330391e-04_wp ) * ta  * va3 *           pa +                     &
2142       (  2.34994441e-06_wp ) * ta2 * va3 *           pa +                     &
2143       (  1.29735808e-04_wp ) *       va4 *           pa +                     &
2144       (  1.29064870e-06_wp ) * ta  * va4 *           pa +                     &
2145       ( -2.28558686e-06_wp ) *       va5 *           pa +                     &
2146       ( -3.69476348e-02_wp ) *             d_tmrt  * pa +                     &
2147       (  1.62325322e-03_wp ) * ta  *       d_tmrt  * pa +                     &
2148       ( -3.14279680e-05_wp ) * ta2 *       d_tmrt  * pa +                     &
2149       (  2.59835559e-06_wp ) * ta3 *       d_tmrt  * pa +                     &
2150       ( -4.77136523e-08_wp ) * ta4 *       d_tmrt  * pa +                     &
2151       (  8.64203390e-03_wp ) *       va  * d_tmrt  * pa +                     &
2152       ( -6.87405181e-04_wp ) * ta  * va  * d_tmrt  * pa +                     &
2153       ( -9.13863872e-06_wp ) * ta2 * va  * d_tmrt  * pa +                     &
2154       (  5.15916806e-07_wp ) * ta3 * va  * d_tmrt  * pa +                     &
2155       ( -3.59217476e-05_wp ) *       va2 * d_tmrt  * pa +                     &
2156       (  3.28696511e-05_wp ) * ta  * va2 * d_tmrt  * pa +                     &
2157       ( -7.10542454e-07_wp ) * ta2 * va2 * d_tmrt  * pa +                     &
2158       ( -1.24382300e-05_wp ) *       va3 * d_tmrt  * pa +                     &
2159       ( -7.38584400e-09_wp ) * ta  * va3 * d_tmrt  * pa +                     &
2160       (  2.20609296e-07_wp ) *       va4 * d_tmrt  * pa +                     &
2161       ( -7.32469180e-04_wp ) *             d_tmrt2 * pa +                     &
2162       ( -1.87381964e-05_wp ) * ta  *       d_tmrt2 * pa +                     &
2163       (  4.80925239e-06_wp ) * ta2 *       d_tmrt2 * pa +                     &
2164       ( -8.75492040e-08_wp ) * ta3 *       d_tmrt2 * pa +                     &
2165       (  2.77862930e-05_wp ) *       va  * d_tmrt2 * pa +                     &
2166       ( -5.06004592e-06_wp ) * ta  * va  * d_tmrt2 * pa +                     &
2167       (  1.14325367e-07_wp ) * ta2 * va  * d_tmrt2 * pa +                     &
2168       (  2.53016723e-06_wp ) *       va2 * d_tmrt2 * pa +                     &
2169       ( -1.72857035e-08_wp ) * ta  * va2 * d_tmrt2 * pa +                     &
2170       ( -3.95079398e-08_wp ) *       va3 * d_tmrt2 * pa +                     &
2171       ( -3.59413173e-07_wp ) *             d_tmrt3 * pa +                     &
2172       (  7.04388046e-07_wp ) * ta  *       d_tmrt3 * pa +                     &
2173       ( -1.89309167e-08_wp ) * ta2 *       d_tmrt3 * pa +                     &
2174       ( -4.79768731e-07_wp ) *       va  * d_tmrt3 * pa +                     &
2175       (  7.96079978e-09_wp ) * ta  * va  * d_tmrt3 * pa +                     &
2176       (  1.62897058e-09_wp ) *       va2 * d_tmrt3 * pa +                     &
2177       (  3.94367674e-08_wp ) *             d_tmrt4 * pa +                     &
2178       ( -1.18566247e-09_wp ) * ta *        d_tmrt4 * pa +                     &
2179       (  3.34678041e-10_wp ) *       va  * d_tmrt4 * pa +                     &
2180       ( -1.15606447e-10_wp ) *             d_tmrt5 * pa
2181
2182    part_pa2 = ( -2.80626406e+00_wp ) *               pa2 +                    &
2183       (  5.48712484e-01_wp ) * ta  *                 pa2 +                    &
2184       ( -3.99428410e-03_wp ) * ta2 *                 pa2 +                    &
2185       ( -9.54009191e-04_wp ) * ta3 *                 pa2 +                    &
2186       (  1.93090978e-05_wp ) * ta4 *                 pa2 +                    &
2187       ( -3.08806365e-01_wp ) *       va *            pa2 +                    &
2188       (  1.16952364e-02_wp ) * ta  * va *            pa2 +                    &
2189       (  4.95271903e-04_wp ) * ta2 * va *            pa2 +                    &
2190       ( -1.90710882e-05_wp ) * ta3 * va *            pa2 +                    &
2191       (  2.10787756e-03_wp ) *       va2 *           pa2 +                    &
2192       ( -6.98445738e-04_wp ) * ta  * va2 *           pa2 +                    &
2193       (  2.30109073e-05_wp ) * ta2 * va2 *           pa2 +                    &
2194       (  4.17856590e-04_wp ) *       va3 *           pa2 +                    &
2195       ( -1.27043871e-05_wp ) * ta  * va3 *           pa2 +                    &
2196       ( -3.04620472e-06_wp ) *       va4 *           pa2 +                    &
2197       (  5.14507424e-02_wp ) *             d_tmrt  * pa2 +                    &
2198       ( -4.32510997e-03_wp ) * ta  *       d_tmrt  * pa2 +                    &
2199       (  8.99281156e-05_wp ) * ta2 *       d_tmrt  * pa2 +                    &
2200       ( -7.14663943e-07_wp ) * ta3 *       d_tmrt  * pa2 +                    &
2201       ( -2.66016305e-04_wp ) *       va  * d_tmrt  * pa2 +                    &
2202       (  2.63789586e-04_wp ) * ta  * va  * d_tmrt  * pa2 +                    &
2203       ( -7.01199003e-06_wp ) * ta2 * va  * d_tmrt  * pa2 +                    &
2204       ( -1.06823306e-04_wp ) *       va2 * d_tmrt  * pa2 +                    &
2205       (  3.61341136e-06_wp ) * ta  * va2 * d_tmrt  * pa2 +                    &
2206       (  2.29748967e-07_wp ) *       va3 * d_tmrt  * pa2 +                    &
2207       (  3.04788893e-04_wp ) *             d_tmrt2 * pa2 +                    &
2208       ( -6.42070836e-05_wp ) * ta  *       d_tmrt2 * pa2 +                    &
2209       (  1.16257971e-06_wp ) * ta2 *       d_tmrt2 * pa2 +                    &
2210       (  7.68023384e-06_wp ) *       va  * d_tmrt2 * pa2 +                    &
2211       ( -5.47446896e-07_wp ) * ta  * va  * d_tmrt2 * pa2 +                    &
2212       ( -3.59937910e-08_wp ) *       va2 * d_tmrt2 * pa2 +                    &
2213       ( -4.36497725e-06_wp ) *             d_tmrt3 * pa2 +                    &
2214       (  1.68737969e-07_wp ) * ta  *       d_tmrt3 * pa2 +                    &
2215       (  2.67489271e-08_wp ) *       va  * d_tmrt3 * pa2 +                    &
2216       (  3.23926897e-09_wp ) *             d_tmrt4 * pa2
2217
2218    part_pa3 = ( -3.53874123e-02_wp ) *               pa3 +                    &
2219       ( -2.21201190e-01_wp ) * ta  *                 pa3 +                    &
2220       (  1.55126038e-02_wp ) * ta2 *                 pa3 +                    &
2221       ( -2.63917279e-04_wp ) * ta3 *                 pa3 +                    &
2222       (  4.53433455e-02_wp ) *       va  *           pa3 +                    &
2223       ( -4.32943862e-03_wp ) * ta  * va  *           pa3 +                    &
2224       (  1.45389826e-04_wp ) * ta2 * va  *           pa3 +                    &
2225       (  2.17508610e-04_wp ) *       va2 *           pa3 +                    &
2226       ( -6.66724702e-05_wp ) * ta  * va2 *           pa3 +                    &
2227       (  3.33217140e-05_wp ) *       va3 *           pa3 +                    &
2228       ( -2.26921615e-03_wp ) *             d_tmrt  * pa3 +                    &
2229       (  3.80261982e-04_wp ) * ta  *       d_tmrt  * pa3 +                    &
2230       ( -5.45314314e-09_wp ) * ta2 *       d_tmrt  * pa3 +                    &
2231       ( -7.96355448e-04_wp ) *       va  * d_tmrt  * pa3 +                    &
2232       (  2.53458034e-05_wp ) * ta  * va  * d_tmrt  * pa3 +                    &
2233       ( -6.31223658e-06_wp ) *       va2 * d_tmrt  * pa3 +                    &
2234       (  3.02122035e-04_wp ) *             d_tmrt2 * pa3 +                    &
2235       ( -4.77403547e-06_wp ) * ta  *       d_tmrt2 * pa3 +                    &
2236       (  1.73825715e-06_wp ) *       va  * d_tmrt2 * pa3 +                    &
2237       ( -4.09087898e-07_wp ) *             d_tmrt3 * pa3
2238
2239    part_pa46 = (  6.14155345e-01_wp ) *              pa4 +                    &
2240       ( -6.16755931e-02_wp ) * ta  *                 pa4 +                    &
2241       (  1.33374846e-03_wp ) * ta2 *                 pa4 +                    &
2242       (  3.55375387e-03_wp ) *       va  *           pa4 +                    &
[3693]2243       ( -5.13027851e-04_wp ) * ta  * va  *           pa4 +                    &
[3569]2244       (  1.02449757e-04_wp ) *       va2 *           pa4 +                    &
2245       ( -1.48526421e-03_wp ) *             d_tmrt  * pa4 +                    &
2246       ( -4.11469183e-05_wp ) * ta  *       d_tmrt  * pa4 +                    &
2247       ( -6.80434415e-06_wp ) *       va  * d_tmrt  * pa4 +                    &
2248       ( -9.77675906e-06_wp ) *             d_tmrt2 * pa4 +                    &
2249       (  8.82773108e-02_wp ) *                       pa5 +                    &
2250       ( -3.01859306e-03_wp ) * ta  *                 pa5 +                    &
2251       (  1.04452989e-03_wp ) *       va  *           pa5 +                    &
2252       (  2.47090539e-04_wp ) *             d_tmrt  * pa5 +                    &
2253       (  1.48348065e-03_wp ) *                       pa6
2254!
[3525]2255!-- Calculate 6th order polynomial as approximation
[3569]2256    utci_ij = ta + part_ta + part_va + part_d_tmrt + part_pa + part_pa2 +      &
2257        part_pa3 + part_pa46
2258!
[3525]2259!-- Consider offset in result
[3569]2260    utci_ij = utci_ij + offset
[3525]2261
2262 END SUBROUTINE calculate_utci_static
2263
2264
2265
2266
2267!------------------------------------------------------------------------------!
2268! Description:
2269! ------------
[3593]2270!> calculate_perct_static: Estimation of perceived temperature (PT, degree_C)
[3525]2271!> Value of perct is the Perceived Temperature, degree centigrade
2272!------------------------------------------------------------------------------!
[3569]2273 SUBROUTINE calculate_perct_static( ta, vp, ws, tmrt, pair, clo, perct_ij )
[3525]2274
2275    IMPLICIT NONE
[3569]2276!
[3525]2277!-- Type of input of the argument list
2278    REAL(wp), INTENT ( IN )  :: ta   !< Local air temperature (degC)
2279    REAL(wp), INTENT ( IN )  :: vp   !< Local vapour pressure (hPa)
2280    REAL(wp), INTENT ( IN )  :: tmrt !< Local mean radiant temperature (degC)
2281    REAL(wp), INTENT ( IN )  :: ws   !< Local wind velocitry (m/s)
2282    REAL(wp), INTENT ( IN )  :: pair !< Local barometric air pressure (hPa)
[3569]2283!
[3525]2284!-- Type of output of the argument list
[3569]2285    REAL(wp), INTENT ( OUT ) :: perct_ij  !< Perceived temperature (degC)
2286    REAL(wp), INTENT ( OUT ) :: clo       !< Clothing index (dimensionless)
2287!
[3525]2288!-- Parameters for standard "Klima-Michel"
[3693]2289    REAL(wp), PARAMETER :: eta = 0._wp  !< Mechanical work efficiency for walking on flat ground
2290                                        !< (compare to Fanger (1972) pp 24f)
2291    REAL(wp), PARAMETER :: actlev = 134.6862_wp  !< Workload by activity per standardized surface (A_Du)
[3569]2292!
[3525]2293!-- Type of program variables
2294    REAL(wp), PARAMETER :: eps = 0.0005  !< Accuracy in clothing insulation (clo) for evaluation the root of Fanger's PMV (pmva=0)
2295    REAL(wp) ::  sclo           !< summer clothing insulation
2296    REAL(wp) ::  wclo           !< winter clothing insulation
2297    REAL(wp) ::  d_pmv          !< PMV deviation (dimensionless --> PMV)
2298    REAL(wp) ::  svp_ta         !< saturation vapor pressure    (hPa)
2299    REAL(wp) ::  sult_lim       !< threshold for sultrieness    (hPa)
2300    REAL(wp) ::  dgtcm          !< Mean deviation dependent on perct
2301    REAL(wp) ::  dgtcstd        !< Mean deviation plus its standard deviation
2302    REAL(wp) ::  clon           !< clo for neutral conditions   (clo)
2303    REAL(wp) ::  ireq_minimal   !< Minimal required clothing insulation (clo)
2304    REAL(wp) ::  pmv_w          !< Fangers predicted mean vote for winter clothing
2305    REAL(wp) ::  pmv_s          !< Fangers predicted mean vote for summer clothing
2306    REAL(wp) ::  pmva           !< adjusted predicted mean vote
[3593]2307    REAL(wp) ::  ptc            !< perceived temp. for cold conditions (degree_C)
[3525]2308    REAL(wp) ::  d_std          !< factor to threshold for sultriness
2309    REAL(wp) ::  pmvs           !< pred. mean vote considering sultrieness
2310
2311    INTEGER(iwp) :: ncount      !< running index
2312    INTEGER(iwp) :: nerr_cold   !< error number (cold conditions)
2313    INTEGER(iwp) :: nerr        !< error number
2314
2315    LOGICAL :: sultrieness
[3569]2316!
[3525]2317!-- Initialise
[3569]2318    perct_ij = bio_fill_value
[3525]2319
2320    nerr     = 0_iwp
2321    ncount   = 0_iwp
2322    sultrieness  = .FALSE.
[3569]2323!
[3525]2324!-- Tresholds: clothing insulation (account for model inaccuracies)
[3569]2325!
[3693]2326!-- summer clothing
[3525]2327    sclo     = 0.44453_wp
[3569]2328!
[3693]2329!-- winter clothing
[3525]2330    wclo     = 1.76267_wp
[3569]2331!
[3525]2332!-- decision: firstly calculate for winter or summer clothing
[3742]2333    IF ( ta <= 10._wp )  THEN
[3569]2334!
[3525]2335!--    First guess: winter clothing insulation: cold stress
2336       clo = wclo
[3753]2337       CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2338       pmv_w = pmva
2339
[3742]2340       IF ( pmva > 0._wp )  THEN
[3569]2341!
[3525]2342!--       Case summer clothing insulation: heat load ?
2343          clo = sclo
[3753]2344          CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2345          pmv_s = pmva
[3742]2346          IF ( pmva <= 0._wp )  THEN
[3569]2347!
[3525]2348!--          Case: comfort achievable by varying clothing insulation
[3693]2349!--          Between winter and summer set values
[3525]2350             CALL iso_ridder ( ta, tmrt, vp, ws, pair, actlev, eta, sclo,      &
[3753]2351                pmv_s, wclo, pmv_w, eps, pmva, ncount, clo )
[3742]2352             IF ( ncount < 0_iwp )  THEN
[3525]2353                nerr = -1_iwp
2354                RETURN
2355             ENDIF
[3742]2356          ELSE IF ( pmva > 0.06_wp )  THEN
[3525]2357             clo = 0.5_wp
2358             CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta,           &
[3753]2359                           pmva )
[3525]2360          ENDIF
[3742]2361       ELSE IF ( pmva < -0.11_wp )  THEN
[3525]2362          clo = 1.75_wp
[3753]2363          CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2364       ENDIF
2365    ELSE
[3569]2366!
[3525]2367!--    First guess: summer clothing insulation: heat load
2368       clo = sclo
[3753]2369       CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2370       pmv_s = pmva
2371
[3742]2372       IF ( pmva < 0._wp )  THEN
[3569]2373!
[3525]2374!--       Case winter clothing insulation: cold stress ?
2375          clo = wclo
[3753]2376          CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2377          pmv_w = pmva
2378
[3742]2379          IF ( pmva >= 0._wp )  THEN
[3569]2380!
[3525]2381!--          Case: comfort achievable by varying clothing insulation
[3693]2382!--          between winter and summer set values
[3525]2383             CALL iso_ridder ( ta, tmrt, vp, ws, pair, actlev, eta, sclo,      &
[3753]2384                               pmv_s, wclo, pmv_w, eps, pmva, ncount, clo )
[3742]2385             IF ( ncount < 0_iwp )  THEN
[3525]2386                nerr = -1_iwp
2387                RETURN
2388             ENDIF
[3742]2389          ELSE IF ( pmva < -0.11_wp )  THEN
[3525]2390             clo = 1.75_wp
2391             CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta,           &
[3753]2392                           pmva )
[3525]2393          ENDIF
[3742]2394       ELSE IF ( pmva > 0.06_wp )  THEN
[3525]2395          clo = 0.5_wp
[3753]2396          CALL fanger ( ta, tmrt, vp, ws, pair, clo, actlev, eta, pmva )
[3525]2397       ENDIF
2398
2399    ENDIF
[3569]2400!
[3525]2401!-- Determine perceived temperature by regression equation + adjustments
2402    pmvs = pmva
[3749]2403    CALL perct_regression( pmva, clo, perct_ij )
[3569]2404    ptc = perct_ij
[3742]2405    IF ( clo >= 1.75_wp  .AND.  pmva <= -0.11_wp )  THEN
[3569]2406!
[3525]2407!--    Adjust for cold conditions according to Gagge 1986
2408       CALL dpmv_cold ( pmva, ta, ws, tmrt, nerr_cold, d_pmv )
[3742]2409       IF ( nerr_cold > 0_iwp )  nerr = -5_iwp
[3525]2410       pmvs = pmva - d_pmv
[3742]2411       IF ( pmvs > -0.11_wp )  THEN
[3525]2412          d_pmv  = 0._wp
2413          pmvs   = -0.11_wp
2414       ENDIF
[3749]2415       CALL perct_regression( pmvs, clo, perct_ij )
[3525]2416    ENDIF
2417!     clo_fanger = clo
2418    clon = clo
[3742]2419    IF ( clo > 0.5_wp  .AND.  perct_ij <= 8.73_wp )  THEN
[3569]2420!
[3525]2421!--    Required clothing insulation (ireq) is exclusively defined for
[3753]2422!--    perceived temperatures (perct) less 10 (C) for a
[3693]2423!--    reference wind of 0.2 m/s according to 8.73 (C) for 0.1 m/s
[3569]2424       clon = ireq_neutral ( perct_ij, ireq_minimal, nerr )
[3525]2425       clo = clon
2426    ENDIF
[3749]2427    CALL calc_sultr( ptc, dgtcm, dgtcstd, sult_lim )
[3525]2428    sultrieness    = .FALSE.
2429    d_std = -99._wp
[3742]2430    IF ( pmva > 0.06_wp  .AND.  clo <= 0.5_wp )  THEN
[3569]2431!
[3525]2432!--    Adjust for warm/humid conditions according to Gagge 1986
2433       CALL saturation_vapor_pressure ( ta, svp_ta )
2434       d_pmv  = deltapmv ( pmva, ta, vp, svp_ta, tmrt, ws, nerr )
2435       pmvs   = pmva + d_pmv
[3749]2436       CALL perct_regression( pmvs, clo, perct_ij )
[3742]2437       IF ( sult_lim < 99._wp )  THEN
2438          IF ( (perct_ij - ptc) > sult_lim )  sultrieness = .TRUE.
[3569]2439!
[3525]2440!--       Set factor to threshold for sultriness
[3749]2441          IF ( ABS( dgtcstd ) > 0.00001_wp )  THEN
[3569]2442             d_std = ( ( perct_ij - ptc ) - dgtcm ) / dgtcstd
[3525]2443          ENDIF
2444       ENDIF
2445    ENDIF
2446
2447 END SUBROUTINE calculate_perct_static
2448
2449!------------------------------------------------------------------------------!
2450! Description:
2451! ------------
[3693]2452!> The SUBROUTINE calculates the (saturation) water vapour pressure
[3525]2453!> (hPa = hecto Pascal) for a given temperature ta (degC).
[3693]2454!> 'ta' can be the air temperature or the dew point temperature. The first will
2455!> result in the current vapor pressure (hPa), the latter will calulate the
2456!> saturation vapor pressure (hPa).
[3525]2457!------------------------------------------------------------------------------!
2458 SUBROUTINE saturation_vapor_pressure( ta, svp_ta )
2459
2460    IMPLICIT NONE
2461
2462    REAL(wp), INTENT ( IN )  ::  ta     !< ambient air temperature (degC)
[3693]2463    REAL(wp), INTENT ( OUT ) ::  svp_ta !< water vapour pressure (hPa)
[3525]2464
2465    REAL(wp)      ::  b
2466    REAL(wp)      ::  c
2467
2468
[3742]2469    IF ( ta < 0._wp )  THEN
[3569]2470!
[3693]2471!--    ta  < 0 (degC): water vapour pressure over ice
[3525]2472       b = 17.84362_wp
2473       c = 245.425_wp
2474    ELSE
[3569]2475!
[3693]2476!--    ta >= 0 (degC): water vapour pressure over water
[3525]2477       b = 17.08085_wp
2478       c = 234.175_wp
2479    ENDIF
[3569]2480!
[3525]2481!-- Saturation water vapour pressure
[3753]2482    svp_ta = 6.1078_wp * EXP( b * ta / ( c + ta ) )
[3525]2483
2484 END SUBROUTINE saturation_vapor_pressure
2485
2486!------------------------------------------------------------------------------!
2487! Description:
2488! ------------
2489!> Find the clothing insulation value clo_res (clo) to make Fanger's Predicted
2490!> Mean Vote (PMV) equal comfort (pmva=0) for actual meteorological conditions
2491!> (ta,tmrt, vp, ws, pair) and values of individual's activity level
2492!------------------------------------------------------------------------------!
2493 SUBROUTINE iso_ridder( ta, tmrt, vp, ws, pair, actlev, eta, sclo,             &
[3753]2494                       pmv_s, wclo, pmv_w, eps, pmva, nerr,               &
[3525]2495                       clo_res )
2496
2497    IMPLICIT NONE
[3569]2498!
[3525]2499!-- Input variables of argument list:
[3693]2500    REAL(wp), INTENT ( IN )  :: ta       !< Ambient temperature (degC)
[3525]2501    REAL(wp), INTENT ( IN )  :: tmrt     !< Mean radiant temperature (degC)
[3693]2502    REAL(wp), INTENT ( IN )  :: vp       !< Water vapour pressure (hPa)
2503    REAL(wp), INTENT ( IN )  :: ws       !< Wind speed (m/s) 1 m above ground
2504    REAL(wp), INTENT ( IN )  :: pair     !< Barometric air pressure (hPa)
[3525]2505    REAL(wp), INTENT ( IN )  :: actlev   !< Individuals activity level per unit surface area (W/m2)
2506    REAL(wp), INTENT ( IN )  :: eta      !< Individuals work efficiency (dimensionless)
2507    REAL(wp), INTENT ( IN )  :: sclo     !< Lower threshold of bracketing clothing insulation (clo)
2508    REAL(wp), INTENT ( IN )  :: wclo     !< Upper threshold of bracketing clothing insulation (clo)
2509    REAL(wp), INTENT ( IN )  :: eps      !< (0.05) accuracy in clothing insulation (clo) for
2510!                                          evaluation the root of Fanger's PMV (pmva=0)
2511    REAL(wp), INTENT ( IN )  :: pmv_w    !< Fanger's PMV corresponding to wclo
2512    REAL(wp), INTENT ( IN )  :: pmv_s    !< Fanger's PMV corresponding to sclo
[3569]2513!
[3693]2514!-- Output variables of argument list:
[3525]2515    REAL(wp), INTENT ( OUT ) :: pmva     !< 0 (set to zero, because clo is evaluated for comfort)
2516    REAL(wp), INTENT ( OUT ) :: clo_res  !< Resulting clothing insulation value (clo)
2517    INTEGER(iwp), INTENT ( OUT ) :: nerr !< Error status / quality flag
[3693]2518                                         !< nerr >= 0, o.k., and nerr is the number of iterations for convergence
2519                                         !< nerr = -1: error = malfunction of Ridder's convergence method
2520                                         !< nerr = -2: error = maximum iterations (max_iteration) exceeded
2521                                         !< nerr = -3: error = root not bracketed between sclo and wclo
[3569]2522!
[3525]2523!-- Type of program variables
2524    INTEGER(iwp), PARAMETER  ::  max_iteration = 15_iwp       !< max number of iterations
2525    REAL(wp),     PARAMETER  ::  guess_0       = -1.11e30_wp  !< initial guess
2526    REAL(wp) ::  x_ridder    !< current guess for clothing insulation   (clo)
2527    REAL(wp) ::  clo_lower   !< lower limit of clothing insulation      (clo)
2528    REAL(wp) ::  clo_upper   !< upper limit of clothing insulation      (clo)
2529    REAL(wp) ::  x_lower     !< lower guess for clothing insulation     (clo)
2530    REAL(wp) ::  x_upper     !< upper guess for clothing insulation     (clo)
2531    REAL(wp) ::  x_average   !< average of x_lower and x_upper          (clo)
2532    REAL(wp) ::  x_new       !< preliminary result for clothing insulation (clo)
2533    REAL(wp) ::  y_lower     !< predicted mean vote for summer clothing
2534    REAL(wp) ::  y_upper     !< predicted mean vote for winter clothing
2535    REAL(wp) ::  y_average   !< average of y_lower and y_upper
2536    REAL(wp) ::  y_new       !< preliminary result for pred. mean vote
2537    REAL(wp) ::  sroot       !< sqrt of PMV-guess
2538    INTEGER(iwp) ::  j       !< running index
[3569]2539!
[3525]2540!-- Initialise
2541    nerr    = 0_iwp
[3569]2542!
[3525]2543!-- Set pmva = 0 (comfort): Root of PMV depending on clothing insulation
[3569]2544    x_ridder    = bio_fill_value
[3525]2545    pmva        = 0._wp
2546    clo_lower   = sclo
2547    y_lower     = pmv_s
2548    clo_upper   = wclo
2549    y_upper     = pmv_w
[3742]2550    IF ( ( y_lower > 0._wp  .AND.  y_upper < 0._wp )  .OR.                     &
2551         ( y_lower < 0._wp  .AND.  y_upper > 0._wp ) )  THEN
[3525]2552       x_lower  = clo_lower
2553       x_upper  = clo_upper
2554       x_ridder = guess_0
2555
[3742]2556       DO  j = 1_iwp, max_iteration
[3525]2557          x_average = 0.5_wp * ( x_lower + x_upper )
2558          CALL fanger ( ta, tmrt, vp, ws, pair, x_average, actlev, eta,        &
[3753]2559                        y_average )
2560          sroot = SQRT( y_average**2 - y_lower * y_upper )
[3749]2561          IF ( ABS( sroot ) < 0.00001_wp )  THEN
[3525]2562             clo_res = x_average
2563             nerr = j
2564             RETURN
2565          ENDIF
2566          x_new = x_average + ( x_average - x_lower ) *                        &
2567                      ( SIGN ( 1._wp, y_lower - y_upper ) * y_average / sroot )
[3753]2568          IF ( ABS( x_new - x_ridder ) <= eps )  THEN
[3525]2569             clo_res = x_ridder
2570             nerr       = j
2571             RETURN
2572          ENDIF
2573          x_ridder = x_new
2574          CALL fanger ( ta, tmrt, vp, ws, pair, x_ridder, actlev, eta,         &
[3753]2575                        y_new )
[3749]2576          IF ( ABS( y_new ) < 0.00001_wp )  THEN
[3525]2577             clo_res = x_ridder
2578             nerr       = j
2579             RETURN
2580          ENDIF
[3749]2581          IF ( ABS( SIGN( y_average, y_new ) - y_average ) > 0.00001_wp )  THEN
[3525]2582             x_lower = x_average
2583             y_lower = y_average
2584             x_upper  = x_ridder
2585             y_upper  = y_new
[3749]2586          ELSE IF ( ABS( SIGN( y_lower, y_new ) - y_lower ) > 0.00001_wp )  THEN
[3525]2587             x_upper  = x_ridder
2588             y_upper  = y_new
[3749]2589          ELSE IF ( ABS( SIGN( y_upper, y_new ) - y_upper ) > 0.00001_wp )  THEN
[3525]2590             x_lower = x_ridder
2591             y_lower = y_new
2592          ELSE
[3569]2593!
[3525]2594!--          Never get here in x_ridder: singularity in y
[3749]2595             nerr    = -1_iwp
[3525]2596             clo_res = x_ridder
2597             RETURN
2598          ENDIF
[3753]2599          IF ( ABS( x_upper - x_lower ) <= eps )  THEN
[3525]2600             clo_res = x_ridder
[3749]2601             nerr    = j
[3525]2602             RETURN
2603          ENDIF
2604       ENDDO
[3569]2605!
[3525]2606!--    x_ridder exceed maximum iterations
2607       nerr       = -2_iwp
2608       clo_res = y_new
2609       RETURN
[3749]2610    ELSE IF ( ABS( y_lower ) < 0.00001_wp )  THEN
[3525]2611       x_ridder = clo_lower
[3749]2612    ELSE IF ( ABS( y_upper ) < 0.00001_wp )  THEN
[3525]2613       x_ridder = clo_upper
2614    ELSE
[3569]2615!
[3525]2616!--    x_ridder not bracketed by u_clo and o_clo
2617       nerr = -3_iwp
2618       clo_res = x_ridder
2619       RETURN
2620    ENDIF
2621
2622 END SUBROUTINE iso_ridder
2623
2624!------------------------------------------------------------------------------!
2625! Description:
2626! ------------
2627!> Regression relations between perceived temperature (perct) and (adjusted)
2628!> PMV. The regression presumes the Klima-Michel settings for reference
2629!> individual and reference environment.
2630!------------------------------------------------------------------------------!
[3569]2631 SUBROUTINE perct_regression( pmv, clo, perct_ij )
[3525]2632
2633    IMPLICIT NONE
2634
2635    REAL(wp), INTENT ( IN ) ::  pmv   !< Fangers predicted mean vote (dimensionless)
2636    REAL(wp), INTENT ( IN ) ::  clo   !< clothing insulation index (clo)
2637
[3569]2638    REAL(wp), INTENT ( OUT ) ::  perct_ij   !< perct (degC) corresponding to given PMV / clo
[3525]2639
[3742]2640    IF ( pmv <= -0.11_wp )  THEN
[3569]2641       perct_ij = 5.805_wp + 12.6784_wp * pmv
[3525]2642    ELSE
[3742]2643       IF ( pmv >= + 0.01_wp )  THEN
[3569]2644          perct_ij = 16.826_wp + 6.163_wp * pmv
[3525]2645       ELSE
[3569]2646          perct_ij = 21.258_wp - 9.558_wp * clo
[3525]2647       ENDIF
2648    ENDIF
2649
2650 END SUBROUTINE perct_regression
2651
2652!------------------------------------------------------------------------------!
2653! Description:
2654! ------------
2655!> FANGER.F90
2656!>
2657!> SI-VERSION: ACTLEV W m-2, DAMPFDRUCK hPa
2658!> Berechnet das aktuelle Predicted Mean Vote nach Fanger
2659!>
2660!> The case of free convection (ws < 0.1 m/s) is dealt with ws = 0.1 m/s
2661!------------------------------------------------------------------------------!
[3753]2662 SUBROUTINE fanger( ta, tmrt, pa, in_ws, pair, in_clo, actlev, eta, pmva )
[3525]2663
2664    IMPLICIT NONE
[3569]2665!
[3525]2666!-- Input variables of argument list:
2667    REAL(wp), INTENT ( IN ) ::  ta       !< Ambient air temperature (degC)
2668    REAL(wp), INTENT ( IN ) ::  tmrt     !< Mean radiant temperature (degC)
2669    REAL(wp), INTENT ( IN ) ::  pa       !< Water vapour pressure (hPa)
2670    REAL(wp), INTENT ( IN ) ::  pair     !< Barometric pressure (hPa) at site
2671    REAL(wp), INTENT ( IN ) ::  in_ws    !< Wind speed (m/s) 1 m above ground
2672    REAL(wp), INTENT ( IN ) ::  in_clo   !< Clothing insulation (clo)
2673    REAL(wp), INTENT ( IN ) ::  actlev   !< Individuals activity level per unit surface area (W/m2)
2674    REAL(wp), INTENT ( IN ) ::  eta      !< Individuals mechanical work efficiency (dimensionless)
[3569]2675!
[3525]2676!-- Output variables of argument list:
2677    REAL(wp), INTENT ( OUT ) ::  pmva    !< Actual Predicted Mean Vote (PMV,
[3693]2678                                         !< dimensionless) according to Fanger corresponding to meteorological
2679                                         !< (ta,tmrt,pa,ws,pair) and individual variables (clo, actlev, eta)
[3569]2680!
[3525]2681!-- Internal variables
2682    REAL(wp) ::  f_cl         !< Increase in surface due to clothing    (factor)
2683    REAL(wp) ::  heat_convection  !< energy loss by autocnvection       (W)
2684    REAL(wp) ::  activity     !< persons activity  (must stay == actlev, W)
[3593]2685    REAL(wp) ::  t_skin_aver  !< average skin temperature               (degree_C)
[3525]2686    REAL(wp) ::  bc           !< preliminary result storage
2687    REAL(wp) ::  cc           !< preliminary result storage
2688    REAL(wp) ::  dc           !< preliminary result storage
2689    REAL(wp) ::  ec           !< preliminary result storage
2690    REAL(wp) ::  gc           !< preliminary result storage
[3593]2691    REAL(wp) ::  t_clothing   !< clothing temperature                   (degree_C)
[3525]2692    REAL(wp) ::  hr           !< radiational heat resistence
2693    REAL(wp) ::  clo          !< clothing insulation index              (clo)
2694    REAL(wp) ::  ws           !< wind speed                             (m/s)
2695    REAL(wp) ::  z1           !< Empiric factor for the adaption of the heat
[3693]2696                              !< ballance equation to the psycho-physical scale (Equ. 40 in FANGER)
[3525]2697    REAL(wp) ::  z2           !< Water vapour diffution through the skin
2698    REAL(wp) ::  z3           !< Sweat evaporation from the skin surface
2699    REAL(wp) ::  z4           !< Loss of latent heat through respiration
2700    REAL(wp) ::  z5           !< Loss of radiational heat
2701    REAL(wp) ::  z6           !< Heat loss through forced convection
2702    INTEGER(iwp) :: i         !< running index
[3569]2703!
[3525]2704!-- Clo must be > 0. to avoid div. by 0!
2705    clo = in_clo
[3742]2706    IF ( clo <= 0._wp )  clo = .001_wp
[3569]2707!
[3525]2708!-- f_cl = Increase in surface due to clothing
2709    f_cl = 1._wp + .15_wp * clo
[3569]2710!
[3525]2711!-- Case of free convection (ws < 0.1 m/s ) not considered
2712    ws = in_ws
[3742]2713    IF ( ws < .1_wp )  THEN
[3525]2714       ws = .1_wp
2715    ENDIF
[3569]2716!
[3525]2717!-- Heat_convection = forced convection
[3753]2718    heat_convection = 12.1_wp * SQRT( ws * pair / 1013.25_wp )
[3569]2719!
[3525]2720!-- Activity = inner heat produktion per standardized surface
2721    activity = actlev * ( 1._wp - eta )
[3569]2722!
[3525]2723!-- T_skin_aver = average skin temperature
2724    t_skin_aver = 35.7_wp - .0275_wp * activity
[3569]2725!
[3525]2726!-- Calculation of constants for evaluation below
2727    bc = .155_wp * clo * 3.96_wp * 10._wp**( -8 ) * f_cl
2728    cc = f_cl * heat_convection
2729    ec = .155_wp * clo
2730    dc = ( 1._wp + ec * cc ) / bc
2731    gc = ( t_skin_aver + bc * ( tmrt + degc_to_k )**4 + ec * cc * ta ) / bc
[3569]2732!
[3525]2733!-- Calculation of clothing surface temperature (t_clothing) based on
[3693]2734!-- Newton-approximation with air temperature as initial guess
[3525]2735    t_clothing = ta
[3742]2736    DO  i = 1, 3
[3525]2737       t_clothing = t_clothing - ( ( t_clothing + degc_to_k )**4 + t_clothing  &
2738          * dc - gc ) / ( 4._wp * ( t_clothing + degc_to_k )**3 + dc )
2739    ENDDO
[3569]2740!
[3525]2741!-- Empiric factor for the adaption of the heat ballance equation
[3693]2742!-- to the psycho-physical scale (Equ. 40 in FANGER)
[3753]2743    z1 = ( .303_wp * EXP( -.036_wp * actlev ) + .0275_wp )
[3569]2744!
[3525]2745!-- Water vapour diffution through the skin
2746    z2 = .31_wp * ( 57.3_wp - .07_wp * activity-pa )
[3569]2747!
[3525]2748!-- Sweat evaporation from the skin surface
2749    z3 = .42_wp * ( activity - 58._wp )
[3569]2750!
[3525]2751!-- Loss of latent heat through respiration
2752    z4 = .0017_wp * actlev * ( 58.7_wp - pa ) + .0014_wp * actlev *            &
2753      ( 34._wp - ta )
[3569]2754!
[3525]2755!-- Loss of radiational heat
2756    z5 = 3.96e-8_wp * f_cl * ( ( t_clothing + degc_to_k )**4 - ( tmrt +        &
2757       degc_to_k )**4 )
[3753]2758    IF ( ABS( t_clothing - tmrt ) > 0._wp )  THEN
[3525]2759       hr = z5 / f_cl / ( t_clothing - tmrt )
2760    ELSE
2761       hr = 0._wp
2762    ENDIF
[3569]2763!
[3525]2764!-- Heat loss through forced convection cc*(t_clothing-TT)
2765    z6 = cc * ( t_clothing - ta )
[3569]2766!
[3525]2767!-- Predicted Mean Vote
2768    pmva = z1 * ( activity - z2 - z3 - z4 - z5 - z6 )
2769
2770 END SUBROUTINE fanger
2771
2772!------------------------------------------------------------------------------!
2773! Description:
2774! ------------
2775!> For pmva > 0 and clo =0.5 the increment (deltapmv) is calculated
2776!> that converts pmva into Gagge's et al. (1986) PMV*.
2777!------------------------------------------------------------------------------!
2778 REAL(wp) FUNCTION deltapmv( pmva, ta, vp, svp_ta, tmrt, ws, nerr )
2779
2780    IMPLICIT NONE
[3693]2781
[3569]2782!
[3525]2783!-- Input variables of argument list:
2784    REAL(wp),     INTENT ( IN )  :: pmva     !< Actual Predicted Mean Vote (PMV) according to Fanger
2785    REAL(wp),     INTENT ( IN )  :: ta       !< Ambient temperature (degC) at screen level
2786    REAL(wp),     INTENT ( IN )  :: vp       !< Water vapour pressure (hPa) at screen level
2787    REAL(wp),     INTENT ( IN )  :: svp_ta   !< Saturation water vapour pressure (hPa) at ta
2788    REAL(wp),     INTENT ( IN )  :: tmrt     !< Mean radiant temperature (degC) at screen level
2789    REAL(wp),     INTENT ( IN )  :: ws       !< Wind speed (m/s) 1 m above ground
[3693]2790
[3569]2791!
[3525]2792!-- Output variables of argument list:
2793    INTEGER(iwp), INTENT ( OUT ) :: nerr     !< Error status / quality flag
[3693]2794                                             !<  0 = o.k.
2795                                             !< -2 = pmva outside valid regression range
2796                                             !< -3 = rel. humidity set to 5 % or 95 %, respectively
2797                                             !< -4 = deltapmv set to avoid pmvs < 0
2798
[3569]2799!
[3693]2800!-- Internal variables:
2801    REAL(wp) ::  pmv          !< temp storage og predicted mean vote
2802    REAL(wp) ::  pa_p50       !< ratio actual water vapour pressure to that of relative humidity of 50 %
2803    REAL(wp) ::  pa           !< vapor pressure (hPa) with hard bounds
2804    REAL(wp) ::  apa          !< natural logarithm of pa (with hard lower border)
2805    REAL(wp) ::  dapa         !< difference of apa and pa_p50
2806    REAL(wp) ::  sqvel        !< square root of local wind velocity
2807    REAL(wp) ::  dtmrt        !< difference mean radiation to air temperature
2808    REAL(wp) ::  p10          !< lower bound for pa
2809    REAL(wp) ::  p95          !< upper bound for pa
2810    REAL(wp) ::  weight       !<
2811    REAL(wp) ::  weight2      !<
[3525]2812    REAL(wp) ::  dpmv_1       !<
2813    REAL(wp) ::  dpmv_2       !<
2814    REAL(wp) ::  pmvs         !<
2815    INTEGER(iwp) :: nreg      !<
2816
[3569]2817!
[3753]2818!-- Regression coefficients:
2819    REAL(wp), DIMENSION(0:7), PARAMETER ::  bpmv = (/                          &
2820     -0.0556602_wp, -0.1528680_wp, -0.2336104_wp, -0.2789387_wp,               &
2821     -0.3551048_wp, -0.4304076_wp, -0.4884961_wp, -0.4897495_wp /)
2822
2823    REAL(wp), DIMENSION(0:7), PARAMETER ::  bpa_p50 = (/                       &
2824     -0.1607154_wp, -0.4177296_wp, -0.4120541_wp, -0.0886564_wp,               &
2825      0.4285938_wp,  0.6281256_wp,  0.5067361_wp,  0.3965169_wp /)
2826
2827    REAL(wp), DIMENSION(0:7), PARAMETER ::  bpa = (/                           &
2828      0.0580284_wp,  0.0836264_wp,  0.1009919_wp,  0.1020777_wp,               &
2829      0.0898681_wp,  0.0839116_wp,  0.0853258_wp,  0.0866589_wp /)
2830
2831    REAL(wp), DIMENSION(0:7), PARAMETER ::  bapa = (/                          &
2832     -1.7838788_wp, -2.9306231_wp, -1.6350334_wp,   0.6211547_wp,              &
2833      3.3918083_wp,  5.5521025_wp,  8.4897418_wp,  16.6265851_wp /)
2834
2835    REAL(wp), DIMENSION(0:7), PARAMETER ::  bdapa = (/                         &
2836      1.6752720_wp,  2.7379504_wp,  1.2940526_wp,  -1.0985759_wp,              &
2837     -3.9054732_wp, -6.0403012_wp, -8.9437119_wp, -17.0671201_wp /)
2838
2839    REAL(wp), DIMENSION(0:7), PARAMETER ::  bsqvel = (/                        &
2840     -0.0315598_wp, -0.0286272_wp, -0.0009228_wp,  0.0483344_wp,               &
2841      0.0992366_wp,  0.1491379_wp,  0.1951452_wp,  0.2133949_wp /)
2842
2843    REAL(wp), DIMENSION(0:7), PARAMETER ::  bta = (/                           &
2844      0.0953986_wp,  0.1524760_wp,  0.0564241_wp, -0.0893253_wp,               &
2845     -0.2398868_wp, -0.3515237_wp, -0.5095144_wp, -0.9469258_wp /)
2846
2847    REAL(wp), DIMENSION(0:7), PARAMETER ::  bdtmrt = (/                        &
2848     -0.0004672_wp, -0.0000514_wp, -0.0018037_wp, -0.0049440_wp,               &
2849     -0.0069036_wp, -0.0075844_wp, -0.0079602_wp, -0.0089439_wp /)
2850
2851    REAL(wp), DIMENSION(0:7), PARAMETER ::  aconst = (/                        &
2852      1.8686215_wp,  3.4260713_wp,   2.0116185_wp,  -0.7777552_wp,             &
2853     -4.6715853_wp, -7.7314281_wp, -11.7602578_wp, -23.5934198_wp /)
2854
2855
2856!
[3525]2857!-- Test for compliance with regression range
[3742]2858    IF ( pmva < -1.0_wp  .OR.  pmva > 7.0_wp )  THEN
[3525]2859       nerr = -2_iwp
2860    ELSE
2861       nerr = 0_iwp
2862    ENDIF
[3569]2863!
[3525]2864!-- Initialise classic PMV
2865    pmv  = pmva
[3569]2866!
[3525]2867!-- Water vapour pressure of air
2868    p10  = 0.05_wp * svp_ta
2869    p95  = 1.00_wp * svp_ta
[3742]2870    IF ( vp >= p10  .AND.  vp <= p95 )  THEN
[3525]2871       pa = vp
2872    ELSE
2873       nerr = -3_iwp
[3742]2874       IF ( vp < p10 )  THEN
[3569]2875!
[3525]2876!--       Due to conditions of regression: r.H. >= 5 %
2877          pa = p10
2878       ELSE
[3569]2879!
[3525]2880!--       Due to conditions of regression: r.H. <= 95 %
2881          pa = p95
2882       ENDIF
2883    ENDIF
[3742]2884    IF ( pa > 0._wp )  THEN
[3569]2885!
[3525]2886!--    Natural logarithm of pa
[3753]2887       apa = LOG( pa )
[3525]2888    ELSE
2889       apa = -5._wp
2890    ENDIF
[3569]2891!
[3525]2892!-- Ratio actual water vapour pressure to that of a r.H. of 50 %
2893    pa_p50   = 0.5_wp * svp_ta
[3742]2894    IF ( pa_p50 > 0._wp  .AND.  pa > 0._wp )  THEN
[3753]2895       dapa   = apa - LOG( pa_p50 )
[3525]2896       pa_p50 = pa / pa_p50
2897    ELSE
2898       dapa   = -5._wp
2899       pa_p50 = 0._wp
2900    ENDIF
[3569]2901!
[3525]2902!-- Square root of wind velocity
[3742]2903    IF ( ws >= 0._wp )  THEN
[3753]2904       sqvel = SQRT( ws )
[3525]2905    ELSE
2906       sqvel = 0._wp
2907    ENDIF
[3569]2908!
[3525]2909!-- Difference mean radiation to air temperature
2910    dtmrt = tmrt - ta
[3569]2911!
[3525]2912!-- Select the valid regression coefficients
[3753]2913    nreg = INT( pmv )
[3742]2914    IF ( nreg < 0_iwp )  THEN
[3569]2915!
[3525]2916!--    value of the FUNCTION in the case pmv <= -1
2917       deltapmv = 0._wp
2918       RETURN
2919    ENDIF
[3693]2920    weight = MOD ( pmv, 1._wp )
[3742]2921    IF ( weight < 0._wp )  weight = 0._wp
2922    IF ( nreg > 5_iwp )  THEN
[3525]2923       nreg  = 5_iwp
[3693]2924       weight   = pmv - 5._wp
2925       weight2  = pmv - 6._wp
[3742]2926       IF ( weight2 > 0_iwp )  THEN
[3693]2927          weight = ( weight - weight2 ) / weight
[3525]2928       ENDIF
2929    ENDIF
[3569]2930!
[3753]2931!-- Regression valid for 0. <= pmv <= 6., bounds are checked above
[3525]2932    dpmv_1 =                                                                   &
[3742]2933       + bpa(nreg) * pa                                                        &
2934       + bpmv(nreg) * pmv                                                      &
2935       + bapa(nreg) * apa                                                      &
2936       + bta(nreg) * ta                                                        &
2937       + bdtmrt(nreg) * dtmrt                                                  &
2938       + bdapa(nreg) * dapa                                                    &
2939       + bsqvel(nreg) * sqvel                                                  &
2940       + bpa_p50(nreg) * pa_p50                                                &
2941       + aconst(nreg)
[3525]2942
[3753]2943!    dpmv_2 = 0._wp
2944!    IF ( nreg < 6_iwp )  THEN  !< nreg is always <= 5, see above
2945    dpmv_2 =                                                                   &
2946       + bpa(nreg+1_iwp)     * pa                                              &
2947       + bpmv(nreg+1_iwp)    * pmv                                             &
2948       + bapa(nreg+1_iwp)    * apa                                             &
2949       + bta(nreg+1_iwp)     * ta                                              &
2950       + bdtmrt(nreg+1_iwp)  * dtmrt                                           &
2951       + bdapa(nreg+1_iwp)   * dapa                                            &
2952       + bsqvel(nreg+1_iwp)  * sqvel                                           &
2953       + bpa_p50(nreg+1_iwp) * pa_p50                                          &
2954       + aconst(nreg+1_iwp)
2955!    ENDIF
[3569]2956!
[3525]2957!-- Calculate pmv modification
[3693]2958    deltapmv = ( 1._wp - weight ) * dpmv_1 + weight * dpmv_2
[3525]2959    pmvs = pmva + deltapmv
[3742]2960    IF ( ( pmvs ) < 0._wp )  THEN