python_fabm.F90 24 KB
Newer Older
Jorn Bruggeman's avatar
Jorn Bruggeman committed
1 2 3 4 5 6 7 8 9 10 11 12 13
#include "fabm_driver.h"
!-----------------------------------------------------------------------
!BOP
!
! !MODULE: Python interface to the Framework for Aquatic Biogeochemical Models (FABM)
!
! !INTERFACE:
   module fabm_python
!
! !DESCRIPTION:
! TODO
!
! !USES:
14
   use iso_c_binding, only: c_double, c_int, c_char, C_NULL_CHAR, c_f_pointer, c_loc, c_ptr
15 16 17

   !DIR$ ATTRIBUTES DLLEXPORT :: STATE_VARIABLE,DIAGNOSTIC_VARIABLE,CONSERVED_QUANTITY

Jorn Bruggeman's avatar
Jorn Bruggeman committed
18 19
   use fabm
   use fabm_config
Jorn Bruggeman's avatar
Jorn Bruggeman committed
20 21
   use fabm_types, only:rk,attribute_length,type_model_list_node,type_base_model, &
                        factory,type_link,type_link_list,type_internal_variable
22
   use fabm_driver, only: type_base_driver, driver
23
   use fabm_properties
Jorn Bruggeman's avatar
Jorn Bruggeman committed
24
   use fabm_python_helper
25
   use fabm_c_helper
Jorn Bruggeman's avatar
Jorn Bruggeman committed
26 27 28 29 30 31

   implicit none
!
! !PUBLIC MEMBER FUNCTIONS:
   public

32
   integer,parameter :: INTERIOR_STATE_VARIABLE        = 1
33 34
   integer,parameter :: SURFACE_STATE_VARIABLE         = 2
   integer,parameter :: BOTTOM_STATE_VARIABLE          = 3
35
   integer,parameter :: INTERIOR_DIAGNOSTIC_VARIABLE   = 4
36 37 38
   integer,parameter :: HORIZONTAL_DIAGNOSTIC_VARIABLE = 5
   integer,parameter :: CONSERVED_QUANTITY             = 6

39
   class (type_model),private,pointer,save :: model => null()
40
   real(8),dimension(:),pointer :: state
Jorn Bruggeman's avatar
Jorn Bruggeman committed
41
   character(len=1024),dimension(:),allocatable :: environment_names,environment_units
42 43
   integer :: index_column_depth
   real(c_double),pointer :: column_depth
44
   type (type_link_list),save :: coupling_link_list
Jorn Bruggeman's avatar
Jorn Bruggeman committed
45

46
   type (type_property_dictionary),save,private :: forced_parameters,forced_couplings
47 48 49

   type,extends(type_base_driver) :: type_python_driver
   contains
50 51
      procedure :: fatal_error => python_driver_fatal_error
      procedure :: log_message => python_driver_log_message
52
   end type
Jorn Bruggeman's avatar
Jorn Bruggeman committed
53 54 55 56 57
!EOP
!-----------------------------------------------------------------------

   contains

58 59 60 61 62 63 64 65 66 67 68 69
   subroutine get_version(length,version_string) bind(c)
!DIR$ ATTRIBUTES DLLEXPORT :: get_version
      use fabm_version, only: fabm_commit_id=>git_commit_id, &
                              fabm_branch_name=>git_branch_name

      integer(c_int),value,intent(in) :: length
      character(kind=c_char)          :: version_string(length)

      call copy_to_c_string(fabm_commit_id//' ('//fabm_branch_name//' branch)', version_string)
   end subroutine get_version


Jorn Bruggeman's avatar
Jorn Bruggeman committed
70 71 72 73 74 75
!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: Initialise the model
!
! !INTERFACE:
76
   subroutine initialize(path) bind(c)
77
!DIR$ ATTRIBUTES DLLEXPORT :: initialize
78
      character(kind=c_char),target,intent(in) :: path(*)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
79 80 81 82 83 84 85 86
!
! !DESCRIPTION:
!
! !REVISION HISTORY:
!  Original author(s): Jorn Bruggeman
!
!EOP
!
87
      character(len=attribute_length),pointer :: ppath
88
      class (type_property),          pointer :: property
Jorn Bruggeman's avatar
Jorn Bruggeman committed
89 90
!-----------------------------------------------------------------------
!BOC
91 92
      call c_f_pointer(c_loc(path), ppath)

93
      if (associated(model)) call finalize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
94

95 96
      if (.not.associated(driver)) allocate(type_python_driver::driver)

97 98 99
      call forced_parameters%finalize()
      call forced_couplings%finalize()

Jorn Bruggeman's avatar
Jorn Bruggeman committed
100
      ! Build FABM model tree (configuration will be read from fabm.yaml).
101 102 103
      allocate(model)
      call fabm_create_model_from_yaml_file(model,path=ppath(:index(ppath,C_NULL_CHAR)-1),parameters=forced_parameters)

104
      ! Get a list of all parameters that had an explicit value specified.
105 106
      property => model%root%parameters%first
      do while (associated(property))
107
         if (.not.model%root%parameters%missing%contains(property%name)) &
108 109 110
            call forced_parameters%set_property(property)
         property => property%next
      end do
Jorn Bruggeman's avatar
Jorn Bruggeman committed
111

112 113 114 115 116 117 118 119
      ! Get a list of all active couplings.
      property => model%root%couplings%first
      do while (associated(property))
         if (.not.model%root%couplings%missing%contains(property%name)) &
            call forced_couplings%set_property(property)
         property => property%next
      end do

Jorn Bruggeman's avatar
Jorn Bruggeman committed
120 121 122
      ! Send information on spatial domain to FABM (this also allocates memory for diagnostics)
      call fabm_set_domain(model)

123
      ! Retrieve arrays to hold values for environmental variables and corresponding metadata.
124 125
      call get_environment_metadata(model,environment_names,environment_units,index_column_depth)
      column_depth => null()
126

127
      call get_couplings(model,coupling_link_list)
128 129 130
   end subroutine initialize
!EOC

131 132 133 134 135 136 137 138 139 140
   subroutine reinitialize()
      type (type_model),           pointer :: newmodel
      type (type_model_list_node), pointer :: node
      class (type_base_model),     pointer :: childmodel
      class (type_property),       pointer :: property,next

      allocate(newmodel)

      ! Transfer forced parameters to root of the model.
      call newmodel%root%parameters%update(forced_parameters)
141
      call newmodel%root%couplings%update(forced_couplings)
142 143 144 145

      ! Re-create original models
      node => model%root%children%first
      do while (associated(node))
146
         if (node%model%user_created) then
147
            call factory%create(node%model%type_name,childmodel)
148
            childmodel%user_created = .true.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
            call newmodel%root%add_child(childmodel,node%model%name,node%model%long_name,configunit=-1)
         end if
         node => node%next
      end do

      ! Clean up old model
      call finalize()
      model => newmodel

      ! Initialize new model
      call fabm_initialize(model)

      ! Removed unused forced parameters from root model.
      property => model%root%parameters%first
      do while (associated(property))
164
         if (.not. model%root%parameters%retrieved%contains(property%name)) then
165 166 167 168 169 170 171 172 173 174 175 176
            next => property%next
            call model%root%parameters%delete(property%name)
            property => next
         else
            property => property%next
         end if
      end do

      ! Send information on spatial domain to FABM (this also allocates memory for diagnostics)
      call fabm_set_domain(model)

      ! Retrieve arrays to hold values for environmental variables and corresponding metadata.
177 178
      call get_environment_metadata(model,environment_names,environment_units,index_column_depth)
      column_depth => null()
179 180

      call get_couplings(model,coupling_link_list)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
181
   end subroutine reinitialize
182

183
   subroutine check_ready() bind(c)
184 185
      !DIR$ ATTRIBUTES DLLEXPORT :: check_ready
      call fabm_check_ready(model)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
186
   end subroutine check_ready
187

188
   integer(c_int) function model_count() bind(c)
189 190 191 192 193 194 195 196 197
      !DIR$ ATTRIBUTES DLLEXPORT :: model_count

      type (type_model_list_node), pointer :: node

      model_count = 0
      node => model%root%children%first
      do while (associated(node))
         model_count = model_count + 1
         node => node%next
Jorn Bruggeman's avatar
Jorn Bruggeman committed
198
      end do
Jorn Bruggeman's avatar
Jorn Bruggeman committed
199
   end function model_count
200

201
   subroutine get_counts(nstate_interior,nstate_surface,nstate_bottom,ndiagnostic_interior,ndiagnostic_horizontal,nconserved, &
202
      ndependencies,nparameters,ncouplings) bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
203
      !DIR$ ATTRIBUTES DLLEXPORT :: get_counts
204 205
      integer(c_int),intent(out) :: nstate_interior,nstate_surface,nstate_bottom
      integer(c_int),intent(out) :: ndiagnostic_interior,ndiagnostic_horizontal
206
      integer(c_int),intent(out) :: nconserved,ndependencies,nparameters,ncouplings
207
      nstate_interior = size(model%state_variables)
208 209
      nstate_surface = size(model%surface_state_variables)
      nstate_bottom = size(model%bottom_state_variables)
210
      ndiagnostic_interior = size(model%diagnostic_variables)
211 212 213 214
      ndiagnostic_horizontal = size(model%horizontal_diagnostic_variables)
      nconserved = size(model%conserved_quantities)
      ndependencies = size(environment_names)
      nparameters = model%root%parameters%size()
215
      ncouplings = coupling_link_list%count()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
216
   end subroutine get_counts
217

218
   subroutine get_variable_metadata(category,index,length,name,units,long_name,path) bind(c)
219
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_metadata
220
      integer(c_int),        intent(in), value             :: category,index,length
221
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name,path
222 223 224 225 226

      class (type_external_variable),pointer :: variable

      ! Get a pointer to the target variable
      select case (category)
227
      case (INTERIOR_STATE_VARIABLE)
228 229 230 231 232
         variable => model%state_variables(index)
      case (SURFACE_STATE_VARIABLE)
         variable => model%surface_state_variables(index)
      case (BOTTOM_STATE_VARIABLE)
         variable => model%bottom_state_variables(index)
233
      case (INTERIOR_DIAGNOSTIC_VARIABLE)
234 235 236 237 238 239
         variable => model%diagnostic_variables(index)
      case (HORIZONTAL_DIAGNOSTIC_VARIABLE)
         variable => model%horizontal_diagnostic_variables(index)
      case (CONSERVED_QUANTITY)
         variable => model%conserved_quantities(index)
      end select
240 241 242 243
      call copy_to_c_string(variable%name,           name)
      call copy_to_c_string(variable%units,          units)
      call copy_to_c_string(variable%local_long_name,long_name)
      call copy_to_c_string(variable%path,           path)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
244
   end subroutine get_variable_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
245

Jorn Bruggeman's avatar
Jorn Bruggeman committed
246 247 248 249
   function get_variable(category,index) bind(c) result(pvariable)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable
      integer(c_int),intent(in), value :: category,index
      type (c_ptr)                     :: pvariable
250 251 252 253 254

      type (type_internal_variable),pointer :: variable

      ! Get a pointer to the target variable
      select case (category)
255
      case (INTERIOR_STATE_VARIABLE)
256 257 258 259 260
         variable => model%state_variables(index)%target
      case (SURFACE_STATE_VARIABLE)
         variable => model%surface_state_variables(index)%target
      case (BOTTOM_STATE_VARIABLE)
         variable => model%bottom_state_variables(index)%target
261
      case (INTERIOR_DIAGNOSTIC_VARIABLE)
262 263 264 265 266 267 268
         variable => model%diagnostic_variables(index)%target
      case (HORIZONTAL_DIAGNOSTIC_VARIABLE)
         variable => model%horizontal_diagnostic_variables(index)%target
      case (CONSERVED_QUANTITY)
         variable => model%conserved_quantities(index)%target
      end select
      pvariable = c_loc(variable)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
269
   end function get_variable
270

271
   subroutine get_parameter_metadata(index,length,name,units,long_name,typecode,has_default) bind(c)
272
      !DIR$ ATTRIBUTES DLLEXPORT :: get_parameter_metadata
273
      integer(c_int),        intent(in), value             :: index,length
274
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name
275
      integer(c_int),        intent(out)                   :: typecode,has_default
276 277 278 279 280 281 282 283 284 285

      integer                       :: i
      class (type_property),pointer :: property

      i = 1
      property => model%root%parameters%first
      do while (associated(property))
         if (index==i) exit
         property => property%next
         i = i + 1
Jorn Bruggeman's avatar
Jorn Bruggeman committed
286 287
      end do

288 289 290 291
      call copy_to_c_string(property%name,     name)
      call copy_to_c_string(property%units,    units)
      call copy_to_c_string(property%long_name,long_name)
      typecode = property%typecode()
292
      has_default = logical2int(property%has_default)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
293
   end subroutine get_parameter_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
294

295 296
   subroutine get_dependency_metadata(index,length,name,units) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_dependency_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
297
      integer(c_int),        intent(in), value             :: index,length
298
      character(kind=c_char),intent(out),dimension(length) :: name,units
Jorn Bruggeman's avatar
Jorn Bruggeman committed
299

300 301
      call copy_to_c_string(environment_names(index),name)
      call copy_to_c_string(environment_units(index),units)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
302
   end subroutine get_dependency_metadata
303

304 305 306 307 308 309 310
   subroutine get_coupling(index,slave,master) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_coupling
      integer(c_int),        intent(in), value :: index
      type (c_ptr),          intent(out)       :: slave,master

      type (type_link),pointer :: link_slave
      integer                  :: i
Knut's avatar
Knut committed
311

312 313 314 315 316 317
      link_slave => coupling_link_list%first
      do i=2,index
         link_slave => link_slave%next
      end do
      slave = c_loc(link_slave%original)
      master = c_loc(link_slave%target)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
318
   end subroutine get_coupling
319

Jorn Bruggeman's avatar
Jorn Bruggeman committed
320 321
   function variable_get_suitable_masters(pvariable) result(plist) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: variable_get_suitable_masters
322 323
      type (c_ptr), intent(in), value :: pvariable
      type (c_ptr)                    :: plist
324

325
      type (type_internal_variable),pointer :: variable
326
      type (type_link_list),        pointer :: list
327 328 329 330

      call c_f_pointer(pvariable, variable)
      list => get_suitable_masters(model,variable)
      plist = c_loc(list)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
331
   end function variable_get_suitable_masters
332

333
   subroutine get_model_metadata(name,length,long_name,user_created) bind(c)
334
      !DIR$ ATTRIBUTES DLLEXPORT :: get_model_metadata
335 336 337
      character(kind=c_char),intent(in), target :: name(*)
      integer(c_int),        intent(in), value  :: length
      character(kind=c_char),intent(out)        :: long_name(length)
338
      integer(c_int),        intent(out)        :: user_created
339

340 341
      character(len=attribute_length),pointer   :: pname
      class (type_base_model),        pointer   :: found_model
342 343 344

      call c_f_pointer(c_loc(name), pname)
      found_model => model%root%find_model(pname(:index(pname,C_NULL_CHAR)-1))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
345 346
      if (.not.associated(found_model)) call driver%fatal_error('get_model_metadata', &
         'model "'//pname(:index(pname,C_NULL_CHAR)-1)//'" not found.')
347
      call copy_to_c_string(found_model%long_name,long_name)
348
      user_created = logical2int(found_model%user_created)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
349
   end subroutine get_model_metadata
350

351 352 353 354 355
   subroutine link_dependency_data(index,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_dependency_data
      integer(c_int),intent(in),value  :: index
      real(c_double),intent(in),target :: value

356
      call fabm_link_interior_data(model,environment_names(index),value)
357 358
      call fabm_link_horizontal_data(model,environment_names(index),value)
      call fabm_link_scalar_data(model,environment_names(index),value)
359
      if (index==index_column_depth) column_depth => value
Jorn Bruggeman's avatar
Jorn Bruggeman committed
360
   end subroutine link_dependency_data
361

362 363
   subroutine link_interior_state_data(index,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_interior_state_data
364 365
      integer(c_int),intent(in),   value  :: index
      real(c_double),intent(inout),target :: value
Jorn Bruggeman's avatar
Jorn Bruggeman committed
366

367
      value = model%state_variables(index)%initial_value
368 369
      call fabm_link_interior_state_data(model,index,value)
   end subroutine link_interior_state_data
Jorn Bruggeman's avatar
Jorn Bruggeman committed
370

371 372 373 374
   subroutine link_surface_state_data(index,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_surface_state_data
      integer(c_int),intent(in),   value  :: index
      real(c_double),intent(inout),target :: value
Jorn Bruggeman's avatar
Jorn Bruggeman committed
375

376 377
      value = model%surface_state_variables(index)%initial_value
      call fabm_link_surface_state_data(model,index,value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
378
   end subroutine link_surface_state_data
Knut's avatar
Knut committed
379

380 381 382 383 384 385 386
   subroutine link_bottom_state_data(index,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_bottom_state_data
      integer(c_int),intent(in),   value  :: index
      real(c_double),intent(inout),target :: value

      value = model%bottom_state_variables(index)%initial_value
      call fabm_link_bottom_state_data(model,index,value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
387
   end subroutine link_bottom_state_data
388

389
   subroutine get_rates(pelagic_rates_, do_surface, do_bottom) bind(c)
390
      !DIR$ ATTRIBUTES DLLEXPORT :: get_rates
391
      real(c_double),target,intent(in) :: pelagic_rates_(*)
392
      integer(c_int),value, intent(in) :: do_surface, do_bottom
393 394

      real(c_double),pointer :: pelagic_rates(:)
395
      real(rk)               :: ext
396

397 398
      call fabm_get_light_extinction(model,ext)
      call fabm_get_light(model)
399 400
      call c_f_pointer(c_loc(pelagic_rates_),pelagic_rates, &
        (/size(model%state_variables)+size(model%surface_state_variables)+size(model%bottom_state_variables)/))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
401
      pelagic_rates = 0.0_rk
402
      if (int2logical(do_surface)) call fabm_do_surface(model,pelagic_rates(1:size(model%state_variables)), &
Jorn Bruggeman's avatar
Jorn Bruggeman committed
403
         pelagic_rates(size(model%state_variables)+1:size(model%state_variables)+size(model%surface_state_variables)))
404
      if (int2logical(do_bottom)) call fabm_do_bottom(model,pelagic_rates(1:size(model%state_variables)), &
405
         pelagic_rates(size(model%state_variables)+size(model%surface_state_variables)+1:))
406 407 408 409 410 411
      if (int2logical(do_surface) .or. int2logical(do_bottom)) then
         if (.not.associated(column_depth)) call driver%fatal_error('get_rates', &
            'Value for environmental dependency '//trim(environment_names(index_column_depth))// &
            ' must be provided if get_rates is called with the do_surface and/or do_bottom flags.')
         pelagic_rates(1:size(model%state_variables)) = pelagic_rates(1:size(model%state_variables))/column_depth
      end if
412
      call fabm_do(model,pelagic_rates(1:size(model%state_variables)))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
413 414

      ! Compute rate of change in conserved quantities
415
      !call fabm_state_to_conserved_quantities(model,pelagic_rates,conserved_rates)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
416 417

      ! Normalize rate of change in conserved quantities to sum of absolute rates of change.
418 419
      !call fabm_state_to_conserved_quantities(model,abs(pelagic_rates),abs_conserved_rates)
      !where (abs_conserved_rates>0.0_rk) conserved_rates = conserved_rates/abs_conserved_rates
Jorn Bruggeman's avatar
Jorn Bruggeman committed
420
   end subroutine get_rates
421

422 423
   subroutine get_interior_diagnostic_data(index,ptr) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_interior_diagnostic_data
424 425
      integer(c_int),intent(in),value :: index
      type(c_ptr),   intent(out)      :: ptr
426 427
      ptr = c_loc(fabm_get_interior_diagnostic_data(model,index))
   end subroutine get_interior_diagnostic_data
428 429 430 431 432 433

   subroutine get_horizontal_diagnostic_data(index,ptr) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_horizontal_diagnostic_data
      integer(c_int),intent(in),value :: index
      type(c_ptr),   intent(out)      :: ptr
      ptr = c_loc(fabm_get_horizontal_diagnostic_data(model,index))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
434
   end subroutine get_horizontal_diagnostic_data
Jorn Bruggeman's avatar
Jorn Bruggeman committed
435

436
   subroutine finalize() bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
437 438 439
      call fabm_finalize(model)
      if (allocated(environment_names)) deallocate(environment_names)
      if (allocated(environment_units)) deallocate(environment_units)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
440
   end subroutine finalize
Jorn Bruggeman's avatar
Jorn Bruggeman committed
441

442
   subroutine reset_parameter(index) bind(c)
443
      !DIR$ ATTRIBUTES DLLEXPORT :: reset_parameter
444 445
      integer(c_int),value,intent(in) :: index
      class (type_property),pointer   :: property
446

447 448 449
      property => model%root%parameters%get_property(index)
      if (.not.associated(property)) return
      call forced_parameters%delete(property%name)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
450 451

      ! Re-initialize the model using updated parameter values
452
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
453
   end subroutine reset_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
454

455 456
   subroutine set_real_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_real_parameter
457 458
      character(kind=c_char),target,intent(in) :: name(*)
      real(c_double),value,         intent(in) :: value
459 460 461 462 463

      character(len=attribute_length),pointer :: pname

      call c_f_pointer(c_loc(name), pname)
      call forced_parameters%set_real(pname(:index(pname,C_NULL_CHAR)-1),value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
464 465

      ! Re-initialize the model using updated parameter values
466
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
467
   end subroutine set_real_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
468

469
   function get_real_parameter(index,default) bind(c) result(value)
470
      !DIR$ ATTRIBUTES DLLEXPORT :: get_real_parameter
471
      integer(c_int),value,intent(in) :: index,default
472
      real(c_double)                  :: value
473 474 475 476 477
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_real_property)
478
         if (int2logical(default)) then
479 480 481 482 483 484 485
            value = property%default
         else
            value = property%value
         end if
      class default
         call driver%fatal_error('get_real_parameter','not a real variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
486
   end function get_real_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
487

488 489
   subroutine set_integer_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_integer_parameter
490 491
      character(kind=c_char),target,intent(in) :: name(*)
      integer(c_int),value,         intent(in) :: value
492 493 494 495 496

      character(len=attribute_length),pointer :: pname

      call c_f_pointer(c_loc(name), pname)
      call forced_parameters%set_integer(pname(:index(pname,C_NULL_CHAR)-1),value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
497 498

      ! Re-initialize the model using updated parameter values
499
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
500
   end subroutine set_integer_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
501

502
   function get_integer_parameter(index,default) bind(c) result(value)
503
      !DIR$ ATTRIBUTES DLLEXPORT :: get_integer_parameter
504
      integer(c_int),value,intent(in) :: index,default
505
      integer(c_int)                  :: value
506 507 508 509 510
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_integer_property)
511
         if (int2logical(default)) then
512 513 514 515 516 517 518
            value = property%default
         else
            value = property%value
         end if
      class default
         call driver%fatal_error('get_integer_parameter','not an integer variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
519
   end function get_integer_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
520

521 522
   subroutine set_logical_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_logical_parameter
523
      character(kind=c_char),target,    intent(in) :: name(*)
524 525 526 527 528
      integer(c_int),value,intent(in) :: value

      character(len=attribute_length),pointer :: pname

      call c_f_pointer(c_loc(name), pname)
529
      call forced_parameters%set_logical(pname(:index(pname,C_NULL_CHAR)-1),int2logical(value))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
530 531

      ! Re-initialize the model using updated parameter values
532
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
533
   end subroutine set_logical_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
534

535
   function get_logical_parameter(index,default) bind(c) result(value)
536
      !DIR$ ATTRIBUTES DLLEXPORT :: get_logical_parameter
537
      integer(c_int),value,intent(in) :: index,default
538
      integer(c_int)                  :: value
539 540 541 542 543
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_logical_property)
544 545
         if (int2logical(default)) then
            value = logical2int(property%default)
546
         else
547
            value = logical2int(property%value)
548 549 550 551
         end if
      class default
         call driver%fatal_error('get_logical_parameter','not a logical variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
552
   end function get_logical_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
553

554 555 556 557 558
   subroutine set_string_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_string_parameter
      character(kind=c_char),target,intent(in) :: name(*),value(*)

      character(len=attribute_length),pointer :: pname,pvalue
Knut's avatar
Knut committed
559

560 561 562
      call c_f_pointer(c_loc(name),  pname)
      call c_f_pointer(c_loc(value), pvalue)
      call forced_parameters%set_string(pname(:index(pname,C_NULL_CHAR)-1),pvalue(:index(pname,C_NULL_CHAR)-1))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
563 564

      ! Re-initialize the model using updated parameter values
565
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
566
   end subroutine set_string_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
567

568 569 570 571 572
   subroutine get_string_parameter(index,default,length,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_string_parameter
      integer(c_int),value,intent(in) :: index,default,length
      character(kind=c_char)          :: value(length)

573 574 575 576 577
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_string_property)
578
         if (int2logical(default)) then
579
            call copy_to_c_string(property%default, value)
580
         else
581
            call copy_to_c_string(property%value, value)
582 583 584 585
         end if
      class default
         call driver%fatal_error('get_string_parameter','not a string variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
586
   end subroutine get_string_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
587

588
   subroutine python_driver_fatal_error(self,location,message)
589 590 591 592 593
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: location,message

      write (*,*) trim(location)//': '//trim(message)
      stop 1
Jorn Bruggeman's avatar
Jorn Bruggeman committed
594
   end subroutine python_driver_fatal_error
595

596
   subroutine python_driver_log_message(self,message)
597 598 599 600
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: message

      !write (*,*) trim(message)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
601
   end subroutine python_driver_log_message
602

Jorn Bruggeman's avatar
Jorn Bruggeman committed
603 604 605 606 607
   end module fabm_python

!-----------------------------------------------------------------------
! Copyright by the GOTM-team under the GNU Public License - www.gnu.org
!-----------------------------------------------------------------------