= Biometeorology parameters =
[[TracNav(doc/app/partoc|nocollapse)]]

== Biometeorology Module ==

With r3XXX a Biometeorology Module (Biomet_Mod) was implemented in PALM. It can provide spatially distributed values of the three thermal indices 

- Perceived Temperature (PT, see Staiger et al. (2012))
- Universal Thermal Climate Index (UTCI, see Jendritzky et al. (2012))
- Physiologically Equivalent Temperature (PET, see Höppe (1993))

that describe thermal perception / thermal stress of a sample human being under the local meteorological conditions. 

[=#steering '''Steering:]\\
\\\\
NAMELIST group name: [=#inipar '''biometeorology_parameters''']\\
----
The module is enabled as soon as the namelist biometeorology_parameters exists. The calculation of the individual indices can be '''switched off (default is on)''' by setting them to .F. This of course requires the Biomet_Mod to be enabled (see above).

||='''Parameter Name'''  =||='''[[../fortrantypes|FORTRAN]]\\[[../fortrantypes|Type]]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top; width: 150px"
[=#biom_pt '''biom_pt''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
L
}}}
{{{#!td style="vertical-align:top; width: 75px"
.T.
}}}
{{{#!td
Switch the calculation of Perceived Temperature off (.F.) or on (.T.).
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#biom_utci '''biom_utci''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
L
}}}
{{{#!td style="vertical-align:top; width: 75px"
.T.
}}}
{{{#!td
Switch the calculation of Universal Thermal Climate Index off (.F.) or on (.T.).
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#biom_pet '''biom_pet''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
L
}}}
{{{#!td style="vertical-align:top; width: 75px"
.T.
}}}
{{{#!td 
Switch the calculation of Physiologically Equivalent Temperature off (.F.) or on (.T.).
}}}
|----------------

\\\\




==== Output ====

Output by the Biomet_Mod is always two dimensional and is provided for the cell level closest to 1.1 m above ground level. All parameters are available for instantaneous and time-averaged input. A list of output quantities can be found below.
Output can be written to 2d and/or 3d files, where only the layer z=0 will be used.
To enable the output of the given quantity, please add
||= '''quantity''' =||= '''long name''' =||= '''unit''' =||= '''input type\\(instantaneous or averaged)''' =||= '''output file\\(2d or 3d)''' =||
|----------------
 {{{#!td style="vertical-align:top; width: 50px"
'biom_pt'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Perceived Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pet'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Physiologically Equivalent Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_utci'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Universal Thermal Climate Index
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pt_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Perceived Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pet_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Physiologically Equivalent Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_utci_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Universal Thermal Climate Index
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
z=0 layer in 3d file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pt_xy'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Perceived Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pet_xy'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Physiologically Equivalent Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_utci_xy'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Universal Thermal Climate Index
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
instantanious input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pt_xy_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Perceived Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_pet_xy_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Physiologically Equivalent Temperature
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
{{{#!td style="vertical-align:top; width: 50px"
'biom_utci_xy_av'
}}}
 {{{#!td style="vertical-align:top; width: 50px"
Universal Thermal Climate Index
}}}
 {{{#!td style="vertical-align:top; width: 50px"
°C
}}}
 {{{#!td style="vertical-align:top; width: 50px"
averaged input
}}}
 {{{#!td style="vertical-align:top; width: 50px"
2d (xy) file
}}}
||
|----------------
to the 
'''data_output'''  
section.

\\\\




==== Proofs: ====
- Staiger, H.; Laschewski, G.; and Graetz, A., 2012: The perceived temperature - a versatile index for the assessment of the human thermal environment. Part A: scientific basics. International Journal of Biometeorology 56(1), 165–176. doi: 10.1007/s00484-011-0409-6.
- Jendritzky, G.; Dear, de R.; and Havenith, G., 2012: UTCI-Why another thermal index? Int J Biometeorol (56), 421–428.
- Höppe, P. R., 1999: The physiological equivalent temperature – a universal index for the biometeorological assessment of the thermal environment. Int J Biometeorol 43, 71–75.\\



== UV Exposure Module ==

With r3XXX a UV exposure Module (uv_exposure_model_mod) was implemented in PALM. It calculates 2-dimensional maps of the vitamin D3-weighted UV exposure of a human for unobstructed environments(Seckmeyer at al., 2013) and obstructed environments (within a city) (Schrempf at al. 2017a, Schrempf at al. 2017b). 

[=#steering '''Steering:]\\
\\\\
NAMELIST group name: [=#inipar '''biometeorology_parameters''']\\
----
The module is enabled as soon as the namelist biometeorology_parameters exists. 

||='''Parameter Name'''  =||='''[[../fortrantypes|FORTRAN]]\\[[../fortrantypes|Type]]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top; width: 150px"
[=#consider_obstructions '''consider_obstructions''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
I
}}}
{{{#!td style="vertical-align:top; width: 75px"
1
}}}
{{{#!td
Considers obstruction (e.g. from buildings and trees).

Value 1: consider obstructions ON (default value)\\
Value 0: consider obstructions OFF

Obstructions file must be calculated manually before the stimulation and provided as NetCDF in the INPUT folder. 
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#clothing '''clothing''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
I
}}}
{{{#!td style="vertical-align:top; width: 75px"
1
}}}
{{{#!td
Choose clothing outfit for human model. 

Value 0: no clothing (also no hair).\\
Value 1: Spring /Summer outfit (arms, hands & face exposed).\\
Value 2: Winter outfit (only, hands & face exposed).
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#orientation_angle '''orientation_angle''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
F
}}}
{{{#!td style="vertical-align:top; width: 75px"
180.0
}}}
{{{#!td 
Orientation angle of front/face of the human model. 
Only active if also parameter '''turn_to_sun''' is set to 0.
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#saa_in_south '''saa_in_south''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
I
}}}
{{{#!td style="vertical-align:top; width: 75px"
1
}}}
{{{#!td 
Azimuthal position of the sun.

Value 0: Azimuthal position of the sun is always south (180°).\\
Value 1: Actual azimuthal position of the sun is calculated based of the current date and time within the simulation. The following parameters are used as input for the solar position calculation: time_utc_init, day_of_year_init, latitude, longitude.
}}}
||
{{{#!td style="vertical-align:top; width: 150px"
[=#turn_to_sun '''turn_to_sun''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
I
}}}
{{{#!td style="vertical-align:top; width: 75px"
1
}}}
{{{#!td 
Orientation of the front/face of the human model.

Value 1: Front/face of the human model is always orientated in direction of the sun.\\
Value 1: Front/face of the human model is orientated towards a specific direction (set by the parameter orientation_angle).
}}}
|----------------

\\\\




==== Output ====






==== [#steering Steering] ====
==== [#string2 String2] ====
==== [#string3 String3] ====

Since r31xx biometeorology models are available in PALM....Biomet_Mod and UV exposure....

Short description of both modules. From here, we will then link to more detailed descriptions.

\\\\
NAMELIST group name: [=#biometpar '''biometeorology_parameters''']\\
----
\\\\
[=#steering '''Steering:]\\
||='''Parameter Name'''  =||='''[[../fortrantypes|FORTRAN]]\\[[../fortrantypes|Type]]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top; width: 150px"
[=#land_category '''land_category''']
}}}
{{{#!td style="vertical-align:top; width: 50px"
I
}}}
{{{#!td style="vertical-align:top; width: 75px"
1
}}}
{{{#!td
Category for land surface.\\\\
Here, a detailed description follows...Maybe also link to an example input file.
}}}
|----------------