ParameterLists.f90 696 KB
Newer Older
1
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++!
2
3
4
5
6
7
!                          Futility Development Group                          !
!                             All rights reserved.                             !
!                                                                              !
! Futility is a jointly-maintained, open-source project between the University !
! of Michigan and Oak Ridge National Laboratory.  The copyright and license    !
! can be found in LICENSE.txt in the head directory of this repository.        !
8
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++!
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
!> @brief This module defines a parameter type object.
!>
!> The purpose of this object is to facilitate encapsulation of an arbitrary
!> number of parameters that may have varying types of values into one object
!> which can be more easily passed around between different code.
!>
!> The object is self-referential which means it can contain objects of the
!> same type as itself. This allows for nested lists of parameters. A parameter
!> is defined by a name, a datatype, an optional description, and a value.
!> The value attribute is polymorphic so that it can be a single integer
!> or an array of double precision reals or a list of other parameters.
!>
!> This module only makes public the base parameter type and it's assignment
!> operation and the exception handler for the module. The base parameter
!> type includes methods for initialization to a specific type, editing the
!> contents of parameter, clearing the contents of a parameter, getting or
!> setting values of existing parameters (or subparameters) and the ability to
!> add or delete parameters nested within other parameters.
27
!>
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
!> The parameters are searched and matched using the name attribute and the
!> matching is not case sensitive.
!>
!> The supported extended parameter types accept the following types of values:
!>  - a list of parameters
!>  - scalar logicals
!>  - @ref Strings::StringType "StringTypes"
!>  - scalar 32-bit integers
!>  - scalar 64-bit integers
!>  - scalar single precision reals
!>  - scalar double precision reals
!>  - 1-D arrays of logicals
!>  - 1-D arrays of 32-bit integers
!>  - 1-D arrays of 64-bit integers
!>  - 1-D arrays of single precision reals
!>  - 1-D arrays of double precision reals
44
!>  - 1-D arrays of "StringTypes"
45
46
47
48
!>  - 2-D arrays of 32-bit integers
!>  - 2-D arrays of 64-bit integers
!>  - 2-D arrays of single precision reals
!>  - 2-D arrays of double precision reals
49
!>  - 2-D arrays of "StringTypes"
50
51
52
53
!>  - 3-D arrays of 32-bit integers
!>  - 3-D arrays of 64-bit integers
!>  - 3-D arrays of single precision reals
!>  - 3-D arrays of double precision reals
54
!>  - 3-D arrays of "StringTypes"
Graham, Aaron's avatar
Graham, Aaron committed
55
56
57
58
!>  - 4-D arrays of 32-bit integers
!>  - 4-D arrays of 64-bit integers
!>  - 4-D arrays of single precision reals
!>  - 4-D arrays of double precision reals
Graham, Aaron's avatar
Graham, Aaron committed
59
60
61
62
63
64
65
66
67
68
69
70
!>  - 5-D arrays of 32-bit integers
!>  - 5-D arrays of 64-bit integers
!>  - 5-D arrays of single precision reals
!>  - 5-D arrays of double precision reals
!>  - 6-D arrays of 32-bit integers
!>  - 6-D arrays of 64-bit integers
!>  - 6-D arrays of single precision reals
!>  - 6-D arrays of double precision reals
!>  - 7-D arrays of 32-bit integers
!>  - 7-D arrays of 64-bit integers
!>  - 7-D arrays of single precision reals
!>  - 7-D arrays of double precision reals
71
72
!++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++!
MODULE ParameterLists
73
#include "UnitTest.h"
Graham, Aaron's avatar
Graham, Aaron committed
74
USE ISO_FORTRAN_ENV
75
USE HashModule
Graham, Aaron's avatar
Graham, Aaron committed
76
77
78
79
80
81
USE UnitTest
USE IntrType
USE Strings
USE ExceptionHandler
USE IO_Strings
USE FileType_XML
82
#ifdef FUTILITY_HAVE_Trilinos
Graham, Aaron's avatar
Graham, Aaron committed
83
USE ForTeuchos_ParameterList
84
#endif
85

Graham, Aaron's avatar
Graham, Aaron committed
86
87
IMPLICIT NONE
PRIVATE !Default private for module contents
88
89
!
! List of Public items
Graham, Aaron's avatar
Graham, Aaron committed
90
91
PUBLIC :: eParams
PUBLIC :: ParamType
Graham, Aaron's avatar
Graham, Aaron committed
92
PUBLIC :: ParamTypePtr
Graham, Aaron's avatar
Graham, Aaron committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
PUBLIC :: ASSIGNMENT(=)
PUBLIC :: OPERATOR(==)

PUBLIC :: char_to_int_array
PUBLIC :: char_to_double_array
PUBLIC :: char_to_string_array

!> The module name
CHARACTER(LEN=*),PARAMETER :: modName='PARAMETERLISTS'
INTEGER(SIK),PARAMETER :: MAX_1D_LEN=10

!> Verification enumerations
INTEGER(SIK),PARAMETER :: VALIDTYPE_VALIDATE=0
INTEGER(SIK),PARAMETER :: VALIDTYPE_VERIFYTEST=1
INTEGER(SIK),PARAMETER :: VALIDTYPE_VERIFYLIST=2

109
110
111
112
!> Hashing parameters
INTEGER(SLK),PARAMETER,PRIVATE :: PL_HASH_POLYNOMIAL_BASE=97_SIK
INTEGER(SLK),PARAMETER,PRIVATE :: PL_HASH_MODULUS=1000000009_SIK

Graham, Aaron's avatar
Graham, Aaron committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
!> Exception handler for the module
TYPE(ExceptionHandlerType),SAVE :: eParams

!> @brief Derived type for a parameter object
!>
!> This is an object which encapsulates a polymorphic value which so that the
!> parameter value can be any number of things e.g.  a real scalar, an integer
!> array, a logical, a string, etc.
!>
!> This type should not have an @c init operation as it logically does not
!> make any sense. For all extended types the @c edit and @c clear methods
!> should be overwritten.
TYPE :: ParamType
  !> @brief The name of the parameter
  !>
  !> Set through input arguments
129
130
  TYPE(StringType),PRIVATE :: name
  !> The hash of the uppercase version of @c %name
131
  INTEGER(SLK) :: upperNameHash=0_SLK
Graham, Aaron's avatar
Graham, Aaron committed
132
  !> @brief The data type for the parameter
133
  !>
Graham, Aaron's avatar
Graham, Aaron committed
134
135
136
137
138
  !> Set internally.
  TYPE(StringType) :: dataType
  !> An optional description for the parameter
  TYPE(StringType) :: description
  !> @brief The parameter value
139
  !>
Graham, Aaron's avatar
Graham, Aaron committed
140
141
142
143
  !> This is only allocated for variables of TYPE(ParamType) for any
  !> extended type it is the additional attribute that should be
  !> accessed.
  CLASS(ParamType),POINTER :: pdat => NULL()
144
145
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
146
  CONTAINS
147
148
149
150
151
152
153
154
155
    !> @copybrief ParameterLists::init_ParamType_Base
    !> @copydoc ParameterLists::init_ParamType_Base
    PROCEDURE,PASS,PRIVATE :: initBase => init_ParamType_Base
    !> @copybrief ParameterLists::rename_ParamType
    !> @copydoc ParameterLists::rename_ParamType
    PROCEDURE,PASS :: rename => rename_ParamType
    !> @copybrief ParameterLists::getName_ParamType
    !> @copydoc ParameterLists::getName_ParamType
    PROCEDURE,PASS :: getName => getName_ParamType
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::init_ParamType_List
    !> @copydoc ParameterLists::init_ParamType_List
    PROCEDURE,PASS,PRIVATE :: initParamList => init_ParamType_List
    !> @copybrief ParameterLists::init_ParamType_SSK
    !> @copydoc ParameterLists::init_ParamType_SSK
    PROCEDURE,PASS,PRIVATE :: initSSK => init_ParamType_SSK
    !> @copybrief ParameterLists::init_ParamType_SDK
    !> @copydoc ParameterLists::init_ParamType_SDK
    PROCEDURE,PASS,PRIVATE :: initSDK => init_ParamType_SDK
    !> @copybrief ParameterLists::init_ParamType_SNK
    !> @copydoc ParameterLists::init_ParamType_SNK
    PROCEDURE,PASS,PRIVATE :: initSNK => init_ParamType_SNK
    !> @copybrief ParameterLists::init_ParamType_SLK
    !> @copydoc ParameterLists::init_ParamType_SLK
    PROCEDURE,PASS,PRIVATE :: initSLK => init_ParamType_SLK
    !> @copybrief ParameterLists::init_ParamType_SBK
    !> @copydoc ParameterLists::init_ParamType_SBK
    PROCEDURE,PASS,PRIVATE :: initSBK => init_ParamType_SBK
    !> @copybrief ParameterLists::init_ParamType_STR
    !> @copydoc ParameterLists::init_ParamType_STR
    PROCEDURE,PASS,PRIVATE :: initSTR => init_ParamType_STR
    !> @copybrief ParameterLists::init_ParamType_CHAR
    !> @copydoc ParameterLists::init_ParamType_CHAR
    PROCEDURE,PASS,PRIVATE :: initCHAR => init_ParamType_CHAR
    !> @copybrief ParameterLists::init_ParamType_SSK_a1
    !> @copydoc ParameterLists::init_ParamType_SSK_a1
    PROCEDURE,PASS,PRIVATE :: initSSKa1 => init_ParamType_SSK_a1
    !> @copybrief ParameterLists::init_ParamType_SDK_a1
    !> @copydoc ParameterLists::init_ParamType_SDK_a1
    PROCEDURE,PASS,PRIVATE :: initSDKa1 => init_ParamType_SDK_a1
    !> @copybrief ParameterLists::init_ParamType_SNK_a1
    !> @copydoc ParameterLists::init_ParamType_SNK_a1
    PROCEDURE,PASS,PRIVATE :: initSNKa1 => init_ParamType_SNK_a1
    !> @copybrief ParameterLists::init_ParamType_SLK_a1
    !> @copydoc ParameterLists::init_ParamType_SLK_a1
    PROCEDURE,PASS,PRIVATE :: initSLKa1 => init_ParamType_SLK_a1
    !> @copybrief ParameterLists::init_ParamType_SBK_a1
    !> @copydoc ParameterLists::init_ParamType_SBK_a1
    PROCEDURE,PASS,PRIVATE :: initSBKa1 => init_ParamType_SBK_a1
    !> @copybrief ParameterLists::init_ParamType_STR_a1
    !> @copydoc ParameterLists::init_ParamType_STR_a1
    PROCEDURE,PASS,PRIVATE :: initSTRa1 => init_ParamType_STR_a1
    !> @copybrief ParameterLists::init_ParamType_SSK_a2
    !> @copydoc ParameterLists::init_ParamType_SSK_a2
    PROCEDURE,PASS,PRIVATE :: initSSKa2 => init_ParamType_SSK_a2
    !> @copybrief ParameterLists::init_ParamType_SDK_a2
    !> @copydoc ParameterLists::init_ParamType_SDK_a2
    PROCEDURE,PASS,PRIVATE :: initSDKa2 => init_ParamType_SDK_a2
    !> @copybrief ParameterLists::init_ParamType_SNK_a2
    !> @copydoc ParameterLists::init_ParamType_SNK_a2
    PROCEDURE,PASS,PRIVATE :: initSNKa2 => init_ParamType_SNK_a2
    !> @copybrief ParameterLists::init_ParamType_SLK_a2
    !> @copydoc ParameterLists::init_ParamType_SLK_a2
    PROCEDURE,PASS,PRIVATE :: initSLKa2 => init_ParamType_SLK_a2
    !> @copybrief ParameterLists::init_ParamType_STR_a2
    !> @copydoc ParameterLists::init_ParamType_STR_a2
    PROCEDURE,PASS,PRIVATE :: initSTRa2 => init_ParamType_STR_a2
    !> @copybrief ParameterLists::init_ParamType_SSK_a3
    !> @copydoc ParameterLists::init_ParamType_SSK_a3
    PROCEDURE,PASS,PRIVATE :: initSSKa3 => init_ParamType_SSK_a3
    !> @copybrief ParameterLists::init_ParamType_SDK_a3
    !> @copydoc ParameterLists::init_ParamType_SDK_a3
    PROCEDURE,PASS,PRIVATE :: initSDKa3 => init_ParamType_SDK_a3
    !> @copybrief ParameterLists::init_ParamType_SNK_a3
    !> @copydoc ParameterLists::init_ParamType_SNK_a3
    PROCEDURE,PASS,PRIVATE :: initSNKa3 => init_ParamType_SNK_a3
    !> @copybrief ParameterLists::init_ParamType_SLK_a3
    !> @copydoc ParameterLists::init_ParamType_SLK_a3
    PROCEDURE,PASS,PRIVATE :: initSLKa3 => init_ParamType_SLK_a3
225
226
227
    !> @copybrief ParameterLists::init_ParamType_STR_a3
    !> @copydoc ParameterLists::init_ParamType_STR_a3
    PROCEDURE,PASS,PRIVATE :: initSTRa3 => init_ParamType_STR_a3
Graham, Aaron's avatar
Graham, Aaron committed
228
229
230
231
232
233
234
235
236
237
238
239
    !> @copybrief ParameterLists::init_ParamType_SSK_a4
    !> @copydoc ParameterLists::init_ParamType_SSK_a4
    PROCEDURE,PASS,PRIVATE :: initSSKa4 => init_ParamType_SSK_a4
    !> @copybrief ParameterLists::init_ParamType_SDK_a4
    !> @copydoc ParameterLists::init_ParamType_SDK_a4
    PROCEDURE,PASS,PRIVATE :: initSDKa4 => init_ParamType_SDK_a4
    !> @copybrief ParameterLists::init_ParamType_SNK_a4
    !> @copydoc ParameterLists::init_ParamType_SNK_a4
    PROCEDURE,PASS,PRIVATE :: initSNKa4 => init_ParamType_SNK_a4
    !> @copybrief ParameterLists::init_ParamType_SLK_a4
    !> @copydoc ParameterLists::init_ParamType_SLK_a4
    PROCEDURE,PASS,PRIVATE :: initSLKa4 => init_ParamType_SLK_a4
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::init_ParamType_SSK_a5
    !> @copydoc ParameterLists::init_ParamType_SSK_a5
    PROCEDURE,PASS,PRIVATE :: initSSKa5 => init_ParamType_SSK_a5
    !> @copybrief ParameterLists::init_ParamType_SDK_a5
    !> @copydoc ParameterLists::init_ParamType_SDK_a5
    PROCEDURE,PASS,PRIVATE :: initSDKa5 => init_ParamType_SDK_a5
    !> @copybrief ParameterLists::init_ParamType_SNK_a5
    !> @copydoc ParameterLists::init_ParamType_SNK_a5
    PROCEDURE,PASS,PRIVATE :: initSNKa5 => init_ParamType_SNK_a5
    !> @copybrief ParameterLists::init_ParamType_SLK_a5
    !> @copydoc ParameterLists::init_ParamType_SLK_a5
    PROCEDURE,PASS,PRIVATE :: initSLKa5 => init_ParamType_SLK_a5
    !> @copybrief ParameterLists::init_ParamType_SSK_a6
    !> @copydoc ParameterLists::init_ParamType_SSK_a6
    PROCEDURE,PASS,PRIVATE :: initSSKa6 => init_ParamType_SSK_a6
    !> @copybrief ParameterLists::init_ParamType_SDK_a6
    !> @copydoc ParameterLists::init_ParamType_SDK_a6
    PROCEDURE,PASS,PRIVATE :: initSDKa6 => init_ParamType_SDK_a6
    !> @copybrief ParameterLists::init_ParamType_SNK_a6
    !> @copydoc ParameterLists::init_ParamType_SNK_a6
    PROCEDURE,PASS,PRIVATE :: initSNKa6 => init_ParamType_SNK_a6
    !> @copybrief ParameterLists::init_ParamType_SLK_a6
    !> @copydoc ParameterLists::init_ParamType_SLK_a6
    PROCEDURE,PASS,PRIVATE :: initSLKa6 => init_ParamType_SLK_a6
    !> @copybrief ParameterLists::init_ParamType_SSK_a7
    !> @copydoc ParameterLists::init_ParamType_SSK_a7
    PROCEDURE,PASS,PRIVATE :: initSSKa7 => init_ParamType_SSK_a7
    !> @copybrief ParameterLists::init_ParamType_SDK_a7
    !> @copydoc ParameterLists::init_ParamType_SDK_a7
    PROCEDURE,PASS,PRIVATE :: initSDKa7 => init_ParamType_SDK_a7
    !> @copybrief ParameterLists::init_ParamType_SNK_a7
    !> @copydoc ParameterLists::init_ParamType_SNK_a7
    PROCEDURE,PASS,PRIVATE :: initSNKa7 => init_ParamType_SNK_a7
    !> @copybrief ParameterLists::init_ParamType_SLK_a7
    !> @copydoc ParameterLists::init_ParamType_SLK_a7
    PROCEDURE,PASS,PRIVATE :: initSLKa7 => init_ParamType_SLK_a7
Graham, Aaron's avatar
Graham, Aaron committed
276
277
278
279
    !> Generic type bound interface for all @c init operations
    GENERIC :: init => initParamList,initSSK,initSDK,initSNK,initSLK, &
        initSBK,initSTR,initCHAR,initSSKa1,initSDKa1,initSNKa1, &
        initSLKa1,initSBKa1,initSTRa1,initSSKa2,initSDKa2,initSNKa2, &
Graham, Aaron's avatar
Graham, Aaron committed
280
        initSLKa2,initSTRa2,initSSKa3,initSDKa3,initSNKa3,initSLKa3, &
281
282
283
        initSTRa3,initSSKa4,initSDKa4,initSNKa4,initSLKa4,initSSKa5, &
        initSDKa5,initSNKa5,initSLKa5,initSSKa6,initSDKa6,initSNKa6, &
        initSLKa6,initSSKa7,initSDKa7,initSNKa7,initSLKa7
Graham, Aaron's avatar
Graham, Aaron committed
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
    PROCEDURE,PASS :: initFromXML
    !> @copybrief ParameterLists::set_ParamType_List
    !> @copydoc ParameterLists::set_ParamType_List
    PROCEDURE,PASS,PRIVATE :: setParamList => set_ParamType_List
    !> @copybrief ParameterLists::set_ParamType_SSK
    !> @copydoc ParameterLists::set_ParamType_SSK
    PROCEDURE,PASS,PRIVATE :: setSSK => set_ParamType_SSK
    !> @copybrief ParameterLists::set_ParamType_SDK
    !> @copydoc ParameterLists::set_ParamType_SDK
    PROCEDURE,PASS,PRIVATE :: setSDK => set_ParamType_SDK
    !> @copybrief ParameterLists::set_ParamType_SNK
    !> @copydoc ParameterLists::set_ParamType_SNK
    PROCEDURE,PASS,PRIVATE :: setSNK => set_ParamType_SNK
    !> @copybrief ParameterLists::set_ParamType_SLK
    !> @copydoc ParameterLists::set_ParamType_SLK
    PROCEDURE,PASS,PRIVATE :: setSLK => set_ParamType_SLK
    !> @copybrief ParameterLists::set_ParamType_SBK
    !> @copydoc ParameterLists::set_ParamType_SBK
    PROCEDURE,PASS,PRIVATE :: setSBK => set_ParamType_SBK
    !> @copybrief ParameterLists::set_ParamType_STR
    !> @copydoc ParameterLists::set_ParamType_STR
    PROCEDURE,PASS,PRIVATE :: setSTR => set_ParamType_STR
    !> @copybrief ParameterLists::set_ParamType_CHAR
    !> @copydoc ParameterLists::set_ParamType_CHAR
    PROCEDURE,PASS,PRIVATE :: setCHAR => set_ParamType_CHAR
    !> @copybrief ParameterLists::set_ParamType_SSK_a1
    !> @copydoc ParameterLists::set_ParamType_SSK_a1
    PROCEDURE,PASS,PRIVATE :: setSSKa1 => set_ParamType_SSK_a1
    !> @copybrief ParameterLists::set_ParamType_SDK_a1
    !> @copydoc ParameterLists::set_ParamType_SDK_a1
    PROCEDURE,PASS,PRIVATE :: setSDKa1 => set_ParamType_SDK_a1
    !> @copybrief ParameterLists::set_ParamType_SNK_a1
    !> @copydoc ParameterLists::set_ParamType_SNK_a1
    PROCEDURE,PASS,PRIVATE :: setSNKa1 => set_ParamType_SNK_a1
    !> @copybrief ParameterLists::set_ParamType_SLK_a1
    !> @copydoc ParameterLists::set_ParamType_SLK_a1
    PROCEDURE,PASS,PRIVATE :: setSLKa1 => set_ParamType_SLK_a1
    !> @copybrief ParameterLists::set_ParamType_SBK_a1
    !> @copydoc ParameterLists::set_ParamType_SBK_a1
    PROCEDURE,PASS,PRIVATE :: setSBKa1 => set_ParamType_SBK_a1
    !> @copybrief ParameterLists::set_ParamType_STR_a1
    !> @copydoc ParameterLists::set_ParamType_STR_a1
    PROCEDURE,PASS,PRIVATE :: setSTRa1 => set_ParamType_STR_a1
    !> @copybrief ParameterLists::set_ParamType_SSK_a2
    !> @copydoc ParameterLists::set_ParamType_SSK_a2
    PROCEDURE,PASS,PRIVATE :: setSSKa2 => set_ParamType_SSK_a2
    !> @copybrief ParameterLists::set_ParamType_SDK_a2
    !> @copydoc ParameterLists::set_ParamType_SDK_a2
    PROCEDURE,PASS,PRIVATE :: setSDKa2 => set_ParamType_SDK_a2
    !> @copybrief ParameterLists::set_ParamType_SNK_a2
    !> @copydoc ParameterLists::set_ParamType_SNK_a2
    PROCEDURE,PASS,PRIVATE :: setSNKa2 => set_ParamType_SNK_a2
    !> @copybrief ParameterLists::set_ParamType_SLK_a2
    !> @copydoc ParameterLists::set_ParamType_SLK_a2
    PROCEDURE,PASS,PRIVATE :: setSLKa2 => set_ParamType_SLK_a2
    !> @copybrief ParameterLists::set_ParamType_STR_a2
    !> @copydoc ParameterLists::set_ParamType_STR_a2
    PROCEDURE,PASS,PRIVATE :: setSTRa2 => set_ParamType_STR_a2
    !> @copybrief ParameterLists::set_ParamType_SSK_a3
    !> @copydoc ParameterLists::set_ParamType_SSK_a3
    PROCEDURE,PASS,PRIVATE :: setSSKa3 => set_ParamType_SSK_a3
    !> @copybrief ParameterLists::set_ParamType_SDK_a3
    !> @copydoc ParameterLists::set_ParamType_SDK_a3
    PROCEDURE,PASS,PRIVATE :: setSDKa3 => set_ParamType_SDK_a3
    !> @copybrief ParameterLists::set_ParamType_SNK_a3
    !> @copydoc ParameterLists::set_ParamType_SNK_a3
    PROCEDURE,PASS,PRIVATE :: setSNKa3 => set_ParamType_SNK_a3
    !> @copybrief ParameterLists::set_ParamType_SLK_a3
    !> @copydoc ParameterLists::set_ParamType_SLK_a3
    PROCEDURE,PASS,PRIVATE :: setSLKa3 => set_ParamType_SLK_a3
354
355
356
    !> @copybrief ParameterLists::set_ParamType_STR_a3
    !> @copydoc ParameterLists::set_ParamType_STR_a3
    PROCEDURE,PASS,PRIVATE :: setSTRa3 => set_ParamType_STR_a3
Graham, Aaron's avatar
Graham, Aaron committed
357
358
359
360
361
362
363
364
365
366
367
368
    !> @copybrief ParameterLists::set_ParamType_SSK_a4
    !> @copydoc ParameterLists::set_ParamType_SSK_a4
    PROCEDURE,PASS,PRIVATE :: setSSKa4 => set_ParamType_SSK_a4
    !> @copybrief ParameterLists::set_ParamType_SDK_a4
    !> @copydoc ParameterLists::set_ParamType_SDK_a4
    PROCEDURE,PASS,PRIVATE :: setSDKa4 => set_ParamType_SDK_a4
    !> @copybrief ParameterLists::set_ParamType_SNK_a4
    !> @copydoc ParameterLists::set_ParamType_SNK_a4
    PROCEDURE,PASS,PRIVATE :: setSNKa4 => set_ParamType_SNK_a4
    !> @copybrief ParameterLists::set_ParamType_SLK_a4
    !> @copydoc ParameterLists::set_ParamType_SLK_a4
    PROCEDURE,PASS,PRIVATE :: setSLKa4 => set_ParamType_SLK_a4
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::set_ParamType_SSK_a5
    !> @copydoc ParameterLists::set_ParamType_SSK_a5
    PROCEDURE,PASS,PRIVATE :: setSSKa5 => set_ParamType_SSK_a5
    !> @copybrief ParameterLists::set_ParamType_SDK_a5
    !> @copydoc ParameterLists::set_ParamType_SDK_a5
    PROCEDURE,PASS,PRIVATE :: setSDKa5 => set_ParamType_SDK_a5
    !> @copybrief ParameterLists::set_ParamType_SNK_a5
    !> @copydoc ParameterLists::set_ParamType_SNK_a5
    PROCEDURE,PASS,PRIVATE :: setSNKa5 => set_ParamType_SNK_a5
    !> @copybrief ParameterLists::set_ParamType_SLK_a5
    !> @copydoc ParameterLists::set_ParamType_SLK_a5
    PROCEDURE,PASS,PRIVATE :: setSLKa5 => set_ParamType_SLK_a5
    !> @copybrief ParameterLists::set_ParamType_SSK_a6
    !> @copydoc ParameterLists::set_ParamType_SSK_a6
    PROCEDURE,PASS,PRIVATE :: setSSKa6 => set_ParamType_SSK_a6
    !> @copybrief ParameterLists::set_ParamType_SDK_a6
    !> @copydoc ParameterLists::set_ParamType_SDK_a6
    PROCEDURE,PASS,PRIVATE :: setSDKa6 => set_ParamType_SDK_a6
    !> @copybrief ParameterLists::set_ParamType_SNK_a6
    !> @copydoc ParameterLists::set_ParamType_SNK_a6
    PROCEDURE,PASS,PRIVATE :: setSNKa6 => set_ParamType_SNK_a6
    !> @copybrief ParameterLists::set_ParamType_SLK_a6
    !> @copydoc ParameterLists::set_ParamType_SLK_a6
    PROCEDURE,PASS,PRIVATE :: setSLKa6 => set_ParamType_SLK_a6
    !> @copybrief ParameterLists::set_ParamType_SSK_a7
    !> @copydoc ParameterLists::set_ParamType_SSK_a7
    PROCEDURE,PASS,PRIVATE :: setSSKa7 => set_ParamType_SSK_a7
    !> @copybrief ParameterLists::set_ParamType_SDK_a7
    !> @copydoc ParameterLists::set_ParamType_SDK_a7
    PROCEDURE,PASS,PRIVATE :: setSDKa7 => set_ParamType_SDK_a7
    !> @copybrief ParameterLists::set_ParamType_SNK_a7
    !> @copydoc ParameterLists::set_ParamType_SNK_a7
    PROCEDURE,PASS,PRIVATE :: setSNKa7 => set_ParamType_SNK_a7
    !> @copybrief ParameterLists::set_ParamType_SLK_a7
    !> @copydoc ParameterLists::set_ParamType_SLK_a7
    PROCEDURE,PASS,PRIVATE :: setSLKa7 => set_ParamType_SLK_a7
Graham, Aaron's avatar
Graham, Aaron committed
405
406
407
408
    !> Generic type bound interface for all @c set operations
    GENERIC :: set => setParamList,setSSK,setSDK,setSNK,setSLK, &
        setSBK,setSTR,setCHAR,setSSKa1,setSDKa1,setSNKa1, &
        setSLKa1,setSBKa1,setSTRa1,setSSKa2,setSDKa2,setSNKa2, &
Graham, Aaron's avatar
Graham, Aaron committed
409
        setSLKa2,setSTRa2,setSSKa3,setSDKa3,setSNKa3,setSLKa3, &
410
411
412
        setSTRa3,setSSKa4,setSDKa4,setSNKa4,setSLKa4,setSSKa5, &
        setSDKa5,setSNKa5,setSLKa5,setSSKa6,setSDKa6,setSNKa6, &
        setSLKa6,setSSKa7,setSDKa7,setSNKa7,setSLKa7
Graham, Aaron's avatar
Graham, Aaron committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
    !> @copybrief ParameterLists::get_ParamType
    !> @copydoc ParameterLists::get_ParamType
    PROCEDURE,PASS,PRIVATE :: getParam => get_ParamType
    !> @copybrief ParameterLists::get_ParamType_List
    !> @copydoc ParameterLists::get_ParamType_List
    PROCEDURE,PASS,PRIVATE :: getParamList => get_ParamType_List
    !> @copybrief ParameterLists::get_ParamType_SSK
    !> @copydoc ParameterLists::get_ParamType_SSK
    PROCEDURE,PASS,PRIVATE :: getSSK => get_ParamType_SSK
    !> @copybrief ParameterLists::get_ParamType_SDK
    !> @copydoc ParameterLists::get_ParamType_SDK
    PROCEDURE,PASS,PRIVATE :: getSDK => get_ParamType_SDK
    !> @copybrief ParameterLists::get_ParamType_SNK
    !> @copydoc ParameterLists::get_ParamType_SNK
    PROCEDURE,PASS,PRIVATE :: getSNK => get_ParamType_SNK
    !> @copybrief ParameterLists::get_ParamType_SLK
    !> @copydoc ParameterLists::get_ParamType_SLK
    PROCEDURE,PASS,PRIVATE :: getSLK => get_ParamType_SLK
    !> @copybrief ParameterLists::get_ParamType_SBK
    !> @copydoc ParameterLists::get_ParamType_SBK
    PROCEDURE,PASS,PRIVATE :: getSBK => get_ParamType_SBK
    !> @copybrief ParameterLists::get_ParamType_STR
    !> @copydoc ParameterLists::get_ParamType_STR
    PROCEDURE,PASS,PRIVATE :: getSTR => get_ParamType_STR
437
438
439
    !> @copybrief ParameterLists::get_ParamType_STR_CHAR
    !> @copydoc ParameterLists::get_ParamType_STR_CHAR
    PROCEDURE,PASS,PRIVATE :: getSTRCHAR => get_ParamType_STR_CHAR
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::get_ParamType_CHAR
    !> @copydoc ParameterLists::get_ParamType_CHAR
    PROCEDURE,PASS,PRIVATE :: getCHAR => get_ParamType_CHAR
    !> @copybrief ParameterLists::get_ParamType_SSK_a1
    !> @copydoc ParameterLists::get_ParamType_SSK_a1
    PROCEDURE,PASS,PRIVATE :: getSSKa1 => get_ParamType_SSK_a1
    !> @copybrief ParameterLists::get_ParamType_SDK_a1
    !> @copydoc ParameterLists::get_ParamType_SDK_a1
    PROCEDURE,PASS,PRIVATE :: getSDKa1 => get_ParamType_SDK_a1
    !> @copybrief ParameterLists::get_ParamType_SNK_a1
    !> @copydoc ParameterLists::get_ParamType_SNK_a1
    PROCEDURE,PASS,PRIVATE :: getSNKa1 => get_ParamType_SNK_a1
    !> @copybrief ParameterLists::get_ParamType_SLK_a1
    !> @copydoc ParameterLists::get_ParamType_SLK_a1
    PROCEDURE,PASS,PRIVATE :: getSLKa1 => get_ParamType_SLK_a1
    !> @copybrief ParameterLists::get_ParamType_SBK_a1
    !> @copydoc ParameterLists::get_ParamType_SBK_a1
    PROCEDURE,PASS,PRIVATE :: getSBKa1 => get_ParamType_SBK_a1
    !> @copybrief ParameterLists::get_ParamType_STR_a1
    !> @copydoc ParameterLists::get_ParamType_STR_a1
    PROCEDURE,PASS,PRIVATE :: getSTRa1 => get_ParamType_STR_a1
    !> @copybrief ParameterLists::get_ParamType_SSK_a2
    !> @copydoc ParameterLists::get_ParamType_SSK_a2
    PROCEDURE,PASS,PRIVATE :: getSSKa2 => get_ParamType_SSK_a2
    !> @copybrief ParameterLists::get_ParamType_SDK_a2
    !> @copydoc ParameterLists::get_ParamType_SDK_a2
    PROCEDURE,PASS,PRIVATE :: getSDKa2 => get_ParamType_SDK_a2
    !> @copybrief ParameterLists::get_ParamType_SNK_a2
    !> @copydoc ParameterLists::get_ParamType_SNK_a2
    PROCEDURE,PASS,PRIVATE :: getSNKa2 => get_ParamType_SNK_a2
    !> @copybrief ParameterLists::get_ParamType_SLK_a2
    !> @copydoc ParameterLists::get_ParamType_SLK_a2
    PROCEDURE,PASS,PRIVATE :: getSLKa2 => get_ParamType_SLK_a2
    !> @copybrief ParameterLists::get_ParamType_STR_a2
    !> @copydoc ParameterLists::get_ParamType_STR_a2
    PROCEDURE,PASS,PRIVATE :: getSTRa2 => get_ParamType_STR_a2
    !> @copybrief ParameterLists::get_ParamType_SSK_a3
    !> @copydoc ParameterLists::get_ParamType_SSK_a3
    PROCEDURE,PASS,PRIVATE :: getSSKa3 => get_ParamType_SSK_a3
    !> @copybrief ParameterLists::get_ParamType_SDK_a3
    !> @copydoc ParameterLists::get_ParamType_SDK_a3
    PROCEDURE,PASS,PRIVATE :: getSDKa3 => get_ParamType_SDK_a3
    !> @copybrief ParameterLists::get_ParamType_SNK_a3
    !> @copydoc ParameterLists::get_ParamType_SNK_a3
    PROCEDURE,PASS,PRIVATE :: getSNKa3 => get_ParamType_SNK_a3
    !> @copybrief ParameterLists::get_ParamType_SLK_a3
    !> @copydoc ParameterLists::get_ParamType_SLK_a3
    PROCEDURE,PASS,PRIVATE :: getSLKa3 => get_ParamType_SLK_a3
488
489
490
    !> @copybrief ParameterLists::get_ParamType_STR_a3
    !> @copydoc ParameterLists::get_ParamType_STR_a3
    PROCEDURE,PASS,PRIVATE :: getSTRa3 => get_ParamType_STR_a3
Graham, Aaron's avatar
Graham, Aaron committed
491
492
493
494
495
496
497
498
499
500
501
502
    !> @copybrief ParameterLists::get_ParamType_SSK_a4
    !> @copydoc ParameterLists::get_ParamType_SSK_a4
    PROCEDURE,PASS,PRIVATE :: getSSKa4 => get_ParamType_SSK_a4
    !> @copybrief ParameterLists::get_ParamType_SDK_a4
    !> @copydoc ParameterLists::get_ParamType_SDK_a4
    PROCEDURE,PASS,PRIVATE :: getSDKa4 => get_ParamType_SDK_a4
    !> @copybrief ParameterLists::get_ParamType_SNK_a4
    !> @copydoc ParameterLists::get_ParamType_SNK_a4
    PROCEDURE,PASS,PRIVATE :: getSNKa4 => get_ParamType_SNK_a4
    !> @copybrief ParameterLists::get_ParamType_SLK_a4
    !> @copydoc ParameterLists::get_ParamType_SLK_a4
    PROCEDURE,PASS,PRIVATE :: getSLKa4 => get_ParamType_SLK_a4
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::get_ParamType_SSK_a5
    !> @copydoc ParameterLists::get_ParamType_SSK_a5
    PROCEDURE,PASS,PRIVATE :: getSSKa5 => get_ParamType_SSK_a5
    !> @copybrief ParameterLists::get_ParamType_SDK_a5
    !> @copydoc ParameterLists::get_ParamType_SDK_a5
    PROCEDURE,PASS,PRIVATE :: getSDKa5 => get_ParamType_SDK_a5
    !> @copybrief ParameterLists::get_ParamType_SNK_a5
    !> @copydoc ParameterLists::get_ParamType_SNK_a5
    PROCEDURE,PASS,PRIVATE :: getSNKa5 => get_ParamType_SNK_a5
    !> @copybrief ParameterLists::get_ParamType_SLK_a5
    !> @copydoc ParameterLists::get_ParamType_SLK_a5
    PROCEDURE,PASS,PRIVATE :: getSLKa5 => get_ParamType_SLK_a5
    !> @copybrief ParameterLists::get_ParamType_SSK_a6
    !> @copydoc ParameterLists::get_ParamType_SSK_a6
    PROCEDURE,PASS,PRIVATE :: getSSKa6 => get_ParamType_SSK_a6
    !> @copybrief ParameterLists::get_ParamType_SDK_a6
    !> @copydoc ParameterLists::get_ParamType_SDK_a6
    PROCEDURE,PASS,PRIVATE :: getSDKa6 => get_ParamType_SDK_a6
    !> @copybrief ParameterLists::get_ParamType_SNK_a6
    !> @copydoc ParameterLists::get_ParamType_SNK_a6
    PROCEDURE,PASS,PRIVATE :: getSNKa6 => get_ParamType_SNK_a6
    !> @copybrief ParameterLists::get_ParamType_SLK_a6
    !> @copydoc ParameterLists::get_ParamType_SLK_a6
    PROCEDURE,PASS,PRIVATE :: getSLKa6 => get_ParamType_SLK_a6
    !> @copybrief ParameterLists::get_ParamType_SSK_a7
    !> @copydoc ParameterLists::get_ParamType_SSK_a7
    PROCEDURE,PASS,PRIVATE :: getSSKa7 => get_ParamType_SSK_a7
    !> @copybrief ParameterLists::get_ParamType_SDK_a7
    !> @copydoc ParameterLists::get_ParamType_SDK_a7
    PROCEDURE,PASS,PRIVATE :: getSDKa7 => get_ParamType_SDK_a7
    !> @copybrief ParameterLists::get_ParamType_SNK_a7
    !> @copydoc ParameterLists::get_ParamType_SNK_a7
    PROCEDURE,PASS,PRIVATE :: getSNKa7 => get_ParamType_SNK_a7
    !> @copybrief ParameterLists::get_ParamType_SLK_a7
    !> @copydoc ParameterLists::get_ParamType_SLK_a7
    PROCEDURE,PASS,PRIVATE :: getSLKa7 => get_ParamType_SLK_a7
Graham, Aaron's avatar
Graham, Aaron committed
539
540
541
542
    !> Generic type bound interface for all @c get operations
    GENERIC :: get => getParam,getParamList,getSSK,getSDK,getSNK, &
        getSLK,getSBK,getSTR,getCHAR,getSSKa1,getSDKa1,getSNKa1, &
        getSBKa1,getSLKa1,getSTRa1,getSSKa2,getSDKa2,getSNKa2, &
Graham, Aaron's avatar
Graham, Aaron committed
543
        getSLKa2,getSTRa2,getSSKa3,getSDKa3,getSNKa3,getSLKa3, &
544
545
        getSTRa3,getSSKa4,getSDKa4,getSNKa4,getSLKa4,getSSKa5, &
        getSDKa5,getSNKa5,getSLKa5,getSSKa6,getSDKa6,getSNKa6, &
546
547
548
549
        getSLKa6,getSSKa7,getSDKa7,getSNKa7,getSLKa7,getSTRCHAR
    !> @copybrief ParameterLists::get_ParamType_hash
    !> @copydoc ParameterLists::get_ParamType_hash
    PROCEDURE,PASS,PRIVATE :: getParam_hash => get_ParamType_hash
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::add_ParamType
    !> @copydoc ParameterLists::add_ParamType
    PROCEDURE,PASS,PRIVATE :: addParam => add_ParamType
    !> @copybrief ParameterLists::add_ParamType_List
    !> @copydoc ParameterLists::add_ParamType_List
    PROCEDURE,PASS,PRIVATE :: addList => add_ParamType_List
    !> @copybrief ParameterLists::add_ParamType_SSK
    !> @copydoc ParameterLists::add_ParamType_SSK
    PROCEDURE,PASS,PRIVATE :: addSSK => add_ParamType_SSK
    !> @copybrief ParameterLists::add_ParamType_SDK
    !> @copydoc ParameterLists::add_ParamType_SDK
    PROCEDURE,PASS,PRIVATE :: addSDK => add_ParamType_SDK
    !> @copybrief ParameterLists::add_ParamType_SNK
    !> @copydoc ParameterLists::add_ParamType_SNK
    PROCEDURE,PASS,PRIVATE :: addSNK => add_ParamType_SNK
    !> @copybrief ParameterLists::add_ParamType_SLK
    !> @copydoc ParameterLists::add_ParamType_SLK
    PROCEDURE,PASS,PRIVATE :: addSLK => add_ParamType_SLK
    !> @copybrief ParameterLists::add_ParamType_SBK
    !> @copydoc ParameterLists::add_ParamType_SBK
    PROCEDURE,PASS,PRIVATE :: addSBK => add_ParamType_SBK
    !> @copybrief ParameterLists::add_ParamType_STR
    !> @copydoc ParameterLists::add_ParamType_STR
    PROCEDURE,PASS,PRIVATE :: addSTR => add_ParamType_STR
    !> @copybrief ParameterLists::add_ParamType_CHAR
    !> @copydoc ParameterLists::add_ParamType_CHAR
    PROCEDURE,PASS,PRIVATE :: addCHAR => add_ParamType_CHAR
    !> @copybrief ParameterLists::add_ParamType_SSK_a1
    !> @copydoc ParameterLists::add_ParamType_SSK_a1
    PROCEDURE,PASS,PRIVATE :: addSSKa1 => add_ParamType_SSK_a1
    !> @copybrief ParameterLists::add_ParamType_SDK_a1
    !> @copydoc ParameterLists::add_ParamType_SDK_a1
    PROCEDURE,PASS,PRIVATE :: addSDKa1 => add_ParamType_SDK_a1
    !> @copybrief ParameterLists::add_ParamType_SNK_a1
    !> @copydoc ParameterLists::add_ParamType_SNK_a1
    PROCEDURE,PASS,PRIVATE :: addSNKa1 => add_ParamType_SNK_a1
    !> @copybrief ParameterLists::add_ParamType_SLK_a1
    !> @copydoc ParameterLists::add_ParamType_SLK_a1
    PROCEDURE,PASS,PRIVATE :: addSLKa1 => add_ParamType_SLK_a1
    !> @copybrief ParameterLists::add_ParamType_SBK_a1
    !> @copydoc ParameterLists::add_ParamType_SBK_a1
    PROCEDURE,PASS,PRIVATE :: addSBKa1 => add_ParamType_SBK_a1
    !> @copybrief ParameterLists::add_ParamType_STR_a1
    !> @copydoc ParameterLists::add_ParamType_STR_a1
    PROCEDURE,PASS,PRIVATE :: addSTRa1 => add_ParamType_STR_a1
    !> @copybrief ParameterLists::add_ParamType_SSK_a2
    !> @copydoc ParameterLists::add_ParamType_SSK_a2
    PROCEDURE,PASS,PRIVATE :: addSSKa2 => add_ParamType_SSK_a2
    !> @copybrief ParameterLists::add_ParamType_SDK_a2
    !> @copydoc ParameterLists::add_ParamType_SDK_a2
    PROCEDURE,PASS,PRIVATE :: addSDKa2 => add_ParamType_SDK_a2
    !> @copybrief ParameterLists::add_ParamType_SNK_a2
    !> @copydoc ParameterLists::add_ParamType_SNK_a2
    PROCEDURE,PASS,PRIVATE :: addSNKa2 => add_ParamType_SNK_a2
    !> @copybrief ParameterLists::add_ParamType_SLK_a2
    !> @copydoc ParameterLists::add_ParamType_SLK_a2
    PROCEDURE,PASS,PRIVATE :: addSLKa2 => add_ParamType_SLK_a2
    !> @copybrief ParameterLists::add_ParamType_STR_a2
    !> @copydoc ParameterLists::add_ParamType_STR_a2
    PROCEDURE,PASS,PRIVATE :: addSTRa2 => add_ParamType_STR_a2
    !> @copybrief ParameterLists::add_ParamType_SSK_a3
    !> @copydoc ParameterLists::add_ParamType_SSK_a3
    PROCEDURE,PASS,PRIVATE :: addSSKa3 => add_ParamType_SSK_a3
    !> @copybrief ParameterLists::add_ParamType_SDK_a3
    !> @copydoc ParameterLists::add_ParamType_SDK_a3
    PROCEDURE,PASS,PRIVATE :: addSDKa3 => add_ParamType_SDK_a3
    !> @copybrief ParameterLists::add_ParamType_SNK_a3
    !> @copydoc ParameterLists::add_ParamType_SNK_a3
    PROCEDURE,PASS,PRIVATE :: addSNKa3 => add_ParamType_SNK_a3
    !> @copybrief ParameterLists::add_ParamType_SLK_a3
    !> @copydoc ParameterLists::add_ParamType_SLK_a3
    PROCEDURE,PASS,PRIVATE :: addSLKa3 => add_ParamType_SLK_a3
622
623
624
    !> @copybrief ParameterLists::add_ParamType_STR_a3
    !> @copydoc ParameterLists::add_ParamType_STR_a3
    PROCEDURE,PASS,PRIVATE :: addSTRa3 => add_ParamType_STR_a3
Graham, Aaron's avatar
Graham, Aaron committed
625
626
627
628
629
630
631
632
633
634
635
636
    !> @copybrief ParameterLists::add_ParamType_SSK_a4
    !> @copydoc ParameterLists::add_ParamType_SSK_a4
    PROCEDURE,PASS,PRIVATE :: addSSKa4 => add_ParamType_SSK_a4
    !> @copybrief ParameterLists::add_ParamType_SDK_a4
    !> @copydoc ParameterLists::add_ParamType_SDK_a4
    PROCEDURE,PASS,PRIVATE :: addSDKa4 => add_ParamType_SDK_a4
    !> @copybrief ParameterLists::add_ParamType_SNK_a4
    !> @copydoc ParameterLists::add_ParamType_SNK_a4
    PROCEDURE,PASS,PRIVATE :: addSNKa4 => add_ParamType_SNK_a4
    !> @copybrief ParameterLists::add_ParamType_SLK_a4
    !> @copydoc ParameterLists::add_ParamType_SLK_a4
    PROCEDURE,PASS,PRIVATE :: addSLKa4 => add_ParamType_SLK_a4
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::add_ParamType_SSK_a5
    !> @copydoc ParameterLists::add_ParamType_SSK_a5
    PROCEDURE,PASS,PRIVATE :: addSSKa5 => add_ParamType_SSK_a5
    !> @copybrief ParameterLists::add_ParamType_SDK_a5
    !> @copydoc ParameterLists::add_ParamType_SDK_a5
    PROCEDURE,PASS,PRIVATE :: addSDKa5 => add_ParamType_SDK_a5
    !> @copybrief ParameterLists::add_ParamType_SNK_a5
    !> @copydoc ParameterLists::add_ParamType_SNK_a5
    PROCEDURE,PASS,PRIVATE :: addSNKa5 => add_ParamType_SNK_a5
    !> @copybrief ParameterLists::add_ParamType_SLK_a5
    !> @copydoc ParameterLists::add_ParamType_SLK_a5
    PROCEDURE,PASS,PRIVATE :: addSLKa5 => add_ParamType_SLK_a5
    !> @copybrief ParameterLists::add_ParamType_SSK_a6
    !> @copydoc ParameterLists::add_ParamType_SSK_a6
    PROCEDURE,PASS,PRIVATE :: addSSKa6 => add_ParamType_SSK_a6
    !> @copybrief ParameterLists::add_ParamType_SDK_a6
    !> @copydoc ParameterLists::add_ParamType_SDK_a6
    PROCEDURE,PASS,PRIVATE :: addSDKa6 => add_ParamType_SDK_a6
    !> @copybrief ParameterLists::add_ParamType_SNK_a6
    !> @copydoc ParameterLists::add_ParamType_SNK_a6
    PROCEDURE,PASS,PRIVATE :: addSNKa6 => add_ParamType_SNK_a6
    !> @copybrief ParameterLists::add_ParamType_SLK_a6
    !> @copydoc ParameterLists::add_ParamType_SLK_a6
    PROCEDURE,PASS,PRIVATE :: addSLKa6 => add_ParamType_SLK_a6
    !> @copybrief ParameterLists::add_ParamType_SSK_a7
    !> @copydoc ParameterLists::add_ParamType_SSK_a7
    PROCEDURE,PASS,PRIVATE :: addSSKa7 => add_ParamType_SSK_a7
    !> @copybrief ParameterLists::add_ParamType_SDK_a7
    !> @copydoc ParameterLists::add_ParamType_SDK_a7
    PROCEDURE,PASS,PRIVATE :: addSDKa7 => add_ParamType_SDK_a7
    !> @copybrief ParameterLists::add_ParamType_SNK_a7
    !> @copydoc ParameterLists::add_ParamType_SNK_a7
    PROCEDURE,PASS,PRIVATE :: addSNKa7 => add_ParamType_SNK_a7
    !> @copybrief ParameterLists::add_ParamType_SLK_a7
    !> @copydoc ParameterLists::add_ParamType_SLK_a7
    PROCEDURE,PASS,PRIVATE :: addSLKa7 => add_ParamType_SLK_a7
Graham, Aaron's avatar
Graham, Aaron committed
673
674
675
676
    !> Generic type bound interface for all @c add operations
    GENERIC :: add => addParam,addList,addSSK,addSDK, &
        addSNK,addSLK,addSBK,addSTR,addCHAR,addSSKa1,addSDKa1, &
        addSNKa1,addSLKa1,addSBKa1,addSTRa1,addSSKa2,addSDKa2, &
Graham, Aaron's avatar
Graham, Aaron committed
677
        addSNKa2,addSLKa2,addSTRa2,addSSKa3,addSDKa3,addSNKa3,addSLKa3, &
678
679
680
        addSTRa3,addSSKa4,addSDKa4,addSNKa4,addSLKa4,addSSKa5, &
        addSDKa5,addSNKa5,addSLKa5,addSSKa6,addSDKa6,addSNKa6, &
        addSLKa6,addSSKa7,addSDKa7,addSNKa7,addSLKa7
Graham, Aaron's avatar
Graham, Aaron committed
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
    !> @copybrief ParameterLists::remove_ParamType
    !> @copydoc ParameterLists::remove_ParamType
    PROCEDURE,PASS :: remove => remove_ParamType
    !> @copybrief ParameterLists::getString_ParamType_scalar
    !> @copydoc ParameterLists::getString_scalar_ParamType_scalar
    PROCEDURE,PASS,PRIVATE :: getString_scalar => getString_ParamType_scalar
    !> @copybrief ParameterLists::getString_ParamType_a1
    !> @copydoc ParameterLists::getString_ParamType_a1
    PROCEDURE,PASS,PRIVATE :: getString_a1 => getString_ParamType_a1
    !> @copybrief ParameterLists::getString_ParamType_a2
    !> @copydoc ParameterLists::getString_ParamType_a2
    PROCEDURE,PASS,PRIVATE :: getString_a2 => getString_ParamType_a2
    !> @copybrief ParameterLists::getString_ParamType_a3
    !> @copydoc ParameterLists::getString_ParamType_a3
    PROCEDURE,PASS,PRIVATE :: getString_a3 => getString_ParamType_a3
    !> Generic type bound interface for all @c getString operations
    GENERIC :: getString => getString_scalar,getString_a1,getString_a2,getString_a3
    !> @copybrief ParameterLists::has_ParamType
    !> @copydoc ParameterLists::has_ParamType
    PROCEDURE,PASS :: has => has_ParamType
    !> @copybrief ParameterLists::convertTo2DStringArray_ParamType
    !> @copydoc ParameterLists::convertTo2DStringArray_ParamType
    PROCEDURE,PASS :: convertTo2DStringArray => convertTo2DStringArray_ParamType
    !> @copybrief ParameterLists::getNextParam_ParamType
    !> @copydoc ParameterLists::getNextParam_ParamType
    PROCEDURE,PASS :: getNextParam => getNextParam_ParamType
    !> @copybrief ParameterLists::getSubParam_List
    !> @copydoc ParameterLists::getSubParam_List
    PROCEDURE,PASS :: getSubPL => getSubParam_List
    !> @copybrief ParameterLists::getSubParams
    !> @copydoc ParameterLists::getSubParams
    PROCEDURE,PASS :: getSubParams => getSubParams
    !> @copybrief ParameterLists::validate_ParamType
    !> @copydoc ParameterLists::validate_ParamType
    PROCEDURE,PASS :: validate => validate_ParamType
    !> @copybrief ParameterLists::verifyTest_ParamType
    !> @copydoc ParameterLists::verifyTest_ParamType
    PROCEDURE,PASS :: verify => verifyTest_ParamType
    !> @copybrief ParameterLists::verifyTest_ParamType
    !> @copydoc ParameterLists::verifyTest_ParamType
    PROCEDURE,PASS :: verifyList => verifyList_ParamType
    !> @copybrief ParameterLists::edit_ParamType
    !> @copydoc ParameterLists::edit_ParamType
    PROCEDURE,PASS :: edit => edit_ParamType
    !> @copybrief ParameterLists::editToXML_ParamType
    !> @copydoc ParameterLists::editToXML_ParamType
    PROCEDURE,PASS :: editToXML => editToXML_ParamType
    !> @copybrief ParameterLists::clear_ParamType
    !> @copydoc ParameterLists::clear_ParamType
    PROCEDURE,PASS :: clear => clear_ParamType
731
732
733
    !> @copybrief ParameterLists::clear_ParamType
    !> @copydoc ParameterLists::clear_ParamType
    PROCEDURE,PASS :: clearBase => clear_ParamType
734
#ifdef FUTILITY_HAVE_Trilinos
Graham, Aaron's avatar
Graham, Aaron committed
735
    PROCEDURE,PASS :: toTeuchosPlist
736
#endif
Graham, Aaron's avatar
Graham, Aaron committed
737
PROCEDURE :: procXMLTree
William Gurecky's avatar
William Gurecky committed
738
PROCEDURE :: procFMUXMLTree
Graham, Aaron's avatar
Graham, Aaron committed
739
ENDTYPE ParamType
740

Graham, Aaron's avatar
Graham, Aaron committed
741
742
743
744
745
746
!> @brief Wrapper type for an array of ParamType pointers
TYPE :: ParamTypePtr
  !> Pointer to the ParamType
  CLASS(ParamType),POINTER :: p => NULL()
ENDTYPE ParamTypePtr

Graham, Aaron's avatar
Graham, Aaron committed
747
748
749
750
!> @brief Extended type of a ParamType for defining a list of parameters
TYPE,EXTENDS(ParamType) :: ParamType_List
  !> The list of parameters
  TYPE(ParamType),ALLOCATABLE :: pList(:)
751
752
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_List
    !> @copydoc ParameterLists::edit_ParamType_List
    PROCEDURE,PASS :: edit => edit_ParamType_List
    !> @copybrief ParameterLists::clear_ParamType_List
    !> @copydoc ParameterLists::clear_ParamType_List
    PROCEDURE,PASS :: clear => clear_ParamType_List
ENDTYPE ParamType_List

!> @brief Extended type of a ParamType for defining a parameter that
!> is a single precision real scalar
TYPE,EXTENDS(ParamType) :: ParamType_SSK
  !> The value of the parameter
  REAL(SSK) :: val=0.0_SSK
767
768
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
769
770
771
772
773
774
775
776
777
778
779
780
781
782
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SSK
    !> @copydoc ParameterLists::edit_ParamType_SSK
    PROCEDURE,PASS :: edit => edit_ParamType_SSK
    !> @copybrief ParameterLists::clear_ParamType_SSK
    !> @copydoc ParameterLists::clear_ParamType_SSK
    PROCEDURE,PASS :: clear => clear_ParamType_SSK
ENDTYPE ParamType_SSK

!> @brief Extended type of a ParamType for defining a parameter that
!> is a double precision real scalar
TYPE,EXTENDS(ParamType) :: ParamType_SDK
  !> The value of the parameter
  REAL(SDK) :: val=0.0_SDK
783
784
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SDK
    !> @copydoc ParameterLists::edit_ParamType_SDK
    PROCEDURE,PASS :: edit => edit_ParamType_SDK
    !> @copybrief ParameterLists::clear_ParamType_SDK
    !> @copydoc ParameterLists::clear_ParamType_SDK
    PROCEDURE,PASS :: clear => clear_ParamType_SDK
ENDTYPE ParamType_SDK

!> @brief Extended type of a ParamType for defining a parameter that
!> is a 32-bit integer scalar
TYPE,EXTENDS(ParamType) :: ParamType_SNK
  !> The value of the parameter
  INTEGER(SNK) :: val=0_SNK
799
800
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
801
802
803
804
805
806
807
808
809
810
811
812
813
814
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SNK
    !> @copydoc ParameterLists::edit_ParamType_SNK
    PROCEDURE,PASS :: edit => edit_ParamType_SNK
    !> @copybrief ParameterLists::clear_ParamType_SNK
    !> @copydoc ParameterLists::clear_ParamType_SNK
    PROCEDURE,PASS :: clear => clear_ParamType_SNK
ENDTYPE ParamType_SNK

!> @brief Extended type of a ParamType for defining a parameter that
!> is a 64-bit integer scalar
TYPE,EXTENDS(ParamType) :: ParamType_SLK
  !> The value of the parameter
  INTEGER(SLK) :: val=0_SLK
815
816
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
817
818
819
820
821
822
823
824
825
826
827
828
829
830
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SLK
    !> @copydoc ParameterLists::edit_ParamType_SLK
    PROCEDURE,PASS :: edit => edit_ParamType_SLK
    !> @copybrief ParameterLists::clear_ParamType_SLK
    !> @copydoc ParameterLists::clear_ParamType_SLK
    PROCEDURE,PASS :: clear => clear_ParamType_SLK
ENDTYPE ParamType_SLK

!> @brief Extended type of a ParamType for defining a parameter that
!> is a logical scalar
TYPE,EXTENDS(ParamType) :: ParamType_SBK
  !> The value of the parameter
  LOGICAL(SBK) :: val=.FALSE.
831
832
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
833
834
835
836
837
838
839
840
841
842
843
844
845
846
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SBK
    !> @copydoc ParameterLists::edit_ParamType_SBK
    PROCEDURE,PASS :: edit => edit_ParamType_SBK
    !> @copybrief ParameterLists::clear_ParamType_SBK
    !> @copydoc ParameterLists::clear_ParamType_SBK
    PROCEDURE,PASS :: clear => clear_ParamType_SBK
ENDTYPE ParamType_SBK

!> @brief Extended type of a ParamType for defining a parameter that
!> is a string derived type
TYPE,EXTENDS(ParamType) :: ParamType_STR
  !> The value of the parameter
  TYPE(StringType) :: val
847
848
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
849
850
851
852
853
854
855
856
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_STR
    !> @copydoc ParameterLists::edit_ParamType_STR
    PROCEDURE,PASS :: edit => edit_ParamType_STR
    !> @copybrief ParameterLists::clear_ParamType_STR
    !> @copydoc ParameterLists::clear_ParamType_STR
    PROCEDURE,PASS :: clear => clear_ParamType_STR
ENDTYPE ParamType_STR
857
858
859
!----------------------------------------------------------------------
!     One-Dimensional Arrays
!----------------------------------------------------------------------
Graham, Aaron's avatar
Graham, Aaron committed
860
861
862
863
864
!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter of single precision reals
TYPE,EXTENDS(ParamType) :: ParamType_SSK_a1
  !> The value of the parameter
  REAL(SSK),ALLOCATABLE :: val(:)
865
866
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
867
868
869
870
871
872
873
874
875
876
877
878
879
880
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SSK_a1
    !> @copydoc ParameterLists::edit_ParamType_SSK_a1
    PROCEDURE,PASS :: edit => edit_ParamType_SSK_a1
    !> @copybrief ParameterLists::clear_ParamType_SSK_a1
    !> @copydoc ParameterLists::clear_ParamType_SSK_a1
    PROCEDURE,PASS :: clear => clear_ParamType_SSK_a1
ENDTYPE ParamType_SSK_a1

!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter of double precision reals
TYPE,EXTENDS(ParamType) :: ParamType_SDK_a1
  !> The value of the parameter
  REAL(SDK),ALLOCATABLE :: val(:)
881
882
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
883
884
885
886
887
888
889
890
891
892
893
894
895
896
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SDK_a1
    !> @copydoc ParameterLists::edit_ParamType_SDK_a1
    PROCEDURE,PASS :: edit => edit_ParamType_SDK_a1
    !> @copybrief ParameterLists::clear_ParamType_SDK_a1
    !> @copydoc ParameterLists::clear_ParamType_SDK_a1
    PROCEDURE,PASS :: clear => clear_ParamType_SDK_a1
ENDTYPE ParamType_SDK_a1

!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter of 32-bit integers
TYPE,EXTENDS(ParamType) :: ParamType_SNK_a1
  !> The value of the parameter
  INTEGER(SNK),ALLOCATABLE :: val(:)
897
898
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
899
900
901
902
903
904
905
906
907
908
909
910
911
912
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SNK_a1
    !> @copydoc ParameterLists::edit_ParamType_SNK_a1
    PROCEDURE,PASS :: edit => edit_ParamType_SNK_a1
    !> @copybrief ParameterLists::clear_ParamType_SNK_a1
    !> @copydoc ParameterLists::clear_ParamType_SNK_a1
    PROCEDURE,PASS :: clear => clear_ParamType_SNK_a1
ENDTYPE ParamType_SNK_a1

!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter of 64-bit integers
TYPE,EXTENDS(ParamType) :: ParamType_SLK_a1
  !> The value of the parameter
  INTEGER(SLK),ALLOCATABLE :: val(:)
913
914
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SLK_a1
    !> @copydoc ParameterLists::edit_ParamType_SLK_a1
    PROCEDURE,PASS :: edit => edit_ParamType_SLK_a1
    !> @copybrief ParameterLists::clear_ParamType_SLK_a1
    !> @copydoc ParameterLists::clear_ParamType_SLK_a1
    PROCEDURE,PASS :: clear => clear_ParamType_SLK_a1
ENDTYPE ParamType_SLK_a1

!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter of single precision reals
TYPE,EXTENDS(ParamType) :: ParamType_SBK_a1
  !> The value of the parameter
  LOGICAL(SBK),ALLOCATABLE :: val(:)
929
930
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
931
932
933
934
935
936
937
938
939
940
941
942
943
944
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SBK_a1
    !> @copydoc ParameterLists::edit_ParamType_SBK_a1
    PROCEDURE,PASS :: edit => edit_ParamType_SBK_a1
    !> @copybrief ParameterLists::clear_ParamType_SBK_a1
    !> @copydoc ParameterLists::clear_ParamType_SBK_a1
    PROCEDURE,PASS :: clear => clear_ParamType_SBK_a1
ENDTYPE ParamType_SBK_a1

!> @brief Extended type of a ParamType for defining a one dimensional
!> array parameter that is a string derived type
TYPE,EXTENDS(ParamType) :: ParamType_STR_a1
  !> The value of the parameter
  TYPE(StringType),ALLOCATABLE :: val(:)
945
946
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
947
948
949
950
951
952
953
954
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_STR_a1
    !> @copydoc ParameterLists::edit_ParamType_STR_a1
    PROCEDURE,PASS :: edit => edit_ParamType_STR_a1
    !> @copybrief ParameterLists::clear_ParamType_STR_a1
    !> @copydoc ParameterLists::clear_ParamType_STR_a1
    PROCEDURE,PASS :: clear => clear_ParamType_STR_a1
ENDTYPE ParamType_STR_a1
955

956
957
958
!----------------------------------------------------------------------
!     Two-Dimensional Arrays
!----------------------------------------------------------------------
Graham, Aaron's avatar
Graham, Aaron committed
959
960
961
962
963
!> @brief Extended type of a ParamType for defining a two dimensional
!> array parameter of single precision reals
TYPE,EXTENDS(ParamType) :: ParamType_SSK_a2
  !> The value of the parameter
  REAL(SSK),ALLOCATABLE :: val(:,:)
964
965
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SSK_a2
    !> @copydoc ParameterLists::edit_ParamType_SSK_a2
    PROCEDURE,PASS :: edit => edit_ParamType_SSK_a2
    !> @copybrief ParameterLists::clear_ParamType_SSK_a2
    !> @copydoc ParameterLists::clear_ParamType_SSK_a2
    PROCEDURE,PASS :: clear => clear_ParamType_SSK_a2
ENDTYPE ParamType_SSK_a2

!> @brief Extended type of a ParamType for defining a two dimensional
!> array parameter of double precision reals
TYPE,EXTENDS(ParamType) :: ParamType_SDK_a2
  !> The value of the parameter
  REAL(SDK),ALLOCATABLE :: val(:,:)
980
981
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
982
983
984
985
986
987
988
989
990
991
992
993
994
995
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SDK_a2
    !> @copydoc ParameterLists::edit_ParamType_SDK_a2
    PROCEDURE,PASS :: edit => edit_ParamType_SDK_a2
    !> @copybrief ParameterLists::clear_ParamType_SDK_a2
    !> @copydoc ParameterLists::clear_ParamType_SDK_a2
    PROCEDURE,PASS :: clear => clear_ParamType_SDK_a2
ENDTYPE ParamType_SDK_a2

!> @brief Extended type of a ParamType for defining a two dimensional
!> array parameter of 32-bit integers
TYPE,EXTENDS(ParamType) :: ParamType_SNK_a2
  !> The value of the parameter
  INTEGER(SNK),ALLOCATABLE :: val(:,:)
996
997
!
!List of type bound procedures
Graham, Aaron's avatar
Graham, Aaron committed
998
999
1000
  CONTAINS
    !> @copybrief ParameterLists::edit_ParamType_SNK_a2
    !> @copydoc ParameterLists::edit_ParamType_SNK_a2