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

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

Reorder calls for initializing surface quantities and give example of user-defined initialization of surface quantities

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