Changes between Version 20 and Version 21 of doc/app/par


Ignore:
Timestamp:
Apr 3, 2018 3:24:40 PM (7 years ago)
Author:
kanani
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/par

    v20 v21  
    88                                 dx = 50.0, dy = 50.0, dz = 50.0,
    99                                 initializing_actions = "set_1d-model_profiles",
    10                                  constant_flux_layer = .TRUE.,/
     10                                 constant_flux_layer = .TRUE., /
    1111
    12       &runtime_parameters  end_time = 9000.0, section_xy = 1, 10, 20,/
     12      &runtime_parameters  end_time = 9000.0, section_xy = 1, 10, 20, /
    1313
    14       &packagename_parameters var1 = .TRUE. /
     14      &packagename_parameters var1 = .TRUE., /
    1515
    16       &user_parameters abcd = 1234,0,/
     16      &user_parameters abcd = 1234, 0, /
    1717}}}
    1818\\
    1919The parameters are separated into four different groups which all start with the so-called NAMELIST group names. These are {{{&initialization_parameters}}}, {{{&runtime_parameters}}} and {{{&packagename_parameters}}} as well as {{{&user_parameters}}}. In each case a group is terminated with one backslash ("/"). Between the beginning of the line and the group name at least one blank has to be typed. Between the group names and the "/", the values are assigned to the variables. The example shows that in principle all FORTRAN data types are allowed. For more details concerning the NAMELIST syntax, refer to appropriate FORTRAN manuals.\\\\
    20 Parameters belonging to the group {{{inipar}}} are first read by PALM. These are the initialization parameters. Second, the so-called run parameters belonging to the group {{{d3par}}} are read in, then the parameters for steering the optional software packages (group {{{packagename}}}, the string "{{{packagename}}}" must be replaced by the NAMELIST group name of the respective package) as well as user-defined parameters (group {{{userpar}}}). The four groups must be given in this order, the last groups, {{{packagename}}} and {{{userpar}}}, may be omitted. If several [../packages software packages] are selected, further NAMELIST groups may be inserted before the group {{{userpar}}}.
     20Parameters belonging to the group {{{&initialization_parameters}}} are first read by PALM. These are the initialization parameters. Second, the so-called run parameters belonging to the group {{{&runtime_parameters}}} are read in, then the parameters for steering the optional software packages (group {{{&packagename_parameters}}}, the string "{{{packagename}}}" must be replaced by the NAMELIST group name of the respective package) as well as user-defined parameters (group {{{&user_parameters}}}). The four groups must be given in this order, the last groups, {{{&packagename_parameters}}} and {{{&user_parameters}}}, may be omitted. If several [../packages software packages] are selected, further NAMELIST groups may be inserted before the group {{{&user_parameters}}}.
    2121
    2222The '''initialization''', '''run''' and '''package parameters''' differ as follows:
     
    2424  * The '''[../inipar initialization parameters]''' are steering the basic settings of the model run. They define e.g. the number of the grid points, the numerical schemes to be used, initial and boundary conditions to be applied, how the three-dimensional fields are initialized at the beginning of a model run (constant  value profiles or 1D-model-pre-run, the initial temperature profile etc.). These parameters apply to the total model run and thus can not be changed with restart runs! If one tries to change these values within the NAMELIST input file of a restart run, then these changes are ignored (sole exception is the parameter [../inipar#initializing_actions initializing_actions], which must be given the value '' 'read_restart_data' '' for restart runs).
    2525       
    26   * The '''[../d3par run parameters]''' are generally steering actions to be carried out during a model run. One can select for example, at which times plot output should happen and which variables are to be written. Additionally one can (and must) specify the time to be simulated. Run parameters only apply to the actual run (job) and with each restart run other values may be declared (if runs are restarted automatically, parameters will usually keep their values, provided that the NAMELIST input file was not changed by the user in the meantime).
     26  * The '''[../d3par runtime parameters]''' are generally steering actions to be carried out during a model run. One can select for example, at which times plot output should happen and which variables are to be written. Additionally one can (and must) specify the time to be simulated. Run parameters only apply to the actual run (job) and with each restart run other values may be declared (if runs are restarted automatically, parameters will usually keep their values, provided that the NAMELIST input file was not changed by the user in the meantime).
    2727       
    2828  * '''Package parameters''' (see [../sppar spectra parameters] and [../dvrpar dvr parameters]) behave like '''run parameters'''. Package parameters determine the behavior of the additional (not user-defined) software packages.
    2929
    30 Starting from version 3.2, the {{{particles-package}}} is part of the default model, so it does not have to be switched on using '''mrun'''-option {{{-p}}}. However, the respective parameters have still to be set by using the NAMELIST group [../parpar particles_par].\\\\
    31 The user-defined parameters are assigned by the user within the NAMELIST group name {{{&user_parameters}}} (see [../userint/userpar here]). They steer actions programmed by the user. By default, this group has only one parameter ([../userpar#region region]). If the user don't want to assign any values to the user-defined  parameters, the group {{{userpar}}} may be omitted. The group name {{{&user_parameters}}} can be changed by the user in the user-defined code. In addition to this, further NAMELIST groups may also be declared (all within routine [source:palm/trunk/SOURCE/user_parin.f90 user_parin]). A simple but complete example of the input file PARIN can be found [../examples/cbl here]. This example file can be used together with the [../configexample configuration file] for the execution of a model test run.\\\\
     30Starting from version 3.2, the {{{particles-package}}} is part of the default model, so it does not have to be switched on using '''mrun'''-option {{{-p}}}. However, the respective parameters have still to be set by using the NAMELIST group [../parpar particle_parameters].\\\\
     31The user-defined parameters are assigned by the user within the NAMELIST group name {{{&user_parameters}}} (see [../userint/userpar here]). They steer actions programmed by the user. By default, this group has only one parameter ([../userpar#region region]). If the user don't want to assign any values to the user-defined  parameters, the group {{{&user_parameters}}} may be omitted. The group name {{{&user_parameters}}} can be changed by the user in the user-defined code. In addition to this, further NAMELIST groups may also be declared (all within routine [source:palm/trunk/SOURCE/user_parin.f90 user_parin]). A simple but complete example of the input file PARIN can be found [../examples/cbl here]. This example file can be used together with the [../configexample configuration file] for the execution of a model test run.\\\\
    3232PALM assigns default values to nearly all parameters. They become effective if no other assignments are given in the parameter file. These default values as well as the parameter name, type and its explanation are described in the lists of the following subsections.