-
Notifications
You must be signed in to change notification settings - Fork 0
/
builder_database.f90
3870 lines (3538 loc) · 237 KB
/
builder_database.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
!------------------------------------------------------------------------------
! o MODULE d_parser_parameters
! o MODULE d_mod_queue
! o MODULE d_input_data_types
! o MODULE d_input_spec_node_def
! o MODULE d_input_specifier_queue_def
! o MODULE d_input_key_node_def
! o MODULE d_input_key_queue_def
! o MODULE d_mod_init_input_key_queue
! o MODULE d_mod_add_input_key
! o MODULE d_position_at_key_interface
! o MODULE d_scan_inp_key_interface
! o MODULE d_add_inp_spec_interface
! o MODULE d_input_built_up_interface
! o MODULE d_mod_value_to_queue
! o MODULE d_common_queues
! o MODULE d_common_nodes
! o MODULE d_mod_check_presence
! o MODULE d_mod_read_and_analyze_input
! o MODULE generic_database
!
! Modules not present in FortranInputParser/builder_database.f90:
! o MODULE mod_SpecialStrings
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
MODULE d_parser_parameters
!------------------------------------------------------------------------------
USE mod_FileExtensions_parser,ONLY:ValidatorC, &
InputC
IMPLICIT NONE
!------------------------------------------------------------------------------
! Note: It seems that using 'Data_len = 987' for everything substantially
! increases the CPU time necessary for reading in material database.
! Thus we still use '267' for most character variables.
!------------------------------------------------------------------------------
! INTEGER,PARAMETER :: Data_len = 987 ! NOT RECOMMENDED, significant increase in CPU time consumption for the large material database file
INTEGER,PARAMETER :: Data_len = 267 ! Maximum line length in input file (267 - SUN, arbitrary - DEC)
! INTEGER,PARAMETER :: Data_len = 120 ! a little bit faster ! Maximum line length in input file (267 - SUN, arbitrary - DEC)
INTEGER,PARAMETER :: Data_len_long = 987 ! Maximum line length in input file
! INTEGER,PARAMETER :: Data_len_very_long = 2987 ! Maximum line length in input file
INTEGER,PARAMETER :: char_length_specifier_content = 80 ! A specifier content can contain up to 267 characters.
CHARACTER(len=*),PARAMETER :: SpecialMacroCharacterC = '%' ! special character used in macro definition
CHARACTER(len=*),PARAMETER :: key_char = '$' ! Character which specifies beginning of keyword (can be chosen)
CHARACTER(len=*),PARAMETER :: end_key_char = ' ' ! Character which specifies end of keyword (must be a blank)
CHARACTER(len=*),PARAMETER :: spec_char = ' ' ! Character which separates a specifier (must be a blank)
CHARACTER(len=*),PARAMETER :: end_spec_char = '=' ! Character which specifies end of specifier (can be chosen)
CHARACTER(len=*),DIMENSION(4),PARAMETER :: comment_signsCV = [ '! ' , '# ' , &
'//' , '/*' ] ! Comment signs. Comment sign and text towards right is ignored.
! CHARACTER(len=*),DIMENSION(4),PARAMETER :: XML_tagCV = [ '< ' , '</' , &
! '> ' , '/>' ] ! XML tags
CHARACTER(len=*) ,PARAMETER :: TEXT_String_BeginC = '!TEXT' ! special string for multiline comment (case sensitive)
CHARACTER(len=*) ,PARAMETER :: TEXT_String_EndC = '!ENDTEXT' ! special string for multiline comment (case sensitive)
! Define 'database_nn3_keywords.val'
! Define 'database_nn3.in'
CHARACTER(len=*),PARAMETER :: keyword_filetypeC = 'database_nn3' ! This is how we call these type of files that we want to parse.
CHARACTER(len=*),PARAMETER :: keyword_filetype_nnpC = 'database_nnp' ! This is how we call these type of files that we want to parse.
CHARACTER(len=*),PARAMETER :: keyword_filenameC = TRIM(keyword_filetypeC)//'_keywords'//ValidatorC ! name of file, containing definitions of keywords and specifiers without file extension
! CHARACTER(len=*),PARAMETER :: MaterialDatabaseFileNameC = TRIM(keyword_filetypeC)//InputC ! default name for material database: database_nn3.in
!------------------------------------------------------------------------------
END MODULE d_parser_parameters
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE mod_SpecialStrings
!------------------------------------------------------------------------------
!
!++m* builder_database.f90/mod_SpecialStrings
!
! NAME
! MODULE mod_SpecialStrings
!
! PURPOSE
! MODULE to treat special strings, e.g. '!TEXT'/'!ENDTEXT'.
!
! CONTAINS
! o SUBROUTINE Multiline_Comment
! o SUBROUTINE Extract_DATA
!
! FILENAME
! FortranInputParser/builder_database.f90
!
!##
!
!------------------------------------------------------------------------------
IMPLICIT NONE
PRIVATE
PUBLIC Multiline_Comment
PUBLIC Extract_DATA
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE Multiline_Comment(String_beginC,String_endC, bufferC , Multiline_Comment_OnL )
!------------------------------------------------------------------------------
!
!++s* mod_SpecialStrings/Multiline_Comment
!
! NAME
! SUBROUTINE Multiline_Comment
!
! PURPOSE
! Checks for multiline comment, and if found, replaces the comment with blanks.
!
! Example:
! !TEXT
! This is a multi-
! line comment.
! !ENDTEXT
!
! USAGE
! CALL Multiline_Comment(String_beginC,String_endC, bufferC , Multiline_Comment_OnL )
!
! INPUT
! o String_beginC: '!TEXT'
! o String_endC: '!ENDTEXT'
! o bufferC: (also output) string of line
! o Multiline_Comment_OnL: (also output) .TRUE. if '!TEXT' had had been found before call of subroutine in previous lines, else .FALSE.
!
! OUTPUT
! o bufferC: (also input) string of line, will be erased if line should be treated as comment
! o Multiline_Comment_OnL: (also input) .TRUE. if '!TEXT' had been found in beginning of string 'bufferC', or if it had been found before call of subroutine.
! It will be set from .TRUE. to .FALSE. if '!ENDTEXT' had been found in beginning of string 'bufferC'.
!
! NOTES
! '!TEXT' is case-sensitive, so '!Text' will not work (to avoid errors when e.g. the substring "!Text is written..." is part of a string).
!
!##
!
!------------------------------------------------------------------------------
!USE String_Utility ,ONLY:StringUpperCase
IMPLICIT NONE
CHARACTER(len=*),INTENT(in) :: String_beginC
CHARACTER(len=*),INTENT(in) :: String_endC
CHARACTER(len=*),INTENT(inout) :: bufferC
LOGICAL ,INTENT(inout) :: Multiline_Comment_OnL
INTEGER :: length_of_string_begin
INTEGER :: length_of_string_end
CHARACTER(len=:),ALLOCATABLE :: buffer_adjust_leftC
LOGICAL :: TreatLineAsCommentL
TreatLineAsCommentL = .FALSE.
buffer_adjust_leftC = ADJUSTL(bufferC) ! Remove leading blanks.
IF ( Multiline_Comment_OnL ) THEN
!----------------------------------------------------------------------------
! '!TEXT' has already been found before call of this soubroutine,
! therefore treat line as comment and search for end string '!ENDTEXT'.
!----------------------------------------------------------------------------
TreatLineAsCommentL = .TRUE.
length_of_string_end = LEN(String_endC) ! Determine length of special string '!ENDTEXT'.
IF ( LEN(buffer_adjust_leftC) >= length_of_string_end ) THEN ! Minimum length is required so that next line does not break.
!------------------------------------------------------
! Check if '!ENDTEXT' is at the beginning of the line.
!------------------------------------------------------
! IF ( StringUpperCase( buffer_adjust_leftC(1:length_of_string_end) ) == String_endC ) THEN ! Check if special string is first word in line.
IF ( buffer_adjust_leftC(1:length_of_string_end) == String_endC ) THEN ! Check if special string is first word in line. [CASE SENSITIVE] to avoid errors such as "!Text will be added later"
Multiline_Comment_OnL = .FALSE. ! special string was found as the first word in the line, therefore reset logical value that indicates begin of multiline comment.
END IF
END IF
ELSE
length_of_string_begin = LEN(String_beginC) ! Determine length of special string '!TEXT'.
IF ( LEN(buffer_adjust_leftC) >= length_of_string_begin ) THEN ! Minimum length is required so that next line does not break.
!------------------------------------------------------
! Check if '!TEXT' is at the beginning of the line.
!------------------------------------------------------
! IF ( StringUpperCase( buffer_adjust_leftC(1:length_of_string_begin) ) == String_beginC ) THEN ! Check if special string is first word in line.
IF ( buffer_adjust_leftC(1:length_of_string_begin) == String_beginC ) THEN ! Check if special string is first word in line. [CASE SENSITIVE] to avoid errors such as "!Text will be added later"
Multiline_Comment_OnL = .TRUE. ! special string was found as the first word in the line
TreatLineAsCommentL = .TRUE.
END IF
END IF
END IF
IF ( TreatLineAsCommentL ) THEN
bufferC = '' ! Erase line as it is treated as comment.
END IF
!------------------------------------------------------------------------------
END SUBROUTINE Multiline_Comment
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
SUBROUTINE Extract_DATA(String_beginC,String_endC, bufferC , Data_Comment_OnL )
!------------------------------------------------------------------------------
!
!++s* mod_SpecialStrings/Extract_DATA
!
! NAME
! SUBROUTINE Extract_DATA
!
! PURPOSE
! Checks for '!DATA' and '!ENDDATA' comment, and if found, replaces this specific line with blanks.
! Everything after '!DATA' is treated as DATA and is not deleted here.
!
! Example:
! !DATA
! Some data goes here.
! !ENDDATA (This line is optional. If not present, everything until end of file is considered to be DATA.)
!
! USAGE
! CALL Extract_DATA(String_beginC,String_endC, bufferC , Data_Comment_OnL )
!
! INPUT
! o String_beginC: '!DATA'
! o String_endC: '!ENDDATA'
! o bufferC: (also output) string of line
! o Data_Comment_OnL: (also output) .TRUE. if '!DATA' had had been found before call of subroutine in previous lines, else .FALSE.
!
! OUTPUT
! o bufferC: (also input) string of line, will be erased if line starts with '!DATA' or '!ENDDATA'
! o Data_Comment_OnL: (also input) .TRUE. if '!DATA' had been found in beginning of string 'bufferC', or if it had been found before call of subroutine.
! It will be set from .TRUE. to .FALSE. if '!ENDDATA' had been found in beginning of string 'bufferC'.
!
! NOTES
! '!DATA' is case-sensitive, so '!data' will not work (to avoid errors when e.g. the substring "!data-out-every-nth-step = 1" is part of a string).
!
!##
!
!------------------------------------------------------------------------------
!USE String_Utility ,ONLY:StringUpperCase
IMPLICIT NONE
CHARACTER(len=*),INTENT(in) :: String_beginC
CHARACTER(len=*),INTENT(in) :: String_endC
CHARACTER(len=*),INTENT(inout) :: bufferC
LOGICAL ,INTENT(inout) :: Data_Comment_OnL
INTEGER :: length_of_string_begin
INTEGER :: length_of_string_end
CHARACTER(len=:),ALLOCATABLE :: buffer_adjust_leftC
LOGICAL :: TreatLineAsCommentL
TreatLineAsCommentL = .FALSE.
buffer_adjust_leftC = ADJUSTL(bufferC) ! Remove leading blanks.
IF ( Data_Comment_OnL ) THEN
!----------------------------------------------------------------------------
! '!DATA' has already been found before call of this soubroutine,
! therefore treat line as DATA and search for end string '!ENDDATA'.
!----------------------------------------------------------------------------
length_of_string_end = LEN(String_endC) ! Determine length of special string '!ENDDATA'.
IF ( LEN(buffer_adjust_leftC) >= length_of_string_end ) THEN ! Minimum length is required so that next line does not break.
!------------------------------------------------------
! Check if '!ENDDATA' is at the beginning of the line.
!------------------------------------------------------
! IF ( StringUpperCase( buffer_adjust_leftC(1:length_of_string_end) ) == String_endC ) THEN ! Check if special string '!ENDDATA' is first word in line.
IF ( buffer_adjust_leftC(1:length_of_string_end) == String_endC ) THEN ! Check if special string '!ENDDATA' is first word in line. [CASE SENSITIVE] to avoid errors such as "!data-out-every-nth-step"
Data_Comment_OnL = .FALSE. ! special string '!ENDDATA' was found as the first word in the line
TreatLineAsCommentL = .TRUE.
END IF
END IF
ELSE
length_of_string_begin = LEN(String_beginC) ! Determine length of special string '!DATA'.
IF ( LEN(buffer_adjust_leftC) >= length_of_string_begin ) THEN ! Minimum length is required so that next line does not break.
!------------------------------------------------------
! Check if '!DATA' is at the beginning of the line.
!------------------------------------------------------
! IF ( StringUpperCase( buffer_adjust_leftC(1:length_of_string_begin) ) == String_beginC ) THEN ! Check if special string '!DATA' is first word in line.
IF ( buffer_adjust_leftC(1:length_of_string_begin) == String_beginC ) THEN ! Check if special string '!DATA' is first word in line. [CASE SENSITIVE] to avoid errors such as "!data-out-every-nth-step"
Data_Comment_OnL = .TRUE. ! special string '!DATA' was found as the first word in the line
TreatLineAsCommentL = .TRUE.
END IF
END IF
END IF
IF ( TreatLineAsCommentL ) THEN
bufferC = '' ! Erase line as it is treated as comment.
END IF
!------------------------------------------------------------------------------
END SUBROUTINE Extract_DATA
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE mod_SpecialStrings
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_mod_queue
!------------------------------------------------------------------------------
!
!++m* builder_inputfile.f90/mod_queue
!
! NAME
! MODULE mod_queue
!
! PURPOSE
! MODULE to build up the queue of the input file.
!
! CONTAINS
! o SUBROUTINE queue_built_up
!
! FILENAME
! FortranInputParser/builder_inputfile.f90
!
!##
!
!------------------------------------------------------------------------------
IMPLICIT NONE
PRIVATE
PUBLIC d_queue_built_up
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_queue_built_up(input_filename_C, queue_1)
!------------------------------------------------------------------------------
!
!++s* mod_queue/queue_built_up
!
! NAME
! SUBROUTINE queue_built_up
!
! PURPOSE
! Builds up the queue of the input file.
!
! USAGE
! CALL queue_built_up(input_filename_C, queue_1)
!
! INPUT
! o input_filename_C:
!
! OUTPUT
! o queue_1:
!
!##
!
!------------------------------------------------------------------------------
USE My_Input_and_Output_Units,ONLY:my_output_unit
USE system_specific_parser ,ONLY:DebugLevel
USE d_parser_parameters ,ONLY:comment_signsCV , &
TEXT_String_BeginC , &
TEXT_String_EndC
USE mod_SpecialStrings ,ONLY:Multiline_Comment
USE queue_type_def ,ONLY:queue_type
USE mod_init_queue ,ONLY:init_queue
USE mod_push ,ONLY:push
USE CharacterManipulation ,ONLY:ReplaceTAB , &
Replace_NonBreakingSpace, &
ReplaceXMLTag
USE mod_Array_of_Strings ,ONLY:String_in_Line
USE DirectoryFileExist ,ONLY:CountLinesInFile, &
ReadFileAndStoreLines
IMPLICIT NONE
CHARACTER(len=*),INTENT(in) :: input_filename_C
TYPE(queue_type),INTENT(out) :: queue_1
CHARACTER(len=:),ALLOCATABLE :: bufferC
TYPE(String_in_Line),DIMENSION(:),ALLOCATABLE :: StringsV
LOGICAL :: Multiline_Comment_OnL ! .TRUE. if special string '!TEXT' was found
INTEGER :: NumberOfLines
INTEGER :: line_number
Multiline_Comment_OnL = .FALSE.
!----------------------------------------------------------
! Disassociate pointer 'queue_1' to top and rear of queue.
!----------------------------------------------------------
CALL init_queue (queue_1) ! create a new queue
!--------------------------------------------------------------------
! 'queue_1%top' and 'queue_1%rear' are now nullified.
!--------------------------------------------------------------------
!----------------------------------------------
! Get number of lines that this file contains.
!----------------------------------------------
CALL CountLinesInFile(input_filename_C, NumberOfLines)
IF (DebugLeveL > 10) WRITE(my_output_unit,*) "NumberOfLines = ",NumberOfLines
!---------------------------------------------------------------------------------
! Allocate storage so that each line of the input file can be stored as a string.
!---------------------------------------------------------------------------------
ALLOCATE(StringsV( NumberOfLines ))
!--------------------------------
! Read file and store the lines.
!--------------------------------
CALL ReadFileAndStoreLines(input_filename_C, StringsV)
!---------------
! Replace tabs.
!---------------
DO line_number=1,NumberOfLines
!--------------------------------------------------------------------
! Check if line contains a TAB.
! If yes, replace it with one blank.
! There are two reasons for this. If tabs are not replaced,
! (1) the ApplyMacro feature is not working properly,
! e.g. if a variable name is followed by a tab or
! if a tab is in front of a variable definition.
! In this case a strange error is produced.
! (2) the nextnano3 input parser produces
! a strange error and stops.
!--------------------------------------------------------------------
!-------------------------------------------------------------------------------------
! CHECK:
! The routine ReplaceTAB takes a long time for a large material database file.
! Thus we set it into comments currently.
! Comment S. Birner: I am actually not sure if this routine takes a long time.
! It seems that it is pretty fast.
! So we better use this feature to make life easier for the users.
!-------------------------------------------------------------------------------------
CALL ReplaceTAB( StringsV(line_number)%StringC )
CALL Replace_NonBreakingSpace( StringsV(line_number)%StringC )
!-----------------------------------------------------------------------------------------
! XML tags <...> can be present. They are ignored and replaced with blanks.
!-----------------------------------------------------------------------------------------
CALL ReplaceXMLTag( StringsV(line_number)%StringC )
END DO
DO line_number=1,NumberOfLines
bufferC = StringsV(line_number)%StringC
!----------------------------------------------------
! Allow for multiline comments.
!
! !TEXT
! This is a multi-
! line comment.
! !ENDTEXT
!
! If multiline comment, then bufferC will be erased.
!----------------------------------------------------
CALL Multiline_Comment( TEXT_String_BeginC, &
TEXT_String_EndC , &
bufferC , Multiline_Comment_OnL )
!---------------------------------------------------
! 'bufferC' is input and output to this subroutine.
!---------------------------------------------------
CALL push(queue_1,bufferC,line_number,comment_signsCV) ! push node onto top of queue_1
END DO
DEALLOCATE(StringsV)
!-------------------------------------------------------------------
! Reading in the database is usually very fast so far.
! However, everything that comes afterwards is more time-consuming.
!-------------------------------------------------------------------
IF (DebugLeveL > 4) WRITE(my_output_unit,*) "Reading in database: done"
!------------------------------------------------------------------------------
END SUBROUTINE d_queue_built_up
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE d_mod_queue
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_input_data_types
!------------------------------------------------------------------------------
USE d_parser_parameters,ONLY:char_length_specifier_content
IMPLICIT NONE
REAL(4) :: xs_t !
REAL(8) :: xd_t !
INTEGER :: in_t !
LOGICAL :: lo_t !
!CHARACTER(Data_len/3) :: ca_t !
!CHARACTER(Data_len) :: ca_t ! to allow for long strings, e.g. long directory names
! Notes: For database: If character string is long, e.g. 267 characters, then the reading of the database takes longer.
CHARACTER(char_length_specifier_content) :: ca_t ! to allow for long strings, e.g. long directory names
!CHARACTER(len=:),ALLOCATABLE :: ca_t ! to allow for long strings, e.g. long directory names <= does not work
!------------------------------------------------------------------------------
END MODULE d_input_data_types
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_input_spec_node_def ! define derived data type for one node in queue of specifiers
!------------------------------------------------------------------------------
USE input_type_names ,ONLY:char_length_type_name, &
char_length_specifier_name
USE d_parser_parameters, ONLY: char_length_specifier_content
USE array_type_specifiers ,ONLY:in_array_node, &
xs_array_node, &
xd_array_node, &
in_array_queue, &
xs_array_queue, &
xd_array_queue
IMPLICIT NONE
TYPE :: input_specifier !
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spxs ! specifier names for real numbers
CHARACTER(char_length_type_name),DIMENSION(:),POINTER :: tyxs ! type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opxs ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prxs ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lixs ! value in line number of input file
REAL(4) ,DIMENSION(:),POINTER :: xs ! array for real numbers (values for specifiers)
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spxd ! specifier names for real double precision numbers
CHARACTER(char_length_type_name),DIMENSION(:),POINTER :: tyxd ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opxd ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prxd ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lixd ! value in line number of input file
REAL(8) ,DIMENSION(:),POINTER :: xd ! array for double precision real numbers
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spin ! specifier names for integer numbers
CHARACTER(char_length_type_name),DIMENSION(:),POINTER :: tyin ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opin ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prin ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: liin ! value in line number of input file
INTEGER ,DIMENSION(:),POINTER :: in ! array for integer numbers
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: spca ! specifier names for character string valued input
CHARACTER(char_length_type_name),DIMENSION(:),POINTER :: tyca ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: opca ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prcaL ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lica ! value in line number of input file
CHARACTER(char_length_specifier_content),DIMENSION(:),POINTER :: ca ! array for character string valued input ! to allow for long strings, e.g. long directory names
!
CHARACTER(char_length_specifier_name),DIMENSION(:),POINTER :: splo ! specifier names for logical valued input
CHARACTER(char_length_type_name),DIMENSION(:),POINTER :: tylo ! data type expected for specifiers
LOGICAL ,DIMENSION(:),POINTER :: oplo ! logical values for is_it_an_optional_input_specifier
LOGICAL ,DIMENSION(:),POINTER :: prlo ! logical values for is_input_specifier_present_in_current_entry
INTEGER ,DIMENSION(:),POINTER :: lilo ! value in line number of input file
LOGICAL ,DIMENSION(:),POINTER :: lo ! array for logical valued input
!
TYPE(in_array_queue),POINTER :: inar_queue ! queue for specifiers with array valued integer input
!
TYPE(xs_array_queue),POINTER :: xsar_queue ! queue for specifiers with array valued real input
!
TYPE(xd_array_queue),POINTER :: xdar_queue ! queue for specifiers with array valued double precision input
!
END TYPE input_specifier !
!----------------------------------------------------------------------!
!
TYPE :: inp_spec_node !
TYPE(input_specifier),POINTER :: input_spec !
TYPE(inp_spec_node) ,POINTER :: next_specifier ! pointer to successor node in queue
END TYPE inp_spec_node !
!------------------------------------------------------------------------------
END MODULE d_input_spec_node_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_input_specifier_queue_def ! queue type definition for specifier queue, associated to a certain keyword node
!------------------------------------------------------------------------------
USE d_input_spec_node_def ! ,ONLY:inp_spec_node
IMPLICIT NONE
TYPE :: input_spec_queue !
TYPE(inp_spec_node), POINTER :: top ! pointer to top node of specifier queue
TYPE(inp_spec_node), POINTER :: rear ! pointer to rear node of specifier queue
END TYPE input_spec_queue !
!------------------------------------------------------------------------------
END MODULE d_input_specifier_queue_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_input_key_node_def ! define derived data type for one node in queue of keywords
!------------------------------------------------------------------------------
USE d_input_specifier_queue_def ! ,ONLY:input_spec_queue
IMPLICIT NONE
TYPE :: input_key_node !
CHARACTER(1),DIMENSION(:),POINTER :: keyword ! pointer to character array, containing a keyword
INTEGER :: length ! number of characters in keyword name
TYPE(input_spec_queue), POINTER :: entries ! pointer to specifier queue, associated with a keyword node
TYPE(input_key_node) , POINTER :: next_key ! pointer to successor node in keyword queue
END TYPE input_key_node !
!------------------------------------------------------------------------------
END MODULE d_input_key_node_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_input_key_queue_def ! queue type definition for keyword queue
!------------------------------------------------------------------------------
USE d_input_key_node_def ! ,ONLY:input_key_node
IMPLICIT NONE
TYPE :: input_key_queue !
TYPE(input_key_node), POINTER :: top ! pointer to top node of keyword queue
TYPE(input_key_node), POINTER :: rear ! pointer to rear node of keyword queue
END TYPE input_key_queue !
!------------------------------------------------------------------------------
END MODULE d_input_key_queue_def !
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_mod_init_input_key_queue
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_init_input_key_queue(s) ! Initialize an empty keyword_queue
!------------------------------------------------------------------------------
USE d_input_key_queue_def,ONLY:input_key_queue
IMPLICIT NONE
TYPE(input_key_queue), INTENT (OUT) :: s !
NULLIFY (s%top,s%rear) ! Disassociate pointer to top and rear of keyword queue
!------------------------------------------------------------------------------
END SUBROUTINE d_init_input_key_queue
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE d_mod_init_input_key_queue
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_mod_add_input_key
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_add_input_key (s, bufferC)
!------------------------------------------------------------------------------
USE d_parser_parameters, ONLY: key_char
USE d_input_key_queue_def,ONLY:input_key_queue
IMPLICIT NONE
TYPE(input_key_queue), INTENT (IN OUT) :: s !
CHARACTER(*), INTENT (IN OUT) :: bufferC !
CHARACTER(1),DIMENSION(:),POINTER :: local_line !
integer :: line_length,ichar
bufferC = TRIM(ADJUSTL(bufferC)) ! remove leading and trailing blanks from line
line_length = LEN_TRIM(ADJUSTL(bufferC)) ! get length of input line
!
IF (line_length == 0) CALL ERROR(1) ! if line is empty, do not generate queue entry ==>>>STOP and call for ERROR
IF (bufferC(1:1)/=key_char) CALL ERROR(2) !
!
ALLOCATE(local_line(line_length)) !
DO ichar=1,line_length !
local_line(ichar) = bufferC(ichar:ichar) ! store data in local_line; new node keyword will poit to this line
END DO !
!
IF (.NOT. ASSOCIATED (s%top)) THEN !
ALLOCATE(s%top) !
ALLOCATE(s%top%entries) !
NULLIFY (s%top%entries%top) !
NULLIFY (s%top%entries%rear) !
s%top%keyword => local_line !
s%top%length = line_length !
NULLIFY(s%top%next_key) !
s%rear => s%top !
ELSE !
ALLOCATE(s%rear%next_key) !
ALLOCATE(s%rear%next_key%entries) !
NULLIFY (s%rear%next_key%entries%top) !
NULLIFY (s%rear%next_key%entries%rear) !
s%rear%next_key%keyword => local_line !
s%rear%next_key%length = line_length !
NULLIFY(s%rear%next_key%next_key) !
s%rear => s%rear%next_key !
END IF !
NULLIFY(s%rear%next_key) ! vmtl ueberfluessig
!
!----------------------------------------------------------------------!
CONTAINS !
!------------------------------------------------------------------------------
SUBROUTINE ERROR(error_number)
!------------------------------------------------------------------------------
USE My_Input_and_Output_Units,ONLY:my_output_unit
IMPLICIT NONE
INTEGER error_number !
!
IF(error_number==1)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'Empty keyword string not allowed in SUB. add_input_key.'!
WRITE(my_output_unit,*) 'Illegal attempt to add keyword input node' !
STOP !
ELSE IF(error_number==2)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In SUBROUTINE add_input_key '!
WRITE(my_output_unit,*) 'keyword string must start with ',key_char,' sign '!
WRITE(my_output_unit,*) 'Illegal attempt to add keyword input node '!
STOP !
ELSE IF(error_number>=3 .OR. error_number<=0)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In ERROR(i) called by SUBROUTINE add_input_key '!
WRITE(my_output_unit,*) 'Dummy argument must be > 0 and < 3. '!
WRITE(my_output_unit,*) 'Actual dummy argument is i = ',error_number !
WRITE(my_output_unit,*) 'Illegal attempt to call SUBROUTINE ERROR '!
STOP !
END IF !
!------------------------------------------------------------------------------
END SUBROUTINE ERROR
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END SUBROUTINE d_add_input_key
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE d_mod_add_input_key
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_position_at_key_interface
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_position_at_key(s,bufferC,node,key_positioned)
!------------------------------------------------------------------------------
USE d_input_key_queue_def,ONLY:input_key_queue
USE d_input_key_node_def ,ONLY:input_key_node
IMPLICIT NONE
TYPE(input_key_queue) :: s !
CHARACTER(len=*), INTENT (IN) :: bufferC !
TYPE(input_key_node),POINTER :: node !
LOGICAL :: key_positioned !
INTEGER :: i
!
key_positioned = .FALSE. !
IF (.NOT.ASSOCIATED(s%top)) CALL ERROR(1) !
node => s%top !
DO
IF (.NOT. ASSOCIATED(node) .OR. key_positioned) EXIT
IF (node%length < 1) CALL ERROR(1) !
IF (LEN_TRIM(bufferC) < 1) CALL ERROR(2) !
IF (LEN_TRIM(bufferC)==node%length) THEN !
key_positioned = .TRUE. !
DO i=1,node%length !
IF (bufferC(i:i)/=node%keyword(i)) key_positioned = .FALSE. !
ENDDO !
END IF !
IF (.NOT.key_positioned) node => node%next_key !
ENDDO !
!----------------------------------------------------------------------!
CONTAINS !
!------------------------------------------------------------------------------
SUBROUTINE ERROR(error_number) !
!------------------------------------------------------------------------------
USE My_Input_and_Output_Units,ONLY:my_output_unit
IMPLICIT NONE
INTEGER error_number !
IF(error_number==1)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'Illegal attempt to call SUBROUTINE position_at_key. '!
WRITE(my_output_unit,*) 'Got empty input_key_queue with empty entry' !
STOP !
ELSE IF(error_number==2)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In SUBROUTINE position_at_key. '!
WRITE(my_output_unit,*) 'Empty keyword string not allowed in this context. '!
WRITE(my_output_unit,*) 'Illegal attempt to position at keyword input node '!
STOP !
ELSE IF(error_number>2 .OR. error_number<1)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In ERROR(i) called by SUBROUTINE position_at_key. '!
WRITE(my_output_unit,*) 'Dummy argument must be > 0 and < 3. '!
WRITE(my_output_unit,*) 'Actual dummy argument is i = ',error_number !
WRITE(my_output_unit,*) 'Illegal attempt to call SUBROUTINE ERROR '!
STOP !
END IF
!------------------------------------------------------------------------------
END SUBROUTINE ERROR
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END SUBROUTINE d_position_at_key
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE d_position_at_key_interface
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_scan_inp_key_interface
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_scan_inp_keys (s,bufferC,found_inp_key)
!------------------------------------------------------------------------------
USE d_input_key_queue_def,ONLY:input_key_queue
USE d_input_key_node_def ,ONLY:input_key_node
IMPLICIT NONE
TYPE(input_key_queue) :: s !
CHARACTER(*), INTENT (IN) :: bufferC !
TYPE(input_key_node), POINTER :: a1 !
LOGICAL :: found_inp_key !
integer i
!
found_inp_key = .FALSE. !
!
IF (ASSOCIATED(s%top)) THEN !
a1 => s%top !
DO
IF (.NOT. ASSOCIATED(a1) .OR. found_inp_key) EXIT
IF (a1%length < 1) CALL ERROR(1) !
IF (LEN_TRIM(bufferC) < 1) CALL ERROR(2) !
IF (LEN_TRIM(bufferC)==a1%length) THEN !
found_inp_key = .TRUE. !
DO i=1,a1%length !
IF (bufferC(i:i)/=a1%keyword(i)) found_inp_key = .FALSE. !
ENDDO !
END IF !
a1 => a1%next_key !
ENDDO !
END IF !
NULLIFY(a1) !
!----------------------------------------------------------------------!
CONTAINS !
!------------------------------------------------------------------------------
SUBROUTINE ERROR(error_number) !
!------------------------------------------------------------------------------
USE My_Input_and_Output_Units,ONLY:my_output_unit
IMPLICIT NONE
INTEGER error_number !
IF(error_number==1)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'Empty keyword string not allowed in SUB. scan_inp_keys.'!
WRITE(my_output_unit,*) 'Got input_key_queue with empty entry' !
STOP !
ELSE IF(error_number==2)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In SUBROUTINE scan_inp_keys. '!
WRITE(my_output_unit,*) 'Keyword string must be not empty. '!
WRITE(my_output_unit,*) 'Illegal attempt to scan for keyword input node '!
STOP !
ELSE IF(error_number>2 .OR. error_number<1)THEN !
WRITE(my_output_unit,*) '>>>>>>> ERROR <<<<< >>>>> ERROR <<<<< >>>>>ERROR<<<<<<<'!
WRITE(my_output_unit,*) 'In ERROR(i) called by SUBROUTINE scan_inp_keys. '!
WRITE(my_output_unit,*) 'Dummy argument must be > 0 and < 3. '!
WRITE(my_output_unit,*) 'Actual dummy argument is i = ',error_number !
WRITE(my_output_unit,*) 'Illegal attempt to call SUBROUTINE ERROR '!
STOP !
END IF !
!------------------------------------------------------------------------------
END SUBROUTINE ERROR
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END SUBROUTINE d_scan_inp_keys
!------------------------------------------------------------------------------
!------------------------------------------------------------------------------
END MODULE d_scan_inp_key_interface
!------------------------------------------------------------------------------
!
!
!
!------------------------------------------------------------------------------
MODULE d_add_inp_spec_interface
!------------------------------------------------------------------------------
IMPLICIT NONE
CONTAINS
!------------------------------------------------------------------------------
SUBROUTINE d_add_inp_spec(s,keywords,keyC,spec)
!------------------------------------------------------------------------------
USE input_type_names,ONLY:name_xs,name_xd,name_in,name_ca,name_lo,&
name_inar,name_xsar,name_xdar, &
char_length_type_name, &
char_length_choice_name
USE keyword_queue_def,ONLY:keyword_queue
USE d_input_key_queue_def ! ,ONLY:input_key_queue
USE mod_get_key_info,ONLY:get_key_info
USE d_position_at_key_interface,ONLY:d_position_at_key
IMPLICIT NONE
TYPE(input_key_queue) :: s !
TYPE(in_array_node),POINTER :: local_inar !
TYPE(xs_array_node),POINTER :: local_xsar !
TYPE(xd_array_node),POINTER :: local_xdar !
TYPE(input_key_node),POINTER,SAVE :: node !
TYPE(inp_spec_node),POINTER :: spec_node !
TYPE(input_specifier),POINTER :: spec_structure !
TYPE(keyword_queue),POINTER :: keywords !
LOGICAL :: key_positioned !
LOGICAL :: found_no_specifierL,optional_specifierL !
!
CHARACTER(len=char_length_type_name) :: data_type
LOGICAL :: ChoiceL
CHARACTER(len=char_length_choice_name) :: ChoiceC
CHARACTER(*), INTENT (IN OUT) :: keyC
CHARACTER(*), INTENT (IN OUT) :: spec
INTEGER :: num_xs,num_xd,num_in,num_ca,num_lo !
integer num_inar,num_xsar,num_xdar,i
!
CALL d_position_at_key(s,keyC,node,key_positioned)
IF (.NOT. key_positioned) CALL ERROR(2) !
!
ALLOCATE(spec_node) !
ALLOCATE(spec_structure) !
ALLOCATE(spec_structure%inar_queue) !
ALLOCATE(spec_structure%xsar_queue) !
ALLOCATE(spec_structure%xdar_queue) !
NULLIFY(spec_structure%inar_queue%top) !
NULLIFY(spec_structure%inar_queue%rear) !
NULLIFY(spec_structure%xsar_queue%top) !
NULLIFY(spec_structure%xsar_queue%rear) !
NULLIFY(spec_structure%xdar_queue%top) !
NULLIFY(spec_structure%xdar_queue%rear) !
!
num_xs = 0 !
num_xd = 0 !
num_in = 0 !
num_ca = 0 !
num_lo = 0 !