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

Last change on this file since 2696 was 2696, checked in by kanani, 4 years ago

Merge of branch palm4u into trunk

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