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

Last change on this file since 4178 was 3768, checked in by raasch, 2 years ago

variables commented out + statement added to avoid compiler warnings about unused variables

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