source: palm/trunk/SOURCE/user_init_3d_model.f90 @ 4174

Last change on this file since 4174 was 3768, checked in by raasch, 5 years ago

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

  • Property svn:keywords set to Id
File size: 4.1 KB
Line 
1!> @file user_init_3d_model.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_3d_model.f90 3768 2019-02-27 14:35:58Z gronemeier $
27! variables commented out to avoid compiler warnings about unused variables
28!
29! 3655 2019-01-07 16:51:22Z knoop
30! Corrected "Former revisions" section
31!
32! 2696 2017-12-14 17:12:51Z kanani
33! Change in file header (GPL part)
34!
35! 2618 2017-11-16 15:37:30Z suehring
36! Provide example for user-defined initialization of surface-related quantities
37!
38! 2233 2017-05-30 18:08:54Z suehring
39!
40! 2232 2017-05-30 17:47:52Z suehring
41! +surface_mod
42!
43! 2000 2016-08-20 18:09:15Z knoop
44! Forced header and separation lines into 80 columns
45!
46! 1682 2015-10-07 23:56:08Z knoop
47! Code annotations made doxygen readable
48!
49! 1320 2014-03-20 08:40:49Z raasch
50! small changes in layout
51!
52! 1036 2012-10-22 13:43:42Z raasch
53! code put under GPL (PALM 3.9)
54!
55! 211 2008-11-11 04:46:24Z raasch
56! Former file user_interface.f90 split into one file per subroutine
57!
58! Description:
59! ------------
60!> Allows the complete initialization of the 3d model.
61!>
62!> @attention The user is responsible to set at least all those quantities which
63!>            are normally set within init_3d_model!
64!------------------------------------------------------------------------------!
65 SUBROUTINE user_init_3d_model
66 
67
68    USE arrays_3d
69   
70    USE control_parameters
71   
72    USE indices
73   
74    USE kinds
75
76    USE surface_mod
77   
78    USE user
79
80    IMPLICIT NONE
81
82!    INTEGER(iwp) ::  l !< running index surface orientation
83!    INTEGER(iwp) ::  m !< running index surface elements
84
85!
86!-- Initialization of surface-related quantities.
87!-- The following example shows required initialization of surface quantitites
88!-- at default-type upward-facing surfaces. 
89!   DO  m = 1, surf_def_h(0)%ns
90!      surf_def_h(0)%ol(m)   = ...    ! Obukhov length
91!      surf_def_h(0)%us(m  ) = ...    ! friction velocity
92!      surf_def_h(0)%usws(m) = ...    ! vertical momentum flux, u-component
93!      surf_def_h(0)%vsws(m) = ...    ! vertical momentum flux, v-component
94!      surf_def_h(0)%z0(m)   = ...    ! roughness length for momentum
95!      IF ( .NOT. neutral )  THEN
96!         surf_def_h(0)%ts(m)   = ... ! scaling parameter
97!         surf_def_h(0)%shf(m)  = ... ! surface sensible heat flux
98!         surf_def_h(0)%z0h(m)  = ... ! roughness length for heat
99!      ENDIF
100!      IF ( humditiy )  THEN
101!         surf_def_h(0)%qs(m)   = ... ! scaling parameter
102!         surf_def_h(0)%qsws(m) = ... ! surface latent heat flux
103!         surf_def_h(0)%z0q(m)  = ... ! roughness length for moisture
104!      ENDIF
105!      IF ( passive_scalar )  THEN
106!         surf_def_h(0)%ss(m)   = ... ! scaling parameter
107!         surf_def_h(0)%ssws(m) = ... ! surface latent heat flux
108!      ENDIF
109!   ENDDO
110!
111!-- Same for natural and urban type surfaces
112!   DO  m = 1, surf_lsm_h%ns
113!      ...
114!   ENDDO
115!   DO  m = 1, surf_usm_h%ns
116!      ...
117!   ENDDO
118!
119!-- Also care for vertically aligned surfaces (default-, natural-, and
120!-- urban-type).
121!   DO  l = 0, 3
122!      DO  m = 1, surf_def_v(l)%ns
123!         ...
124!      ENDDO
125!      DO  m = 1, surf_lsm_v(l)%ns
126!         ...
127!      ENDDO
128!      DO  m = 1, surf_usm_v(l)%ns
129!         ...
130!      ENDDO
131!   ENDDO
132!
133!
134!-- In the following, initialize 3D quantities, e.g. u, v, w, pt, etc..
135
136 END SUBROUTINE user_init_3d_model
137
Note: See TracBrowser for help on using the repository browser.