Changes between Version 46 and Version 47 of doc/app/user_parameters


Ignore:
Timestamp:
Jul 28, 2023 7:51:44 AM (15 months ago)
Author:
raasch
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/user_parameters

    v46 v47  
    1212namelist /user_parameters/  abcd, data_output_masks_user, data_output_pr_user, data_output_user, region
    1313}}}
    14 The listed parameters after abcd are included in [wiki:doc/app/userint/int#user_parin user_parin] by default, and they are described in the table below.
     14The listed parameters after abcd are defined in [wiki:doc/app/userint/int#user_parin user_parin] by default. A complete list of pre-defined parameters can be found [https://docs.palm-model.org/latest/Reference/LES_Model/Namelists/#user-parameters here].
    1515In the parameter file [wiki:doc/app/iofiles#PARIN PARIN] a value can be assigned:
    1616{{{
     
    2222The user-module is automatically activated when the {{{&user_parameters}}} namelist appears in the parameter file [wiki:doc/app/iofiles#PARIN PARIN] (_p3d).
    2323
    24 \\\\
    25 
    26 '''namelist group name:''' [=#user_parameters '''{{{user_parameters}}}''']
    27 ----
    28 ||='''Parameter Name'''  =||='''[../fortrantypes Fortran]\\[../fortrantypes Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
    29 |----------------
    30 {{{#!td style="vertical-align:top"
    31 [=#data_output_masks_user '''data_output_masks_user''']
    32 }}}
    33 {{{#!td style="vertical-align:top"
    34 C * 10 ('''max_masks''', 100)
    35 }}}
    36 {{{#!td style="vertical-align:top"
    37 '''max_masks''' *100* ' '
    38 }}}
    39 {{{#!td
    40 User-defined quantities for which masked data are to be output (see [../maskedoutput Masked data output]).\\\\
    41 Beside the PALM standard output quantities (which can be selected via parameter [../runtime_parameters#data_output_masks data_output_masks]), the user can define (without any restriction) additional output quantities (e.g. the temperature variance, etc.) of masked data. Each of these quantities has to be given a unique identifier (string) which must be different from the strings defining the standard output quantities (see list in the description of [../runtime_parameters#data_output_masks data_output_masks]). Data output can be switched on by assigning the respective strings to '''data_output_masks_user'''. \\\\
    42 The user has to calculate/provide the respective data array(s) by appropriately extending the user interface (see [[../userint/output|here]])\\\\
    43 For further steering of the masked output (output times, defining mask locations, time averaging, etc.), the steering parameters for [../runtime_parameters#data_output_masks data_output_masks] apply accordingly.\\\\
    44 }}}
    45 |----------------
    46 {{{#!td style="vertical-align:top;width: 150px"
    47 [=#data_output_pr_user '''data_output_pr_user''']
    48 }}}
    49 {{{#!td style="vertical-align:top;style="width: 50px"
    50 C * 10 (200)
    51 }}}
    52 {{{#!td style="vertical-align:top;style="width: 75px"
    53 200 * ' '
    54 }}}
    55 {{{#!td
    56 User defined quantities for which horizontally averaged profile data is to be output. \\\\
    57 Beside the PALM standard output quantities (which can be selected via parameter [../runtime_parameters#data_output_pr data_output_pr]), the user can define (without any restriction) additional
    58 output quantities (e.g. turbulent resolved-scale horizontal momentum fluxes, etc.). Each of these quantities has to be given a unique identifier (string) which must be different
    59 from the strings defining the standard output quantities (see list in the description of [../runtime_parameters#data_output_pr data_output_pr]). Data output can be switched on by assigning the
    60 respective strings to '''data_output_user'''.\\\\
    61 The user has to calculate/provide the respective data array(s) by appropriately extending the user interface (see [[../userint/output|here]])
    62 }}}
    63 |----------------
    64 {{{#!td style="vertical-align:top"
    65 [=#data_output_user '''data_output_user''']
    66 }}}
    67 {{{#!td style="vertical-align:top"
    68 C * 10 (100)
    69 }}}
    70 {{{#!td style="vertical-align:top"
    71 100 * ' '
    72 }}}
    73 {{{#!td
    74 User defined quantities for which 2d cross section and/or 3d volume data are to be output.\\\\
    75 Beside the PALM standard output quantities (which can be selected via parameter [../runtime_parameters#data_output data_output]), the user can define (without any restriction) additional output
    76 quantities (e.g. the temperature variance, etc.). Each of these quantities has to be given a unique identifier (string) which must be different from the strings defining the standard
    77 output quantities (see list in the description of [../runtime_parameters#data_output data_output]). Data output can be switched on by assigning the respective strings to '''data_output_user'''. \\\\
    78 The user has to calculate/provide the respective data array(s) by appropriately extending the user interface (see [[../userint/output|here]])\\\\
    79 For further steering of the user defined output (output times, cross section levels, time averaging, etc.), the steering parameters for [../runtime_parameters#data_output data_output] apply
    80 accordingly.\\\\
    81 '''Example:'''\\
    82 If the user defined output quantity is the temperature variance and if the user has chosen the string '' 'pt2' '' as an identifier for this quantity, then output of horizontal cross sections can be selected by assigning '''data_output_user''' = '' 'pt2_xy' ''.
    83 }}}
    84 |----------------
    85 {{{#!td style="vertical-align:top"
    86 [=#region '''region''']
    87 }}}
    88 {{{#!td style="vertical-align:top"
    89 C*40 (0:9)
    90 }}}
    91 {{{#!td style="vertical-align:top"
    92 'total domain'
    93 }}}
    94 {{{#!td
    95 Name(s) of the subdomain(s) defined by the user.\\\\
    96 With this variable, names can be assigned to the subsections defined by the user (see [../initialization_parameters#statistic_regions statistic_regions]). Up to 9 subdomains are allowed ('''region''' (1)
    97 to '''region''' (9)), the total domain has the index 0 ('''region''' (0)). 
    98 }}}
    99 |----------------
    100 {{{#!td style="vertical-align:top"
    101 [=#switch_off_module '''switch_off_module''']
    102 }}}
    103 {{{#!td style="vertical-align:top"
    104 L
    105 }}}
    106 {{{#!td style="vertical-align:top"
    107 .F.
    108 }}}
    109 {{{#!td
    110 
    111 }}}