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

Last change on this file since 2233 was 2233, checked in by suehring, 4 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 4.4 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 2233 2017-05-30 18:08:54Z suehring $
27!
28! 2232 2017-05-30 17:47:52Z suehring
29! +Generic tunnel added
30! +Example of setting user-defined topography
31!
32! 2000 2016-08-20 18:09:15Z knoop
33! Forced header and separation lines into 80 columns
34!
35! 1968 2016-07-18 12:01:49Z suehring
36! Change dimensions for nzb_local, which do not longer need to be set on
37! multigrid ghost points.
38!
39! 1682 2015-10-07 23:56:08Z knoop
40! Code annotations made doxygen readable
41!
42! 1320 2014-03-20 08:40:49Z raasch
43! kind-parameters added to all INTEGER and REAL declaration statements,
44! kinds are defined in new module kinds,
45! old module precision_kind is removed,
46! revision history before 2012 removed,
47! comment fields (!:) to be used for variable explanations added to
48! all variable declaration statements
49!
50! 1036 2012-10-22 13:43:42Z raasch
51! code put under GPL (PALM 3.9)
52!
53! 217 2008-12-09 18:00:48Z letzel
54! +topography_grid_convention
55! Former file user_interface.f90 split into one file per subroutine
56!
57! Description:
58! ------------
59!> Execution of user-defined grid initializing actions
60!------------------------------------------------------------------------------!
61 SUBROUTINE user_init_grid( topo_3d )
62 
63
64    USE control_parameters
65   
66    USE indices
67   
68    USE kinds
69   
70    USE user
71
72    IMPLICIT NONE
73
74    INTEGER(iwp)                                           ::  k_topo      !< topography top index
75    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  topo_3d     !< 3D topography field
76
77    REAL(wp) ::  h_topo !< user-defined topography height
78
79!
80!-- Here the user-defined grid initializing actions follow:
81
82!
83!-- Set the index array nzb_local for non-flat topography.
84!-- Here consistency checks concerning domain size and periodicity are necessary
85    SELECT CASE ( TRIM( topography ) )
86
87       CASE ( 'flat', 'single_building', 'single_street_canyon', 'tunnel' )
88!
89!--       Not allowed here since these are the standard cases used in init_grid.
90
91       CASE ( 'user_defined_topography_1' )
92!
93!--       Here the user can define his own topography.
94!--       After definition, please remove the following three lines!
95          message_string = 'topography "' // topography // '" not available yet'
96          CALL message( 'user_init_grid', 'UI0005', 1, 2, 0, 6, 0 )
97!
98!--       The user is allowed to set surface-mounted as well as non-surface
99!--       mounted topography (e.g. overhanging structures). For both, use
100!--       3D array topo_3d and set bit 0. The convention is: bit is zero inside
101!--       topography, bit is 1 for atmospheric grid point.
102!--       The following example shows how to prescribe sine-like topography
103!--       along x-direction with amplitude of 10 * dz and wavelength 10 * dy.
104!           DO  i = nxlg, nxrg
105!              h_topo = 10.0_wp * dz * (SIN(3.14_wp*0.5_wp)*i*dx / ( 5.0_wp * dy ) )**2
106!
107!              k_topo = MINLOC( ABS( zw - h_topo ), 1 ) - 1
108!
109!              topo_3d(k_topo+1:nzt+1,:,i) =                                     &
110!                                          IBSET( topo_3d(k_topo+1:nzt+1,:,i), 0 )
111!           ENDDO
112!
113!           CALL exchange_horiz_int( topo_3d, nbgp )
114
115       CASE DEFAULT
116!
117!--       The DEFAULT case is reached if the parameter topography contains a
118!--       wrong character string that is neither recognized in init_grid nor
119!--       here in user_init_grid.
120          message_string = 'unknown topography "' // topography // '"'
121          CALL message( 'user_init_grid', 'UI0006', 1, 2, 0, 6, 0 )
122
123    END SELECT
124
125
126
127
128 END SUBROUTINE user_init_grid
129
Note: See TracBrowser for help on using the repository browser.