source: palm/trunk/SOURCE/user_init_grid.f90 @ 2101

Last change on this file since 2101 was 2101, checked in by suehring, 7 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 3.3 KB
Line 
1!> @file user_init_grid.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
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
17! Copyright 1997-2017 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: user_init_grid.f90 2101 2017-01-05 16:42:31Z suehring $
27!
28! 2000 2016-08-20 18:09:15Z knoop
29! Forced header and separation lines into 80 columns
30!
31! 1968 2016-07-18 12:01:49Z suehring
32! Change dimensions for nzb_local, which do not longer need to be set on
33! multigrid ghost points.
34!
35! 1682 2015-10-07 23:56:08Z knoop
36! Code annotations made doxygen readable
37!
38! 1320 2014-03-20 08:40:49Z raasch
39! kind-parameters added to all INTEGER and REAL declaration statements,
40! kinds are defined in new module kinds,
41! old module precision_kind is removed,
42! revision history before 2012 removed,
43! comment fields (!:) to be used for variable explanations added to
44! all variable declaration statements
45!
46! 1036 2012-10-22 13:43:42Z raasch
47! code put under GPL (PALM 3.9)
48!
49! 217 2008-12-09 18:00:48Z letzel
50! +topography_grid_convention
51! Former file user_interface.f90 split into one file per subroutine
52!
53! Description:
54! ------------
55!> Execution of user-defined grid initializing actions
56!------------------------------------------------------------------------------!
57 SUBROUTINE user_init_grid( nzb_local )
58 
59
60    USE control_parameters
61   
62    USE indices
63   
64    USE kinds
65   
66    USE user
67
68    IMPLICIT NONE
69
70    INTEGER(iwp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  nzb_local   !<
71
72!
73!-- Here the user-defined grid initializing actions follow:
74
75!
76!-- Set the index array nzb_local for non-flat topography.
77!-- Here consistency checks concerning domain size and periodicity are necessary
78    SELECT CASE ( TRIM( topography ) )
79
80       CASE ( 'flat', 'single_building', 'single_street_canyon' )
81!
82!--       Not allowed here since these are the standard cases used in init_grid.
83
84       CASE ( 'user_defined_topography_1' )
85!
86!--       Here the user can define his own topography.
87!--       After definition, please remove the following three lines!
88          message_string = 'topography "' // topography // '" not available yet'
89          CALL message( 'user_init_grid', 'UI0005', 1, 2, 0, 6, 0 )
90
91       CASE DEFAULT
92!
93!--       The DEFAULT case is reached if the parameter topography contains a
94!--       wrong character string that is neither recognized in init_grid nor
95!--       here in user_init_grid.
96          message_string = 'unknown topography "' // topography // '"'
97          CALL message( 'user_init_grid', 'UI0006', 1, 2, 0, 6, 0 )
98
99    END SELECT
100
101
102 END SUBROUTINE user_init_grid
103
Note: See TracBrowser for help on using the repository browser.