Changes between Version 51 and Version 52 of doc/app/runtime_parameters


Ignore:
Timestamp:
Sep 14, 2010 7:33:24 AM (15 years ago)
Author:
weinreis
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • doc/app/runtime_parameters

    v51 v52  
    9090The user is allowed to extend the above list of quantities by defining his own output quantities (see the user-parameter [[../userpar#data_output_user|data_output_user]]).\\\\
    9191The time interval of the output times is determined via [#dt_data_output dt_data_output]. This is valid for all types of output quantities by default. Individual time intervals for instantaneous(!) 3d and section data can be declared using [#dt_do3d dt_do3d], [#dt_do2d_xy dt_do2d_xy], [#dt_do2d_xz dt_do2d_xz], and [#dt_do2d_yz dt_do2d_yz].\\\\
    92 Also, an individual time interval for output of temporally averaged data can be assigned using parameter [dt_data_output_av]. This applies to both 3d volume and cross section data. The length of the averaging interval is controlled via parameter [#averaging_interval averaging_interval].\\\\
    93 The parameter [[skip_time_data_output]] can be used to shift data output activities for a given time interval. Individual intervals can be set using [[skip_time_do3d]], [[skip_time_do2d_xy]], [[skip_time_do2d_xz]], [[skip_time_do2d_yz]], and [[skip_time_data_output_av]].\\\\
    94 With the parameter [[nz_do3d]] the output can be limited in the vertical direction up to a certain grid point.\\\\
    95 Cross sections extend through the total model domain. In the two horizontal directions all grid points with 0 <= i <= [[nx]]+1 and 0 <= j <= [[ny]]+1 are output so that in case of cyclic boundary conditions the complete total domain is represented. The location(s) of the cross sections can be defined with parameters [[section_xy]], [[section_xz]], and [[section_yz]]. Assigning '''section_..''' = ''-1'' causes the output data to be averaged along the direction normal to the respective section.\\\\
     92Also, an individual time interval for output of temporally averaged data can be assigned using parameter [#dt_data_output_av dt_data_output_av]. This applies to both 3d volume and cross section data. The length of the averaging interval is controlled via parameter [#averaging_interval averaging_interval].\\\\
     93The parameter [#skip_time_data_output skip_time_data_output] can be used to shift data output activities for a given time interval. Individual intervals can be set using [#skip_time_do3d skip_time_do3d], [#skip_time_do2d_xy skip_time_do2d_xy], [#skip_time_do2d_xz skip_time_do2d_xz], [#skip_time_do2d_yz skip_time_do2d_yz], and [#skip_time_data_output_av skip_time_data_output_av].\\\\
     94With the parameter [[../inipar#nz_do3d|nz_do3d]] the output can be limited in the vertical direction up to a certain grid point.\\\\
     95Cross sections extend through the total model domain. In the two horizontal directions all grid points with 0 <= i <= [[../inipar#nx|nx]]+1 and 0 <= j <= [[../inipar#ny|ny]]+1 are output so that in case of cyclic boundary conditions the complete total domain is represented. The location(s) of the cross sections can be defined with parameters [#section_xy section_xy], [#section_xz section_xz], and [#section_yz section_yz]. Assigning '''section_..''' = ''-1'' causes the output data to be averaged along the direction normal to the respective section.\\\\
    9696'''Output of user defined quantities:'''\\\\
    97 Beside the standard quantities from the above list, the user can output any other quantities. These have to be defined and calculated within the user-defined code (see [[LINK]]). They can be selected for output with the user-parameter [[../userpar#data_output_user|data_output_user]] for which the same rules apply as for '''data_output'''. Output of the user defined quantities (time interval, averaging, selection of cross sections, etc.) is controlled with the parameters listed above and data are written to the same file(s) as the standard quantities.\\\\
     97Beside the standard quantities from the above list, the user can output any other quantities. These have to be defined and calculated within the user-defined code (see [[LINK 3.5.4]]). They can be selected for output with the user-parameter [[../userpar#data_output_user|data_output_user]] for which the same rules apply as for '''data_output'''. Output of the user defined quantities (time interval, averaging, selection of cross sections, etc.) is controlled with the parameters listed above and data are written to the same file(s) as the standard quantities.\\\\
    9898'''Output on parallel machines:'''\\\\
    99 By default, with parallel runs, processors output only data of their respective subdomains into seperate local files (file names are constructed by appending the four digit processor ID, e.g. <filename>_0000, <filename>_0001, etc.). After PALM has finished, the contents of these individual files are sampled into one final file using the program {{{combine_plot_fields.x}}} (to be started e.g. by a suitable OUTPUT command in the '''mrun''' configuration file).\\\\
    100 Alternatively, PALM is able to collect all grid points of a cross section on PE0 before output is done. In this case only one  output file ([[DATA_2D_XY_NETCDF]], etc.) is created and {{{combine_plot_fields.x}}} does not have to be called. In case of very large numbers of horizontal gridpoints, sufficient memory is required on PE0.  This method can be used by assigning [[data_output_2d_on_each_pe]] = ''.F.''.\\\\
     99By default, with parallel runs, processors output only data of their respective subdomains into seperate local files (file names are constructed by appending the four digit processor ID, e.g. <filename>_0000, <filename>_0001, etc.). After PALM has finished, the contents of these individual files are sampled into one final file using the program {{{combine_plot_fields.x}}} (automatically activated by '''mrun''').\\\\
     100Alternatively, PALM is able to collect all grid points of a cross section on PE0 before output is done. In this case only one  output file ([[../iofiles#DATA_2D_XY_NETCDF|DATA_2D_XY_NETCDF]], etc.) is created and {{{combine_plot_fields.x}}} does not have to be called. In case of very large numbers of horizontal gridpoints, sufficient memory is required on PE0.  This method can be used by assigning [#data_output_2d_on_each_pe data_output_2d_on_each_pe] = ''.F.''.\\\\
    1011013d volume data output is always handled seperately by each processor so that {{{combine_plot_fields.x}}} has to be called anyway after PALM has been finished.\\\\
    102102'''Old formats:'''\\\\
    103 Beside the NetCDF format, 2d cross section data and 3d volume data can also be output, for historical reasons, in a different (binary) format using parameter [[data_output_format]].\\\\
    104 By assigning '''data_output_format''' = '' 'avs' '', the 3d volume data is output to the local file PLOT3D_DATA. Output is in FORTRAN binary format readable by the plot software AVS.  The order of data on the file follows the order used in the assignment for data_output (e.g. data_output = 'p', 'v',...  means that the file starts with the pressure data, followed by the v-component of the velocity, etc.). Both instantaneous and time averaged data are written on this file! Additional to this file, PALM creates a second binary file (local name PLOT3D_COOR) with coordinate information needed by AVS. As third and fourth file two ASCII files are created (AVS-FLD-format, local name PLOT3D_FLD and PLOT3D_FLD_COOR), which describe the contents of the data file and/or coordinate file and are used by AVS. However, AVS expects the content description in one file. This needs the local file PLOT3D_FLD_COOR to be appended to the file PLOT3D_FLD (by suitable OUTPUT command in the mrun configuration file: “cat PLOT3D_FLD_COOR >> PLOT3D_FLD”) after PALM has finished. To reduce the amount of data, output to this file can be done in compressed form (see do3d_compress). Further details about plotting 3d volume data with AVS can be found in chapter 4.5.5.
     103Beside the NetCDF format, 2d cross section data and 3d volume data can also be output, for historical reasons, in a different (binary) format using parameter [#data_output_format data_output_format].\\\\
     104By assigning '''data_output_format''' = '' 'avs' '', the 3d volume data is output to the local file [[../iofiles#PLOT3D_DATA|PLOT3D_DATA]]. Output is in FORTRAN binary format readable by the plot software AVS.  The order of data on the file follows the order used in the assignment for '''data_output''' (e.g. '''data_output''' = '' 'p', 'v',...'' means that the file starts with the pressure data, followed by the v-component of the velocity, etc.). Both instantaneous and time averaged data are written on this file! Additional to this file, PALM creates a second binary file (local name [[../iofiles#PLOT3D_COOR|PLOT3D_COOR) with coordinate information needed by AVS. As third and fourth file two ASCII files are created (AVS-FLD-format, local name [[../iofiles#PLOT3D_FLD|PLOT3D_FLD]] and [[../iofiles#PLOT3D_FLD_COOR|PLOT3D_FLD_COOR]]), which describe the contents of the data file and/or coordinate file and are used by AVS. However, AVS expects the content description in one file. This needs the local file [[../iofiles#PLOT3D_FLD_COOR|PLOT3D_FLD_COOR]] to be appended to the file [[../iofiles#PLOT3D_FLD|PLOT3D_FLD]] (by suitable OUTPUT command in the '''mrun''' configuration file: “cat PLOT3D_FLD_COOR >> PLOT3D_FLD”) after PALM has finished. To reduce the amount of data, output to this file can be done in compressed form (see [#do3d_compress do3d_compress]). Further details about plotting 3d volume data with AVS can be found in chapter [[4.5.5]].
    105105}}}
    106106|----------------