python_fabm.F90 22.6 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 33 34 35 36 37 38
   integer,parameter :: BULK_STATE_VARIABLE            = 1
   integer,parameter :: SURFACE_STATE_VARIABLE         = 2
   integer,parameter :: BOTTOM_STATE_VARIABLE          = 3
   integer,parameter :: BULK_DIAGNOSTIC_VARIABLE       = 4
   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
   type (type_link_list),save :: coupling_link_list
Jorn Bruggeman's avatar
Jorn Bruggeman committed
43

44
   type (type_property_dictionary),save,private :: forced_parameters,forced_couplings
45 46 47

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

   contains

!-----------------------------------------------------------------------
!BOP
!
! !IROUTINE: Initialise the model
!
! !INTERFACE:
62
   subroutine initialize(path) bind(c)
63
!DIR$ ATTRIBUTES DLLEXPORT :: initialize
64
      character(kind=c_char),target,intent(in) :: path(*)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
65 66 67 68 69 70 71 72
!
! !DESCRIPTION:
!
! !REVISION HISTORY:
!  Original author(s): Jorn Bruggeman
!
!EOP
!
73
      character(len=attribute_length),pointer :: ppath
74
      class (type_property),          pointer :: property
Jorn Bruggeman's avatar
Jorn Bruggeman committed
75 76
!-----------------------------------------------------------------------
!BOC
77 78
      call c_f_pointer(c_loc(path), ppath)

79
      if (associated(model)) call finalize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
80

81 82
      if (.not.associated(driver)) allocate(type_python_driver::driver)

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

87
      ! Get a list of all parameters that had an explicit value specified.
88 89
      property => model%root%parameters%first
      do while (associated(property))
90
         if (.not.model%root%parameters%missing%contains(property%name)) &
91 92 93
            call forced_parameters%set_property(property)
         property => property%next
      end do
Jorn Bruggeman's avatar
Jorn Bruggeman committed
94

95 96 97 98 99 100 101 102
      ! 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
103 104 105
      ! Send information on spatial domain to FABM (this also allocates memory for diagnostics)
      call fabm_set_domain(model)

106 107 108
      ! Retrieve arrays to hold values for environmental variables and corresponding metadata.
      call get_environment_metadata(model,environment_names,environment_units)

109
      call get_couplings(model,coupling_link_list)
110 111 112
   end subroutine initialize
!EOC

113 114 115 116 117 118 119 120 121 122
   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)
123
      call newmodel%root%couplings%update(forced_couplings)
124 125 126 127

      ! Re-create original models
      node => model%root%children%first
      do while (associated(node))
128
         if (node%model%user_created) then
129
            call factory%create(node%model%type_name,childmodel)
130
            childmodel%user_created = .true.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
            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))
146
         if (.not. model%root%parameters%retrieved%contains(property%name)) then
147 148 149 150 151 152 153 154 155 156 157 158 159
            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.
      call get_environment_metadata(model,environment_names,environment_units)
160 161

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

164
   subroutine check_ready() bind(c)
165 166
      !DIR$ ATTRIBUTES DLLEXPORT :: check_ready
      call fabm_check_ready(model)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
167
   end subroutine check_ready
168

169
   integer(c_int) function model_count() bind(c)
170 171 172 173 174 175 176 177 178
      !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
179
      end do
Jorn Bruggeman's avatar
Jorn Bruggeman committed
180
   end function model_count
181

Jorn Bruggeman's avatar
Jorn Bruggeman committed
182
   subroutine get_counts(nstate_bulk,nstate_surface,nstate_bottom,ndiagnostic_bulk,ndiagnostic_horizontal,nconserved, &
183
      ndependencies,nparameters,ncouplings) bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
184
      !DIR$ ATTRIBUTES DLLEXPORT :: get_counts
185 186
      integer(c_int),intent(out) :: nstate_bulk,nstate_surface,nstate_bottom
      integer(c_int),intent(out) :: ndiagnostic_bulk,ndiagnostic_horizontal
187
      integer(c_int),intent(out) :: nconserved,ndependencies,nparameters,ncouplings
188 189 190 191 192 193 194 195
      nstate_bulk = size(model%state_variables)
      nstate_surface = size(model%surface_state_variables)
      nstate_bottom = size(model%bottom_state_variables)
      ndiagnostic_bulk = size(model%diagnostic_variables)
      ndiagnostic_horizontal = size(model%horizontal_diagnostic_variables)
      nconserved = size(model%conserved_quantities)
      ndependencies = size(environment_names)
      nparameters = model%root%parameters%size()
196
      ncouplings = coupling_link_list%count()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
197
   end subroutine get_counts
198

199
   subroutine get_variable_metadata(category,index,length,name,units,long_name,path) bind(c)
200
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_metadata
201
      integer(c_int),        intent(in), value             :: category,index,length
202
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name,path
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

      class (type_external_variable),pointer :: variable

      ! Get a pointer to the target variable
      select case (category)
      case (BULK_STATE_VARIABLE)
         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)
      case (BULK_DIAGNOSTIC_VARIABLE)
         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
221 222 223 224
      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
225
   end subroutine get_variable_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
226

Jorn Bruggeman's avatar
Jorn Bruggeman committed
227 228 229 230
   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
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

      type (type_internal_variable),pointer :: variable

      ! Get a pointer to the target variable
      select case (category)
      case (BULK_STATE_VARIABLE)
         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
      case (BULK_DIAGNOSTIC_VARIABLE)
         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
250
   end function get_variable
251

252
   subroutine get_parameter_metadata(index,length,name,units,long_name,typecode,has_default) bind(c)
253
      !DIR$ ATTRIBUTES DLLEXPORT :: get_parameter_metadata
254
      integer(c_int),        intent(in), value             :: index,length
255
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name
256
      integer(c_int),        intent(out)                   :: typecode,has_default
257 258 259 260 261 262 263 264 265 266

      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
267 268
      end do

269 270 271 272
      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()
273
      has_default = logical2int(property%has_default)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
274
   end subroutine get_parameter_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
275

276 277
   subroutine get_dependency_metadata(index,length,name,units) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_dependency_metadata
Jorn Bruggeman's avatar
Jorn Bruggeman committed
278
      integer(c_int),        intent(in), value             :: index,length
279
      character(kind=c_char),intent(out),dimension(length) :: name,units
Jorn Bruggeman's avatar
Jorn Bruggeman committed
280

281 282
      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
283
   end subroutine get_dependency_metadata
284

285 286 287 288 289 290 291
   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
292

293 294 295 296 297 298
      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
299
   end subroutine get_coupling
300

Jorn Bruggeman's avatar
Jorn Bruggeman committed
301 302
   function variable_get_suitable_masters(pvariable) result(plist) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: variable_get_suitable_masters
303 304
      type (c_ptr), intent(in), value :: pvariable
      type (c_ptr)                    :: plist
305

306
      type (type_internal_variable),pointer :: variable
307
      type (type_link_list),        pointer :: list
308 309 310 311

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

314
   subroutine get_model_metadata(name,length,long_name,user_created) bind(c)
315
      !DIR$ ATTRIBUTES DLLEXPORT :: get_model_metadata
316 317 318
      character(kind=c_char),intent(in), target :: name(*)
      integer(c_int),        intent(in), value  :: length
      character(kind=c_char),intent(out)        :: long_name(length)
319
      integer(c_int),        intent(out)        :: user_created
320

321 322
      character(len=attribute_length),pointer   :: pname
      class (type_base_model),        pointer   :: found_model
323 324 325

      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
326 327
      if (.not.associated(found_model)) call driver%fatal_error('get_model_metadata', &
         'model "'//pname(:index(pname,C_NULL_CHAR)-1)//'" not found.')
328
      call copy_to_c_string(found_model%long_name,long_name)
329
      user_created = logical2int(found_model%user_created)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
330
   end subroutine get_model_metadata
331

332 333 334 335 336 337 338 339
   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

      call fabm_link_bulk_data(model,environment_names(index),value)
      call fabm_link_horizontal_data(model,environment_names(index),value)
      call fabm_link_scalar_data(model,environment_names(index),value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
340
   end subroutine link_dependency_data
341 342 343 344 345

   subroutine link_bulk_state_data(index,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_bulk_state_data
      integer(c_int),intent(in),   value  :: index
      real(c_double),intent(inout),target :: value
Jorn Bruggeman's avatar
Jorn Bruggeman committed
346

347 348
      value = model%state_variables(index)%initial_value
      call fabm_link_bulk_state_data(model,index,value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
349
   end subroutine link_bulk_state_data
Jorn Bruggeman's avatar
Jorn Bruggeman committed
350

351 352 353 354
   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
355

356 357
      value = model%surface_state_variables(index)%initial_value
      call fabm_link_surface_state_data(model,index,value)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
358
   end subroutine link_surface_state_data
Knut's avatar
Knut committed
359

360 361 362 363 364 365 366
   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
367
   end subroutine link_bottom_state_data
368 369 370

   subroutine get_rates(pelagic_rates_) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_rates
371
      real(c_double),target,intent(in) :: pelagic_rates_(*)
372 373

      real(c_double),pointer :: pelagic_rates(:)
374
      real(rk)               :: ext
375

376 377
      call fabm_get_light_extinction(model,ext)
      call fabm_get_light(model)
378 379
      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
380
      pelagic_rates = 0.0_rk
Jorn Bruggeman's avatar
Jorn Bruggeman committed
381 382 383 384
      call fabm_do_bottom(model,pelagic_rates(1:size(model%state_variables)), &
         pelagic_rates(size(model%state_variables)+size(model%surface_state_variables)+1:))
      call fabm_do_surface(model,pelagic_rates(1:size(model%state_variables)), &
         pelagic_rates(size(model%state_variables)+1:size(model%state_variables)+size(model%surface_state_variables)))
385
      call fabm_do(model,pelagic_rates(1:size(model%state_variables)))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
386 387

      ! Compute rate of change in conserved quantities
388
      !call fabm_state_to_conserved_quantities(model,pelagic_rates,conserved_rates)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
389 390

      ! Normalize rate of change in conserved quantities to sum of absolute rates of change.
391 392
      !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
393
   end subroutine get_rates
394 395 396 397 398 399

   subroutine get_bulk_diagnostic_data(index,ptr) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_bulk_diagnostic_data
      integer(c_int),intent(in),value :: index
      type(c_ptr),   intent(out)      :: ptr
      ptr = c_loc(fabm_get_bulk_diagnostic_data(model,index))
Jorn Bruggeman's avatar
Jorn Bruggeman committed
400
   end subroutine get_bulk_diagnostic_data
401 402 403 404 405 406

   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
407
   end subroutine get_horizontal_diagnostic_data
Jorn Bruggeman's avatar
Jorn Bruggeman committed
408

409
   subroutine finalize() bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
410 411 412
      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
413
   end subroutine finalize
Jorn Bruggeman's avatar
Jorn Bruggeman committed
414

415
   subroutine reset_parameter(index) bind(c)
416
      !DIR$ ATTRIBUTES DLLEXPORT :: reset_parameter
417 418
      integer(c_int),value,intent(in) :: index
      class (type_property),pointer   :: property
419

420 421 422
      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
423 424

      ! Re-initialize the model using updated parameter values
425
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
426
   end subroutine reset_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
427

428 429
   subroutine set_real_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_real_parameter
430 431
      character(kind=c_char),target,intent(in) :: name(*)
      real(c_double),value,         intent(in) :: value
432 433 434 435 436

      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
437 438

      ! Re-initialize the model using updated parameter values
439
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
440
   end subroutine set_real_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
441

442
   function get_real_parameter(index,default) bind(c) result(value)
443
      !DIR$ ATTRIBUTES DLLEXPORT :: get_real_parameter
444
      integer(c_int),value,intent(in) :: index,default
445
      real(c_double)                  :: value
446 447 448 449 450
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_real_property)
451
         if (int2logical(default)) then
452 453 454 455 456 457 458
            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
459
   end function get_real_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
460

461 462
   subroutine set_integer_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_integer_parameter
463 464
      character(kind=c_char),target,intent(in) :: name(*)
      integer(c_int),value,         intent(in) :: value
465 466 467 468 469

      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
470 471

      ! Re-initialize the model using updated parameter values
472
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
473
   end subroutine set_integer_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
474

475
   function get_integer_parameter(index,default) bind(c) result(value)
476
      !DIR$ ATTRIBUTES DLLEXPORT :: get_integer_parameter
477
      integer(c_int),value,intent(in) :: index,default
478
      integer(c_int)                  :: value
479 480 481 482 483
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_integer_property)
484
         if (int2logical(default)) then
485 486 487 488 489 490 491
            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
492
   end function get_integer_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
493

494 495
   subroutine set_logical_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_logical_parameter
496
      character(kind=c_char),target,    intent(in) :: name(*)
497 498 499 500 501
      integer(c_int),value,intent(in) :: value

      character(len=attribute_length),pointer :: pname

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

      ! Re-initialize the model using updated parameter values
505
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
506
   end subroutine set_logical_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
507

508
   function get_logical_parameter(index,default) bind(c) result(value)
509
      !DIR$ ATTRIBUTES DLLEXPORT :: get_logical_parameter
510
      integer(c_int),value,intent(in) :: index,default
511
      integer(c_int)                  :: value
512 513 514 515 516
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_logical_property)
517 518
         if (int2logical(default)) then
            value = logical2int(property%default)
519
         else
520
            value = logical2int(property%value)
521 522 523 524
         end if
      class default
         call driver%fatal_error('get_logical_parameter','not a logical variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
525
   end function get_logical_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
526

527 528 529 530 531
   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
532

533 534 535
      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
536 537

      ! Re-initialize the model using updated parameter values
538
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
539
   end subroutine set_string_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
540

541 542 543 544 545
   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)

546 547 548 549 550
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_string_property)
551
         if (int2logical(default)) then
552
            call copy_to_c_string(property%default, value)
553
         else
554
            call copy_to_c_string(property%value, value)
555 556 557 558
         end if
      class default
         call driver%fatal_error('get_string_parameter','not a string variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
559
   end subroutine get_string_parameter
Jorn Bruggeman's avatar
Jorn Bruggeman committed
560

561
   subroutine python_driver_fatal_error(self,location,message)
562 563 564 565 566
      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
567
   end subroutine python_driver_fatal_error
568

569
   subroutine python_driver_log_message(self,message)
570 571 572 573
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: message

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

Jorn Bruggeman's avatar
Jorn Bruggeman committed
576 577 578 579 580
   end module fabm_python

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