Changeset 212 for palm/trunk/DOC/app/chapter_3.5.html

Timestamp:

Nov 11, 2008 9:09:24 AM (15 years ago)

Author:

raasch

Message:

manual updated for changes in the user interface

File:

• palm/trunk/DOC/app/chapter_3.5.html (modified) (5 diffs)

palm/trunk/DOC/app/chapter_3.5.html

@@ -16 +16 @@
 2.0</a> and the technical documentation are usually not
 sufficient
-and must be supplemented by the rigorous study of the source code of
-the model. Programming experiences with FORTRAN95 and if necessary
+and must be supplemented by a rigorous study of the model's source code. Programming experiences with FORTRAN95 and if necessary
 experiences with the parallelization tool MPI are absolutely
-neccessary! </p>
+necessary! </p>
 <p style="line-height: 100%;">Changes of the standard
 model code by the
@@ -43 +42 @@
 pre-defined names, which must not be changed by the user. Their basic
 versions are a component of the standard model
-code and they are all included in the source code file
-<tt><font style="font-size: 10pt;" size="2">user_interface.f90</font></tt><font style="font-size: 10pt;" size="2">.</font>
+code and can be found in the source code files
+<tt><font style="font-size: 10pt;" size="2">user_***.f90</font></tt><font style="font-size: 10pt;" size="2">.</font>
 <font color="#000000">The</font> basic versions
 accomplish nearly no
@@ -50 +49 @@
 user as required. Actions which are already accomplished in these
 basic versions by default should not be changed. Here is an example
-of such a basic version: </p>
+of such a basic version (file <span style="font-family: Courier New,Courier,monospace;">user_init.f90</span>): </p>
 <p style="line-height: 100%;">&nbsp; </p>
 <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
@@ -67 +66 @@
 appears in the example
 above. This is a
-user-defined module (it is located at
-the beginning of the file <tt><font style="font-size: 10pt;" size="2">user_interface.f90</font></tt>)
+user-defined module (it can be found in file <tt><font style="font-size: 10pt;" size="2">user_module.f90</font></tt>)
 and can be used for communication between the user-defined routines. In
 this module own variables can be declared as desired. It
-is not used outside of the user code. </p>
+is not used (and should not be used!) outside of the user code. </p>
 <p style="line-height: 100%;">A very typical request of
 users is the
@@ -79 +77 @@
 for 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
 contents of
-the file <tt><font style="font-size: 10pt;" size="2">user_interface.f90</font></tt>
-can be used as a basis for extensions. However the file should not be
-manipulated directly (it is anyway write protected by default), but it
-should be
-copied to another file. User write permits for this new file must be
-declared by means of the unix command <tt><font style="font-size: 10pt;" size="2">chmod</font></tt>.
+the files <tt><font style="font-size: 10pt;" size="2">user_***.f90</font></tt>
+can be used as a basis for extensions. However these files should not be
+manipulated directly. Instead, a copy should be used.
 </p>
 <p style="line-height: 100%;">The following sections