Call location

Subroutine name and argument

Possible actions

End of parin.f90

user_parin

Declaration of user-defined parameters in the NAMELIST group &userpar. These parameters can be read from the local file PARIN and be used for steering the user-defined code (see chapter 4.0). The user-defined parameter region is already pre-defined in &userpar and must not be changed. Additional NAMELIST groups may be declared if desired. 
The CPU time needed for executing user_parin is included in the local file CPU_MEASURES within the category “initialisation”.

End of header.f90

user_header( io )

Output of the values of the user-defined parameters to the local files HEADER and RUN_CONTROL. This output should be made anyway in order to subsequently check the parameter values used for the respective run. The number of the output unit is passed as an argument and must be used in each WRITE statement (e.g.: “WRITE ( io,…”)). By default, this subroutine only creates output if a user-defined NAMELIST is found in file PARIN (in this case the variable user_defined_namelist_found is set  .TRUE. in user_parin). The names of any user-defined subdomains are displayed by default (see statistic_regions).

End of init_3d_model.f90

user_init

Here, user-defined initialization actions which should be accomplished before the start of the 3D-model can be implemented (e.g. inhomogenous change of the surface temperature, the roughness length, or similar). At this point, all default parameter initializations of the model (chapter 4.1) have already been carried out at all. 

One of the most important actions here is the definition of user-defined subdomains for statistic analysis and output (see statistic_regions and chapter 3.5.3). 
CPU time for user_init is considered in the local file CPU_MEASURES within the category “initialisation”.

Execution of user-defined grid initializing actions.

Here, the user can define the two-dimensional index array nzb_local that is used to set up a non-flat topography. This requires definition of at least one new topography mode in the SELECT CASE( TRIM(topography) ) command in user_init_grid. Note that the topography modes 'flat' and 'single_building' are not allowed here since these are the standard cases used in the calling routine init_grid.

CPU time for user_init_grid is considered in the local file CPU_MEASURES within the category “initialisation”.

In the middle of init_particles.f90

user_init_
particles

With this routine e.g. size and color of particles, which have been released initially from a source, can be specified. Like the calling routine init_particles, this routine is only called if particle advection is switched on (see package parameter dt_prel).

End of advec_particles.f90

user_particle_
attributes

Here the particles can be assigned new attributes (diameter, color etc.) after each time step. Like the calling routine advec_particles, this routine is only called if particle advection is switched on (see package parameter dt_prel).

Before the plot of particles and cross-sections in
dvrp_plot.f90

user_dvrp_coltab ( mode )

With this routine, color tables can be adjusted which should be used for output with the dvrp software. Individuell color tables for particles and cross-sections are possible. For this purpose the two arrays interval_values_dvrp and interval_h_dvrp (declared in the module dvrp_variables) have to be preset with appropriate values. The number of color table entries must be assigned to the variable of dvrp_colourtable_entries. The value of the subroutine argument mode defines, whether the color table is valid for particles or for cross-sections (i.e. mode can have the values “particles” or “slicer”). 
This routine only becomes active if dvrp-graphics is switched on (see package parameter dt_dvrp).

Beginning and end of the time integration loop of 
time_integration.f90 as well as after each prognostic equation in
prognostic_equations.f90

user_actions( location )

or

user_actions( i, j, location )

In this routine user actions can be implemented which are to be executed either at each time step or at certain times (defined by the user). Since in each case the routine is called at the beginning and at the end of a time step as well as after each prognostic equation it must be defined at which place (and/or at which places) the respective actions are supposed to be executed. For this purpose an appropriate CASE structure is already inserted in this routine. The location of the calling routine is passed to this routine via the argument location. For example, if called at the beginning of a time step, location = 'before_timestep' and if called at the end, location = 'after_timestep'.

Calculation of user-defined output quantities should be carried out at location = 'after_integration'.

Important: if the cache-optimized version of prognostic_equation.f90 is used (this is the default for IBM-Regatta-Systems), the loop variables i and j must be passed as arguments for all calls within prognostic_equations.

CPU time for user_actions appears within the category “user_actions” in the local file CPU_MEASURES. If the cache-optimized version of prognostic_equation.f90 is used, this time measurement only considers the CPU time which was needed outside of the prognostic equations. Time needed for calls within prognostic_equations is considered within the category "all prog.equations".

Important: this subroutine is written as a FORTRAN module, which uses so-called function overloading. It can be called in two ways: with one argument (location) and with three arguments (i, j, location). The three argument version is used in the cache-optimized version of prognostic_equations. Depending on the number of given arguments the subroutine internally calls user_actions or user_actions_ij. So the user must insert the actions (code extensions) desired for the respective prognostic equation either in the CASE structure of user_actions, or/and in the CASE structure of user_actions_ij!

flow_statistics.f90 before the summation of array hom (horizontal averages)

user_statistics

Horizontal averages of vertical profiles of additional quantities (for example user variables) can be computed and written to the array sums. Please use profile numbers starting from 70 upward (thus e.g. sums (…, 60) =…). These additional profiles are temporally averaged in flow_statistics. If these profiles should be displayed with the plot program profil, further instructions in the user-defined software are necessary. For this, an understanding of the operating mode of the subroutine plot_1d is required.

End of palm.f90

user_last_
action

User-defined actions which are to be executed at the end of a model run. When user_last_actions is called all model actions are already completed, but the files opened by the model are not closed yet and possibly terminating actions for these files (see subroutine of close_files) are also not carried out yet. 
CPU time for user_last_actions appears in the local file CPU_MEASURES within the category “last actions” (the time necessary for close_files is included).