Changes between Version 58 and Version 59 of doc/app/userint/int

Timestamp:

Feb 12, 2020 1:31:02 PM (5 years ago)

Author:

scharf

Comment:

--

doc/app/userint/int

@@ -36 +36 @@
 }}}
 {{{#!td
-Output of the values of the user-defined parameters to the local files [../../iofiles#HEADER HEADER] and [../../iofiles#RUN_CONTROL 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 [../../iofiles#PARIN 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 [../../inipar#statistic_regions statistic_regions]).
+Output of the values of the user-defined parameters to the local files [../../iofiles#HEADER HEADER] and [../../iofiles#RUN_CONTROL 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 [../../iofiles#PARIN 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 [../../initialization_parameters#statistic_regions statistic_regions]).
 }}}
 |----------------
@@ -46 +46 @@
 }}}
 {{{#!td
-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 (see [[../../inipar|Initialization parameters]]) 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 [../../inipar#statistic_regions statistic_regions] and [[../subd|Definition of user-defined domains]]) and of additional time series quantities (see comment line example in the file). 
+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 (see [[../../initialization_parameters|Initialization parameters]]) 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 [../../initialization_parameters#statistic_regions statistic_regions] and [[../subd|Definition of user-defined domains]]) and of additional time series quantities (see comment line example in the file). 
 CPU time for user_init is considered in the local file [../../iofiles#CPU_MEASURES CPU_MEASURES] within the category "initialisation".\\
 See also [#user_init_3d_model user_init_3d_model].
@@ -92 +92 @@
 {{{#!td
 User-defined initilisation of the plant canopy model.\\
-Here, the user can define the two three-dimensional arrays {{{lad_s}}} and {{{cdc}}} that stand for the leaf area density and the canopy drag coefficient. By this, the user can configure a plant canopy. This requires defining at least one new [../../inipar#canopy_mode canopy_mode] in the {{{SELECT CASE( TRIM(canopy_mode) )}}} command in {{{user_init_plant_canopy}}}. Note that the [../../inipar#canopy_mode canopy_mode]'' 'block' ''is not allowed here since it is the standard case used in the calling routine {{{init_3d_model}}}. 
+Here, the user can define the two three-dimensional arrays {{{lad_s}}} and {{{cdc}}} that stand for the leaf area density and the canopy drag coefficient. By this, the user can configure a plant canopy. This requires defining at least one new [../../initialization_parameters#canopy_mode canopy_mode] in the {{{SELECT CASE( TRIM(canopy_mode) )}}} command in {{{user_init_plant_canopy}}}. Note that the [../../initialization_parameters#canopy_mode canopy_mode]'' 'block' ''is not allowed here since it is the standard case used in the calling routine {{{init_3d_model}}}. 
 }}}
 |----------------
@@ -103 +103 @@
 {{{#!td
 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 [../../inipar#topography topography] mode in the {{{SELECT CASE( TRIM(topography) )}}} command and the definition of [../../inipar#topography_grid_convention topography_grid_convention] in {{{user_init_grid}}}. Note that the [../../inipar#topography topography] modes'' 'flat', 'single_building' ''and'' 'read_from_file' ''are not allowed here since these are the standard cases used in the calling routine {{{init_grid}}}.\\
+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 [../../initialization_parameters#topography topography] mode in the {{{SELECT CASE( TRIM(topography) )}}} command and the definition of [../../initialization_parameters#topography_grid_convention topography_grid_convention] in {{{user_init_grid}}}. Note that the [../../initialization_parameters#topography topography] modes'' 'flat', 'single_building' ''and'' 'read_from_file' ''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 [../../iofiles#CPU_MEASURES CPU_MEASURES] within the category "initialisation".
 }}}
@@ -181 +181 @@
 }}}
 {{{#!td
-Horizontal averages of vertical profiles of user-defined quantities can be computed here. Also, additional time series quantities can be calculated. They have to be defined before in routine [#user_init user_init]. The routine is called once for each defined  statistic_region (see [../../inipar#statistic_regions statistic_regions]).\\
+Horizontal averages of vertical profiles of user-defined quantities can be computed here. Also, additional time series quantities can be calculated. They have to be defined before in routine [#user_init user_init]. The routine is called once for each defined  statistic_region (see [../../initialization_parameters#statistic_regions statistic_regions]).\\
 The routine contains some simple examples (as comment lines) in order to demonstrate how to use it.\\\\
 Profile sums have to be stored in the array {{{sums_l}}}. The profile identification number (second index of array {{{sums_l}}}) must be within the range [ {{{pr_palm+1}}} , {{{pr_palm+max_pr_user}}} ], where {{{pr_palm}}} is an internal parameter and  {{{max_pr_user}}} is the number of user-defined profiles as given by parameter [../../userpar#data_output_pr_user data_output_pr_user] in the respective {{{PALM}}} run. \\
@@ -264 +264 @@
 }}}
 {{{#!td
-Resorts user-defined quantities (to be output as volume data; see [../../userpar#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The input parameter {{{nz_do}}} defines the upper limit of vertical grid index {{{k}}} of the output array (see [../../d3par#)nz_do3d nz_do3d]. The output parameter found has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
+Resorts user-defined quantities (to be output as volume data; see [../../userpar#data_output_user data_output_user]) with indices {{{(k,j,i)}}} to a temporary array {{{local_pf}}} with indices {{{(i,j,k)}}} and sets the grid on which they are defined. Depending on the value of input parameter {{{av}}} resorting is done for instantaneous ({{{av}}}=''0'') or time averaged data ({{{av}}}=''1''). Input parameter {{{variable}}} contains the string identifier of the respective variable. The input parameter {{{nz_do}}} defines the upper limit of vertical grid index {{{k}}} of the output array (see [../../runtime_parameters#)nz_do3d nz_do3d]. The output parameter found has to be set ''.TRUE.'' by the user, otherwise, an error message will appear in the job protocol for the respective output quantity.\\
 See chapter [[../output|User-defined output quantities]] about creating user-defined output quantities.
 }}}