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

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

Code annotations made doxygen readable

  • 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 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_grid.f90 1682 2015-10-07 23:56:08Z knoop $
26!
27! 1320 2014-03-20 08:40:49Z raasch
28! kind-parameters added to all INTEGER and REAL declaration statements,
29! kinds are defined in new module kinds,
30! old module precision_kind is removed,
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! 217 2008-12-09 18:00:48Z letzel
39! +topography_grid_convention
40! Former file user_interface.f90 split into one file per subroutine
41!
42! Description:
43! ------------
44!> Execution of user-defined grid initializing actions
45!> First argument gls contains the number of ghost layers, which is > 1 if the
46!> multigrid method for the pressure solver is used
47!------------------------------------------------------------------------------!
48 SUBROUTINE user_init_grid( gls, nzb_local )
49 
50
51    USE control_parameters
52   
53    USE indices
54   
55    USE kinds
56   
57    USE user
58
59    IMPLICIT NONE
60
61    INTEGER(iwp) ::  gls   !<
62
63    INTEGER(iwp),                                                              &
64       DIMENSION(-gls:ny+gls,-gls:nx+gls) ::                                   &
65          nzb_local   !<
66
67!
68!-- Here the user-defined grid initializing actions follow:
69
70!
71!-- Set the index array nzb_local for non-flat topography.
72!-- Here consistency checks concerning domain size and periodicity are necessary
73    SELECT CASE ( TRIM( topography ) )
74
75       CASE ( 'flat', 'single_building', 'single_street_canyon' )
76!
77!--       Not allowed here since these are the standard cases used in init_grid.
78
79       CASE ( 'user_defined_topography_1' )
80!
81!--       Here the user can define his own topography.
82!--       After definition, please remove the following three lines!
83          message_string = 'topography "' // topography // '" not available yet'
84          CALL message( 'user_init_grid', 'UI0005', 1, 2, 0, 6, 0 )
85
86       CASE DEFAULT
87!
88!--       The DEFAULT case is reached if the parameter topography contains a
89!--       wrong character string that is neither recognized in init_grid nor
90!--       here in user_init_grid.
91          message_string = 'unknown topography "' // topography // '"'
92          CALL message( 'user_init_grid', 'UI0006', 1, 2, 0, 6, 0 )
93
94    END SELECT
95
96
97 END SUBROUTINE user_init_grid
98
Note: See TracBrowser for help on using the repository browser.