source: palm/trunk/SOURCE/user_init.f90 @ 1682

Last change on this file since 1682 was 1682, checked in by knoop, 8 years ago

Code annotations made doxygen readable

  • Property svn:keywords set to Id
File size: 2.7 KB
Line 
1!> @file user_init.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2014 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21! Code annotations made doxygen readable
22!
23! Former revisions:
24! -----------------
25! $Id: user_init.f90 1682 2015-10-07 23:56:08Z knoop $
26!
27! 1353 2014-04-08 15:21:23Z heinze
28! REAL constants provided with KIND-attribute
29!
30! 1320 2014-03-20 08:40:49Z raasch
31! revision history before 2012 removed,
32! comment fields (!:) to be used for variable explanations added to
33! all variable declaration statements
34!
35! 1036 2012-10-22 13:43:42Z raasch
36! code put under GPL (PALM 3.9)
37!
38! 211 2008-11-11 04:46:24Z raasch
39! Former file user_interface.f90 split into one file per subroutine
40!
41! Description:
42! ------------
43!> Execution of user-defined initializing actions
44!------------------------------------------------------------------------------!
45 SUBROUTINE user_init
46 
47
48    USE control_parameters
49   
50    USE indices
51   
52    USE kinds
53   
54    USE netcdf_control
55   
56    USE pegrid
57   
58    USE user
59
60    IMPLICIT NONE
61
62    CHARACTER (LEN=20) :: field_char   !<
63!
64!-- Here the user-defined initializing actions follow:
65!-- Sample for user-defined output
66!    ALLOCATE( u2(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
67!    ALLOCATE( ustvst(nzb:nzt+1,nysg:nyng,nxlg:nxrg) );  ustvst = 0.0_wp
68
69!-- Sample for user-defined time series
70!-- For each time series quantity you have to give a label and a unit,
71!-- which will be used for the NetCDF file. They must not contain more than
72!-- seven characters. The value of dots_num has to be increased by the
73!-- number of new time series quantities. Its old value has to be store in
74!-- dots_num_palm. See routine user_statistics on how to output calculate
75!-- and output these quantities.
76!    dots_label(dots_num+1) = 'abs_umx'
77!    dots_unit(dots_num+1)  = 'm/s'
78!    dots_label(dots_num+2) = 'abs_vmx'
79!    dots_unit(dots_num+2)  = 'm/s'
80!
81!    dots_num_palm = dots_num
82!    dots_num = dots_num + 2
83
84 END SUBROUTINE user_init
85
Note: See TracBrowser for help on using the repository browser.