Index: palm/trunk/DOC/app/chapter_3.5.1.html
===================================================================
--- palm/trunk/DOC/app/chapter_3.5.1.html	(revision 54)
+++ palm/trunk/DOC/app/chapter_3.5.1.html	(revision 89)
@@ -1,32 +1,13 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head>
-
-  <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252">
-  
-
-
-  <title>PALM chapter 3.5.1</title><meta name="GENERATOR" content="StarOffice 7 (Win32)">
-
-  <meta name="AUTHOR" content="Siegfried Raasch">
-
-  <meta name="CREATED" content="20040802;11451548">
-
-  <meta name="CHANGED" content="20041112;14401801">
-
-  <meta name="KEYWORDS" content="parallel LES model">
-
-  <style>
+<meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252"><title>PALM
+chapter 3.5.1</title> <meta name="GENERATOR" content="StarOffice 7 (Win32)"> <meta name="AUTHOR" content="Siegfried Raasch"> <meta name="CREATED" content="20040802;11451548"> <meta name="CHANGED" content="20041112;14401801"> <meta name="KEYWORDS" content="parallel LES model"> <style>
 <!--
 @page { size: 21cm 29.7cm }
 -->
-  </style></head>
-<body style="direction: ltr;" lang="en-US">
-
-<h3 style="line-height: 100%;">3.5.1 Interfaces for
+</style></head>
+<body style="direction: ltr;" lang="en-US"><h3 style="line-height: 100%;">3.5.1 Interfaces for
 user-defined code<br>
-
-</h3>
-
-<p style="margin-bottom: 0cm; line-height: 100%;">The
+</h3><p style="margin-bottom: 0cm; line-height: 100%;">The
 following table
 describes the available interfaces for user-defined code in the model,
@@ -34,47 +15,17 @@
 names and possible arguments of the subroutines involved as well as
 actions which can be accomplished in these subroutines. <br>
-
 &nbsp; </p>
-
-<table style="width: 100%;" border="1" cellpadding="2" cellspacing="4">
-
-  <col width="211"> <col width="117"> <col width="862"> <tbody>
-
-    <tr>
-
-      <td width="211">
-      <p><font size="4"><b>Call location</b></font></p>
-
-      </td>
-
-      <td width="117">
-      <p><font size="4"><b>Subroutine name and
-argument</b></font></p>
-
-      </td>
-
-      <td style="width: 862px;">
-      <p><font size="4"><b>Possible actions</b></font></p>
-
-      </td>
-
-    </tr>
-
-    <tr><td>---</td><td><span style="font-family: monospace;"><a name="user"></a>MODULE user</span></td><td>All
+<table style="width: 100%;" border="1" cellpadding="2" cellspacing="4"> <col width="211"> <col width="117"> <col width="862"> <tbody> <tr><td width="211"> <p><font size="4"><b>Call
+location</b></font></p> </td> <td width="117"> <p><font size="4"><b>Subroutine
+name and
+argument</b></font></p> </td> <td style="width: 862px;"> <p><font size="4"><b>Possible
+actions</b></font></p> </td> </tr> <tr><td>---</td><td><span style="font-family: monospace;"><a name="user"></a>MODULE
+user</span></td><td>All
 user-defined variables which are used outside the respective local
-scopes of the user-defined subroutines have to be declared here.</td></tr><tr valign="top">
-
-      <td width="211">
-      <p>End of <tt><font style="font-size: 10pt;" size="2">parin.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_parin"></a>user_parin</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>Declaration of user-defined parameters in the NAMELIST
+scopes of the user-defined subroutines have to be declared here.</td></tr><tr valign="top"> <td width="211"> <p>End
+of <tt><font style="font-size: 10pt;" size="2">parin.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_parin"></a>user_parin</font></font></tt></p>
+</td> <td width="862"> <p>Declaration of
+user-defined parameters in the NAMELIST
 group <tt><font style="font-size: 10pt;" size="2">&amp;userpar</font></tt>.
 These
@@ -85,28 +36,14 @@
 and must not be changed. Additional NAMELIST groups may be declared if
 desired.&nbsp; <br>
-
 The CPU time needed for executing <tt><font style="font-size: 10pt;" size="2">user_parin</font></tt>
 is included in the
 local file <a href="chapter_3.4.html#CPU_MEASURES">CPU_MEASURES</a>
-within the category &ldquo;initialisation&rdquo;.</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p>End of <tt><font style="font-size: 10pt;" size="2">header.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_header"></a>user_header( io )</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>Output of the values of the user-defined parameters to
+within the category &ldquo;initialisation&rdquo;.</p> </td>
+</tr> <tr valign="top"> <td width="211"><p>End
+of <tt><font style="font-size: 10pt;" size="2">header.f90</font></tt></p>
+</td>
+<td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_header"></a>user_header(
+io )</font></font></tt></p> </td> <td width="862"> <p>Output of the values of the
+user-defined parameters to
 the
 local files <a href="chapter_3.4.html#HEADER">HEADER</a>
@@ -125,23 +62,8 @@
 user-defined
 subdomains are displayed by default (see <a href="chapter_4.1.html#statistic_regions">statistic_regions</a>).</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p>End of <tt><font style="font-size: 10pt;" size="2">init_3d_model.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init"></a>user_init</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>Here, user-defined initialization actions which should
+</td> </tr> <tr valign="top"> <td width="211"> <p>End of <tt><font style="font-size: 10pt;" size="2">init_3d_model.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init"></a>user_init</font></font></tt></p>
+</td> <td width="862"> <p>Here, user-defined
+initialization actions which should
 be
 accomplished before the start of the 3D-model can be implemented (e.g.
@@ -150,32 +72,21 @@
 the model (<a href="chapter_4.1.html">chapter
 4.1</a>) have already been carried out at all.&nbsp; </p>
-
-      <p>One of the most important actions here is the definition
+<p>One of the most important actions here is the definition
 of
 user-defined subdomains for statistic analysis and output (see <a href="chapter_4.1.html#statistic_regions">statistic_regions</a>
 and <a href="chapter_3.5.3.html">chapter
-3.5.3</a>) and of additional time series quantities (see comment line example in the file).&nbsp; <br>
-
+3.5.3</a>) and of additional time series quantities (see comment
+line example in the file).&nbsp; <br>
 CPU time for <tt><font style="font-size: 10pt;" size="2">user_init</font></tt>
 is considered in the local file <a href="chapter_3.4.html#CPU_MEASURES">CPU_MEASURES</a>
-within the category &ldquo;initialisation&rdquo;.</p><p>See also <tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a href="#user_init_3d_model">user_init_3d_model</a>.</font></font></tt></p>
-
-      </td>
-
-    </tr>
-
-    <tr>
-
-      <td style="vertical-align: top;"><tt><font style="font-size: 10pt;" size="2">DEFAULT</font></tt>
+within the category &ldquo;initialisation&rdquo;.</p><p>See
+also <tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a href="#user_init_3d_model">user_init_3d_model</a>.</font></font></tt></p>
+</td> </tr> <tr> <td style="vertical-align: top;"><tt><font style="font-size: 10pt;" size="2">DEFAULT</font></tt>
 case of <tt><font style="font-size: 10pt;" size="2">SELECT
 CASE( TRIM(topography) ) </font></tt>command in the
-middle&nbsp;of <tt><font style="font-size: 10pt;" size="2">init_grid.f90</font></tt></td>
-
-      <td style="vertical-align: top;"><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_grid"></a>user_init_grid</font></font></tt></td>
-
-      <td>
-      <p>Execution of user-defined grid initializing actions.</p>
-
-      <p>Here, the user can define the two-dimensional index
+middle&nbsp;of <tt><font style="font-size: 10pt;" size="2">init_grid.f90</font></tt></td> <td style="vertical-align: top;"><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_grid"></a>user_init_grid</font></font></tt></td>
+<td> <p>Execution of user-defined grid initializing
+actions.</p> <p>Here, the user can define the
+two-dimensional index
 array&nbsp;<tt><font style="font-size: 10pt;" size="2">nzb_local</font></tt> that is used to
 set up a non-flat topography. This requires definition of at least one
@@ -184,35 +95,19 @@
 in&nbsp;<tt><font style="font-size: 10pt;" size="2">user_init_grid</font></tt>.
 Note that the <a href="chapter_4.1.html#topography">topography</a>&nbsp;modes
-      <span style="font-style: italic;">'flat'</span>
+<span style="font-style: italic;">'flat'</span>
 and <span style="font-style: italic;">'single_building'</span>
 are not allowed here since these are the standard cases used in the
-calling routine <tt><font style="font-size: 10pt;" size="2">init_grid</font></tt>. </p>
-
-      <p>CPU time for <tt><font style="font-size: 10pt;" size="2">user_init_grid</font></tt>
+calling routine <tt><font style="font-size: 10pt;" size="2">init_grid</font></tt>. </p> <p>CPU
+time for <tt><font style="font-size: 10pt;" size="2">user_init_grid</font></tt>
 is considered in the local file <a href="chapter_3.4.html#CPU_MEASURES">CPU_MEASURES</a>
-within the category &ldquo;initialisation&rdquo;.</p>
-
-      </td>
-
-    </tr>
-
-    <tr><td style="vertical-align: top;">In the middle of <tt><font style="font-size: 10pt;" size="2">init_3d_model.f90</font></tt></td><td style="vertical-align: top;"><span style="font-family: monospace;"></span><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_3d_model"></a>user_init_3d_<br>model</font></font></tt></td><td style="vertical-align: top;">Initialization of the 3d-model.<br><br>Allows
+within the category &ldquo;initialisation&rdquo;.</p> </td>
+</tr> <tr><td style="vertical-align: top;">In
+the middle of <tt><font style="font-size: 10pt;" size="2">init_3d_model.f90</font></tt></td><td style="vertical-align: top;"><span style="font-family: monospace;"></span><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_3d_model"></a>user_init_3d_<br>model</font></font></tt></td><td style="vertical-align: top;">Initialization of the 3d-model.<br><br>Allows
 the complete initialization of the 3d model. The user is responsible to
-set at least all those quantities which are normally set within <tt><font style="font-size: 10pt;" size="2">init_3d_model</font></tt>.</td></tr><tr valign="top">
-
-      <td width="211">
-      <p>In the middle of <tt><font style="font-size: 10pt;" size="2">init_particles.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_particles"></a>user_init_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br>
-
-      </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">particles</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>With this routine e.g. size and color of particles,
+set at least all those quantities which are normally set within <tt><font style="font-size: 10pt;" size="2">init_3d_model</font></tt>.</td></tr><tr valign="top"> <td width="211"> <p>In
+the middle of <tt><font style="font-size: 10pt;" size="2">init_particles.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_init_particles"></a>user_init_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br> </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">particles</font></font></tt></p>
+</td> <td width="862"> <p>With this routine
+e.g. size and color of particles,
 which have
 been released initially from a source, can be specified. Like the
@@ -220,51 +115,18 @@
 this routine is only
 called if particle advection is switched on (see package parameter <a href="chapter_4.2.html#dt_prel">dt_prel</a>).</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p>End of <tt><font style="font-size: 10pt;" size="2">advec_particles.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_particle_attributes"></a>user_particle_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br>
-
-      </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">attributes</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>Here the particles can be assigned new attributes
+</td> </tr> <tr valign="top"> <td width="211"> <p>End of <tt><font style="font-size: 10pt;" size="2">advec_particles.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_particle_attributes"></a>user_particle_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br> </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">attributes</font></font></tt></p>
+</td> <td width="862"> <p>Here the particles
+can be assigned new attributes
 (diameter,
 color etc.) after each time step. Like the calling routine <tt><font style="font-size: 10pt;" size="2">advec_particles</font><font style="font-size: 11pt;" size="2">,</font> </tt>this
 routine is only
 called if particle advection is switched on (see package parameter <a href="chapter_4.2.html#dt_prel">dt_prel</a>).</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p>Before the plot of particles and cross-sections in <br>
-
-      <tt><font style="font-size: 10pt;" size="2">dvrp_plot.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_dvrp_coltab"></a>user_dvrp_coltab
+</td> </tr> <tr valign="top"> <td width="211"> <p>Before the plot of particles and
+cross-sections in <br> <tt><font style="font-size: 10pt;" size="2">dvrp_plot.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_dvrp_coltab"></a>user_dvrp_coltab
 (</font></font></tt><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> mode )</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>With this routine, color tables can be adjusted which
+</td> <td width="862"> <p>With this routine,
+color tables can be adjusted which
 should
 be used for output with the dvrp software. Individuell color tables for
@@ -280,41 +142,17 @@
 can have the values &ldquo;<i>particles&rdquo;</i>
 or &ldquo;<i>slicer&rdquo;</i>).&nbsp; <br>
-
 This routine only becomes active if dvrp-graphics is switched on (see
 package parameter <a href="chapter_4.2.html#dt_dvrp">dt_dvrp</a>).</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p>Beginning and end of the time integration loop
-of&nbsp; <br>
-
-      <tt><font style="font-size: 10pt;" size="2">time_integration.f90</font></tt>
-as well as after each prognostic equation in <br>
-
-      <tt><font style="font-size: 10pt;" size="2">prognostic_equations.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_actions"></a>user_actions( location )</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> </font></font> </p>
-
-      <p>or<br>
-
-      <font face="Cumberland, monospace"><font style="font-size: 10pt;" size="2"> </font></font>
-      </p>
-
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">user_actions( i, j,</font></font></tt><span style="font-family: Cumberland,monospace;"> </span><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">location )</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      
-
-      <p>In this routine user actions can be implemented which
+</td> </tr> <tr valign="top"> <td width="211"> <p>Beginning and end of the time
+integration loop
+of&nbsp; <br> <tt><font style="font-size: 10pt;" size="2">time_integration.f90</font></tt>
+as well as after each prognostic equation in <br> <tt><font style="font-size: 10pt;" size="2">prognostic_equations.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_actions"></a>user_actions(
+location )</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> </font></font> </p>
+<p>or<br> <font face="Cumberland, monospace"><font style="font-size: 10pt;" size="2"> </font></font>
+</p> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">user_actions(
+i, j,</font></font></tt><span style="font-family: Cumberland,monospace;"> </span><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">location )</font></font></tt></p>
+</td> <td width="862"> <p>In this routine
+user actions can be implemented which
 are to
 be executed either at each time step or at certain times (defined by
@@ -328,5 +166,6 @@
 For example, if called at the beginning of a time step, <tt><font style="font-size: 10pt;" size="2">location</font></tt>
 =&nbsp;<i>'before_timestep' </i>and if
-called at the end, <tt><font style="font-size: 10pt;" size="2">location</font></tt><font style="font-size: 10pt;" size="2"> </font>=&nbsp;<i>'after_timestep'</i><span style="font-weight: bold;">.</span></p><p>Calculation of user-defined output quantities should be carried out at <span style="font-family: monospace;">location</span> = <span style="font-style: italic;">'after_integration'</span>.<span style="font-weight: bold;"></span></p><p><span style="font-weight: bold;">Important:</span>
+called at the end, <tt><font style="font-size: 10pt;" size="2">location</font></tt><font style="font-size: 10pt;" size="2"> </font>=&nbsp;<i>'after_timestep'</i><span style="font-weight: bold;">.</span></p><p>Calculation
+of user-defined output quantities should be carried out at <span style="font-family: monospace;">location</span> = <span style="font-style: italic;">'after_integration'</span>.<span style="font-weight: bold;"></span></p><p><span style="font-weight: bold;">Important:</span>
 if the
 cache-optimized version of <span style="font-family: monospace;">prognostic_equation.f90</span>
@@ -335,7 +174,5 @@
 passed as arguments for
 all calls within <span style="font-family: monospace;">prognostic_equations</span>.
-      </p>
-
-      <p>CPU time for <tt><font style="font-size: 10pt;" size="2">user_actions</font></tt>
+</p> <p>CPU time for <tt><font style="font-size: 10pt;" size="2">user_actions</font></tt>
 appears within the category &ldquo;user_actions&rdquo; in the
 local file <a href="chapter_3.4.html#CPU_MEASURES">CPU_MEASURES</a>.
@@ -344,9 +181,6 @@
 needed outside of the prognostic equations. Time needed for calls
 within prognostic_equations is considered within the category "all
-prog.equations".<br>
-
-      </p>
-
-      <p><b>Important:</b> this subroutine is written
+prog.equations".<br> </p> <p><b>Important:</b>
+this subroutine is written
 as a FORTRAN
 module, which uses so-called function overloading. It can be called in
@@ -362,58 +196,103 @@
 respective prognostic equation either in the CASE structure of <tt><font style="font-size: 10pt;" size="2">user_actions</font><font style="font-size: 11pt;" size="2">,</font> </tt>or/and
 in the CASE
-structure of <tt><font style="font-size: 10pt;" size="2">user_actions_ij</font></tt>!</p>
-
-      </td>
-
-    </tr>
-
-    <tr valign="top">
-
-      <td width="211">
-      <p><tt><font style="font-size: 10pt;" size="2">flow_statistics.f90</font></tt>
+structure of <tt><font style="font-size: 10pt;" size="2">user_actions_ij</font></tt>!</p> </td>
+</tr> <tr valign="top"> <td width="211"><p><tt><font style="font-size: 10pt;" size="2">flow_statistics.f90</font></tt>
 before the summation of array <span style="font-family: monospace;">hom</span>
-(horizontal averages)<br>
-
-      </p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_statistics"></a>user_statistics<br>( sr )</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>Horizontal
+(horizontal averages)<br> </p> </td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_statistics"></a>user_statistics<br>(
+sr )</font></font></tt></p> </td> <td width="862"> <p>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
-<a href="#user_init"><span style="font-family: Courier New,Courier,monospace;">user_init</span></a>. The routine is called once for each defined statistic region (see <a href="chapter_4.1.html#statistic_region">statistic_region</a>).</p><p></p><p>The routine contains some simple examples (as comment lines) in order to demonstrate how to use it.</p><p><br>Profiles have to be written to
+<a href="#user_init"><span style="font-family: Courier New,Courier,monospace;">user_init</span></a>.
+The routine is called once for each defined statistic region (see <a href="chapter_4.1.html#statistic_region">statistic_region</a>).</p><p></p><p>The
+routine contains some simple examples (as comment lines) in order to
+demonstrate how to use it.</p><p><br>Profiles have to
+be written to
 the array <tt><font style="font-size: 10pt;" size="2">sums</font></tt>.
 Please use profile numbers starting from 70 upward (thus e.g. <tt><font style="font-size: 10pt;" size="2">sums (&hellip;,
 60) =</font></tt><font style="font-size: 10pt;" size="2">&hellip;)</font>. These additional
 profiles
-are temporally averaged in <tt><font style="font-size: 10pt;" size="2">flow_statistics</font></tt>.</p>
-
-      </td>
-
-    </tr>
-
-    <tr><td style="vertical-align: top;">End of <span style="font-family: monospace;">check_parameters.f90</span> where output quantities are checked</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_check_data_output"></a>user_check_data_<br>output( variable, unit )</span></td><td style="vertical-align: top;">Here the <span style="font-family: monospace;">unit</span>(s) of user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>) have to be set. Input parameter <span style="font-family: monospace;">variable</span> contains the string identifier of the respective variable. For those variables not recognized by the user, the parameter <span style="font-family: monospace;">unit</span> is set to "illegal", which tells the calling routine that the output variable is not defined and leads to a program abort.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;"><span style="font-family: monospace;">netcdf.f90</span> (4 times) where the vertical grid coordinates for cross sections and volume data are defined</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_define_netcdf_grid"></a>user_define_<br>netcdf_grid( variable, found, grid_x, grid_y, grid_z )</span></td><td style="vertical-align: top;">Set the grid on which user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>) are defined. Input parameter <span style="font-family: monospace;">variable</span> contains the string identifier of the respective variable. Allowed values are <span style="font-style: italic;">'x'</span> and <span style="font-style: italic;">'xu'</span> for <span style="font-family: monospace;">grid_x</span>, <span style="font-style: italic;">'y'</span> and <span style="font-style: italic;">'yv'</span> for <span style="font-family: monospace;">grid_y</span>, and<span style="font-family: monospace;"></span>&nbsp;<span style="font-style: italic;">'zu'</span> and <span style="font-style: italic;">'zw'</span> for <span style="font-family: monospace;">grid_z</span>. The output parameter <span style="font-family: monospace;">found</span> has to be set <span style="font-style: italic;">.TRUE.</span> by the user, otherwise an error message will appear in the job protocol for the respective output quantity.<br><br><span style="font-weight: bold;">Example:</span><br>If an output quantity is defined at the center of the grid boxes, the following settings have to be used:<br><br><div style="margin-left: 40px;"><span style="font-family: monospace;">grid_x = <span style="font-style: italic;">'x'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_y = <span style="font-style: italic;">'y'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_z = <span style="font-style: italic;">'zu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">found &nbsp;= <span style="font-style: italic;">.TRUE.</span></span><br></div><br>For defining an output quantity at the grid points where the u-velocity-component is defined, please use<br><br><div style="margin-left: 40px;"><span style="font-family: monospace;">grid_x = <span style="font-style: italic;">'xu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_y = <span style="font-style: italic;">'y'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_z = <span style="font-style: italic;">'zu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">found &nbsp;= <span style="font-style: italic;">.TRUE.</span></span><br></div><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;">Middle of <span style="font-family: monospace;">data_output_2d.f90</span></td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_data_output_2d"></a>user_data_<br>output_2d( av, variable, found, grid, local_pf )</span></td><td style="vertical-align: top;">Resorts&nbsp;user-defined&nbsp;quantities (to be output as cross-section data;&nbsp;see <a href="chapter_4.3.html#data_output_user">data_output_user</a>) with indices (k,j,i) to a temporary array <span style="font-family: monospace;">local_pf</span> with indices (i,j,k) and sets the <span style="font-family: monospace;">grid</span> on which they are defined. Depending on the value of input parameter <span style="font-family: monospace;">av</span> resorting is done for instantaneous (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">0</span>) or time averaged data (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">1</span>). Input parameter <span style="font-family: monospace;">variable</span> contains the string identifier of the respective variable. Allowed values for <span style="font-family: monospace;">grid</span> are&nbsp;<span style="font-style: italic;">'zu'</span> and&nbsp;<span style="font-style: italic;">'zw'</span>. The output parameter <span style="font-family: monospace;">found</span> has to be set <span style="font-style: italic;">.TRUE.</span> by the user, otherwise an error message will appear in the job protocol for the respective output quantity.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;"><span style="font-family: monospace;">data_output_3d.f90</span> at the end of the CASE structure</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_data_output_3d"></a>user_data_<br>output_3d( av, variable, found, local_pf, nz_do )</span></td><td style="vertical-align: top;">Resorts&nbsp;user-defined&nbsp;quantities (to be output as volume data;&nbsp;see <a href="chapter_4.3.html#data_output_user">data_output_user</a>) with indices (k,j,i) to a temporary array <span style="font-family: monospace;">local_pf</span> with indices (i,j,k) and sets the <span style="font-family: monospace;">grid</span> on which they are defined. Depending on the value of input parameter <span style="font-family: monospace;">av</span> resorting is done for instantaneous (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">0</span>) or time averaged data (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">1</span>). Input parameter <span style="font-family: monospace;">variable</span> contains the string identifier of the respective variable<span style="font-family: monospace;"></span><span style="font-style: italic;"></span><span style="font-style: italic;"></span>. The input parameter <span style="font-family: monospace;">nz_do</span> defines the upper limit of vertical grid index k of the output array (see <a href="chapter_4.2.html#nz_do3d">nz_do3d</a>). The output parameter <span style="font-family: monospace;">found</span> has to be set <span style="font-style: italic;">.TRUE.</span> by the user, otherwise an error message will appear in the job protocol for the respective output quantity.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;">End of <span style="font-family: monospace;">average_3d_data.f90</span>, middle and end of <span style="font-family: monospace;">sum_up_3d_data.f90</span></td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_3d_data_averaging"></a>user_3d_data_<br>averaging( mode, variable )</span></td><td style="vertical-align: top;">Sum up and time-average of user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>) as well as allocation of the arrays necessary for storing the respective averages. Input parameter <span style="font-family: monospace;">variable</span> contains the string identifier of the respective variable. Depending on the requested action, input parameter <span style="font-family: monospace;">mode</span> has the value <span style="font-style: italic;">'allocate'</span>, <span style="font-style: italic;">'sum'</span>, or <span style="font-style: italic;">'average'</span>.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about creating user-defined output quantities. </td></tr><tr valign="top">
-
-      <td width="211">
-      <p>End of <tt><font style="font-size: 10pt;" size="2">palm.f90</font></tt></p>
-
-      </td>
-
-      <td width="117">
-      <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_last_action"></a>user_last_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br>
-
-      </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">action</font></font></tt></p>
-
-      </td>
-
-      <td width="862">
-      <p>User-defined actions which are to be executed at the end
+are temporally averaged in <tt><font style="font-size: 10pt;" size="2">flow_statistics</font></tt>.</p> </td>
+</tr> <tr><td style="vertical-align: top;">End
+of <span style="font-family: monospace;">check_parameters.f90</span>
+where output quantities are checked</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_check_data_output"></a>user_check_data_<br>output(
+variable, unit )</span></td><td style="vertical-align: top;">Here the <span style="font-family: monospace;">unit</span>(s) of
+user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>)
+have to be set. Input parameter <span style="font-family: monospace;">variable</span>
+contains the string identifier of the respective variable. For those
+variables not recognized by the user, the parameter <span style="font-family: monospace;">unit</span> is set to
+"illegal", which tells the calling routine that the output variable is
+not defined and leads to a program abort.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about
+creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;"><span style="font-family: monospace;">netcdf.f90</span> (4
+times) where the vertical grid coordinates for cross sections and
+volume data are defined</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_define_netcdf_grid"></a>user_define_<br>netcdf_grid(
+variable, found, grid_x, grid_y, grid_z )</span></td><td style="vertical-align: top;">Set the grid on which
+user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>)
+are defined. Input parameter <span style="font-family: monospace;">variable</span>
+contains the string identifier of the respective variable. Allowed
+values are <span style="font-style: italic;">'x'</span>
+and <span style="font-style: italic;">'xu'</span>
+for <span style="font-family: monospace;">grid_x</span>,
+<span style="font-style: italic;">'y'</span> and <span style="font-style: italic;">'yv'</span> for <span style="font-family: monospace;">grid_y</span>, and<span style="font-family: monospace;"></span>&nbsp;<span style="font-style: italic;">'zu'</span> and <span style="font-style: italic;">'zw'</span> for <span style="font-family: monospace;">grid_z</span>. The
+output parameter <span style="font-family: monospace;">found</span>
+has to be set <span style="font-style: italic;">.TRUE.</span>
+by the user, otherwise an error message will appear in the job protocol
+for the respective output quantity.<br><br><span style="font-weight: bold;">Example:</span><br>If
+an output quantity is defined at the center of the grid boxes, the
+following settings have to be used:<br><br><div style="margin-left: 40px;"><span style="font-family: monospace;">grid_x = <span style="font-style: italic;">'x'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_y = <span style="font-style: italic;">'y'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_z = <span style="font-style: italic;">'zu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">found &nbsp;= <span style="font-style: italic;">.TRUE.</span></span><br></div><br>For
+defining an output quantity at the grid points where the
+u-velocity-component is defined, please use<br><br><div style="margin-left: 40px;"><span style="font-family: monospace;">grid_x = <span style="font-style: italic;">'xu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_y = <span style="font-style: italic;">'y'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">grid_z = <span style="font-style: italic;">'zu'</span></span><br style="font-family: monospace;"><span style="font-family: monospace;">found &nbsp;= <span style="font-style: italic;">.TRUE.</span></span><br></div><br>See
+<a href="chapter_3.5.4.html">chapter 3.5.4</a> about
+creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;">Middle of <span style="font-family: monospace;">data_output_2d.f90</span></td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_data_output_2d"></a>user_data_<br>output_2d(
+av, variable, found, grid, local_pf )</span></td><td style="vertical-align: top;">Resorts&nbsp;user-defined&nbsp;quantities
+(to be output as cross-section data;&nbsp;see <a href="chapter_4.3.html#data_output_user">data_output_user</a>)
+with indices (k,j,i) to a temporary array <span style="font-family: monospace;">local_pf</span> with
+indices (i,j,k) and sets the <span style="font-family: monospace;">grid</span>
+on which they are defined. Depending on the value of input parameter <span style="font-family: monospace;">av</span> resorting is
+done for instantaneous (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">0</span>) or time averaged
+data (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">1</span>). Input parameter
+<span style="font-family: monospace;">variable</span>
+contains the string identifier of the respective variable. Allowed
+values for <span style="font-family: monospace;">grid</span>
+are&nbsp;<span style="font-style: italic;">'zu'</span>
+and&nbsp;<span style="font-style: italic;">'zw'</span>.
+The output parameter <span style="font-family: monospace;">found</span>
+has to be set <span style="font-style: italic;">.TRUE.</span>
+by the user, otherwise an error message will appear in the job protocol
+for the respective output quantity.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about
+creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;"><span style="font-family: monospace;">data_output_3d.f90</span>
+at the end of the CASE structure</td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_data_output_3d"></a>user_data_<br>output_3d(
+av, variable, found, local_pf, nz_do )</span></td><td style="vertical-align: top;">Resorts&nbsp;user-defined&nbsp;quantities
+(to be output as volume data;&nbsp;see <a href="chapter_4.3.html#data_output_user">data_output_user</a>)
+with indices (k,j,i) to a temporary array <span style="font-family: monospace;">local_pf</span> with
+indices (i,j,k) and sets the <span style="font-family: monospace;">grid</span>
+on which they are defined. Depending on the value of input parameter <span style="font-family: monospace;">av</span> resorting is
+done for instantaneous (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">0</span>) or time averaged
+data (<span style="font-family: monospace;">av</span>=<span style="font-style: italic;">1</span>). Input parameter
+<span style="font-family: monospace;">variable</span>
+contains the string identifier of the respective variable<span style="font-family: monospace;"></span><span style="font-style: italic;"></span><span style="font-style: italic;"></span>. The input
+parameter <span style="font-family: monospace;">nz_do</span>
+defines the upper limit of vertical grid index k of the output array
+(see <a href="chapter_4.2.html#nz_do3d">nz_do3d</a>).
+The output parameter <span style="font-family: monospace;">found</span>
+has to be set <span style="font-style: italic;">.TRUE.</span>
+by the user, otherwise an error message will appear in the job protocol
+for the respective output quantity.<br><br>See <a href="chapter_3.5.4.html">chapter 3.5.4</a> about
+creating user-defined output quantities.</td></tr><tr><td style="vertical-align: top;">End of <span style="font-family: monospace;">average_3d_data.f90</span>,
+middle and end of <span style="font-family: monospace;">sum_up_3d_data.f90</span></td><td style="vertical-align: top;"><span style="font-family: monospace;"><a name="user_3d_data_averaging"></a>user_3d_data_<br>averaging(
+mode, variable )</span></td><td style="vertical-align: top;">Sum up and time-average of
+user-defined output quantities (see <a href="chapter_4.3.html#data_output_user">data_output_user</a>)
+as well as allocation of the arrays necessary for storing the
+respective averages. Input parameter <span style="font-family: monospace;">variable</span>
+contains the string identifier of the respective variable. Depending on
+the requested action, input parameter <span style="font-family: monospace;">mode</span> has the
+value <span style="font-style: italic;">'allocate'</span>,
+<span style="font-style: italic;">'sum'</span>, or <span style="font-style: italic;">'average'</span>.<br><br>See
+<a href="chapter_3.5.4.html">chapter 3.5.4</a> about
+creating user-defined output quantities. </td></tr><tr valign="top"> <td width="211"> <p>End
+of <tt><font style="font-size: 10pt;" size="2">palm.f90</font></tt></p>
+</td> <td width="117"> <p><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"><a name="user_last_action"></a>user_last_</font></font></tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace"> <br> </font></font><tt><font style="font-size: 10pt;" size="2"><font face="Cumberland, monospace">action</font></font></tt></p>
+</td> <td width="862"> <p>User-defined
+actions which are to be executed at the end
 of a
 model run. When <tt><font style="font-size: 10pt;" size="2">user_last_actions</font></tt>
@@ -423,24 +302,10 @@
 are also not carried
 out yet.&nbsp; <br>
-
 CPU time for <tt><font style="font-size: 10pt;" size="2">user_last_actions</font></tt>
 appears in the local file <a href="chapter_3.4.html#CPU_MEASURES">CPU_MEASURES</a>
 within the category &ldquo;last actions&rdquo; (the time
 necessary for <tt><font style="font-size: 10pt;" size="2">close_files</font></tt> is included).</p>
-
-      </td>
-
-    </tr>
-
-  </tbody>
-</table>
-
-<hr>
-<p style="line-height: 100%;"><br>
-
-<font color="#000080"><font color="#000080"><a href="chapter_3.5.html"><font color="#000080"><img src="left.gif" name="Grafik1" align="bottom" border="2" height="32" width="32"></font></a><a href="index.html"><font color="#000080"><img src="up.gif" name="Grafik2" align="bottom" border="2" height="32" width="32"></font></a><a href="chapter_3.5.2.html"><font color="#000080"><img src="right.gif" name="Grafik3" align="bottom" border="2" height="32" width="32"></font></a></font></font></p>
-
-<p style="line-height: 100%;"><i>Last
-change:&nbsp;</i>&nbsp;23/03/06 (SR)</p>
-
+</td> </tr> </tbody></table><hr>
+<p style="line-height: 100%;"><br><font color="#000080"><font color="#000080"><a href="chapter_3.5.html"><font color="#000080"><img src="left.gif" name="Grafik1" align="bottom" border="2" height="32" width="32"></font></a><a href="index.html"><font color="#000080"><img src="up.gif" name="Grafik2" align="bottom" border="2" height="32" width="32"></font></a><a href="chapter_3.5.2.html"><font color="#000080"><img src="right.gif" name="Grafik3" align="bottom" border="2" height="32" width="32"></font></a></font></font></p><p style="line-height: 100%;"><i>Last
+change: </i>$Id$</p>
 </body></html>
