source: palm/trunk/DOC/app/chapter_3.5.html @ 212

Last change on this file since 212 was 212, checked in by raasch, 13 years ago

manual updated for changes in the user interface

  • Property svn:keywords set to Id
File size: 6.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head>
3<meta content="text/html; charset=windows-1252" http-equiv="CONTENT-TYPE"><title>PALM chapter 3.5</title> <meta content="StarOffice 7 (Win32)" name="GENERATOR"> <meta content="Siegfried Raasch" name="AUTHOR"> <meta content="20040802;10431831" name="CREATED"> <meta content="20041112;14292662" name="CHANGED"> <meta content="parallel LES model" name="KEYWORDS"> <style>
4<!--
5@page { size: 21cm 29.7cm }
6-->
7</style></head>
8<body style="direction: ltr;" lang="en-US"><h3 style="line-height: 100%;">3.5 Programming of user-defined
9code
10extensions<br>
11</h3><p style="line-height: 100%;">Programming
12user-defined code
13extensions usually requires exact knowledge of the internal structure
14of PALM.
15Appropriate explanations in <a href="chapter_2.0.html">chapter
162.0</a> and the technical documentation are usually not
17sufficient
18and must be supplemented by a rigorous study of the model's source code. Programming experiences with FORTRAN95 and if necessary
19experiences with the parallelization tool MPI are absolutely
20necessary! </p>
21<p style="line-height: 100%;">Changes of the standard
22model code by the
23user
24should be avoided whenever possible and are reserved to the
25developer-group of PALM. The corrections, revisions and extensions of
26the
27model accomplished by this group are published in the
28<a href="../tec/index.html">technical/numerical
29documentation</a> and the accordingly updated source files are
30accessible to the users (see <a href="chapter_5.1.html">chapter
315.1</a>).</p>
32<p style="line-height: 100%;">However, the user frequently
33may feel the
34need to make extensions of the model code for his/her own simulations.
35For this purpose, a set
36of interfaces is available, which can be used to add user-defined code
37to the model. This
38chapter describes the programming of such user-defined code extensions.</p><p style="line-height: 100%;">The integration of user-defined
39code
40occurs in the form of subroutine calls, which are made at a set of
41places in the model code, by default. These subroutines have
42pre-defined names, which must not be changed by the user. Their basic
43versions are a component of the standard model
44code and can be found in the source code files
45<tt><font style="font-size: 10pt;" size="2">user_***.f90</font></tt><font style="font-size: 10pt;" size="2">.</font>
46<font color="#000000">The</font> basic versions
47accomplish nearly no
48actions, thus they are pure templates, which can be extended by the
49user as required. Actions which are already accomplished in these
50basic versions by default should not be changed. Here is an example
51of such a basic version (file <span style="font-family: Courier New,Courier,monospace;">user_init.f90</span>): </p>
52<p style="line-height: 100%;">&nbsp; </p>
53<pre style="line-height: 100%;"><font color="#000000"><font style="font-size: 10pt;" size="2">SUBROUTINE user_init</font></font><br><br><font color="#000000"><font style="font-size: 10pt;" size="2">!------------------------------------------------------------------------------</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">!</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">!</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">! Description:</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">! -----------</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">! Execution of user-defined initializing actions</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">!------------------------------------------------------------------------------</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">!</font></font><br><br><font color="#000000"> <font style="font-size: 10pt;" size="2">USE control_parameters</font></font><br><font color="#000000"> <font style="font-size: 10pt;" size="2">USE user</font></font><br><br><font color="#000000"> <font style="font-size: 10pt;" size="2">IMPLICIT NONE</font></font><br><br><font color="#000000"><font style="font-size: 10pt;" size="2">!</font></font><br><font color="#000000"><font style="font-size: 10pt;" size="2">!-- Here the user defined initializing actions follow:</font></font><br><br><br><font color="#000000"><font style="font-size: 10pt;" size="2">END SUBROUTINE user_init</font></font></pre><p style="line-height: 100%;">The communication (handling of
54variables)
55with the model occurs via the
56global variables, which are defined within the individual FORTRAN -
57modules of PALM. The appropriate modules (they are all in the
58source code file <tt><font style="font-size: 10pt;" size="2">modules.f90</font></tt>)
59must be declared by means of <font size="2"><font face="Cumberland, monospace">USE</font></font>
60statements in the
61user-defined routines in order to be able to work with the variables
62contained in them. As in the example, this is already done with the
63module <tt><font style="font-size: 10pt;" size="2">control_parameters</font></tt>.
64This yields access to most of the existing parameters for steering the
65model. Furthermore, the module <tt><font style="font-size: 11pt;" size="2">user</font></tt>
66appears in the example
67above. This is a
68user-defined module (it can be found in file <tt><font style="font-size: 10pt;" size="2">user_module.f90</font></tt>)
69and can be used for communication between the user-defined routines. In
70this module own variables can be declared as desired. It
71is not used (and should not be used!) outside of the user code. </p>
72<p style="line-height: 100%;">A very typical request of
73users is the
74calculation and output of
75quantities which are not part of PALM's standard output. Several
76routines in the basic user interface are already designed and prepared
77for calculating and output of such quantities (see <a href="chapter_3.5.4.html">3.5.4</a>).</p><p style="line-height: 100%;">As already mentioned, the
78contents of
79the files <tt><font style="font-size: 10pt;" size="2">user_***.f90</font></tt>
80can be used as a basis for extensions. However these files should not be
81manipulated directly. Instead, a copy should be used.
82</p>
83<p style="line-height: 100%;">The following sections
84describe, which
85interfaces for user-defined code exist in the
86model, how user parameters can be defined for steering this code
87and how it is translated and linked to the model. &nbsp;</p>
88<hr><p style="line-height: 100%;"><br>
89<font color="#000080"><font color="#000080"><a href="chapter_3.4.html"><font color="#000080"><img name="Grafik1" src="left.gif" align="bottom" border="2" height="32" width="32"></font></a><a href="index.html"><font color="#000080"><img name="Grafik2" src="up.gif" align="bottom" border="2" height="32" width="32"></font></a><a href="chapter_3.5.1.html"><font color="#000080"><img name="Grafik3" src="right.gif" align="bottom" border="2" height="32" width="32"></font></a></font></font></p><p style="line-height: 100%;"><i>Last change:&nbsp;</i>
90$Id: chapter_3.5.html 212 2008-11-11 09:09:24Z raasch $</p>
91</body></html>
Note: See TracBrowser for help on using the repository browser.