source: palm/trunk/SOURCE/user_init_plant_canopy.f90 @ 2488

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

last commit documented

  • Property svn:keywords set to Id
File size: 4.3 KB
Line 
1!> @file user_init_plant_canopy.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_plant_canopy.f90 2101 2017-01-05 16:42:31Z knoop $
27!
28! 2000 2016-08-20 18:09:15Z knoop
29! Forced header and separation lines into 80 columns
30!
31! 1951 2016-06-20 10:05:12Z suehring
32! Bugfix in example initialization
33!
34! 1682 2015-10-07 23:56:08Z knoop
35! Code annotations made doxygen readable
36!
37! 1484 2014-10-21 10:53:05Z kanani
38! Changes in the course of the canopy-model modularization:
39!   module plant_canopy_model_mod added,
40!   definition of array cdc (canopy drag coefficient) removed, since it is now
41!   defined purely as a single constant value (see module plant_canopy_model)
42!
43! 1353 2014-04-08 15:21:23Z heinze
44! REAL constants provided with KIND-attribute
45!
46! 1320 2014-03-20 08:40:49Z raasch
47! kind-parameters added to all INTEGER and REAL declaration statements,
48! kinds are defined in new module kinds,
49! old module precision_kind is removed,
50! revision history before 2012 removed,
51! comment fields (!:) to be used for variable explanations added to
52! all variable declaration statements
53!
54! 1036 2012-10-22 13:43:42Z raasch
55! code put under GPL (PALM 3.9)
56!
57! 211 2008-11-11 04:46:24Z raasch
58! Former file user_interface.f90 split into one file per subroutine
59!
60! Description:
61! ------------
62!> Initialisation of the leaf area density array (for scalar grid points) and
63!> the array of the canopy drag coefficient, if the user has not chosen any
64!> of the default cases
65!------------------------------------------------------------------------------!
66 SUBROUTINE user_init_plant_canopy
67 
68
69    USE arrays_3d
70   
71    USE control_parameters
72   
73    USE indices
74   
75    USE kinds
76
77    USE plant_canopy_model_mod
78   
79    USE user
80
81    IMPLICIT NONE
82
83    INTEGER(iwp) :: i   !< running index
84    INTEGER(iwp) :: j   !< running index
85
86!
87!-- Here the user-defined grid initializing actions follow:
88
89!
90!-- Set the 3D-array lad_s for user defined canopies
91    SELECT CASE ( TRIM( canopy_mode ) )
92
93       CASE ( 'block' )
94!
95!--       Not allowed here since this is the standard case used in init_3d_model.
96
97       CASE ( 'user_defined_canopy_1' )
98!
99!--       Here the user can define his own forest topography.
100!--       The following lines contain an example, where the plant canopy extends
101!--       only over the second half of the model domain along x.
102!--       Attention: DO-loops have to include the ghost points (nxlg-nxrg,
103!--       nysg-nyng), because no exchange of ghost point information is intended,
104!--       in order to minimize communication between CPUs.
105!          DO  i = nxlg, nxrg
106!             IF ( i >= INT( ( nx+1 ) / 2 ) ) THEN
107!                DO  j = nysg, nyng
108!                   lad_s(:,j,i) = lad(:)
109!                ENDDO
110!             ELSE
111!                lad_s(:,:,i) = 0.0_wp
112!             ENDIF
113!          ENDDO
114!
115!--       After definition, please
116!--       remove the following three lines!
117          message_string = 'canopy_mode "' // canopy_mode // &
118                           '" not available yet'
119          CALL message( 'user_init_plant_canopy', 'UI0007', 0, 1, 0, 6, 0 )
120         
121       CASE DEFAULT
122!
123!--       The DEFAULT case is reached if the parameter canopy_mode contains a
124!--       wrong character string that is neither recognized in init_3d_model nor
125!--       here in user_init_plant_canopy.
126          message_string = 'unknown canopy_mode "' // canopy_mode // '"'
127          CALL message( 'user_init_plant_canopy', 'UI0008', 1, 2, 0, 6, 0 )
128
129    END SELECT
130
131
132 END SUBROUTINE user_init_plant_canopy
133
Note: See TracBrowser for help on using the repository browser.