source: palm/trunk/DOC/app/chapter_3.5.2.html @ 141

Last change on this file since 141 was 62, checked in by raasch, 18 years ago

Id string added to all html files

  • Property svn:keywords set to Id
File size: 4.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head>
3<meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252"><title>PALM
4chapter 3.5.2</title> <meta name="GENERATOR" content="StarOffice 7 (Win32)"> <meta name="AUTHOR" content="Siegfried Raasch"> <meta name="CREATED" content="20040802;13321506"> <meta name="CHANGED" content="20041112;14455666"> <meta name="KEYWORDS" content="parallel LES model"> <style>
5<!--
6@page { size: 21cm 29.7cm }
7-->
8</style></head>
9<body style="direction: ltr;" lang="en-US"><h3 style="line-height: 100%;">&nbsp;3.5.2 Definition of
10user-defined
11parameters</h3>
12<p style="line-height: 100%;">As for the model in general,
13also the
14user-defined code will have to be steered by parameters. For each
15run the model should to be able to read in current values of these
16parameters. The declaration of user-defined parameters takes place in
17the user-defined module <tt><font style="font-size: 10pt;" size="2">user</font></tt>
18(located at the beginning of the file <tt><font style="font-size: 10pt;" size="2">user_interface.f90</font></tt>).
19This module must be declared in all relevant user-defined routines via
20a USE statement, in order to make the parameters available. </p>
21<p style="line-height: 100%;">The user can assign values
22to the
23user-defined parameters within the NAMELIST group <tt><font style="font-size: 11pt;" size="2">&amp;userpar
24<font size="3"><font face="Thorndale, serif">in
25the local file</font></font>
26<a href="chapter_3.4.html#PARIN">PARIN</a></font></tt>.
27This NAMELIST group must be located after the initialization
28parameters and run parameters (<tt><font style="font-size: 10pt;" size="2">&amp;inipar</font></tt><font style="font-size: 10pt;" size="2">,
29</font><tt><font style="font-size: 10pt;" size="2">&amp;d3par</font></tt>)
30(see <a href="chapter_4.0.html">chapter
314.0</a>). Before values of the user-defined parameters can be
32assigned,
33the parameters must be declared within the appropriate NAMELIST
34statement in the user-defined subroutine <tt><font style="font-size: 10pt;" size="2">user_parin</font></tt>.
35</p>
36<p style="line-height: 100%;">The following example
37illustrates the
38procedure. The example assumes that the user declares a
39LOGICAL variable named <tt><font style="font-size: 10pt;" size="2">abcd</font></tt>
40for steering the user-defined code. This variable
41must be declared in the module <tt>user</tt>: </p>
42<ul> <p style="line-height: 100%;"><tt><font style="font-size: 10pt;" size="2">LOGICAL:: abcd =
43.FALSE.</font></tt></p>
44</ul><p style="line-height: 100%;">Pay attention
45that in this example a
46default value (.FALSE.) is assigned to the variable and it will keep
47this value if nothing else is assigned within the file <tt>PARIN</tt>.
48In <tt><font style="font-size: 10pt;" size="2">user_parin</font>
49<font face="Thorndale, serif">the</font></tt>
50NAMELIST must be extended by the name of the new variable: </p>
51<ul> <p style="line-height: 100%;"><tt><font style="font-size: 10pt;" size="2">NAMELIST /userpar/
52&nbsp;abcd, data_output_user, region.</font></tt></p>
53</ul><p style="line-height: 100%;">In the parameter
54file PARIN a value can
55be assigned: </p>
56<ul> <p style="line-height: 100%;">. <br>
57. <br> <tt><font style="font-size: 10pt;" size="2">&amp;userpar abcd = .T.,</font></tt><font style="font-size: 10pt;" size="2"> ...</font></p>
58</ul><p style="line-height: 100%;">User defined
59parameters in the file PARIN
60are
61considered as run parameters, i.e. they must be specified again for
62each restart run.</p>
63<p style="line-height: 100%;">In each case the user should
64carry out
65a control output of the parameter values, so
66that their values during the respective model run are really known. For
67this
68purpose the user-defined subroutine <tt><font style="font-size: 10pt;" size="2">user_header</font></tt>
69which writes into the files <a href="chapter_3.4.html#HEADER">HEADER</a>
70and <a href="chapter_3.4.html#RUN_CONTROL">RUN_CONTROL</a>
71is available. <br>
72&nbsp; </p>
73<hr><p style="line-height: 100%;"><br>
74&nbsp;<font color="#000080"><font color="#000080"><a href="chapter_3.5.1.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.3.html"><font color="#000080"><img src="right.gif" name="Grafik3" align="bottom" border="2" height="32" width="32"></font></a><br>
75</font></font></p><p style="line-height: 100%;"><span style="font-style: italic;">Last
76change:</span> $Id: chapter_3.5.2.html 62 2007-03-13 02:52:40Z raasch $<font color="#000080"><font color="#000080"><br>
77</font></font></p></body></html>
Note: See TracBrowser for help on using the repository browser.