-
Notifications
You must be signed in to change notification settings - Fork 6
/
aed_dummy.F90
250 lines (213 loc) · 11 KB
/
aed_dummy.F90
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
!###############################################################################
!# #
!# aed_dummy.F90 #
!# #
!# Developed by : #
!# AquaticEcoDynamics (AED) Group #
!# School of Agriculture and Environment #
!# The University of Western Australia #
!# #
!# http:https://aquatic.science.uwa.edu.au/ #
!# #
!# Copyright 2013 - 2024 - The University of Western Australia #
!# #
!# AED is free software: you can redistribute it and/or modify #
!# it under the terms of the GNU General Public License as published by #
!# the Free Software Foundation, either version 3 of the License, or #
!# (at your option) any later version. #
!# #
!# AED is distributed in the hope that it will be useful, #
!# but WITHOUT ANY WARRANTY; without even the implied warranty of #
!# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
!# GNU General Public License for more details. #
!# #
!# You should have received a copy of the GNU General Public License #
!# along with this program. If not, see <http:https://www.gnu.org/licenses/>. #
!# #
!# ----------------------------------------------------------------------- #
!# #
!# Created July 2019 #
!# #
!###############################################################################
! !
! .----------------. .----------------. .----------------. !
! | .--------------. || .--------------. || .--------------. | !
! | | ________ | || | ____ ____ | || | ____ ____ | | !
! | | |_ ___ `. | || ||_ | | _|| || ||_ \ / _|| | !
! | | | | `. \ | || | | | | | | || | | \/ | | | !
! | | | | | | | || | | | , | | || | | |\ /| | | | !
! | | _| |___.' / | || | | `.__. , | || | _| |_\/_| |_ | | !
! | | |________.' | || | |_______. | || ||_____||_____|| | !
! | | | || | | || | | | !
! | '--------------' || '--------------' || '--------------' | !
! '----------------' '----------------' '----------------' !
! !
!###############################################################################
#include "aed.h"
!
MODULE aed_dummy
!-------------------------------------------------------------------------------
! aed_dummy --- dummy model
!
! The AED module "dummy" contains only variables to provide vars required in
! other modules that we didnt provide (usually for debugging purposes)
!-------------------------------------------------------------------------------
USE aed_core
IMPLICIT NONE
PRIVATE
!
PUBLIC aed_dummy_data_t
!
TYPE,extends(aed_model_data_t) :: aed_dummy_data_t
!# Variable identifiers
INTEGER :: num_v, num_dv, num_sv, num_dsv
INTEGER :: id_sine, id_vsine
INTEGER,ALLOCATABLE :: id_dummy_v(:), id_dummy_dv(:), &
id_dummy_sv(:), id_dummy_dsv(:)
AED_REAL,ALLOCATABLE :: dm_max(:), dm_min(:)
AED_REAL,ALLOCATABLE :: dm_smax(:), dm_smin(:)
CONTAINS
PROCEDURE :: define => aed_define_dummy
PROCEDURE :: calculate => aed_calculate_dummy
PROCEDURE :: calculate_benthic => aed_calculate_benthic_dummy
END TYPE
! MODULE GLOBALS
AED_REAL :: today = 1.
INTEGER :: diag_level = 10 ! 0 = no diagnostic outputs
! 1 = basic diagnostic outputs
! 2 = flux rates, and supporitng
! 3 = other metrics
!10 = all debug & checking outputs
!===============================================================================
CONTAINS
!###############################################################################
SUBROUTINE aed_define_dummy(data, namlst)
!-------------------------------------------------------------------------------
! Initialise the AED model
!
! Here, the aed namelist is read and te variables exported
! by the model are registered with AED.
!-------------------------------------------------------------------------------
!ARGUMENTS
INTEGER,INTENT(in) :: namlst
CLASS (aed_dummy_data_t),INTENT(inout) :: data
!
!LOCALS
INTEGER :: status
INTEGER :: i, num_v, num_dv, num_sv, num_dsv
CHARACTER(len=4),POINTER :: prefix => null()
! %% NAMELIST %% /aed_dummy/
! %% Last Checked 20/08/2021
CHARACTER(len=40) :: dm_vars(100) = ''
AED_REAL :: dm_max(100) = NaN_
AED_REAL :: dm_min(100) = NaN_
AED_REAL :: dm_init(100) = 0.
CHARACTER(len=40) :: dm_dvars(100) = ''
CHARACTER(len=40) :: dm_svars(100) = ''
AED_REAL :: dm_smax(100) = NaN_
AED_REAL :: dm_smin(100) = NaN_
AED_REAL :: dm_sinit(100) = 0.
CHARACTER(len=40) :: dm_dsvars(100) = ''
! %% From Module Globals
! INTEGER :: diag_level = 10 ! 0 = no diagnostic outputs
! ! 1 = basic diagnostic outputs
! ! 2 = flux rates, and supporitng
! ! 3 = other metrics
! !10 = all debug & checking outputs
! %% END NAMELIST %% /aed_dummy/
NAMELIST /aed_dummy/ dm_vars, dm_max, dm_min, dm_init, &
dm_dvars, &
dm_svars, dm_smax, dm_smin, dm_sinit, &
dm_dsvars, diag_level
!
!-------------------------------------------------------------------------------
!BEGIN
print *," aed_dummy initialization"
num_v = 0 ; num_dv = 0 ; num_sv = 0 ; num_dsv = 0
! Read the namelist
read(namlst,nml=aed_dummy,iostat=status)
IF (status /= 0) STOP 'Error reading namelist aed_dummy'
DO i=1,100 ; IF (dm_vars(i) .EQ. '' ) THEN ; num_v = i-1 ; EXIT ; ENDIF ; ENDDO
DO i=1,100 ; IF (dm_dvars(i) .EQ. '' ) THEN ; num_dv = i-1 ; EXIT ; ENDIF ; ENDDO
DO i=1,100 ; IF (dm_svars(i) .EQ. '' ) THEN ; num_sv = i-1 ; EXIT ; ENDIF ; ENDDO
DO i=1,100 ; IF (dm_dsvars(i) .EQ. '' ) THEN ; num_dsv = i-1 ; EXIT ; ENDIF ; ENDDO
ALLOCATE(data%id_dummy_v(num_v))
ALLOCATE(data%id_dummy_dv(num_dv))
ALLOCATE(data%id_dummy_sv(num_sv))
ALLOCATE(data%id_dummy_dsv(num_dsv))
ALLOCATE(data%dm_min(num_v)) ; ALLOCATE(data%dm_max(num_v))
ALLOCATE(data%dm_smin(num_sv)) ; ALLOCATE(data%dm_smax(num_sv))
data%num_v = num_v
data%num_dv = num_dv
data%num_sv = num_sv
data%num_dsv = num_dsv
CALL aed_set_prefix(prefix)
! Register state variables
DO i=1,data%num_v
data%id_dummy_v(i) = aed_define_variable(dm_vars(i), '', '', dm_init(i), dm_min(i), dm_max(i), 0.)
data%dm_min(i) = dm_min(i)
data%dm_max(i) = dm_max(i)
ENDDO
DO i=1,data%num_sv
data%id_dummy_sv(i) = aed_define_sheet_variable(dm_svars(i), '', '', dm_sinit(i), dm_smin(i), dm_smax(i), .FALSE.)
data%dm_smin(i) = dm_smin(i)
data%dm_smax(i) = dm_smax(i)
ENDDO
DO i=1,data%num_dv
data%id_dummy_dv(i) = aed_define_diag_variable(dm_dvars(i), '', '')
ENDDO
DO i=1,data%num_dsv
data%id_dummy_dsv(i) = aed_define_sheet_diag_variable(dm_dsvars(i), '', '', .FALSE.)
ENDDO
data%id_vsine = aed_define_diag_variable('DUM_vol_sine', 'no units', 'DBG volume sine between 0.0 and 1.0')
data%id_sine = aed_define_sheet_diag_variable('DUM_sine', 'no units', 'DBG sine wave between 0.0 and 1.0', .FALSE.)
END SUBROUTINE aed_define_dummy
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_calculate_dummy(data,column,layer_idx)
!-------------------------------------------------------------------------------
!ARGUMENTS
CLASS (aed_dummy_data_t),INTENT(in) :: data
TYPE (aed_column_t),INTENT(inout) :: column(:)
INTEGER,INTENT(in) :: layer_idx
!
!LOCALS
INTEGER :: i
AED_REAL :: scale, offs
!-------------------------------------------------------------------------------
!BEGIN
_DIAG_VAR_(data%id_vsine) = &
(sin(MOD((today+(layer_idx-1)*10.),365.)/365. * 2 * 3.1415) * 0.5) + 0.5
DO i=1,data%num_v
scale = (data%dm_max(i) - data%dm_min(i)) / 2.
offs = data%dm_min(i) + scale
_STATE_VAR_(data%id_dummy_v(i)) = &
(sin(MOD((today+(layer_idx-1)*10.),365.)/365. * 2 * 3.1415) * scale) + offs
ENDDO
END SUBROUTINE aed_calculate_dummy
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!###############################################################################
SUBROUTINE aed_calculate_benthic_dummy(data,column,layer_idx)
!-------------------------------------------------------------------------------
!ARGUMENTS
CLASS (aed_dummy_data_t),INTENT(in) :: data
TYPE (aed_column_t),INTENT(inout) :: column(:)
INTEGER,INTENT(in) :: layer_idx
!
!LOCALS
INTEGER :: i
AED_REAL :: scale, offs
!-------------------------------------------------------------------------------
!BEGIN
IF (layer_idx .EQ. 1) today = today + 1.0/36.5
_DIAG_VAR_S_(data%id_sine) = &
(sin(MOD((today+(layer_idx-1)*10.),365.)/365. * 2 * 3.1415) * 0.5) + 0.5
DO i=1,data%num_sv
scale = (data%dm_smax(i) - data%dm_smin(i)) / 2.
offs = data%dm_smin(i) + scale
_STATE_VAR_S_(data%id_dummy_sv(i)) = &
(sin(MOD((today+(layer_idx-1)*10.),365.)/365. * 2 * 3.1415) * scale) + offs
ENDDO
END SUBROUTINE aed_calculate_benthic_dummy
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
END MODULE aed_dummy