Changes between Initial Version and Version 1 of doc/app/iofiles/pids/static

Timestamp:

Jul 2, 2019 1:24:05 PM (6 years ago)

Author:

scharf

Comment:

--

doc/app/iofiles/pids/static

@@ +1 @@
+== [=#static_input '''Static input file'''] ==
+
+The static input file encompasses topography information as well as all necessary information file to initialize all land- and urban-type surfaces in the model, such as heat capacities, roughness, albedo, emissivity, etc..
+The initialization procedure for the surfaces follows a multi-step approach, depending on the given level of detail of each variable as provided in the static input file. 
+In a first step, surfaces are initialized horizontally homogeneous with a bulk classification for each type (e.g. vegetation or soil), either set by a default value or set by a namelist-provided value, while the bulk classification provides standard values for a variety of parameters. 
+In a second step, surfaces are initialized individually by providing the bulk classification at each grid point individually. 
+In case more detailed information is available, all or even single parameters can be initialized individually at each grid point.
+
+The provided input data is used to classify each surface element according to its treatment, i.e. default-, natural- or urban-type, in order to treat each surface element accordingly. 
+In case no land-surface or urban-surface scheme is applied, all surfaces are classified as default-type. 
+If a surface element has vegetation, pavement or water, it will be classified as natural-type and is treated by the land-surface scheme, while building surfaces will be treated by the urban-surface scheme. 
+
+\\\\
+=== [=#attr '''Global attributes:] === 
+
+'''Following list of mandatory attributes is expected by PALM when reading input data from the static input file.'''
+
+||='''Attribute'''  =||='''Type'''  =||='''Explanation / Remarks'''  =||
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_lat '''origin_lat''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Geographical latitude in degrees north. This attribute defines the south boundary of the model domain and overwrites the namelist parameter [../../inipar#latitude latitude], which is used e.g. for the Coriolis parameters as well as for the radiation.  
+Please note, in case of a nested run, values of [../../inipar#latitude latitude] will be synchronized internally to the respective value of the root parent domain. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_lon '''origin_lon''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Geographical longitude in degrees east. This attribute defines the left boundary of the model domain and overwrites the namelist parameter [../../inipar#longitude longitude], which is used e.g. for the radiation.  
+Please note, in case of a nested run, values of [../../inipar#longitude longitude] will be synchronized internally to the respective value of the root parent domain. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_time '''origin_time''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_CHAR
+}}}
+{{{#!td
+Reference point in time (UTC) {{{YYYY­-MM­-DD hh:mm:ss +00}}}. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_x '''origin_x''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Reference x-location in m (UTM) of left model boundary.
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_y '''origin_y''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Reference y-location in m (UTM) of south model boundary. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#origin_z '''origin_z''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Reference height in m above sea level after DHHN2016. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#rotation_angle '''rotation_angle''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td
+Clockwise angle of rotation in degrees between North positive y axis and the y axis in the data, e.g. ''0.0''. 
+}}}
+\\\\
+=== [=#topo '''Topography:] ===
+
+In order to prescribe topography from the static input file, [../../inipar#topography topography] = 'read_from_file' is required. 
+
+||='''Input variable'''  =||='''Type'''  =||='''LOD''' =||='''Explanation / Remarks'''  =||
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#zt '''zt(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Terrain height in m relative to [#origin_z origin_z]. 
+If not provided, the relative terrain height will be set to 0 all over the model domain. 
+Please note, '''zt''' must not contain any {{{_FillValues}}}.
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#buildings_2d '''buildings_2d(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+1 
+}}}
+{{{#!td
+2-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''' are prescribed, [#building_id building_id] is required.  
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#buildings_3d '''buildings_3d(z,y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+2
+}}}
+{{{#!td
+3-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''' do not need to be prescribed beyond the top level of the highest buildings. If '''buildings_3d''' are prescribed, [#building_id building_id] is required.  
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#building_id '''building_id(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_INT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Building ID is used to identify single building envelopes, 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_2d/3d is defined. 
+}}}
+
+\\\\
+
+=== [=#surf '''Surface variables''':] ===
+
+For a proper classification of natural land and water surfaces, [#pavement_type pavement_type], [#soil_type soil_type], [#vegetation_type vegetation_type] and [#water_type water_type] are required, which define bulk parameters for albedo, soil, root distribution, leaf-area density, etc. To enable initialization of the land-surface model with input-file-provided variables, the namelist parameter [../../lsmpar#surface_type surface_type] needs to be set to 'netcdf'.  
+In case more than one of the surface types (vegetation, pavement, water) is given at an (x,y) location, the relative fraction of each of the types must be provided by [#surface_fraction surface_fraction].
+Further, if the [../../usmpar urban-surface model] is applied, also [#building_type building_type] is required, which defines bulk parameters to run the urban-surface model. Please note, for the sake of consistency, at least one of the variables  [#pavement_type pavement_type], [#vegetation_type vegetation_type], [#water_type water_type] or [#building_type building_type] needs to be defined at each (x,y) location if the land- and urban-surface model is applied.
+If only the land-surface model is applied but no urban-surface model, one of [#pavement_type pavement_type], [#vegetation_type vegetation_type] or [#water_type water_type] needs to be defined at each (x,y) location. 
+Further, in case data is taken from the static input file, both, the land- and urban-surface model need to be either switched on or off. Applying only one of the energy-balance models is not sufficient and will lead to a controlled termination.  \\
+
+||='''Input variable'''  =||='''Type'''  =||='''LOD''' =||='''Explanation / Remarks'''  =||
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#albedo_pars '''albedo_pars'''] //
+'''(nalbedo_pars,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Spectral and broadband albedo for natural and urban surfaces for ''(y,x)''-locations. 
+When [#albedo_type albedo_type] = 0, all parameters must be set. Otherwise, single parameters for a given [#albedo_type albedo_type] can be overwritten, while the remaining parameters must be set to {{{_FillValue}}}.
+}}} 
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#albedo_type '''albedo_type(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Optional classification of albedo. Default values for '''albedo_type''' are already set in the bulk parametrization of [#buiding_type building_type], [#pavement_type pavement_type], [#vegetation_type vegetation_type], [#water_type water_type], but will be overwritten in case '''albedo_type''' is defined. The value of '''albedo_type''' will also overwrite the prescribed values in [#vegetation_pars vegetation_pars], [#water_pars water_pars], or [#pavement_pars pavement_pars]. 
+An overview of the different albedo types can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#building_pars '''building_pars'''] //
+'''(nbuilding_pars,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Parameters for the building parameterization. When [#building_type building_type] = 0, all parameters must be set. Otherwise, single parameters for a given [#building_type building_type] can be overwritten, while the remaining parameters must be set to {{{_FillValue}}}. '''building_pars''' becomes only effective if the [../../usmpar urban-surface model] or the [#indoor_model indoor_model] are applied. 
+Building parameters can be distinguished between ground-floor and upper level. For more information, please see [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#building_surface_pars '''building_surface_pars'''] //
+'''(nbuilding_surface_pars,s,\\
+y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Detailed information for specific building surfaces. This variable 
+can contain data for the entire domain or for selected areas where 
+detailed data is available. 
+Setting of '''building_surface_pars''' will replace parameter settings made by [#building_type building_type] and [#building_pars building_pars].
+'''building_surface_pars''' becomes only effective if the [../../usmpar urban-surface model] is applied. 
+For more information, please see [[attachment:PALM_input_data_standard_v1.9.pdf|here]]. \\\\
+'''Please note: this input variable is currently not implemented.'''
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#building_type '''building_type(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Building type used to select bulk parameters. '''building_type''' is required if the [../../usmpar urban-surface model] or the [#indoor_model indoor_model]  are applied.
+Please note, '''building_type''' must not contain any {{{_FillValue}}} at grid points where buildings_2d/3d is defined. 
+An overview of the different building types can be found [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#pavement_pars '''pavement_pars'''] //
+'''(npavement_pars,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Parameters required for the bulk pavement parameterization in the
+land surface scheme.
+When [#pavement_type pavement_type] = 0, all parameters must be set. Otherwise, single parameters for a given [#pavement_type pavement_type] can be overwritten, while the remaining parameters must be set to {{{_FillValue}}}.
+}}} 
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#pavement_subsurface_pars '''pavement_subsurface_pars'''] //
+'''(npavement_subsurface_pars,  \\
+zsoil,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Parameters required for the bulk pavement parameterization. 
+For all zsoil levels where '''pavement_subsurface_pars''' is not missing, the settings of the soil model are overwritten, i.e. thermal conductivity and heat capacities are set, and the layers are impermeable for water.
+When [#pavement_type pavement_type] = 0, all parameters must be set. 
+}}} 
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#pavement_type '''pavement_type(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Bulk classification of pavements on soil. At locations where '''pavement_type''' is defined, [#soil_type soil_type] must not contain any {{{_FillValues}}}. '''pavement_type''' overwrites the homogeneously prescribed setting via the namelist parameter [../../lsmpar#pavement_type pavement_type]. An overview of the different pavement types can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#soil_pars '''soil_pars'''] //
+'''(nsoil_pars,(zsoil),y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+1, 2
+}}}
+{{{#!td
+Parameters for soil parametrization. 
+When [#soil_type soil_type] = 0, all parameters must be set. Otherwise, 
+single parameters for a given [#soil_type soil_type] can be overwritten, while the remaining parameters must be set to {{{_FillValue}}}.
+In case {{{lod = 1}}}, prescribed parameters are vertically uniform, 
+while in case {{{lod = 2}}} parameters can be set for each layer individually. An overview of the different soil parameters can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#soil_type '''soil_type((zsoil),y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+1, 2
+}}}
+{{{#!td
+Bulk classification of soil in terms of porosity. '''soil_type''' overwrites the homogeneously prescribed setting via the namelist parameter [../../lsmpar#soil_type soil_type]. 
+In case {{{lod = 1}}}, a 2-dimensional vertically uniform soil texture is prescribed, while in case {{{lod = 2}}} the 3-dimensional soil_type is set for each layer individually. An overview of the different soil types can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#surface_fraction '''surface_fraction'''] //
+'''(nsurface_fraction,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Relative fraction of the respective surface type given via [#vegetation vegetation_type] (nsurface_fraction = 0), [#pavement_type pavement_type] (nsurface_fraction = 1) and [#water_type water_type] (nsurface_fraction = 2). The sum over all relative fractions must be equal to one for each location. This parameter is only needed at 
+locations (y,x) where more than one surface type (vegetation, 
+pavement, water) is defined. Moreover, if more than one surface type is defined at a location, the relative fractions of the respective surface types must not be 0. Also, if '''surface_fraction''' is given for one of the above mentioned surface types, this type need to be defined at this location. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#vegetation_pars '''vegetation_pars'''] //
+'''(nvegetation_pars,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Parameters for the bulk parametrization of non-resolved vegetation in the land-surface model for each ''(y,x)''-location.  
+All/single parameters of vegetation_pars for a given [#vegetation_type vegetation_type] can be overwritten for given ''(y,x)''-location. If only single parameters shall be overwritten, all other parameters must be set to {{{_FillValue}}}. Please note, if [#vegetation_type vegetation_type] = 0, all parameters must be set. 
+An overview of the different vegetation parameters can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#vegetation_type '''vegetation_type(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Bulk classification of non-resolved vegetation surfaces at natural land surface types. At locations where '''vegetation_type''' is defined, [#soil_type soil_type] must not contain any {{{_FillValues}}}. '''vegetation_type''' overwrites the homogeneously prescribed setting via the namelist parameter [../../lsmpar#vegetation_type vegetation_type]. An overview of the different vegetation types can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#water_pars '''water_pars'''] //
+'''(nalbedo_pars,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Parameters used for the parameterization of water surfaces. 
+When [#water_type water_type] = 0, all parameters must be set. Otherwise, single parameters for a given [#water_type water_type] can be overwritten, while the remaining parameters must be set to {{{_FillValue}}}.
+}}} 
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#water_type '''water_type(y,x)''']
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_BYTE
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Bulk classification of water bodies. '''water_type''' overwrites the homogeneously prescribed setting via the namelist parameter [../../lsmpar#water_type water_type]. An overview of the different water types can be found  [[attachment:PALM_input_data_standard_v1.9.pdf|here]].
+}}}
+
+\\\\
+
+=== [=#plant '''Resolved plant canopy:] ===
+
+In order to consider resolved plant canopy, the [../../canpar plant-canopy model] need to be switched on and setting of [#canopy_mode canopy_mode] = 'read_from_file_3d' is required. 
+
+||='''Input variable'''  =||='''Type'''  =||='''LOD''' =||='''Explanation / Remarks'''  =||
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#lad '''lad'''] //
+'''(zlad,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Vegetation resolved by the plant-canopy model in terms of a three­
+dimensional leaf area density (LAD). 
+Please note, plant canopy is prescribed relative to the underlying topography and will be mounted on top of the terrain. 
+A preprocessor tool is available to convert arbitrary vegetation information to an LAD field. If '''lad''' is set, all settings of LAD-related parameters made in the namelist [../../canpar &plant_canopy_parameters] will be ignored. 
+Please note, unresolved vegetation is already treated via the land-surface model considered by [#vegetation_type vegetation_type]. Please check for possible double counting of similar vegetation in case [#vegetation_type vegetation_type] and '''lad''' is set at ''(y,x)''-location. 
+}}} 
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#bad '''bad'''] //
+'''(zlad,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Basal area in m2 (i.e. trunk area) per grid volume. A preprocessor 
+tool is available to convert arbritrary vegetation information to an
+basal area density field. The dimension of the field must be equal 
+to that of the leaf area density. Please note, basal area is prescribed relative to the underlying topography. 
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#root_area_dens_r '''root_area_dens_r''']//
+'''(zsoil,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Root area of the resolved vegetation in the soil.
+}}}
+|----------------
+{{{#!td style="vertical-align:top;width: 150px"
+[=#root_area_dens_s '''root_area_dens_s''']//
+'''(zsoil,y,x)'''
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+NC_FLOAT
+}}}
+{{{#!td style="vertical-align:top;width: 50px"
+none
+}}}
+{{{#!td
+Root area of the parameterized vegetation in the soil that is set via 
+[#vegetation_type vegetation_type]. When [#vegetation_type vegetation_type] = 0, the '''root_area_density_s''' must be set.
+}}}
+\\\\\\