Changes between Version 16 and Version 17 of doc/app/iofiles/pids/static


Ignore:
Timestamp:
Nov 25, 2019 2:21:01 PM (5 years ago)
Author:
maronga
Comment:

--

Legend:

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

    v16 v17  
    4040||[=#source ''source'']   || NC_CHAR    || User-defined text  ||
    4141||[=#title ''title'']     || NC_CHAR    || Short description, e.g., {{{"PALM input file for scenario 1b"}}} ||
    42 ||[=#version''version'']  || NC_INT     || e.g. {{{"1"}}} ||
     42||[=#version ''version'']  || NC_INT     || e.g. {{{"1"}}} ||
    4343'''(*) are mandatory attributes'''
    4444
    4545
    4646\\\\
    47 === [=#topo '''Topography:] ===
     47=== [=#topo '''Topography set-up:] ===
    4848
    4949In order to prescribe topography from the static input file, [wiki:doc/app/inipar#topography topography] = 'read_from_file' is required.
    5050
    5151||='''Input variable'''  =||='''Type'''  =||='''Attributes''' =||='''Explanation / Remarks'''  =||
    52 ||[=#building_id ''building_id(y,x)'']   || NC_INT       ||{{{_FillValue=-9999}}}\\{{{coordinates}}}\\{{{grid_mapping}}}\\{{{long_name="building_id_number"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}  || The building ID is used to identify single building envelopes which are composed of a number of grid volumes, and which is used for correct mapping of buildings on top of the underlying terrain, as well as for the [#indoor_model indoor_model]. Please note, '''building_id''' must not contain any {{{_FillValue}}} at grid points where buildings are is defined via [#building_2d building_2d] or [#building_3d building_3d].
    53 ||[=#buildings_2d ''buildings_2d(y,x)''] || NC_FLOAT     ||{{{_FillValue=-9999.f}}}\\{{{coordinates}}}\\{{{grid_mapping}}}\\{{{lod}}}=1\\{{{long_name="building_height"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="m"}}} || Two-dimensional building height in m relative to the underlying terrain. No holes or overhanging structures are possible. ''buildings_2d'' will be mounted on top of the maximum local terrain height occupied by the respective building. Please note, ''buildings_2d'' will not be used if [#buildings_3d buildings_3d] is present on file. If ''buildings_2d'' is used [#building_id building_id] is required. ||
    54 ||[=#buildings_3d ''buildings_3d(z,y,x)''] || NC_BYTE     ||{{{_FillValue=-127b}}}\\{{{coordinates}}}\\{{{flag_meanings="no building, building"}}}\\ {{{flag_values=0b, 1b}}}\\{{{grid_mapping}}}\\{{{long_name="building_flag"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}\\{{{valid_range=0b,1b}}} || Three-dimensional building topology relative to the underlying terrain. ''buildings_3d'' will be mapped on top of the maximum local terrain height occupied by the respective building. Note, ''buildings_3d'' does not need to be prescribed beyond the top level of the highest buildings, i.e. ''z'' dimension can me minimized accordingly. If ''buildings_3d'' is prescribed, [#building_id building_id] is required. 
    55 ||[=#obstruction_uv ''obstruction_uv(azimuth_uv,zenith_uv,y,x)''] || NC_BYTE     ||{{{_FillValue=-127b}}}\\{{{coordinates}}}\\{{{flag_meanings="no obstruction, obstruction"}}}\\{{{flag_values=0b, 1b}}}\\{{{grid_mapping}}}\\{{{long_name="obstruction"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}\\{{{valid_range=0b,1b}}}  || Obstruction of the sky at a pixel location (y,x). This field is needed only if the [wiki:doc/app/biometeorology_parameters#UVExposureModel UV exposure model] is used. ||
    56 ||[=#zt ''zt(y,x)'']                       || NC_FLOAT     ||{{{long_name="terrain_height"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="m"}}}\\{{{_FillValue=-9999.0}}} \\{{{coordinates}}}\\{{{grid_mapping}}} || Terrain height in m relative to [#origin_z origin_z]. If not provided, the relative terrain height will be set to 0 m all over the model domain. Please note, ''zt'' must not contain any {{{_FillValues}}}. ||
     52||[=#building_id ''building_id(y,x)'']   || NC_INT       ||{{{_FillValue=-9999}}}(*)\\{{{coordinates}}}\\{{{grid_mapping}}}\\{{{long_name="building_id_number"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}  || The building ID is used to identify single building envelopes which are composed of a number of grid volumes, and which is used for correct mapping of buildings on top of the underlying terrain, as well as for the [#indoor_model indoor_model]. Please note, '''building_id''' must not contain any {{{_FillValue}}} at grid points where buildings are is defined via [#building_2d building_2d] or [#building_3d building_3d].
     53||[=#buildings_2d ''buildings_2d(y,x)''] || NC_FLOAT     ||{{{_FillValue=-9999.f}}}(*)\\{{{coordinates}}}\\{{{grid_mapping}}}\\{{{lod}}}=1\\{{{long_name="building_height"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="m"}}} || Two-dimensional building height in m relative to the underlying terrain. No holes or overhanging structures are possible. ''buildings_2d'' will be mounted on top of the maximum local terrain height occupied by the respective building. Please note, ''buildings_2d'' will not be used if [#buildings_3d buildings_3d] is present on file. If ''buildings_2d'' is used [#building_id building_id] is required. ||
     54||[=#buildings_3d ''buildings_3d(z,y,x)''] || NC_BYTE     ||{{{_FillValue=-127b}}}(*)\\{{{coordinates}}}\\{{{flag_meanings="no building, building"}}}\\ {{{flag_values=0b, 1b}}}\\{{{grid_mapping}}}\\{{{long_name="building_flag"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}\\{{{valid_range=0b,1b}}} || Three-dimensional building topology relative to the underlying terrain. ''buildings_3d'' will be mapped on top of the maximum local terrain height occupied by the respective building. Note, ''buildings_3d'' does not need to be prescribed beyond the top level of the highest buildings, i.e. ''z'' dimension can me minimized accordingly. If ''buildings_3d'' is prescribed, [#building_id building_id] is required. 
     55||[=#obstruction_uv ''obstruction_uv(azimuth_uv,zenith_uv,y,x)''] || NC_BYTE     ||{{{_FillValue=-127b}}}(*)\\{{{coordinates}}}\\{{{flag_meanings="no obstruction, obstruction"}}}\\{{{flag_values=0b, 1b}}}\\{{{grid_mapping}}}\\{{{long_name="obstruction"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="1"}}}\\{{{valid_range=0b,1b}}}  || Obstruction of the sky at a pixel location (y,x). This field is needed only if the [wiki:doc/app/biometeorology_parameters#UVExposureModel UV exposure model] is used. ||
     56||[=#zt ''zt(y,x)'']                       || NC_FLOAT     ||{{{_FillValue=-9999.0}}}(*)\\{{{coordinates}}}\\{{{grid_mapping}}}\\{{{long_name="terrain_height"}}}\\{{{res_orig}}}\\{{{source}}}\\{{{units="m"}}} || Terrain height in m relative to [#origin_z origin_z]. If not provided, the relative terrain height will be set to 0 m all over the model domain. Please note, ''zt'' must not contain any {{{_FillValues}}}. ||
     57'''(*) are mandatory attributes'''
    5758\\\\
    5859
     
    384385[#vegetation_type vegetation_type]. When [#vegetation_type vegetation_type] = 0, the '''root_area_density_s''' must be set.
    385386}}}
     387\\\\
     388=== [=#example '''Example static driver file:] ===
     389soon.
    386390\\\\\\