Default
value

adjust_mixing_length

Near-surface adjustment of the mixing length to the Prandtl-layer law. 

Usually the mixing length in LES models l_LES depends (as in PALM) on the grid size and is possibly restricted further in case of stable stratification and near the lower wall (see parameter wall_adjustment). With adjust_mixing_length = .T. the Prandtl' mixing length l_PR = kappa * z/phi is calculated and the mixing length actually used in the model is set l = MIN (l_LES, l_PR). This usually gives a decrease of the mixing length at the bottom boundary and considers the fact that eddy sizes decrease in the vicinity of the wall. 

Warning: So far, there is no good experience with adjust_mixing_length = .T. ! 

With adjust_mixing_length = .T. and the Prandtl-layer being switched on (see prandtl_layer) '(u*)** 2+neumann' should always be set as the lower boundary condition for the TKE (see bc_e_b), otherwise the near-surface value of the TKE is not in agreement with the Prandtl-layer law (Prandtl-layer law and Prandtl-Kolmogorov-Ansatz should provide the same value for K_m). A warning is given, if this is not the case.

alpha_surface

Inclination of the model domain with respect to the horizontal (in degrees). 

By means of alpha_surface the model domain can be inclined in x-direction with respect to the horizontal. In this way flows over inclined surfaces (e.g. drainage flows, gravity flows) can be simulated. In case of alpha_surface /= 0 the buoyancy term appears both in the equation of motion of the u-component and of the w-component.

An inclination is only possible in case of cyclic horizontal boundary conditions along x AND y (see bc_lr and bc_ns) and topography = 'flat'.

Runs with inclined surface still require additional user-defined code as well as modifications to the default code. Please ask the PALM developer  group.

bc_e_b

Bottom boundary condition of the TKE. 

bc_e_b may be set to 'neumann' or '(u*) ** 2+neumann'. bc_e_b = 'neumann' yields to e(k=0)=e(k=1) (Neumann boundary condition), where e(k=1) is calculated via the prognostic TKE equation. Choice of '(u*)**2+neumann' also yields to e(k=0)=e(k=1), but the TKE at the Prandtl-layer top (k=1) is calculated diagnostically by e(k=1)=(us/0.1)**2. However, this is only allowed if a Prandtl-layer is used (prandtl_layer). If this is not the case, a warning is given and bc_e_b is reset to 'neumann'. 

At the top boundary a Neumann boundary condition is generally used: (e(nz+1) = e(nz)).

bc_lr

bc_ns

bc_p_b

Bottom boundary condition of the perturbation pressure. 

Allowed values are 'dirichlet', 'neumann' and 'neumann+inhomo'.  'dirichlet' sets p(k=0)=0.0,  'neumann' sets p(k=0)=p(k=1). 'neumann+inhomo' corresponds to an extended Neumann boundary condition where heat flux or temperature inhomogeneities near the surface (pt(k=1))  are additionally regarded (see Shen and LeClerc (1995, Q.J.R. Meteorol. Soc., 1209)). This condition is only permitted with the Prandtl-layer switched on (prandtl_layer), otherwise the run is terminated. 

Since at the bottom boundary of the model the vertical velocity disappears (w(k=0) = 0.0), the consistent Neumann condition ('neumann' or 'neumann+inhomo') dp/dz = 0 should be used, which leaves the vertical component w unchanged when the pressure solver is applied. Simultaneous use of the Neumann boundary conditions both at the bottom and at the top boundary (bc_p_t) usually yields no consistent solution for the perturbation pressure and should be avoided.

bc_p_t

Top boundary condition of the perturbation pressure. 

Allowed values are 'dirichlet' (p(k=nz+1)= 0.0) or 'neumann' (p(k=nz+1)=p(k=nz)). 

Simultaneous use of Neumann boundary conditions both at the top and bottom boundary (bc_p_b) usually yields no consistent solution for the perturbation pressure and should be avoided. Since at the bottom boundary the Neumann condition  is a good choice (see bc_p_b), a Dirichlet condition should be set at the top boundary.

bc_pt_b

Bottom boundary condition of the potential temperature. 

Allowed values are 'dirichlet' (pt(k=0) = const. = pt_surface + pt_surface_initial_change; the user may change this value during the run using user-defined code) and 'neumann' (pt(k=0)=pt(k=1)). 
When a constant surface sensible heat flux is used (surface_heatflux), bc_pt_b = 'neumann' must be used, because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed.

In the coupled atmosphere executable, bc_pt_b is internally set and does not need to be prescribed.

bc_pt_t

Top boundary condition of the potential temperature. 

Allowed are the values 'dirichlet' (pt(k=nz+1) does not change during the run), 'neumann' (pt(k=nz+1)=pt(k=nz)), and 'initial_gradient'. With the 'initial_gradient'-condition the value of the temperature gradient at the top is calculated from the initial temperature profile (see pt_surface, pt_vertical_gradient) by bc_pt_t_val = (pt_init(k=nz+1) - pt_init(k=nz)) / dzu(nz+1).
Using this value (assumed constant during the run) the temperature boundary values are calculated as 

pt(k=nz+1) = pt(k=nz) + bc_pt_t_val * dzu(nz+1)

(up to k=nz the prognostic equation for the temperature is solved).
When a constant sensible heat flux is used at the top boundary (top_heatflux), bc_pt_t = 'neumann' must be used, because otherwise the resolved scale may contribute to the top flux so that a constant value cannot be guaranteed.

bc_q_b

Bottom boundary condition of the specific humidity / total water content. 

Allowed values are 'dirichlet' (q(k=0) = const. = q_surface + q_surface_initial_change; the user may change this value during the run using user-defined code) and 'neumann' (q(k=0)=q(k=1)). 
When a constant surface latent heat flux is used (surface_waterflux), bc_q_b = 'neumann' must be used, because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed.

bc_q_t

Top boundary condition of the specific humidity / total water content. 

Allowed are the values 'dirichlet' (q(k=nz) and q(k=nz+1) do not change during the run) and 'neumann'. With the Neumann boundary condition the value of the humidity gradient at the top is calculated from the initial humidity profile (see q_surface, q_vertical_gradient) by: bc_q_t_val = ( q_init(k=nz) - q_init(k=nz-1)) / dzu(nz).
Using this value (assumed constant during the run) the humidity boundary values are calculated as 

q(k=nz+1) =q(k=nz) + bc_q_t_val * dzu(nz+1)

(up tp k=nz the prognostic equation for q is solved).

bc_s_b

Bottom boundary condition of the scalar concentration. 

Allowed values are 'dirichlet' (s(k=0) = const. = s_surface + s_surface_initial_change; the user may change this value during the run using user-defined code) and 'neumann' (s(k=0) = s(k=1)). 
When a constant surface concentration flux is used (surface_scalarflux), bc_s_b = 'neumann' must be used, because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed.

bc_s_t

Top boundary condition of the scalar concentration. 

Allowed are the values 'dirichlet' (s(k=nz) and s(k=nz+1) do not change during the run) and 'neumann'. With the Neumann boundary condition the value of the scalar concentration gradient at the top is calculated from the initial scalar concentration profile (see s_surface, s_vertical_gradient) by: bc_s_t_val = (s_init(k=nz) - s_init(k=nz-1)) / dzu(nz).
Using this value (assumed constant during the run) the concentration boundary values are calculated as

s(k=nz+1) = s(k=nz) + bc_s_t_val * dzu(nz+1)

(up to k=nz the prognostic equation for the scalar concentration is solved).

Top boundary condition of the salinity. 

This parameter only comes into effect for ocean runs (see parameter ocean).

Allowed are the values 'dirichlet' (sa(k=nz+1) does not change during the run) and 'neumann' (sa(k=nz+1)=sa(k=nz)). 

When a constant salinity flux is used at the top boundary (top_salinityflux), bc_sa_t = 'neumann' must be used, because otherwise the resolved scale may contribute to the top flux so that a constant value cannot be guaranteed.

bc_uv_b

Bottom boundary condition of the horizontal velocity components u and v. 

Allowed values are 'dirichlet' and 'neumann'. bc_uv_b = 'dirichlet' yields the no-slip condition with u=v=0 at the bottom. Due to the staggered grid u(k=0) and v(k=0) are located at z = - 0,5 * dz (below the bottom), while u(k=1) and v(k=1) are located at z = +0,5 * dz. u=v=0 at the bottom is guaranteed using mirror boundary condition: 

u(k=0) = - u(k=1) and v(k=0) = - v(k=1)

The Neumann boundary condition yields the free-slip condition with u(k=0) = u(k=1) and v(k=0) = v(k=1). With Prandtl - layer switched on (see prandtl_layer), the free-slip condition is not allowed (otherwise the run will be terminated).

bc_uv_t

Top boundary condition of the horizontal velocity components u and v. 

Allowed values are 'dirichlet', 'dirichlet_0' and 'neumann'. The Dirichlet condition yields u(k=nz+1) = ug(nz+1) and v(k=nz+1) = vg(nz+1), Neumann condition yields the free-slip condition with u(k=nz+1) = u(k=nz) and v(k=nz+1) = v(k=nz) (up to k=nz the prognostic equations for the velocities are solved). The special condition 'dirichlet_0' can be used for channel flow, it yields the no-slip condition u(k=nz+1) = ug(nz+1) = 0 and v(k=nz+1) = vg(nz+1) = 0.

In the coupled ocean executable, bc_uv_t is internally set ('neumann') and does not need to be prescribed.

Kinematic salinity flux near the surface (in psu m/s). 

The respective salinity flux value is used as bottom (horizontally homogeneous) boundary condition for the salinity equation. This additionally requires that a Neumann condition must be used for the salinity, which is currently the only available condition.

cloud_physics

Parameter to switch on the condensation scheme. 

'default'

Per default, PALM uses 'initial_profiles' for cyclic lateral boundary conditions (bc_lr = 'cyclic' and bc_ns = 'cyclic') and 'inflow_profile' for non-cyclic lateral boundary conditions (bc_lr /= 'cyclic' or bc_ns /= 'cyclic').

'initial_profiles'

The target volume flow is calculated at t=0 from the initial profiles of u and v. This setting is only allowed for cyclic lateral boundary conditions (bc_lr = 'cyclic' and bc_ns = 'cyclic').

'inflow_profile'

The target volume flow is calculated at every timestep from the inflow profile of u or v, respectively. This setting is only allowed for non-cyclic lateral boundary conditions (bc_lr /= 'cyclic' or bc_ns /= 'cyclic').

'bulk_velocity'

The target volume flow is calculated from a predefined bulk velocity (see u_bulk and v_bulk). This setting is only allowed for cyclic lateral boundary conditions (bc_lr = 'cyclic' and bc_ns = 'cyclic').

cut_spline_overshoot

Cuts off of so-called overshoots, which can occur with the upstream-spline scheme. 

The cubic splines tend to overshoot in case of discontinuous changes of variables between neighbouring grid points. This may lead to errors in calculating the advection tendency. Choice of cut_spline_overshoot = .TRUE. (switched on by default) allows variable values not to exceed an interval defined by the respective adjacent grid points. This interval can be adjusted seperately for every prognostic variable (see initialization parameters overshoot_limit_e, overshoot_limit_pt, overshoot_limit_u, etc.). This might be necessary in case that the default interval has a non-tolerable effect on the model results. 

Overshoots may also be removed using the parameters ups_limit_e, ups_limit_pt, etc. as well as by applying a long-filter (see long_filter_factor).

damp_level_1d

Height where the damping layer begins in the 1d-model (in m). 

This parameter is used to switch on a damping layer for the 1d-model, which is generally needed for the damping of inertia oscillations. Damping is done by gradually increasing the value of the eddy diffusivities about 10% per vertical grid level (starting with the value at the height given by damp_level_1d, or possibly from the next grid pint above), i.e. K_m(k+1) = 1.1 * K_m(k). The values of K_m are limited to 10 m**2/s at maximum. 
This parameter only comes into effect if the 1d-model is switched on for the initialization of the 3d-model using initializing_actions = 'set_1d-model_profiles'.

dp_external

dp_smooth

dp_level_b

dpdxy

dt

Time step for the 3d-model (in s). 

By default, (i.e. if a Runge-Kutta scheme is used, see timestep_scheme) the value of the time step is calculating after each time step (following the time step criteria) and used for the next step.

If the user assigns dt a value, then the time step is fixed to this value throughout the whole run (whether it fulfills the time step criteria or not). However, changes are allowed for restart runs, because dt can also be used as a run parameter. 

In case that the calculated time step meets the condition

dt < 0.00001 * dt_max (with dt_max = 20.0)

the simulation will be aborted. Such situations usually arise in case of any numerical problem / instability which causes a non-realistic increase of the wind speed. 

A small time step due to a large mean horizontal windspeed speed may be enlarged by using a coordinate transformation (see galilei_transformation), in order to spare CPU time.

If the leapfrog timestep scheme is used (see timestep_scheme) a temporary time step value dt_new is calculated first, with dt_new = cfl_factor * dt_crit where dt_crit is the maximum timestep allowed by the CFL and diffusion condition. Next it is examined whether dt_new exceeds or falls below the value of the previous timestep by at least +5 % / -2%. If it is smaller, dt = dt_new is immediately used for the next timestep. If it is larger, then dt = 1.02 * dt_prev (previous timestep) is used as the new timestep, however the time step is only increased if the last change of the time step is dated back at least 30 iterations. If dt_new is located in the interval mentioned above, then dt does not change at all. By doing so, permanent time step changes as well as large sudden changes (increases) in the time step are avoided.

dt_pr_1d

Temporal interval of vertical profile output of the 1D-model (in s). 

Data are written in ASCII format to file LIST_PROFIL_1D. This parameter is only in effect if the 1d-model has been switched on for the initialization of the 3d-model with initializing_actions = 'set_1d-model_profiles'.

dt_run_control_1d

Temporal interval of runtime control output of the 1d-model (in s). 

Data are written in ASCII format to file RUN_CONTROL. This parameter is only in effect if the 1d-model is switched on for the initialization of the 3d-model with initializing_actions = 'set_1d-model_profiles'.

dx

Horizontal grid spacing along the x-direction (in m). 

Along x-direction only a constant grid spacing is allowed.

For coupled runs this parameter must be equal in both parameter files PARIN and PARIN_O.

dy

Horizontal grid spacing along the y-direction (in m). 

Along y-direction only a constant grid spacing is allowed.

For coupled runs this parameter must be equal in both parameter files PARIN and PARIN_O.

dz

Vertical grid spacing (in m). 

This parameter must be assigned by the user, because no default value is given.

By default, the model uses constant grid spacing along z-direction, but it can be stretched using the parameters dz_stretch_level and dz_stretch_factor. In case of stretching, a maximum allowed grid spacing can be given by dz_max.

Assuming a constant dz, the scalar levels (zu) are calculated directly by: 

zu(0) = - dz * 0.5 
zu(1) = dz * 0.5

The w-levels lie half between them: 

zw(k) = ( zu(k) + zu(k+1) ) * 0.5

dz_stretch_factor

Stretch factor for a vertically stretched grid (see dz_stretch_level). 

The stretch factor should not exceed a value of approx. 1.10 - 1.12, otherwise the discretization errors due to the stretched grid not negligible any more. (refer Kalnay de Rivas)

dz_stretch_level

Height level above/below which the grid is to be stretched vertically (in m). 

For ocean = .F., dz_stretch_level is the height level (in m) above which the grid is to be stretched vertically. The vertical grid spacings dz above this level are calculated as 

dz(k+1) = dz(k) * dz_stretch_factor

and used as spacings for the scalar levels (zu). The w-levels are then defined as: 

zw(k) = ( zu(k) + zu(k+1) ) * 0.5.

For ocean = .T., dz_stretch_level is the height level (in m, negative) below which the grid is to be stretched vertically. The vertical grid spacings dz below this level are calculated correspondingly as

dz(k-1) = dz(k) * dz_stretch_factor.

end_time_1d

Time to be simulated for the 1d-model (in s). 

The default value corresponds to a simulated time of 10 days. Usually, after such a period the inertia oscillations have completely decayed and the solution of the 1d-model can be regarded as stationary (see damp_level_1d). This parameter is only in effect if the 1d-model is switched on for the initialization of the 3d-model with initializing_actions = 'set_1d-model_profiles'.

fft_method

FFT-method to be used.

The fast fourier transformation (FFT) is used for solving the perturbation pressure equation with a direct method (see psolver) and for calculating power spectra (see optional software packages, section 4.2).

By default, system-specific, optimized routines from external vendor libraries are used. However, these are available only on certain computers and there are more or less severe restrictions concerning the number of gridpoints to be used with them.

There are two other PALM internal methods available on every machine (their respective source code is part of the PALM source code):

1.: The Temperton-method from Clive Temperton (ECWMF) which is computationally very fast and switched on with fft_method = 'temperton-algorithm'. The number of horizontal gridpoints (nx+1, ny+1) to be used with this method must be composed of prime factors 2, 3 and 5.

galilei_transformation

With galilei_transformation = .T., a so-called Galilei-transformation is switched on which ensures that the coordinate system of the model is moved along with the geostrophical wind. Alternatively, the model domain can be moved along with the averaged horizontal wind (see use_ug_for_galilei_tr, this can and will naturally change in time). With this method, numerical inaccuracies of the Piascek - Williams - scheme (concerns in particular the momentum advection) are minimized. Beyond that, in the majority of cases the lower relative velocities in the moved system permit a larger time step (dt). Switching the transformation on is only worthwhile if the geostrophical wind (ug, vg) and the averaged horizontal wind clearly deviate from the value 0. In each case, the distance the coordinate system has been moved is written to the file RUN_CONTROL. 

Non-cyclic lateral boundary conditions (see bc_lr and bc_ns), the specification of a gestrophic wind that is not constant with height as well as e.g. stationary inhomogeneities at the bottom boundary do not allow the use of this transformation.

grid_matching

humidity

Parameter to switch on the prognostic equation for specific humidity q.

The initial vertical profile of q can be set via parameters q_surface, q_vertical_gradient and q_vertical_gradient_level.  Boundary conditions can be set via q_surface_initial_change and surface_waterflux.

initializing_actions

Initialization actions to be carried out. 

This parameter does not have a default value and therefore must be assigned with each model run. For restart runs initializing_actions = 'read_restart_data' must be set. For the initial run of a job chain the following values are allowed: 

'set_constant_profiles'

A horizontal wind profile consisting of linear sections (see ug_surface, ug_vertical_gradient, ug_vertical_gradient_level and vg_surface, vg_vertical_gradient, vg_vertical_gradient_level, respectively) as well as a vertical temperature (humidity) profile consisting of linear sections (see pt_surface, pt_vertical_gradient, q_surface and q_vertical_gradient) are assumed as initial profiles. The subgrid-scale TKE is set to 0 but K_m and K_h are set to very small values because otherwise no TKE would be generated.

'set_1d-model_profiles'

The arrays of the 3d-model are initialized with the (stationary) solution of the 1d-model. These are the variables e, kh, km, u, v and with Prandtl layer switched on rif, us, usws, vsws. The temperature (humidity) profile consisting of linear sections is set as for 'set_constant_profiles' and assumed as constant in time within the 1d-model. For steering of the 1d-model a set of parameters with suffix "_1d" (e.g. end_time_1d, damp_level_1d) is available.

'by_user'

The initialization of the arrays of the 3d-model is under complete control of the user and has to be done in routine user_init_3d_model of the user-interface.

'initialize_vortex'

'initialize_ptanom'

A 2d-Gauss-like shape disturbance (x,y) is added to the initial temperature field with radius 10.0 * dx and center at jc = (nx+1)/2. This may be used for tests of scalar advection schemes (see scalar_advec). Such tests require a horizontal wind profile constant with hight and diffusion switched off (see 'initialize_vortex'). Additionally, the buoyancy term must be switched of in the equation of motion  for w (this requires the user to comment out the call of buoyancy in the source code of prognostic_equations.f90).

'cyclic_fill'

Here, 3d-data from a precursor run are read by the initial (main) run. The precursor run is allowed to have a smaller domain along x and y compared with the main run. Also, different numbers of processors can be used for these two runs. Limitations are that the precursor run must use cyclic horizontal boundary conditions and that the number of vertical grid points, nz, must be same for the precursor run and the main run. If the total domain of the main run is larger than that of the precursor run, the domain is filled by cyclic repetition of the (cyclic) precursor data. This initialization method is recommended if a turbulent inflow is used (see turbulent_inflow). 3d-data must be made available to the run by activating an appropriate file connection statement for local file BININ. See chapter 3.9 for more details, where usage of a turbulent inflow is explained.

Values may be combined, e.g. initializing_actions = 'set_constant_profiles initialize_vortex', but the values of 'set_constant_profiles', 'set_1d-model_profiles' , and 'by_user' must not be given at the same time.

km_constant

Constant eddy diffusivities are used (laminar simulations). 

If this parameter is specified, both in the 1d and in the 3d-model constant values for the eddy diffusivities are used in space and time with K_m = km_constant and K_h = K_m / prandtl_number. The prognostic equation for the subgrid-scale TKE is switched off. Constant eddy diffusivities are only allowed with the Prandtl layer (prandtl_layer) switched off.

km_damp_max

This leaf area density gradient holds starting from the height  level defined by lad_vertical_gradient_level (precisely: for all uv levels k where zu(k) > lad_vertical_gradient_level, lad(k) is set: lad(k) = lad(k-1) + dzu(k) * lad_vertical_gradient) up to the level defined by pch_index. Above that level lad(k) will automatically set to 0.0. A total of 10 different gradients for 11 height intervals (10 intervals if lad_vertical_gradient_level(1) = 0.0) can be assigned. The leaf area density at the surface is assigned via lad_surface. 

long_filter_factor

Filter factor for the so-called Long-filter.

This filter very efficiently eliminates 2-delta-waves sometimes cauesed by the upstream-spline scheme (see Mahrer and Pielke, 1978: Mon. Wea. Rev., 106, 818-830). It works in all three directions in space. A value of long_filter_factor = 0.01 sufficiently removes the small-scale waves without affecting the longer waves.

By default, the filter is switched off (= 0.0). It is exclusively applied to the tendencies calculated by the upstream-spline scheme (see momentum_advec and scalar_advec), not to the prognostic variables themselves. At the bottom and top boundary of the model domain the filter effect for vertical 2-delta-waves is reduced. There, the amplitude of these waves is only reduced by approx. 50%, otherwise by nearly 100%. 
Filter factors with values > 0.01 also reduce the amplitudes of waves with wavelengths longer than 2-delta (see the paper by Mahrer and Pielke, quoted above).

momentum_advec

Advection scheme to be used for the momentum equations.

The user can choose between the following schemes:
 

'pw-scheme'

'ups-scheme'

Since the cubic splines used tend to overshoot under certain circumstances, this effect must be adjusted by suitable filtering and smoothing (see cut_spline_overshoot, long_filter_factor, ups_limit_pt, ups_limit_u, ups_limit_v, ups_limit_w). This is always neccessary for runs with stable stratification, even if this stratification appears only in parts of the model domain.

nsor_ini

Initial number of iterations with the SOR algorithm. 

This parameter is only effective if the SOR algorithm was selected as the pressure solver scheme (psolver = 'sor') and specifies the number of initial iterations of the SOR scheme (at t = 0). The number of subsequent iterations at the following timesteps is determined with the parameter nsor. Usually nsor < nsor_ini, since in each case subsequent calls to psolver use the solution of the previous call as initial value. Suitable test runs should determine whether sufficient convergence of the solution is obtained with the default value and if necessary the value of nsor_ini should be changed.

nx

Number of grid points in x-direction. 

A value for this parameter must be assigned. Since the lower array bound in PALM starts with i = 0, the actual number of grid points is equal to nx+1. In case of cyclic boundary conditions along x, the domain size is (nx+1)* dx.

For parallel runs, in case of grid_matching = 'strict', nx+1 must be an integral multiple of the processor numbers (see npex and npey) along x- as well as along y-direction (due to data transposition restrictions).

For coupled runs this parameter must be equal in both parameter files PARIN and PARIN_O.

ny

Number of grid points in y-direction. 

A value for this parameter must be assigned. Since the lower array bound in PALM starts with j = 0, the actual number of grid points is equal to ny+1. In case of cyclic boundary conditions along y, the domain size is (ny+1) * dy.

For parallel runs, in case of grid_matching = 'strict', ny+1 must be an integral multiple of the processor numbers (see npex and npey)  along y- as well as along x-direction (due to data transposition restrictions).

For coupled runs this parameter must be equal in both parameter files PARIN and PARIN_O.

nz

Number of grid points in z-direction. 

A value for this parameter must be assigned. Since the lower array bound in PALM starts with k = 0 and since one additional grid point is added at the top boundary (k = nz+1), the actual number of grid points is nz+2. However, the prognostic equations are only solved up to nz (u, v) or up to nz-1 (w, scalar quantities). The top boundary for u and v is at k = nz+1 (u, v) while at k = nz for all other quantities. 

For parallel runs,  in case of grid_matching = 'strict', nz must be an integral multiple of the number of processors in x-direction (due to data transposition restrictions).

• An additional prognostic equation for salinity is solved.
• Potential temperature in buoyancy and stability-related terms is replaced by potential density.
• Potential density is calculated from the equation of state for seawater after each timestep, using the algorithm proposed by Jackett et al. (2006, J. Atmos. Oceanic Technol., 23, 1709-1728).
  So far, only the initial hydrostatic pressure is entered into this equation.
• z=0 (sea surface) is assumed at the model top (vertical grid index k=nzt on the w-grid), with negative values of z indicating the depth.
• Initial profiles are constructed (e.g. from pt_vertical_gradient / pt_vertical_gradient_level) starting from the sea surface, using surface values given by pt_surface, sa_surface, ug_surface, and vg_surface.
• Zero salinity flux is used as default boundary condition at the bottom of the sea.
• If switched on, random perturbations are by default imposed to the upper model domain from zu(nzt*2/3) to zu(nzt-3).

omega

Angular velocity of the rotating system (in rad s^-1). 

The angular velocity of the earth is set by default. The values of the Coriolis parameters are calculated as: 

f = 2.0 * omega * sin(phi) 
f* = 2.0 * omega * cos(phi)

outflow_damping_width

overshoot_limit_e

Allowed limit for the overshooting of subgrid-scale TKE in case that the upstream-spline scheme is switched on (in m²/s²). 

By deafult, if cut-off of overshoots is switched on for the upstream-spline scheme (see cut_spline_overshoot), no overshoots are permitted at all. If overshoot_limit_e is given a non-zero value, overshoots with the respective amplitude (both upward and downward) are allowed. 

Only positive values are allowed for overshoot_limit_e.

overshoot_limit_pt

Allowed limit for the overshooting of potential temperature in case that the upstream-spline scheme is switched on (in K). 

For further information see overshoot_limit_e. 

Only positive values are allowed for overshoot_limit_pt.

overshoot_limit_u

For further information see overshoot_limit_e. 

Only positive values are allowed for overshoot_limit_u.

overshoot_limit_v

Allowed limit for the overshooting of the v-component of velocity in case that the upstream-spline scheme is switched on (in m/s). 

For further information see overshoot_limit_e. 

Only positive values are allowed for overshoot_limit_v.

overshoot_limit_w

Allowed limit for the overshooting of the w-component of velocity in case that the upstream-spline scheme is switched on (in m/s). 

For further information see overshoot_limit_e. 

Only positive values are permitted for overshoot_limit_w.

passive_scalar

Parameter to switch on the prognostic equation for a passive scalar.

The initial vertical profile of s can be set via parameters s_surface, s_vertical_gradient and  s_vertical_gradient_level. Boundary conditions can be set via s_surface_initial_change and surface_scalarflux. 

Note:
With passive_scalar switched on, the simultaneous use of humidity (see humidity) is impossible.

phi

Geographical latitude (in degrees). 

The value of this parameter determines the value of the Coriolis parameters f and f*, provided that the angular velocity (see omega) is non-zero.

prandtl_layer

Parameter to switch on a Prandtl layer. 

By default, a Prandtl layer is switched on at the bottom boundary between z = 0 and z = 0.5 * dz (the first computational grid point above ground for u, v and the scalar quantities). In this case, at the bottom boundary, free-slip conditions for u and v (see bc_uv_b) are not allowed. Likewise, laminar simulations with constant eddy diffusivities (km_constant) are forbidden. 

With Prandtl-layer switched off, the TKE boundary condition bc_e_b = '(u*)**2+neumann' must not be used and is automatically changed to 'neumann' if necessary.  Also, the pressure boundary condition bc_p_b = 'neumann+inhomo'  is not allowed.

If the Prandtl-layer is switched off and fluxes shall be prescribed at the surface (by setting surface_heatflux), it is required to set the parameter use_surface_fluxes = .T..

The roughness length is declared via the parameter roughness_length.

precipitation

Parameter to switch on the precipitation scheme.

For precipitation processes PALM uses a simplified Kessler scheme. This scheme only considers the so-called autoconversion, that means the generation of rain water by coagulation of cloud drops among themselves. Precipitation begins and is immediately removed from the flow as soon as the liquid water content exceeds the critical value of 0.5 g/kg.

The precipitation rate and amount can be output by assigning the runtime parameter data_output = 'prr*' or 'pra*', respectively. The time interval on which the precipitation amount is defined can be controlled via runtime parameter precipitation_amount_interval.

pt_surface

Surface potential temperature (in K). 

This parameter assigns the value of the potential temperature pt at the surface (k=0). Starting from this value, the initial vertical temperature profile is constructed with pt_vertical_gradient and pt_vertical_gradient_level . This profile is also used for the 1d-model as a stationary profile.

Attention:
In case of ocean runs (see ocean), this parameter gives the temperature value at the sea surface, which is at k=nzt. The profile is then constructed from the surface down to the bottom of the model.

pt_surface_initial
_change

Change in surface temperature to be made at the beginning of the 3d run (in K). 

If pt_surface_initial_change is set to a non-zero value, the near surface sensible heat flux is not allowed to be given simultaneously (see surface_heatflux).

pt_vertical_gradient

Temperature gradient(s) of the initial temperature profile (in K / 100 m). 

This temperature gradient holds starting from the height  level defined by pt_vertical_gradient_level (precisely: for all uv levels k where zu(k) > pt_vertical_gradient_level, pt_init(k) is set: pt_init(k) = pt_init(k-1) + dzu(k) * pt_vertical_gradient) up to the top boundary or up to the next height level defined by pt_vertical_gradient_level. A total of 10 different gradients for 11 height intervals (10 intervals if pt_vertical_gradient_level(1) = 0.0) can be assigned. The surface temperature is assigned via pt_surface. 

Example: 

pt_vertical_gradient = 1.0, 0.5, 
pt_vertical_gradient_level = 500.0, 1000.0,

That defines the temperature profile to be neutrally stratified up to z = 500.0 m with a temperature given by pt_surface. For 500.0 m < z <= 1000.0 m the temperature gradient is 1.0 K / 100 m and for z > 1000.0 m up to the top boundary it is 0.5 K / 100 m (it is assumed that the assigned height levels correspond with uv levels).

Attention:
In case of ocean runs (see ocean), the profile is constructed like described above, but starting from the sea surface (k=nzt) down to the bottom boundary of the model. Height levels have then to be given as negative values, e.g. pt_vertical_gradient_level = -500.0, -1000.0.

pt_vertical_gradient
_level

10 *  0.0

Height level from which on the temperature gradient defined by pt_vertical_gradient is effective (in m). 

The height levels have to be assigned in ascending order. The default values result in a neutral stratification regardless of the values of pt_vertical_gradient (unless the top boundary of the model is higher than 100000.0 m). For the piecewise construction of temperature profiles see pt_vertical_gradient.

q_surface

Surface specific humidity / total water content (kg/kg). 

This parameter assigns the value of the specific humidity q at the surface (k=0).  Starting from this value, the initial humidity profile is constructed with  q_vertical_gradient and q_vertical_gradient_level. This profile is also used for the 1d-model as a stationary profile.

q_surface_initial
_change

Change in surface specific humidity / total water content to be made at the beginning of the 3d run (kg/kg). 

If q_surface_initial_change is set to a non-zero value the near surface latent heat flux (water flux) is not allowed to be given simultaneously (see surface_waterflux).

q_vertical_gradient

Humidity gradient(s) of the initial humidity profile (in 1/100 m). 

This humidity gradient holds starting from the height level  defined by q_vertical_gradient_level (precisely: for all uv levels k, where zu(k) > q_vertical_gradient_level, q_init(k) is set: q_init(k) = q_init(k-1) + dzu(k) * q_vertical_gradient) up to the top boundary or up to the next height level defined by q_vertical_gradient_level. A total of 10 different gradients for 11 height intervals (10 intervals if q_vertical_gradient_level(1) = 0.0) can be asigned. The surface humidity is assigned via q_surface.

Example: 

q_vertical_gradient = 0.001, 0.0005, 
q_vertical_gradient_level = 500.0, 1000.0,

q_vertical_gradient
_level

10 *  0.0

Height level from which on the humidity gradient defined by q_vertical_gradient is effective (in m). 

The height levels are to be assigned in ascending order. The default values result in a humidity constant with height regardless of the values of q_vertical_gradient (unless the top boundary of the model is higher than 100000.0 m). For the piecewise construction of humidity profiles see q_vertical_gradient.

radiation

Parameter to switch on longwave radiation cooling at cloud-tops. 

Long-wave radiation processes are parameterized by the effective emissivity, which considers only the absorption and emission of long-wave radiation at cloud droplets. The radiation scheme can be used only with cloud_physics = .TRUE. .

random_generator

'numerical
recipes'

Random number generator to be used for creating uniformly distributed random numbers.

It is used if random perturbations are to be imposed on the velocity field or on the surface heat flux field (see create_disturbances and random_heatflux). By default, the "Numerical Recipes" random number generator is used. This one provides exactly the same order of random numbers on all different machines and should be used in particular for comparison runs.

Besides, a system-specific generator is available ( random_generator = 'system-specific') which should particularly be used for runs on vector parallel computers (NEC), because the default generator cannot be vectorized and therefore significantly drops down the code performance on these machines.

random_heatflux

Parameter to impose random perturbations on the internal two-dimensional near surface heat flux field shf.

rif_max

Upper limit of the flux-Richardson number. 

With the Prandtl layer switched on (see prandtl_layer), flux-Richardson numbers (rif) are calculated for z=z_p (k=1) in the 3d-model (in the 1d model for all heights). Their values in particular determine the values of the friction velocity (1d- and 3d-model) and the values of the eddy diffusivity (1d-model). With small wind velocities at the Prandtl layer top or small vertical wind shears in the 1d-model, rif can take up unrealistic large values. They are limited by an upper (rif_max) and lower limit (see rif_min) for the flux-Richardson number. The condition rif_max > rif_min must be met.

rif_min

Lower limit of the flux-Richardson number. 

For further explanations see rif_max. The condition rif_max > rif_min must be met.

roughness_length

Roughness length (in m). 

This parameter is effective only in case that a Prandtl layer is switched on (see prandtl_layer).

Surface salinity (in psu). 

This parameter assigns the value of the salinity sa at the sea surface (k=nzt). Starting from this value, the initial vertical salinity profile is constructed from the surface down to the bottom of the model (k=0) by using sa_vertical_gradient and sa_vertical_gradient_level .

Salinity gradient(s) of the initial salinity profile (in psu / 100 m). 

This parameter only comes into effect for ocean runs (see parameter ocean).

This salinity gradient holds starting from the height  level defined by sa_vertical_gradient_level (precisely: for all uv levels k where zu(k) < sa_vertical_gradient_level, sa_init(k) is set: sa_init(k) = sa_init(k+1) - dzu(k+1) * sa_vertical_gradient) down to the bottom boundary or down to the next height level defined by sa_vertical_gradient_level. A total of 10 different gradients for 11 height intervals (10 intervals if sa_vertical_gradient_level(1) = 0.0) can be assigned. The surface salinity at k=nzt is assigned via sa_surface. 

Example: 

sa_vertical_gradient = 1.0, 0.5, 
sa_vertical_gradient_level = -500.0, -1000.0,

That defines the salinity to be constant down to z = -500.0 m with a salinity given by sa_surface. For -500.0 m < z <= -1000.0 m the salinity gradient is 1.0 psu / 100 m and for z < -1000.0 m down to the bottom boundary it is 0.5 psu / 100 m (it is assumed that the assigned height levels correspond with uv levels).

Height level from which on the salinity gradient defined by sa_vertical_gradient is effective (in m). 

This parameter only comes into effect for ocean runs (see parameter ocean).

The height levels have to be assigned in descending order. The default values result in a constant salinity profile regardless of the values of sa_vertical_gradient (unless the bottom boundary of the model is lower than -100000.0 m). For the piecewise construction of salinity profiles see sa_vertical_gradient.

scalar_advec

Advection scheme to be used for the scalar quantities. 

The user can choose between the following schemes:

'pw-scheme'

'bc-scheme'

The upstream-spline-scheme is used (see Mahrer and Pielke, 1978: Mon. Wea. Rev., 106, 818-830). In opposite to the Piascek Williams scheme, this is characterized by much better numerical features (less numerical diffusion, better preservation of flux structures, e.g. vortices), but computationally it is much more expensive. In addition, the use of the Euler-timestep scheme is mandatory (timestep_scheme = 'euler'), i.e. the timestep accuracy is only first order. For this reason the advection of momentum (see momentum_advec) should then also be carried out with the upstream-spline scheme, because otherwise the momentum would be subject to large numerical diffusion due to the upstream scheme. 

Since the cubic splines used tend to overshoot under certain circumstances, this effect must be adjusted by suitable filtering and smoothing (see cut_spline_overshoot, long_filter_factor, ups_limit_pt, ups_limit_u, ups_limit_v, ups_limit_w). This is always neccesssary for runs with stable stratification, even if this stratification appears only in parts of the model domain. 

With stable stratification the upstream-upline scheme also produces gravity waves with large amplitude, which must be suitably damped (see rayleigh_damping_factor).

Important: The  upstream-spline scheme is not implemented for humidity and passive scalars (see humidity and passive_scalar) and requires the use of a 2d-domain-decomposition. The last conditions severely restricts code optimization on several machines leading to very long execution times! This scheme is also not allowed for non-cyclic lateral boundary conditions (see bc_lr and bc_ns).

statistic_regions

Number of additional user-defined subdomains for which statistical analysis and corresponding output (profiles, time series) shall be made. 

By default, vertical profiles and other statistical quantities are calculated as horizontal and/or volume average of the total model domain. Beyond that, these calculations can also be carried out for subdomains which can be defined using the field rmask within the user-defined software (see chapter 3.5.3). The number of these subdomains is determined with the parameter statistic_regions. Maximum 9 additional subdomains are allowed. The parameter region can be used to assigned names (identifier) to these subdomains which are then used in the headers of the output files and plots.

If the default NetCDF output format is selected (see parameter data_output_format), data for the total domain and all defined subdomains are output to the same file(s) (DATA_1D_PR_NETCDF, DATA_1D_TS_NETCDF). In case of statistic_regions > 0, data on the file for the different domains can be distinguished by a suffix which is appended to the quantity names. Suffix 0 means data for the total domain, suffix 1 means data for subdomain 1, etc.

In case of data_output_format = 'profil', individual local files for profiles (PLOT1D_DATA) are created for each subdomain. The individual subdomain files differ by their name (the number of the respective subdomain is attached, e.g. PLOT1D_DATA_1). In this case the name of the file with the data of the total domain is PLOT1D_DATA_0. If no subdomains are declared (statistic_regions = 0), the name PLOT1D_DATA is used (this must be considered in the respective file connection statements of the mrun configuration file).

surface_heatflux

Kinematic sensible heat flux at the bottom surface (in K m/s). 

If a value is assigned to this parameter, the internal two-dimensional surface heat flux field shf is initialized with the value of surface_heatflux as bottom (horizontally homogeneous) boundary condition for the temperature equation. This additionally requires that a Neumann condition must be used for the potential temperature (see bc_pt_b), because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed. Also, changes of the surface temperature (see pt_surface_initial_change) are not allowed. The parameter random_heatflux can be used to impose random perturbations on the (homogeneous) surface heat flux field shf.

Attention:
Setting of surface_heatflux requires setting of use_surface_fluxes=.T., if the Prandtl-layer is switched off (prandtl_layer=.F.). 

In case of a non-flat topography, the internal two-dimensional surface heat flux field shf is initialized with the value of surface_heatflux at the bottom surface and wall_heatflux(0) at the topography top face. The parameter random_heatflux can be used to impose random perturbations on this combined surface heat flux field shf. 

If no surface heat flux is assigned, shf is calculated at each timestep by u_* * theta_* (of course only with prandtl_layer switched on). Here, u_* and theta_* are calculated from the Prandtl law assuming logarithmic wind and temperature profiles between k=0 and k=1. In this case a Dirichlet condition (see bc_pt_b) must be used as bottom boundary condition for the potential temperature.

See also top_heatflux.

surface_pressure

Atmospheric pressure at the surface (in hPa). 

surface_scalarflux

Scalar flux at the surface (in kg/(m² s)). 

If a non-zero value is assigned to this parameter, the respective scalar flux value is used as bottom (horizontally homogeneous) boundary condition for the scalar concentration equation. This additionally requires that a Neumann condition must be used for the scalar concentration (see bc_s_b), because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed. Also, changes of the surface scalar concentration (see s_surface_initial_change) are not allowed.

If no surface scalar flux is assigned (surface_scalarflux = 0.0), it is calculated at each timestep by u_* * s_* (of course only with Prandtl layer switched on). Here, s_* is calculated from the Prandtl law assuming a logarithmic scalar concentration profile between k=0 and k=1. In this case a Dirichlet condition (see bc_s_b) must be used as bottom boundary condition for the scalar concentration.

surface_waterflux

Kinematic water flux near the surface (in m/s). 

If a non-zero value is assigned to this parameter, the respective water flux value is used as bottom (horizontally homogeneous) boundary condition for the humidity equation. This additionally requires that a Neumann condition must be used for the specific humidity / total water content (see bc_q_b), because otherwise the resolved scale may contribute to the surface flux so that a constant value cannot be guaranteed. Also, changes of the surface humidity (see q_surface_initial_change) are not allowed.

If no surface water flux is assigned (surface_waterflux = 0.0), it is calculated at each timestep by u_* * q_* (of course only with Prandtl layer switched on). Here, q_* is calculated from the Prandtl law assuming a logarithmic temperature profile between k=0 and k=1. In this case a Dirichlet condition (see bc_q_b) must be used as the bottom boundary condition for the humidity.

s_surface

Surface value of the passive scalar (in kg/m³). 

s_surface_initial
_change

Change in surface scalar concentration to be made at the beginning of the 3d run (in kg/m³). 

If s_surface_initial_change is set to a non-zero value, the near surface scalar flux is not allowed to be given simultaneously (see surface_scalarflux).

s_vertical_gradient

Scalar concentration gradient(s) of the initial scalar concentration profile (in kg/m³ / 100 m). 

The scalar gradient holds starting from the height level defined by s_vertical_gradient_level (precisely: for all uv levels k, where zu(k) > s_vertical_gradient_level, s_init(k) is set: s_init(k) = s_init(k-1) + dzu(k) * s_vertical_gradient) up to the top boundary or up to the next height level defined by s_vertical_gradient_level. A total of 10 different gradients for 11 height intervals (10 intervals if s_vertical_gradient_level(1) = 0.0) can be assigned. The surface scalar value is assigned via s_surface.

Example: 

s_vertical_gradient = 0.1, 0.05, 
s_vertical_gradient_level = 500.0, 1000.0,

That defines the scalar concentration to be constant with height up to z = 500.0 m with a value given by s_surface. For 500.0 m < z <= 1000.0 m the scalar gradient is 0.1 kg/m³ / 100 m and for z > 1000.0 m up to the top boundary it is 0.05 kg/m³ / 100 m (it is assumed that the assigned height levels correspond with uv levels).

s_vertical_gradient_
level

10 * 0.0

Height level from which on the scalar gradient defined by s_vertical_gradient is effective (in m). 

The height levels are to be assigned in ascending order. The default values result in a scalar concentration constant with height regardless of the values of s_vertical_gradient (unless the top boundary of the model is higher than 100000.0 m). For the piecewise construction of scalar concentration profiles see s_vertical_gradient.

timestep_scheme

'runge
kutta-3'

Time step scheme to be used for the integration of the prognostic variables. 

The user can choose between the following schemes:

'runge-kutta-3'

'runge-kutta-2'

Topography mode. 

The user can choose between the following modes:

'flat'

'single_building'

'single_street_canyon'

'read_from_file'

• 'cell_edge': the distance between cell edges defines the extent of topography. This setting is normally for generic topographies, i.e. topographies that are constructed using length parameters. For example, topography = 'single_building' is constructed using building_length_x and building_length_y. The advantage of this setting is that the actual size of generic topography is independent of the grid size, provided that the length parameters are an integer multiple of the grid lengths dx and dy. This is convenient for resolution parameter studies.
• 'cell_center': the number of topography cells define the extent of topography. This setting is normally for rastered real topographies derived from digital elevation models. For example, topography = 'read_from_file' is constructed using the input file TOPOGRAPHY_DATA. The advantage of this setting is that the rastered topography cells of the input file are directly mapped to topography grid boxes in PALM.

• 'cell_edge' if topography = 'single_building' or 'single_street_canyon',
• 'cell_center' if topography = 'read_from_file',
• none (' ' ) otherwise, leading to an abort if topography_grid_convention is not set.

• For PALM simulations using a user-defined topography, the topography_grid_convention must be explicitly set to either 'cell_edge' or 'cell_center'.
• For PALM simulations using a standard topography ('single_building', 'single_street_canyon' or 'read_from_file'), it is possible but not required to set the  topography_grid_convention because appropriate default values apply.

Kinematic sensible heat flux at the top boundary (in K m/s). 

If a value is assigned to this parameter, the internal two-dimensional surface heat flux field tswst is initialized with the value of top_heatflux as top (horizontally homogeneous) boundary condition for the temperature equation. This additionally requires that a Neumann condition must be used for the potential temperature (see bc_pt_t), because otherwise the resolved scale may contribute to the top flux so that a constant flux value cannot be guaranteed. 

Note:
The application of a top heat flux additionally requires the setting of initial parameter use_top_fluxes = .T..

No Prandtl-layer is available at the top boundary so far.

See also surface_heatflux.

If a value is assigned to this parameter, the internal two-dimensional u-momentum flux field uswst is initialized with the value of top_momentumflux_u as top (horizontally homogeneous) boundary condition for the u-momentum equation.

Notes:
The application of a top momentum flux additionally requires the setting of initial parameter use_top_fluxes = .T.. Setting of top_momentumflux_u requires setting of top_momentumflux_v also.

A Neumann condition should be used for the u velocity component (see bc_uv_t), because otherwise the resolved scale may contribute to the top flux so that a constant flux value cannot be guaranteed. 

No Prandtl-layer is available at the top boundary so far.

The coupled ocean parameter file PARIN_O should include dummy REAL value assignments to both top_momentumflux_u and top_momentumflux_v (e.g. top_momentumflux_u = 0.0, top_momentumflux_v = 0.0) to enable the momentum flux coupling.

If a value is assigned to this parameter, the internal two-dimensional v-momentum flux field vswst is initialized with the value of top_momentumflux_v as top (horizontally homogeneous) boundary condition for the v-momentum equation.

Notes:
The application of a top momentum flux additionally requires the setting of initial parameter use_top_fluxes = .T.. Setting of top_momentumflux_v requires setting of top_momentumflux_u also.

A Neumann condition should be used for the v velocity component (see bc_uv_t), because otherwise the resolved scale may contribute to the top flux so that a constant flux value cannot be guaranteed. 

No Prandtl-layer is available at the top boundary so far.

The coupled ocean parameter file PARIN_O should include dummy REAL value assignments to both top_momentumflux_u and top_momentumflux_v (e.g. top_momentumflux_u = 0.0, top_momentumflux_v = 0.0) to enable the momentum flux coupling.

Kinematic salinity flux at the top boundary, i.e. the sea surface (in psu m/s). 

This parameter only comes into effect for ocean runs (see parameter ocean).

If a value is assigned to this parameter, the internal two-dimensional surface heat flux field saswst is initialized with the value of top_salinityflux as top (horizontally homogeneous) boundary condition for the salinity equation. This additionally requires that a Neumann condition must be used for the salinity (see bc_sa_t), because otherwise the resolved scale may contribute to the top flux so that a constant flux value cannot be guaranteed. 

Note:
The application of a salinity flux at the model top additionally requires the setting of initial parameter use_top_fluxes = .T..

See also bottom_salinityflux.

ug_surface

ug_vertical_gradient

ug_vertical_gradient_level

ups_limit_e

Subgrid-scale turbulent kinetic energy difference used as criterion for applying the upstream scheme when upstream-spline advection is switched on (in m²/s²).  

This variable steers the appropriate treatment of the advection of the subgrid-scale turbulent kinetic energy in case that the uptream-spline scheme is used . For further information see ups_limit_pt. 

Only positive values are allowed for ups_limit_e.

ups_limit_pt

Temperature difference used as criterion for applying  the upstream scheme when upstream-spline advection  is switched on (in K). 

This criterion is used if the upstream-spline scheme is switched on (see scalar_advec).
If, for a given gridpoint, the absolute temperature difference with respect to the upstream grid point is smaller than the value given for ups_limit_pt, the upstream scheme is used for this gridpoint (by default, the upstream-spline scheme is always used). Reason: in case of a very small upstream gradient, the advection should cause only a very small tendency. However, in such situations the upstream-spline scheme may give wrong tendencies at a grid point due to spline overshooting, if simultaneously the downstream gradient is very large. In such cases it may be more reasonable to use the upstream scheme. The numerical diffusion caused by the upstream schme remains small as long as the upstream gradients are small.

The percentage of grid points for which the upstream scheme is actually used, can be output as a time series with respect to the three directions in space with run parameter (see dt_dots, the timeseries names in the NetCDF file are 'splptx', 'splpty', 'splptz'). The percentage of gridpoints  should stay below a certain limit, however, it is not possible to give a general limit, since it depends on the respective flow. 

Only positive values are permitted for ups_limit_pt.

ups_limit_u

Velocity difference (u-component) used as criterion for applying the upstream scheme when upstream-spline advection is switched on (in m/s). 

This variable steers the appropriate treatment of the advection of the u-velocity-component in case that the upstream-spline scheme is used. For further information see ups_limit_pt. 

Only positive values are permitted for ups_limit_u.

ups_limit_v

Velocity difference (v-component) used as criterion for applying the upstream scheme when upstream-spline advection is switched on (in m/s). 

This variable steers the appropriate treatment of the advection of the v-velocity-component in case that the upstream-spline scheme is used. For further information see ups_limit_pt. 

Only positive values are permitted for ups_limit_v.

ups_limit_w

Velocity difference (w-component) used as criterion for applying the upstream scheme when upstream-spline advection is switched on (in m/s). 

This variable steers the appropriate treatment of the advection of the w-velocity-component in case that the upstream-spline scheme is used. For further information see ups_limit_pt. 

Only positive values are permitted for ups_limit_w.

use_surface_fluxes

Parameter to steer the treatment of the subgrid-scale vertical fluxes within the diffusion terms at k=1 (bottom boundary).

By default, the near-surface subgrid-scale fluxes are parameterized (like in the remaining model domain) using the gradient approach. If use_surface_fluxes = .TRUE., the user-assigned surface fluxes are used instead (see surface_heatflux, surface_waterflux and surface_scalarflux) or the surface fluxes are calculated via the Prandtl layer relation (depends on the bottom boundary conditions, see bc_pt_b, bc_q_b and bc_s_b).

use_surface_fluxes is automatically set .TRUE., if a Prandtl layer is used (see prandtl_layer). 

The user may prescribe the surface fluxes at the bottom boundary without using a Prandtl layer by setting use_surface_fluxes = .T. and prandtl_layer = .F.. If , in this case, the momentum flux (u_*²) should also be prescribed, the user must assign an appropriate value within the user-defined code.

Parameter to steer the treatment of the subgrid-scale vertical fluxes within the diffusion terms at k=nz (top boundary).

By default, the fluxes at nz are calculated using the gradient approach. If use_top_fluxes = .TRUE., the user-assigned top fluxes are used instead (see top_heatflux, top_momentumflux_u, top_momentumflux_v, top_salinityflux).

Currently, no value for the latent heatflux can be assigned. In case of use_top_fluxes = .TRUE., the latent heat flux at the top will be automatically set to zero.

use_ug_for_galilei_tr

Switch to determine the translation velocity in case that a Galilean transformation is used.

In case of a Galilean transformation (see galilei_transformation), use_ug_for_galilei_tr = .T.  ensures that the coordinate system is translated with the geostrophic windspeed.

Alternatively, with use_ug_for_galilei_tr = .F., the geostrophic wind can be replaced as translation speed by the (volume) averaged velocity. However, in this case the user must be aware of fast growing gravity waves, so this choice is usually not recommended!

vg_surface

vg_vertical_gradient

vg_vertical_gradient_level

wall_adjustment

Parameter to restrict the mixing length in the vicinity of the bottom boundary (and near vertical walls of a non-flat topography). 

With wall_adjustment = .TRUE., the mixing length is limited to a maximum of  1.8 * z. This condition typically affects only the first grid points above the bottom boundary.

In case of  a non-flat topography the respective horizontal distance from vertical walls is used.

ws_vertical_gradient

Gradient(s) of the profile for the large scale subsidence/ascent velocity (in (m/s) / 100 m). 

This gradient holds starting from the height  level defined by ws_vertical_gradient_level (precisely: for all uv levels k where zu(k) > ws_vertical_gradient_level, w_subs(k) is set: w_subs(k) = w_subs(k-1) + dzu(k) * ws_vertical_gradient) up to the top boundary or up to the next height level defined by ws_vertical_gradient_level. A total of 10 different gradients for 11 height intervals (10 intervals if ws_vertical_gradient_level(1) = 0.0) can be assigned.  

Example: 

ws_vertical_gradient = -0.002, 0.0, 
ws_vertical_gradient_level = 0.0, 1000.0,

That defines the subsidence/ascent profile to be linear up to z = 1000.0 m with a surface value of 0 m/s. For z > 1000.0 m up to the top boundary the gradient is 0.0 (m/s) / 100 m (it is assumed that the assigned height levels correspond with uv levels).

With an appropriate construction of w_subs the height of the boundary layer z_i can be kept approximately constant.

Attention:
The large scale vertical motion is only applied to the prognostic equation for the scalar quantities (potential temperature, humidity if humidity = .T. or passive scalar if passive_scalar = .T.) because it cannot be applied to the momentum equations due to incompressibility. Thus, the model is not mass consistent.

ws_vertical_gradient
_level

10 *  0.0

Height level from which on the gradient for the subsidence/ascent velocity defined by ws_vertical_gradient is effective (in m). 

The height levels have to be assigned in ascending order. The default values result in a profile which is zero everywhere regardless of the values of ws_vertical_gradient. For the piecewise construction of the subsidence/ascent velocity profile see ws_vertical_gradient.