Changes between Version 2 and Version 3 of doc/app/iofiles/pids/aerosol


Ignore:
Timestamp:
Dec 2, 2019 2:55:38 PM (5 years ago)
Author:
monakurppa
Comment:

Inital version of the aerosol (salsa) driver documentation

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/iofiles/pids/aerosol

    v2 v3  
    11== [=#salsa_input '''Aerosol input file'''] ==
    22
    3 The aerosol input file contains information needed to setup aerosol emissions. Aerosol emission value can be given applying two alternative level of detail (lod): 1 or 2. See [../../../tec/aerosol aerosol module documentation] for further details.
     3The aerosol (salsa) driver contains surface-emission information of aerosol particles for the aerosol module SALSA. Aerosol emissions can be given using two levels of detail (lod):
     4 * lod=1: given as total mass emissions per emission category without information on the size distribution
     5 * lod=2: given as total aerosol number containing information also on the aerosol size distribution
    46
    5 ||='''Variables'''  =||='''Type''' =||='''Explanation / Remarks'''  =||
     7----
     8
     9=== [=#attr '''Global attributes'''] ===
     10
     11No mandatory attributes. For good documentation, please consider applying global attributes listed for the [../static static driver].
     12
     13----
     14
     15=== [=#attrlist '''List of attributes'''] ===
     16The following list gives an overview of attributes that can be assigned to variables in an aerosol driver file.
     17||='''Attribute'''  =||= '''Type'''  =||= '''Value''' =||= '''Description''' =||
     18||{{{_FillValue}}}   || Variable-specific || Variable-specific       || Fill value for missing data ||
     19||{{{lod}}}          || NC_INT   || Variable-specific                || Level of detail used for some variables ||
     20||{{{long_name}}}    || NC_CHAR  || Variable-specific                || Variable long name ||
     21||{{{source}}}       || NC_CHAR  || Variable-specific                || Data source ||
     22||{{{units}}}        || NC_CHAR  || Variable-specific                || Units of the variable ||
     23
     24----
     25
     26=== [=#dimensions '''List of dimensions'''] ===
     27The following list provides an overview of all dimension variables that can be used in an aerosol driver file.
     28||='''Dimension'''  =||= '''Type'''  =||= '''Value''' =||= '''Description''' =||
     29||''composition_index'' || NC_INT || - || Index of each chemical component in [#composition_name ''composition_name''] and [#emission_mass_fracs ''emission_mass_fracs''] ||
     30||''max_string_length'' || NC_INT || 25 || Maximum string length in [#composition_name ''composition_name''] and [#emission_category_name ''emission_category_name''] ||
     31||''ncat'' || NC_INT || - || number of elements in [#pavement_pars ''pavement_pars''] ||
     32||''npavement_subsurface_pars'' || NC_INT || 2 || Number of emission categories in [#emission_category_name ''emission_category_name''], [#emission_mass_fracs ''emission_mass_fracs''], [#emission_number_fracs ''emission_number_fracs''] and [#aerosol_emission_values ''aerosol_emission_values''] ||
     33||''nhoursyear'' || NC_INT || 8760/8784 || Number of hours per year in [#emission_time_factors ''emission_time_factors''] (sum must equal to 1). ||
     34{{{#!td style="vertical-align:top"
     35[=#composition_name ''nmonthdayhour'']
     36}}}
     37{{{#!td style="vertical-align:top"
     38NC_INT
     39}}}
     40{{{#!td style="vertical-align:top"
     4191
     42}}}
     43{{{#!td style="vertical-align:top"
     44Number of required input values for emission time rescaling factors in [#emission_time_factors ''emission_time_factors'']:\\
     45   {{{#!td
     46         ||= ''Index'' =||= Description  =||
     47         ||  1-12  ||scaling per month (sum must be 1)                  ||
     48         ||  13-19 ||scaling per day of week (sum must be 1)            ||
     49         ||  20-43 ||scaling per hour for a working day (sum must be 1) ||
     50         ||  44-67 ||scaling per hour for a Saturday (sum must be 1)    ||
     51         ||  68-91 ||scaling per hour for a Sunday (sum must be 1)      ||
     52
     53   }}}
     54}}}
     55
     56----
     57
     58=== [=#coordinates '''List of coordinate variables'''] ===
     59The following list provides an overview of all coordinate variables that can be used in an aerosol driver file.
     60||='''Variable'''   =||= '''Type'''  =||='''Attributes''' =||= '''Remarks''' =||
     61||''Dmid''              || NC_FLOAT ||{{{long_name="geometric mean diameter of an aerosol size bin}}}\\{{{units="m"}}} || Geometric mean diameter of a aerosol size bin (in m). Has to conform the size bin description given using [wiki:doc/app/salsa_parameters#nbin nbin] and [wiki:doc/app/salsa_parameters#nbin reglim] in salsa_parameters. ||
     62||''time''              || NC_FLOAT ||{{{long_name="time}}}\\{{{units="seconds since YYYYMMDD hh:mm UTC"}}} || Time in seconds since the beginning of the simulation (in UTC time). E.g., 7am (UTC+3) = 14400 ||
     63||''x''              || NC_FLOAT ||{{{axis="X"}}}\\{{{long_name="distance to origin in x-direction}}}\\{{{units="m"}}} || ||
     64||''y''              || NC_FLOAT ||{{{axis="Y"}}}\\{{{long_name="distance to origin in y-direction}}}\\{{{units="m"}}} || ||
     65
     66----
     67
     68=== [=#emission_cat '''Emission categories'''] ===
     69The following list provides an overview of all variables to describe the emission categories in an aerosol driver file.
     70
     71||='''Input variable'''  =||='''Type'''  =||='''Attributes''' =||='''Remarks'''  =||
     72||[=#emission_category_index ''emission_category_index(ncat)'']   || NC_BYTE       ||{{{long_name="emission category index"}}}  || Index of the emission category(ies) given in [#emission_category_name ''emission_category_name'']. ||
     73||[=#emission_category_name ''emission_category_name(ncat,max_string_length)''] || NC_CHAR     ||{{{long_name="emission category name"}}} || Currently available categories:
     74"traffic exhaust",
     75"road dust" and
     76"wood combustion".
     77Applied to construct size distributions for aerosol emissions if {{{aerosol_emission_values:lod=1}}}, i.e., the size distributions are not specifically given using [#emission_numbers_fracs ''emission_number_fracs'']. ||
     78
     79----
     80
     81=== [=#emission_number_mass_fracs '''Number size distribution and mass composition of aerosol emission per category'''] ===
     82The following list provides an overview of all variables to describe the number size distribution and mass composition of aerosol emissions in an aerosol driver file.
     83
     84||='''Input variable'''  =||='''Type'''  =||='''Attributes''' =||='''Remarks'''  =||
     85{{{#!td style="vertical-align:top"
     86[=#composition_name ''composition_name(composition_index,max_string_length)'']
     87}}}
     88{{{#!td style="vertical-align:top"
     89NC_CHAR
     90}}}
     91{{{#!td style="vertical-align:top"
     92{{{long_name="aerosol composition name"}}}
     93}}}
     94{{{#!td style="vertical-align:top"
     95Name of different chemical components in [#emission_mass_fracs ''emission_mass_fracs'']. List of the available chemical components:\\
     96   {{{#!td
     97         ||= ''Component'' =||= Description  =||
     98         ||  'H2SO4', 'SO4', 'h2so4', 'so4'          ||Sulphur / sulphuric acid ||
     99         ||  'OC', 'oc'                              ||Organic carbon           ||
     100         ||  'BC', 'bc'                              ||Black carbon             ||
     101         ||  'DU', 'du'                              ||Dust                     ||
     102         ||  'SS', 'ss'                              ||Sea salt                 ||
     103         ||  'HNO3', 'NO3', 'NO', 'hno3', 'no3', 'no'||Nitrares / nitric acid   ||
     104         ||  'NH3', 'NH4', 'NH', 'nh3', 'nh4', 'nh'  ||Ammonium / ammonia       ||
     105
     106   }}}
     107}}}
    6108|----------------
    7 {{{#!td style="vertical-align:top;width: 150px"
    8 [=#aerosol_emission_values '''aerosol_emission_values''']//
    9 ((time),y,x,ncat)
     109{{{#!td style="vertical-align:top"
     110[=#emission_mass_fracs ''emission_mass_fracs(ncat,composition_index)'']
    10111}}}
    11 {{{#!td style="vertical-align:top;width: 50px"
     112{{{#!td style="vertical-align:top"
    12113NC_FLOAT
    13114}}}
    14 {{{#!td
    15 Emission values of aerosol particles. The coordinates vary based on the chosen level of detail.\\
    16 
    17 {{{lod=1}}}: Emissions are provided per emission category and yearly as total PM in dimensions {{{aerosol_emission_values(y,x,ncat)}}}. They are then scaled by pre-defined rescaling factors '''emission_time_factors'''. Default categories are ''traffic exhaust'', ''road dust'', ''wood combustion'', ''other''.//
    18 
    19 {{{lod=2}}}: Emissions are provided per emission category at given points in time and space in dimensions {{{aerosol_emission_values(time,y,x,ncat)}}} and in units # m^-2^ s^-1^. Total number emissions are then scaled to size bins by '''emission_number_fracs'''.
     115{{{#!td style="vertical-align:top"
     116{{{_FillValue=-9999.f}}}\\{{{long_name="mass fractions of chemical components in aerosol emissions"}}}
     117}}}
     118{{{#!td style="vertical-align:top"
     119Mass fraction of different chemical components listed in [#composition_name ''composition_name''].
    20120}}}
    21121|----------------
    22 {{{#!td style="vertical-align:top;width: 150px"
    23 [=#composition_name '''composition_name''']//
    24 (composition_index,max_string_length)
     122{{{#!td style="vertical-align:top"
     123[=#emission_number_fracs ''emission_number_fracs(ncat,Dmid)'']
    25124}}}
    26 {{{#!td style="vertical-align:top;width: 50px"
    27 NC_CHAR
    28 }}}
    29 {{{#!td
    30 List of chemical components of aerosol particles.
    31 }}}
    32 |----------------
    33 {{{#!td style="vertical-align:top;width: 150px"
    34 [=#emission_category_index '''emission_category_index''']//
    35 (ncat)
    36 }}}
    37 {{{#!td style="vertical-align:top;width: 50px"
    38 NC_BYTE
    39 }}}
    40 {{{#!td
    41 Category index of the emission quantity in question (e.g. 1 = traffic emissions). {{{lod=1}}} only.
    42 }}}
    43 |----------------
    44 {{{#!td style="vertical-align:top;width: 150px"
    45 [=#emission_category_name '''emission_category_name''']//
    46 (ncat,max_string_length)
    47 }}}
    48 {{{#!td style="vertical-align:top;width: 50px"
    49 NC_CHAR
    50 }}}
    51 {{{#!td
    52 Emission categories names (match to emission_category_index of the same index element). {{{lod=1}}} only.
    53 }}}
    54 |----------------
    55 {{{#!td style="vertical-align:top;width: 150px"
    56 [=#emission_mass_fracs '''emission_mass_fracs''']//
    57 ((ncat),composition_index)
    58 }}}
    59 {{{#!td style="vertical-align:top;width: 50px"
     125{{{#!td style="vertical-align:top"
    60126NC_FLOAT
    61127}}}
    62 {{{#!td
    63 Mass fractions of chemical components in aerosol emissions.
     128{{{#!td style="vertical-align:top"
     129{{{_FillValue=-9999.f}}}\\{{{long_name="number fractions of aerosol size bins in aerosol emissions"}}}
    64130}}}
    65 |----------------
    66 {{{#!td style="vertical-align:top;width: 150px"
    67 [=#emission_number_fracs '''emission_number_fracs''']//
    68 (ncat,Dmid)
     131{{{#!td style="vertical-align:top"
     132Number fraction of each aerosol size bin. Bin mean diameters are given in [#Dmid ''Dmid'']. Only applied when {{{aerosol_emission_values:lod=2}}}.
    69133}}}
    70 {{{#!td style="vertical-align:top;width: 50px"
     134
     135----
     136
     137=== [=#temporal_scaling '''Temporal scaling variables'''] ===
     138The following list provides an overview of all variables used to scale [#aerosol_emission_values ''aerosol_emission_values''] if {{{aerosol_emission_values:lod=1}}}.
     139
     140||='''Input variable'''  =||='''Type'''  =||='''Attributes''' =||='''Remarks'''  =||
     141{{{#!td style="vertical-align:top"
     142[=#emission_time_factors ''emission_time_factors(ncat,[nmonthday],[nhoursyear])'']
     143}}}
     144{{{#!td style="vertical-align:top"
    71145NC_FLOAT
    72146}}}
    73 {{{#!td
    74 Number fractions of each size bin per emission category in aerosol emissions.
     147{{{#!td style="vertical-align:top"
     148{{{lod=1/2}}}\\{{{long_name="emission time scaling factors"}}}
    75149}}}
    76 |----------------
    77 {{{#!td style="vertical-align:top;width: 150px"
    78 [=#emission_time_factors '''emission_time_factors''']//
    79 (ncat,(nhoursyear),(nmonthdayhour))
     150{{{#!td style="vertical-align:top"
     151Emission time scaling factors for aerosol_emission_values. Two levels of detail (lod) are possible:\\
     152 * lod=1: scaling according to month-day-hour classification (see nmonthdayhour)
     153 * lod=2: scaling for each hour of the year (see nhoursyear)
    80154}}}
    81 {{{#!td style="vertical-align:top;width: 50px"
     155
     156----
     157
     158=== [=#emission_values '''Surface emission data'''] ===
     159In order to enable surface emissions of aerosol particles, one must set [wiki:doc/app/salsa_parameters#salsa_emission_mode salsa_emission_mode]  = 'read_from_file' in salsa_parameters.
     160
     161||='''Input variable'''  =||='''Type'''  =||='''Attributes''' =||='''Remarks'''  =||
     162{{{#!td style="vertical-align:top"
     163[=#aerosol_emission_values ''aerosol_emission_values([time],y,x,ncat)'']
     164}}}
     165{{{#!td style="vertical-align:top"
    82166NC_FLOAT
    83167}}}
    84 {{{#!td
    85 Emission time scaling factors for emission_values ({{{lod=1}}}). Two different time factors are possible: 1) Scaling according to month‑day‑hour classification ({{{emission_time_factors(ncat,nmonthdayhour)}}}), or scaling for each hour of the year ({{{emission_time_factors(ncat,nhoursyear)}}}).
     168{{{#!td style="vertical-align:top"
     169{{{_FillValue=-9999.f}}}\\{{{lod=1/2}}}\\{{{long_name="aerosol emission values"}}}\\{{{units='#/m2/s'}}}
    86170}}}
     171{{{#!td style="vertical-align:top"
     172Emission values of aerosol particles. The coordinates vary based on the chosen level of detail.\\
     173 * {{{lod=1}}}: Emissions are provided per emission category and yearly as total PM in dimensions {{{aerosol_emission_values(y,x,ncat)}}}. They are then scaled by pre-defined rescaling factors [#emission_time_factors ''emission_time_factors'']. Default categories are traffic exhaust, road dust, wood combustion, other.
     174 * {{{lod=2}}}: Emissions are provided per emission category at given points in time and space in dimensions {{{aerosol_emission_values(time,y,x,ncat)}}} and in units # m^-2^ s^-1^. Total number emissions are then scaled to size bins by [#emission_number_fracs ''emission_number_fracs''].
     175}}}
     176
     177
     178----
     179
     180=== [=#example '''Example static driver file] ===
     181{{{
     182#!div style="align:'left'; width: 400px; border: 0px solid; float:right"
     183
     184}}}
     185An example aerosol driver file can be downloaded [https://palm.muk.uni-hannover.de/trac/browser/palm/trunk/TESTS/cases/urban_environment_salsa here].