File: kim_model_driver_create_module.f90

package info (click to toggle)
kim-api 2.0~beta2.gita734d1-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,944 kB
  • sloc: cpp: 22,447; f90: 13,218; ansic: 3,865; sh: 1,960; makefile: 298
file content (347 lines) | stat: -rw-r--r-- 15,875 bytes parent folder | download
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
!
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the Common Development
! and Distribution License Version 1.0 (the "License").
!
! You can obtain a copy of the license at
! http://www.opensource.org/licenses/CDDL-1.0.  See the License for the
! specific language governing permissions and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each file and
! include the License file in a prominent location with the name LICENSE.CDDL.
! If applicable, add the following below this CDDL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
!
! Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
!
! CDDL HEADER END
!

!
! Copyright (c) 2016--2018, Regents of the University of Minnesota.
! All rights reserved.
!
! Contributors:
!    Ryan S. Elliott
!

!
! Release: This file is part of the kim-api.git repository.
!


module kim_model_driver_create_module
  use, intrinsic :: iso_c_binding
  implicit none
  private

  public &
    kim_model_driver_create_handle_type, &
    kim_model_driver_create_null_handle, &
    operator (.eq.), &
    operator (.ne.), &
    kim_model_driver_create_get_number_of_parameter_files, &
    kim_model_driver_create_get_parameter_file_name, &
    kim_model_driver_create_set_model_numbering, &
    kim_model_driver_create_set_influence_distance_pointer, &
    kim_model_driver_create_set_neighbor_list_pointers, &
    kim_model_driver_create_set_refresh_pointer, &
    kim_model_driver_create_set_destroy_pointer, &
    kim_model_driver_create_set_compute_arguments_create_pointer, &
    kim_model_driver_create_set_compute_arguments_destroy_pointer, &
    kim_model_driver_create_set_compute_pointer, &
    kim_model_driver_create_set_species_code, &
    kim_model_driver_create_set_parameter_pointer, &
    kim_model_driver_create_set_model_buffer_pointer, &
    kim_model_driver_create_set_units, &
    kim_model_driver_create_convert_unit, &
    kim_model_driver_create_log_entry, &
    kim_model_driver_create_string

  type, bind(c) :: kim_model_driver_create_handle_type
    type(c_ptr) :: p = c_null_ptr
  end type kim_model_driver_create_handle_type

  type(kim_model_driver_create_handle_type), protected, save &
    :: kim_model_driver_create_null_handle

  interface operator (.eq.)
    logical function kim_model_driver_create_handle_equal(left, right)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) :: left
      type(kim_model_driver_create_handle_type), intent(in) :: right
    end function kim_model_driver_create_handle_equal
  end interface operator (.eq.)

  interface operator (.ne.)
    logical function kim_model_driver_createhandle_not_equal(left, right)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) :: left
      type(kim_model_driver_create_handle_type), intent(in) :: right
    end function kim_model_driver_createhandle_not_equal
  end interface operator (.ne.)

  interface kim_model_driver_create_set_parameter_pointer
    subroutine kim_model_driver_create_set_parameter_pointer_integer( &
      model_driver_create_handle, int1, description, ierr)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      integer(c_int), intent(in), target :: int1(:)
      character(len=*, kind=c_char), intent(in) :: description
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_parameter_pointer_integer

    subroutine kim_model_driver_create_set_parameter_pointer_double( &
      model_driver_create_handle, double1, description, ierr)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      real(c_double), intent(in), target :: double1(:)
      character(len=*, kind=c_char), intent(in) :: description
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_parameter_pointer_double
  end interface kim_model_driver_create_set_parameter_pointer

  interface
    subroutine kim_model_driver_create_get_number_of_parameter_files( &
      model_driver_create_handle, number_of_parameter_files)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      integer(c_int), intent(out) :: number_of_parameter_files
    end subroutine kim_model_driver_create_get_number_of_parameter_files

    subroutine kim_model_driver_create_get_parameter_file_name( &
      model_driver_create_handle, index, parameter_file_name, ierr)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      integer(c_int), intent(in), value :: index
      character(len=*, kind=c_char), intent(out) :: parameter_file_name
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_get_parameter_file_name

    subroutine kim_model_driver_create_set_model_numbering( &
      model_driver_create_handle, numbering, ierr)
      use, intrinsic :: iso_c_binding
      use kim_numbering_module, only : kim_numbering_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_numbering_type), intent(in), value :: numbering
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_model_numbering

    subroutine kim_model_driver_create_set_influence_distance_pointer( &
      model_driver_create_handle, influence_distance)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      real(c_double), intent(in), target :: influence_distance
    end subroutine kim_model_driver_create_set_influence_distance_pointer

    subroutine kim_model_driver_create_set_neighbor_list_pointers( &
      model_driver_create_handle, number_of_neighbor_lists, cutoffs, &
      model_will_not_request_neighbors_of_noncontributing_particles)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(inout) &
        :: model_driver_create_handle
      integer(c_int), intent(in), value :: number_of_neighbor_lists
      real(c_double), intent(in), target :: cutoffs(number_of_neighbor_lists)
      integer(c_int), intent(in), target :: &
        model_will_not_request_neighbors_of_noncontributing_particles( &
        number_of_neighbor_lists)
    end subroutine kim_model_driver_create_set_neighbor_list_pointers

    subroutine kim_model_driver_create_set_refresh_pointer( &
      model_driver_create_handle, language_name, fptr, ierr)
      use, intrinsic :: iso_c_binding
      use kim_language_name_module, only : kim_language_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_language_name_type), intent(in), value :: language_name
      type(c_funptr), intent(in), value :: fptr
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_refresh_pointer

    subroutine kim_model_driver_create_set_destroy_pointer( &
      model_driver_create_handle, language_name, fptr, ierr)
      use, intrinsic :: iso_c_binding
      use kim_language_name_module, only : kim_language_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_language_name_type), intent(in), value :: language_name
      type(c_funptr), intent(in), value :: fptr
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_destroy_pointer

    subroutine kim_model_driver_create_set_compute_arguments_create_pointer( &
      model_driver_create_handle, language_name, fptr, ierr)
      use, intrinsic :: iso_c_binding
      use kim_language_name_module, only : kim_language_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_language_name_type), intent(in), value :: language_name
      type(c_funptr), intent(in), value :: fptr
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_compute_arguments_create_pointer

    subroutine kim_model_driver_create_set_compute_arguments_destroy_pointer( &
      model_driver_create_handle, language_name, fptr, ierr)
      use, intrinsic :: iso_c_binding
      use kim_language_name_module, only : kim_language_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_language_name_type), intent(in), value :: language_name
      type(c_funptr), intent(in), value :: fptr
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_compute_arguments_destroy_pointer

    subroutine kim_model_driver_create_set_compute_pointer( &
      model_driver_create_handle, language_name, fptr, ierr)
      use, intrinsic :: iso_c_binding
      use kim_language_name_module, only : kim_language_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_language_name_type), intent(in), value :: language_name
      type(c_funptr), intent(in), value :: fptr
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_compute_pointer

    subroutine kim_model_driver_create_set_species_code( &
      model_driver_create_handle, species_name, code, ierr)
      use, intrinsic :: iso_c_binding
      use kim_species_name_module, only : kim_species_name_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_species_name_type), intent(in), value :: species_name
      integer(c_int), intent(in), value :: code
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_species_code

    subroutine kim_model_driver_create_set_model_buffer_pointer( &
      model_driver_create_handle, ptr)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(c_ptr), intent(in), value :: ptr
    end subroutine kim_model_driver_create_set_model_buffer_pointer

    subroutine kim_model_driver_create_set_units( &
      model_driver_create_handle, length_unit, energy_unit, charge_unit, &
      temperature_unit, time_unit, ierr)
      use, intrinsic :: iso_c_binding
      use kim_unit_system_module, only : &
        kim_length_unit_type, &
        kim_energy_unit_type, &
        kim_charge_unit_type, &
        kim_temperature_unit_type, &
        kim_time_unit_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_length_unit_type), intent(in), value :: length_unit
      type(kim_energy_unit_type), intent(in), value :: energy_unit
      type(kim_charge_unit_type), intent(in), value :: charge_unit
      type(kim_temperature_unit_type), intent(in), value :: temperature_unit
      type(kim_time_unit_type), intent(in), value :: time_unit
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_set_units

    subroutine kim_model_driver_create_convert_unit( &
      model_driver_create_handle, from_length_unit, from_energy_unit, &
      from_charge_unit, from_temperature_unit, from_time_unit, &
      to_length_unit, to_energy_unit, to_charge_unit, to_temperature_unit, &
      to_time_unit, length_exponent, energy_exponent, charge_exponent, &
      temperature_exponent, time_exponent, conversion_factor, ierr)
      use, intrinsic :: iso_c_binding
      use kim_unit_system_module, only : kim_length_unit_type
      use kim_unit_system_module, only : kim_energy_unit_type
      use kim_unit_system_module, only : kim_charge_unit_type
      use kim_unit_system_module, only : kim_temperature_unit_type
      use kim_unit_system_module, only : kim_time_unit_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_length_unit_type), intent(in), value :: from_length_unit
      type(kim_energy_unit_type), intent(in), value :: from_energy_unit
      type(kim_charge_unit_type), intent(in), value :: from_charge_unit
      type(kim_temperature_unit_type), intent(in), value :: &
        from_temperature_unit
      type(kim_time_unit_type), intent(in), value :: from_time_unit
      type(kim_length_unit_type), intent(in), value :: to_length_unit
      type(kim_energy_unit_type), intent(in), value :: to_energy_unit
      type(kim_charge_unit_type), intent(in), value :: to_charge_unit
      type(kim_temperature_unit_type), intent(in), value :: &
        to_temperature_unit
      type(kim_time_unit_type), intent(in), value :: to_time_unit
      real(c_double), intent(in), value :: length_exponent
      real(c_double), intent(in), value :: energy_exponent
      real(c_double), intent(in), value :: charge_exponent
      real(c_double), intent(in), value :: temperature_exponent
      real(c_double), intent(in), value :: time_exponent
      real(c_double), intent(out) :: conversion_factor
      integer(c_int), intent(out) :: ierr
    end subroutine kim_model_driver_create_convert_unit

    subroutine kim_model_driver_create_log_entry( &
      model_driver_create_handle, log_verbosity, message, line_number, &
      file_name)
      use, intrinsic :: iso_c_binding
      use kim_log_verbosity_module, only : kim_log_verbosity_type
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      type(kim_log_verbosity_type), intent(in), value :: log_verbosity
      character(len=*, kind=c_char), intent(in) :: message
      integer(c_int), intent(in), value :: line_number
      character(len=*, kind=c_char), intent(in) :: file_name
    end subroutine kim_model_driver_create_log_entry

    subroutine kim_model_driver_create_string( &
      model_driver_create_handle, string)
      use, intrinsic :: iso_c_binding
      import kim_model_driver_create_handle_type
      implicit none
      type(kim_model_driver_create_handle_type), intent(in) &
        :: model_driver_create_handle
      character(len=*, kind=c_char), intent(out) :: string
    end subroutine kim_model_driver_create_string
  end interface
end module kim_model_driver_create_module