-
Notifications
You must be signed in to change notification settings - Fork 57
/
ModuleAtmosphere.F90
4925 lines (3587 loc) · 232 KB
/
ModuleAtmosphere.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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
!------------------------------------------------------------------------------
! IST/MARETEC, Water Modelling Group, Mohid modelling system
!------------------------------------------------------------------------------
!
! TITLE : Mohid Model
! PROJECT : Mohid Land, Mohid SurfaceWater
! MODULE : Atmosphere
! URL : http://www.mohid.com
! AFFILIATION : IST/MARETEC, Marine Modelling Group
! DATE : July 2003
! REVISION : Frank & Pedro Chambel Leitao, Luis Fernandes - v4.0
! DESCRIPTION : Module used to read and calculate values for atmosphere
!
!------------------------------------------------------------------------------
!
!This program is free software; you can redistribute it and/or
!modify it under the terms of the GNU General Public License
!version 2, as published by the Free Software Foundation.
!
!This program 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, write to the Free Software
!Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
!
!------------------------------------------------------------------------------
Module ModuleAtmosphere
use ModuleGlobalData
use ModuleDrawing
use ModuleTime
use ModuleHDF5
use ModuleFunctions, only : ConstructPropertyID, CHUNK_J
use ModuleFillMatrix, only : ConstructFillMatrix, ModifyFillMatrix, KillFillMatrix, &
GetIfMatrixRemainsConstant, GetFillMatrixDTPrediction, &
GetNextValueForDTPred, GetValuesProcessingOptions, &
UngetFillMatrix, ModifyFillMatrixVectorial
use ModuleTimeSerie, only : StartTimeSerie, WriteTimeSerie, KillTimeSerie, &
GetTimeSerieLocation, CorrectsCellsTimeSerie, &
GetNumberOfTimeSeries, TryIgnoreTimeSerie, GetTimeSerieName
use ModuleEnterData, only : ReadFileName, ConstructEnterData, GetData, &
ExtractBlockFromBuffer, Block_Unlock, GetOutPutTime, &
KillEnterData
use ModuleGridData, only : GetGridData, UngetGridData
use ModuleHorizontalGrid, only : GetHorizontalGrid, GetHorizontalGridSize, GetGridAngle, &
GetGridLatitudeLongitude, WriteHorizontalGrid, &
UnGetHorizontalGrid, RotateVectorFieldToGrid, &
GetGridCellArea, GetXYCellZ, GetDDecompMPI_ID, &
GetDDecompON, GetGridOutBorderPolygon, &
ComputeAngleFromGridComponents, RotateVectorGridToField
use ModuleStatistic, only : ConstructStatistic, GetStatisticMethod, &
GetStatisticParameters, ModifyStatistic, KillStatistic
use ModuleStopWatch, only : StartWatch, StopWatch
implicit none
private
!Subroutines & Functions---------------------------------------------------
!Constructor
public :: StartAtmosphere
private :: AllocateInstance
private :: ReadPropertiesFilesName
private :: ConstructPropertyList
private :: ConstructProperty
private :: Add_Property
private :: Construct_PropertyValues
private :: ConstructOutPut
private :: ConstructSurfStatistics
private :: OpenHDF5OutPutFile
private :: ConstructTimeSerie
!private :: RotateAtmosphereVectorFields
!Selector
public :: GetWindHeight
public :: GetAirMeasurementHeight
public :: GetAtmosphereProperty
private :: SearchProperty
public :: AtmospherePropertyExists
public :: GetAtmospherenProperties
public :: GetAtmospherePropertiesIDByIdx
public :: GetNextAtmosphereDTPrediction
public :: UngetAtmosphere
private :: ReadLockExternalVar
private :: ReadUnlockExternalVar
!Modifier
public :: ModifyAtmosphere
private :: ModifyAirTemperature
private :: ModifyWindVelocity
private :: ComputeWindVelocity
private :: ModifyWindDirection
private :: ModifyWindModulus
private :: ModifyPrecipitation
private :: ModifySolarRadiation
private :: ClimatologicSolarRadiation
private :: RandomCloud !Function
private :: TOARadiation !Function
private :: ModifyAtmosphericPressure
private :: ModifyCo2AtmosphericPressure
private :: ModifyO2AtmosphericPressure
private :: ModifyPropByIrri
private :: ModifyPropByRain
private :: ModifySunHours
private :: ModifyCloudCover
private :: ModifyRelativeHumidity
private :: ModifyPBLHeight
private :: ModifyIrrigation
private :: ModifyRandom
private :: ModifyOutput
private :: OutPutResultsHDF5
private :: OutPut_TimeSeries
private :: OutPut_Statistics
private :: ModifyAtmospDeposOxidNO3 !LLP
private :: ModifyAtmospDeposReduNH4 !LLP
!Destructor
public :: KillAtmosphere
private :: DeallocateInstance
private :: DeallocateVariables
!Management
private :: Ready
private :: LocateObjAtmosphere
!Interfaces----------------------------------------------------------------
private :: UngetAtmosphere1D
private :: UngetAtmosphere2D
interface UngetAtmosphere
module procedure UngetAtmosphere1D
module procedure UngetAtmosphere2D
end interface UngetAtmosphere
private :: GetAtmospherePropertyScalar
private :: GetAtmospherePropertyVectorial
interface GetAtmosphereProperty
module procedure GetAtmospherePropertyScalar
module procedure GetAtmospherePropertyVectorial
end interface GetAtmosphereProperty
!Parameter-----------------------------------------------------------------
!Sun constant (W / m**2)
real, parameter :: KSun = 1367.0
character(LEN = StringLength), parameter :: block_begin = '<beginproperty>'
character(LEN = StringLength), parameter :: block_end = '<endproperty>'
!Parameter
integer, parameter :: Radiation_MOHID = 1
integer, parameter :: Radiation_CEQUALW2 = 2
integer, parameter :: CloudFromSunHours = 1
integer, parameter :: CloudFromRandom = 2
integer, parameter :: CloudFromRadiation = 3
!Types---------------------------------------------------------------------
type T_External
integer, dimension(:,:), pointer :: MappingPoints2D => null()
real, dimension(:,:), pointer :: GridCellArea => null()
real, dimension(:,:), pointer :: Latitude => null()
real, dimension(:,:), pointer :: Longitude => null()
logical :: Backtracking = .false.
end type T_External
type T_OutPut
type (T_Time), pointer, dimension(:) :: OutTime => null()
logical :: True = .false. !initialization: Jauch
integer :: NextHDF5 = null_int !initialization: Jauch
integer :: Number = null_int !initialization: Jauch
end type T_OutPut
type T_Statistics
integer :: ID = null_int, & !initialization: Jauch
IDx = null_int, & !initialization: Jauch
IDy = null_int !initialization: Jauch
character(LEN = Pathlength) :: File = null_str !initialization: Jauch
logical :: ON = .false. !initialization: Jauch
end type T_Statistics
type T_Property
type (T_PropertyID) :: ID
real, dimension(:,:), pointer :: Field => null() !scalar field. (e.g. converted angle to cell ref)
real, dimension(:,:), pointer :: FieldInputRef => null() !original scalar field (orig angle in input ref)
real, dimension(:,:), pointer :: FieldU => null() !vectorial field rotated to grid cells - U comp.
real, dimension(:,:), pointer :: FieldV => null() !vectorial field rotated to grid cells - V comp.
real, dimension(:,:), pointer :: FieldX => null() !vectorial original field - X (zonal component)
real, dimension(:,:), pointer :: FieldY => null() !vectorial original field - Y (meridional comp.)
!real, dimension(:,:), pointer :: FieldGrid => null()
real :: RandomValue = null_real !initialization: Jauch
logical :: HasRandomComponent = .false.
logical :: PropAddedByIrri = .false.
logical :: PropAddedByRain = .false.
logical :: FirstActualization = .true.
real :: RandomComponent = FillValueReal
logical :: UseToPredictDT = .true.
real :: PredictedDT = -null_real
real :: DTForNextEvent = -null_real
logical :: TimeSerie = .false.
logical :: BoxTimeSerie = .false.
logical :: OutputHDF = .false.
logical :: Constant = .false.
logical :: NoInterpolateValueInTime = .false.
logical :: AccumulateValueInTime = .false.
logical :: InterpolateValueInTime = .false.
logical :: UseOriginalValue = .false.
type (T_Statistics) :: Statistics
type (T_Property), pointer :: Next => null()
type (T_Property), pointer :: Prev => null()
end type T_Property
type T_Files
character(len=Pathlength) :: ConstructData = null_str !initialization: Jauch
character(len=Pathlength) :: Results = null_str !initialization: Jauch
end type T_Files
type T_DTLimits
real :: Limit = 0
real :: DT = 0
end type T_DTLimits
type T_Limits_A
logical :: UseLimits = .false.
type(T_DTLimits) :: Light
type(T_DTLimits) :: Medium
type(T_DTLimits) :: Heavy
real :: MaxValue = 0.0
end type T_Limits_A
type T_Atmosphere
integer :: InstanceID = null_int !initialization: Jauch
character(PathLength) :: ModelName = null_str !initialization: Jauch
integer :: ModelType = MOHIDLAND_
type(T_Size2D) :: Size
type(T_Size2D) :: WorkSize
type(T_External) :: ExternalVar
type(T_Files) :: Files
type(T_Property), pointer :: FirstAtmosphereProp => null()
type(T_Property), pointer :: LastAtmosphereProp => null()
type(T_OutPut) :: OutPut
type(T_Time ) :: BeginTime
type(T_Time ) :: EndTime
type(T_Time ) :: ActualTime
type(T_Time ) :: NextCompute
type(T_Time ) :: LastOutPutHDF5
logical :: WindHeightDefined
logical :: AirMeasurementHeightDefined
logical :: PredictDT = .true.
integer :: PredictDTMethod = 1
real :: WindHeight
real :: AirMeasurementHeight
! real :: PredictedDT = -null_real
! real :: DTForNextEvent = -null_real
! real :: IrriPredictedDT = -null_real
! real :: IrriDTForNextEvent = -null_real
! real :: PrecPredictedDT = -null_real
! real :: PrecDTForNextEvent = -null_real
! logical :: UsePrecipitationForDTPred = .false.
! logical :: UseIrrigationForDTPred = .false.
type(T_Limits_A) :: Rain
type(T_Limits_A) :: Irrigation
integer :: RadiationMethod = 1
integer :: CloudCoverMethod = null_int !initialization: Jauch
real :: CloudCoverNight = 0.595
real :: CloudCoverMinDay = 0.3
real, pointer, dimension(:,: ) :: LastRadiation => null()
integer :: LastCalculateRandomCloud = null_int
integer :: PropertiesNumber = FillValueInt
integer :: CurrentIndex = 2
logical :: PropsAddedByRain = .false.
logical :: PropsAddedByIrri = .false.
logical :: CheckPropertyValues = .false. !initialization: Jauch
real :: ConversionFactorPrec = null_real
logical :: PrecReqConv = .false.
integer, dimension(2) :: PrecMaxCoord
real :: ConversionFactorIrri = null_real
logical :: IrriReqConv = .false.
integer, dimension(2) :: IrriMaxCoord
logical :: OverrideWindVelStandard = .false.
!Instance of Module HDF5
integer :: ObjHDF5 = 0
!Instance of Module_EnterData
integer :: ObjEnterData = 0 !Data File - ConstructData
!Instance of ModuleGridData
integer :: ObjGridData = 0
!Instance of ModuleHorizontalGrid
integer :: ObjHorizontalGrid = 0
!Instance of ModuleTime
integer :: ObjTime = 0
!Instance of ModuleBoxDif
integer :: ObjBoxDif = 0
!Instance of ModuleTimeSerie
integer :: ObjTimeSerie = 0
!Collection of instances
type(T_Atmosphere), pointer :: Next => null()
end type T_Atmosphere
!Global Module Variables
type (T_Atmosphere), pointer :: FirstObjAtmosphere => null()
type (T_Atmosphere), pointer :: Me => null()
!--------------------------------------------------------------------------
contains
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!CONSTRUCTOR CONSTRUCTOR CONSTRUCTOR CONSTRUCTOR CONSTRUCTOR CONSTRUCTOR
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
subroutine StartAtmosphere(ModelName, &
ModelType, &
AtmosphereID, &
TimeID, &
GridDataID, &
HorizontalGridID, &
MappingPoints, &
CheckValues, &
STAT)
!Arguments--------------------------------------------------------------
character(Len=*) :: ModelName
integer :: ModelType
integer :: AtmosphereID
integer :: TimeID
integer :: GridDataID
integer :: HorizontalGridID
integer, dimension(:, :), pointer :: MappingPoints
logical, optional :: CheckValues
integer, optional, intent(OUT) :: STAT
!External--------------------------------------------------------------
integer :: STAT_CALL
integer :: ready_
!Local-----------------------------------------------------------------
integer :: STAT_
character(len = StringLength) :: WarningString
!Begin-----------------------------------------------------------------
STAT_ = UNKNOWN_
!Assures nullification of the global variable
if (.not. ModuleIsRegistered(mAtmosphere_)) then
nullify (FirstObjAtmosphere)
call RegisterModule (mAtmosphere_)
endif
call Ready(AtmosphereID, ready_)
cd0 : if (ready_ .EQ. OFF_ERR_) then
!Allocates a new Instance
call AllocateInstance
Me%ModelName = ModelName
Me%ModelType = ModelType
!Associates External Instances
Me%ObjTime = AssociateInstance (mTIME_, TimeID )
Me%ObjGridData = AssociateInstance (mGRIDDATA_, GridDataID )
Me%ObjHorizontalGrid = AssociateInstance (mHORIZONTALGRID_, HorizontalGridID)
Me%ExternalVar%MappingPoints2D => MappingPoints
if (present(CheckValues)) Me%CheckPropertyValues = CheckValues
call ReadLockExternalVar
!Read the name file of the Atmosphere module
call ReadPropertiesFilesName
!Construct enter data
call ConstructEnterData(Me%ObjEnterData, Me%Files%ConstructData, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'StartAtmosphere - ModuleAtmosphere - ERR01'
call ConstructGlobalVariables
if (Me%CloudCoverMethod == CloudFromRadiation) then
allocate( Me%LastRadiation ( Me%WorkSize%ILB:Me%WorkSize%IUB, &
Me%WorkSize%JLB:Me%WorkSize%JUB) )
!Me%LastRadiation = null_real
Me%LastRadiation = 0.
endif
!Constructs the property list
call ConstructPropertyList
if (Me%CheckPropertyValues) then
call CheckPropertyValues (Constructing = .true.)
endif
call ConstructTimeSerie
call ConstructOutput
call KillEnterData(Me%ObjEnterData, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'StartAtmosphere - ModuleAtmosphere - ERR02'
! By default a output file is always open in the construction phase
if (Me%OutPut%True) call OpenHDF5OutPutFile
WarningString = 'Construct'
call ModifyOutPut(WarningString)
call null_time(Me%ActualTime)
nullify(Me%ExternalVar%MappingPoints2D)
call ReadUnlockExternalVar
!Returns ID
AtmosphereID = Me%InstanceID
STAT_ = SUCCESS_
else cd0
stop 'StartAtmosphere - ModuleAtmosphere - ERR03'
end if cd0
if (present(STAT)) STAT = STAT_
end subroutine StartAtmosphere
!--------------------------------------------------------------------------
subroutine AllocateInstance
!Local-----------------------------------------------------------------
type (T_Atmosphere), pointer :: NewAtmosphere => null()
type (T_Atmosphere), pointer :: PreviousAtmosphere => null()
!Allocates new instance
allocate (NewAtmosphere)
nullify (NewAtmosphere%Next)
!Insert New Instance into list and makes Current point to it
if (.not. associated(FirstObjAtmosphere)) then
FirstObjAtmosphere => NewAtmosphere
Me => NewAtmosphere
else
PreviousAtmosphere => FirstObjAtmosphere
Me => FirstObjAtmosphere%Next
do while (associated(Me))
PreviousAtmosphere => Me
Me => Me%Next
enddo
Me => NewAtmosphere
PreviousAtmosphere%Next => NewAtmosphere
endif
Me%InstanceID = RegisterNewInstance (mATMOSPHERE_)
end subroutine AllocateInstance
!--------------------------------------------------------------------------
subroutine ConstructGlobalVariables
!External--------------------------------------------------------------
integer :: STAT_CALL, iflag, defValue
real, dimension(6) :: limits
!Begin------------------------------------------------------------------
call GetComputeTimeLimits(Me%ObjTime, BeginTime = Me%BeginTime, &
EndTime = Me%EndTime, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR10'
!Actualize the time
Me%ActualTime = Me%BeginTime
Me%NextCompute = Me%ActualTime
! Check if the simulation goes backward in time or forward in time (default mode)
call GetBackTracking(Me%ObjTime, Me%ExternalVar%BackTracking, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) &
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR20'
! Sets the last output equal to zero
call SetDate(Me%LastOutPutHDF5, 0, 0, 0, 0, 0, 0)
call GetHorizontalGridSize(Me%ObjHorizontalGrid, Size = Me%Size, &
WorkSize = Me%WorkSize, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR30'
call GetData (Me%WindHeight, &
Me%ObjEnterData, iflag, &
Keyword = 'WIND_MEASUREMENT_HEIGHT', &
!Default = 10m, &
SearchType = FromFile, &
ClientModule = 'ModuleAtmosphere', &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) &
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR40'
if (iflag /= 0) then
Me%WindHeightDefined = .true.
else
Me%WindHeightDefined = .false.
endif
call GetData (Me%AirMeasurementHeight, &
Me%ObjEnterData, iflag, &
Keyword = 'AIR_MEASUREMENT_HEIGHT', &
!Default = 10m, &
SearchType = FromFile, &
ClientModule = 'ModuleAtmosphere', &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) &
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR45'
if (iflag /= 0) then
Me%AirMeasurementHeightDefined = .true.
else
Me%AirMeasurementHeightDefined = .false.
endif
call GetData(Me%RadiationMethod, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'RADIATION_METHOD', &
ClientModule = 'ModuleAtmosphere', &
Default = Radiation_Mohid, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR40'
!Do not use random number as default method to compute cloud cover
!the method from radiation does a ratio between TOA radiation and given solar radiation
!nowadays solar radiation data is something that both land and water models have and there is no
!justification for using random numbers! David June 2015
call GetData(Me%CloudCoverMethod, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'CLOUD_COVER_METHOD', &
ClientModule = 'ModuleAtmosphere', &
!Default = CloudFromRandom, &
Default = CloudFromRadiation, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR50'
!if keyword not found and model will compute warn user that the default method has changed
!done in ContructPropertyValues
!Do not allow cloud cover from random
if (Me%CloudCoverMethod == CloudFromRandom) then
write (*,*) ''
write (*,*) 'CLOUD_COVER_METHOD : 2 (from random numbers), in atmosphere data file'
write (*,*) 'was abandoned. The default method now is CLOUD_COVER_METHOD : 3.'
write (*,*) 'Please use CLOUD_COVER_METHOD : 3 (from radiation)'
write (*,*) ' or CLOUD_COVER_METHOD : 1 (from sun hours)'
write (*,*) ' or use a constant value or solution from file.'
write (*,*) ''
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR50.1'
endif
if (Me%CloudCoverMethod == CloudFromRadiation) then
!Cloud cover value for night (radiation is zero).
!0.595 is from FAO Irrigation and Drainage Paper Report 56
call GetData(Me%CloudCoverNight, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'CLOUD_COVER_NIGHT', &
ClientModule = 'ModuleAtmosphere', &
Default = 0.595, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR51'
!Minimum cloud cover value for during day (to avoid sunrise and sunset very low values)
!0.3 is from FAO Irrigation and Drainage Paper Report 56
call GetData(Me%CloudCoverMinDay, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'CLOUD_COVER_MIN_DAY', &
ClientModule = 'ModuleAtmosphere', &
Default = 0.3, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR52'
endif
call GetData(Me%PredictDT, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'PREDICT_DT', &
ClientModule = 'ModuleAtmosphere', &
Default = .true., &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR60'
!This can not be a string that is set by the user.
!In operational models this value is not 'MOHID Land Model'
!so that the timeseries are saved with a correct model name
!This was changed to a integer that is not changed by the user
!if (trim(Me%ModelName) == 'MOHID Land Model') then
if (Me%ModelType == MOHIDLAND_) then
defValue = 2
else
defValue = 1
endif
call GetData(Me%PredictDTMethod, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'PREDICT_DT_METHOD', &
ClientModule = 'ModuleAtmosphere', &
Default = defValue, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR60'
write (*,*) ''
write (*,*) 'Atmosphere DT Prediction Method: ', Me%PredictDTMethod
write (*,*) ''
call GetData(limits, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'RAIN_LIMITS', &
ClientModule = 'ModuleAtmosphere', &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR70'
if (iflag <= 0) then
Me%Rain%UseLimits = .false.
elseif (iflag < 6) then
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR71'
else
Me%Rain%UseLimits = .true.
Me%Rain%Light%Limit = limits(1)
Me%Rain%Light%DT = limits(2)
Me%Rain%Medium%Limit = limits(3)
Me%Rain%Medium%DT = limits(4)
Me%Rain%Heavy%Limit = limits(5)
Me%Rain%Heavy%DT = limits(6)
endif
call GetData(limits, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'IRRI_LIMITS', &
ClientModule = 'ModuleAtmosphere', &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR80'
if (iflag <= 0) then
Me%Irrigation%UseLimits = .false.
elseif (iflag < 6) then
stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR81'
else
Me%Irrigation%UseLimits = .true.
Me%Irrigation%Light%Limit = limits(1)
Me%Irrigation%Light%DT = limits(2)
Me%Irrigation%Medium%Limit = limits(3)
Me%Irrigation%Medium%DT = limits(4)
Me%Irrigation%Heavy%Limit = limits(5)
Me%Irrigation%Heavy%DT = limits(6)
endif
call GetData(Me%OverrideWindVelStandard, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'OVERRIDE_WIND_VEL_STANDARD', &
ClientModule = 'ModuleAtmosphere', &
Default = .false., &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructGlobalVariables - ModuleAtmosphere - ERR100'
end subroutine ConstructGlobalVariables
!--------------------------------------------------------------------------
!Read the name of the files need to construct and modify
! the Atmosphere properties
subroutine ReadPropertiesFilesName
!External--------------------------------------------------------------
character(len = StringLength) :: Message
integer :: STAT_CALL
!Begin------------------------------------------------------------------
!Opens the Atmosphere data file
! ASCII file used to construct new properties
Message ='Atmosphere Data Properties.'
Message = trim(Message)
call ReadFileName('SURF_DAT', Me%Files%ConstructData, Message = Message, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ReadPropertiesFilesName - ModuleAtmosphere - ERR01'
! ---> File in HDF format where is written instant fields of Atmosphere properties
Message ='Instant fields of Atmosphere properties in HDF format.'
Message = trim(Message)
call ReadFileName('SURF_HDF', Me%Files%Results, Message = Message, &
TIME_END = Me%EndTime, Extension = 'sur', &
MPI_ID = GetDDecompMPI_ID(Me%ObjHorizontalGrid),&
DD_ON = GetDDecompON (Me%ObjHorizontalGrid),&
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ReadPropertiesFilesName - ModuleAtmosphere - ERR02'
end subroutine ReadPropertiesFilesName
!--------------------------------------------------------------------------
subroutine OpenHDF5OutPutFile
!Local-----------------------------------------------------------------
real, pointer, dimension(:, :) :: GridData
integer :: STAT_CALL
integer :: WorkILB, WorkIUB
integer :: WorkJLB, WorkJUB
integer :: HDF5_CREATE
!----------------------------------------------------------------------
!Bounds
WorkILB = Me%WorkSize%ILB
WorkIUB = Me%WorkSize%IUB
WorkJLB = Me%WorkSize%JLB
WorkJUB = Me%WorkSize%JUB
!Gets File Access Code
call GetHDF5FileAccess (HDF5_CREATE = HDF5_CREATE)
!Opens HDF File
call ConstructHDF5 (Me%ObjHDF5, trim(Me%Files%Results)//"5", &
HDF5_CREATE, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR01'
!Write the Horizontal Grid
call WriteHorizontalGrid(Me%ObjHorizontalGrid, Me%ObjHDF5, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR02'
!Gets a pointer to GridData
call GetGridData (Me%ObjGridData, GridData, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR03'
!Sets limits for next write operations
call HDF5SetLimits (Me%ObjHDF5, WorkILB, WorkIUB, WorkJLB, &
WorkJUB, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR05'
!Writes the GridData
call HDF5WriteData (Me%ObjHDF5, "/Grid", "Bathymetry", "m", &
Array2D = GridData, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR06'
!Writes the WaterPoints
call HDF5WriteData (Me%ObjHDF5, "/Grid", "MappingPoints2D", "-", &
Array2D = Me%ExternalVar%MappingPoints2D, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR07'
!Writes everything to disk
call HDF5FlushMemory (Me%ObjHDF5, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR08'
!Ungets the GridData
call UngetGridData (Me%ObjGridData, GridData, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'Open_HDF5_OutPut_File - ModuleAtmosphere - ERR09'
end subroutine OpenHDF5OutPutFile
!--------------------------------------------------------------------------
subroutine ConstructTimeSerie
!External--------------------------------------------------------------
integer :: iflag, STAT_CALL
!Local-----------------------------------------------------------------
real :: CoordX, CoordY
logical :: CoordON, IgnoreOK
integer :: dn, Id, Jd, TimeSerieNumber
type(T_Property), pointer :: PropertyX
integer :: nProperties
character(len=PathLength) :: TimeSerieLocationFile
character(len=StringLength) :: TimeSerieName
character(len=StringLength), dimension(:), pointer :: PropertyList
type (T_Polygon), pointer :: ModelDomainLimit
character(len=StringLength) :: PropertyNameX, PropertyNameY
!Begin-----------------------------------------------------------------
!First checks out how many properties will have time series
PropertyX => Me%FirstAtmosphereProp
nProperties = 0
do while (associated(PropertyX))
if (PropertyX%TimeSerie) then
!vectorial property - need to get data in user referential - X and Y
!~ if (Check_Vectorial_Property(PropertyX%ID%IDNumber)) then
if (PropertyX%ID%IsVectorial) then
nProperties = nProperties + 2
else
nProperties = nProperties + 1
endif
endif
PropertyX=>PropertyX%Next
enddo
if (nProperties > 0) then
!Allocates PropertyList
allocate(PropertyList(nProperties), STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR10'
!Fills up PropertyList
PropertyX => Me%FirstAtmosphereProp
nProperties = 0
do while (associated(PropertyX))
if (PropertyX%TimeSerie) then
nProperties = nProperties + 1
!vectorial property - need to get data in user referential - X and Y
!~ if (Check_Vectorial_Property(PropertyX%ID%IDNumber)) then
if (PropertyX%ID%IsVectorial) then
!get the correct names of the properties
call Get_Vectorial_PropertyNames(PropertyX%ID%IDNumber, PropertyNameX, PropertyNameY)
PropertyList(nProperties) = trim(adjustl(PropertyNameX))
nProperties = nProperties + 1
PropertyList(nProperties) = trim(adjustl(PropertyNameY))
else
PropertyList(nProperties) = trim(adjustl(PropertyX%ID%name))
endif
endif
PropertyX=>PropertyX%Next
enddo
call GetData(TimeSerieLocationFile, &
Me%ObjEnterData, iflag, &
SearchType = FromFile, &
keyword = 'TIME_SERIE_LOCATION', &
ClientModule = 'ModuleWaterProperties', &
Default = Me%Files%ConstructData, &
STAT = STAT_CALL)
if (STAT_CALL .NE. SUCCESS_) &
stop 'Construct_Time_Serie - ModuleAtmosphere - ERR20'
call GetGridOutBorderPolygon(HorizontalGridID = Me%ObjHorizontalGrid, &
Polygon = ModelDomainLimit, &
STAT = STAT_CALL)
if (STAT_CALL .NE. SUCCESS_) &
stop 'Construct_Time_Serie - ModuleAtmosphere - ERR25'
!Constructs TimeSerie
call StartTimeSerie(Me%ObjTimeSerie, Me%ObjTime, &
trim(TimeSerieLocationFile), &
PropertyList, "srs", &
WaterPoints2D = Me%ExternalVar%MappingPoints2D, &
ModelName = Me%ModelName, &
ModelDomain = ModelDomainLimit, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR30'
call UngetHorizontalGrid(HorizontalGridID = Me%ObjHorizontalGrid, &
Polygon = ModelDomainLimit, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR35'
!Deallocates PropertyList
deallocate(PropertyList, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR40'
!Corrects if necessary the cell of the time serie based in the time serie coordinates
call GetNumberOfTimeSeries(Me%ObjTimeSerie, TimeSerieNumber, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR50'
do dn = 1, TimeSerieNumber
call TryIgnoreTimeSerie(Me%ObjTimeSerie, dn, IgnoreOK, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR60'
if (IgnoreOK) cycle
call GetTimeSerieLocation(Me%ObjTimeSerie, dn, &
CoordX = CoordX, &
CoordY = CoordY, &
CoordON = CoordON, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR70'
call GetTimeSerieName(Me%ObjTimeSerie, dn, TimeSerieName, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR80'
if (CoordON) then
call GetXYCellZ(Me%ObjHorizontalGrid, CoordX, CoordY, Id, Jd, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_ .and. STAT_CALL /= OUT_OF_BOUNDS_ERR_) then
stop 'CConstructTimeSerie - ModuleAtmosphere - ERR90'
endif
! if (STAT_CALL == OUT_OF_BOUNDS_ERR_ .or. Id < 0 .or. Jd < 0) then
! call TryIgnoreTimeSerie(Me%ObjTimeSerie, dn, IgnoreOK, STAT = STAT_CALL)
! if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR100'
! if (IgnoreOK) then
! cycle
! else
! stop 'ConstructTimeSerie - ModuleAtmosphere - ERR80'
! endif
!endif
call CorrectsCellsTimeSerie(Me%ObjTimeSerie, dn, Id, Jd, STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR110'
endif
call GetTimeSerieLocation(Me%ObjTimeSerie, dn, &
LocalizationI = Id, &
LocalizationJ = Jd, &
STAT = STAT_CALL)
if (STAT_CALL /= SUCCESS_) stop 'ConstructTimeSerie - ModuleAtmosphere - ERR120'
if (Me%ExternalVar%MappingPoints2D(Id, Jd) /= WaterPoint) then
write(*,*) 'Time Serie in a land cell - ',trim(TimeSerieName),' - ',trim(Me%ModelName)
endif
enddo
endif
end subroutine ConstructTimeSerie
!--------------------------------------------------------------------------
subroutine ConstructPropertyList
!Local-----------------------------------------------------------------
type (T_Property), pointer :: NewProperty => null()
type (T_Property), pointer :: PropertyX => null()
type (T_Property), pointer :: PropertyY => null()
integer :: ClientNumber
integer :: i, j, STAT_CALL
logical :: BlockFound
integer :: dummy, iflag
!----------------------------------------------------------------------
! Initialize the Atmosphere properties number
Me%PropertiesNumber = 0
! Initialize the Atmosphere properties list