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 25 26 27 28 29 30
   use fabm_python_helper

   implicit none
!
! !PUBLIC MEMBER FUNCTIONS:
   public

31 32 33 34 35 36 37
   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

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

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

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

   contains

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

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

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

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

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

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

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

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

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

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

      call get_couplings(model,coupling_link_list)
161 162
   end subroutine

163 164 165 166 167
   subroutine check_ready()
      !DIR$ ATTRIBUTES DLLEXPORT :: check_ready
      call fabm_check_ready(model)
   end subroutine

168
   integer(c_int) function model_count() bind(c)
169 170 171 172 173 174 175 176 177
      !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
178
      end do
179 180
   end function

181
   subroutine get_variable_counts(nstate_bulk,nstate_surface,nstate_bottom,ndiagnostic_bulk,ndiagnostic_horizontal,nconserved, &
182
      ndependencies,nparameters,ncouplings) bind(c)
183 184 185
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_counts
      integer(c_int),intent(out) :: nstate_bulk,nstate_surface,nstate_bottom
      integer(c_int),intent(out) :: ndiagnostic_bulk,ndiagnostic_horizontal
186
      integer(c_int),intent(out) :: nconserved,ndependencies,nparameters,ncouplings
187 188 189 190 191 192 193 194
      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()
195
      ncouplings = coupling_link_list%count()
196 197
   end subroutine

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

      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
220 221 222 223
      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)
224
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
225

226
   subroutine get_parameter_metadata(index,length,name,units,long_name,typecode,has_default) bind(c)
227
      !DIR$ ATTRIBUTES DLLEXPORT :: get_parameter_metadata
228
      integer(c_int),        intent(in), value             :: index,length
229
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name
230
      integer(c_int),        intent(out)                   :: typecode,has_default
231 232 233 234 235 236 237 238 239 240

      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
241 242
      end do

243 244 245 246
      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()
247
      has_default = logical2int(property%has_default)
248
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
249

250 251 252
   subroutine get_dependency_metadata(index,length,name,units) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_dependency_metadata
      integer(c_int),intent(in), value             :: index,length
253
      character(kind=c_char),intent(out),dimension(length) :: name,units
Jorn Bruggeman's avatar
Jorn Bruggeman committed
254

255 256 257 258
      call copy_to_c_string(environment_names(index),name)
      call copy_to_c_string(environment_units(index),units)
   end subroutine

259 260 261 262 263 264 265
   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
266

267 268 269 270 271 272 273 274 275 276 277 278 279
      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)
   end subroutine

   function get_suitable_masters_for_ptr(pvariable) result(plist) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_suitable_masters_for_ptr
      type (c_ptr),          intent(in), value :: pvariable
      type (c_ptr)                             :: plist

280
      type (type_internal_variable),pointer :: variable
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
      type (type_link_list),         pointer :: list

      call c_f_pointer(pvariable, variable)
      list => get_suitable_masters(model,variable)
      plist = c_loc(list)
   end function

   function link_list_count(plist) bind(c) result(value)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_list_count
      type (c_ptr),          intent(in), value :: plist
      integer(c_int)                           :: value

      type (type_link_list),pointer :: list

      call c_f_pointer(plist, list)
      value = list%count()
   end function

   function link_list_index(plist,index) bind(c) result(pvariable)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_list_index
      type (c_ptr),  intent(in), value :: plist
      integer(c_int),intent(in), value :: index
      type (c_ptr)                     :: pvariable

      type (type_link_list),pointer :: list
      type (type_link),     pointer :: link
      integer                       :: i
Knut's avatar
Knut committed
308

309 310 311 312 313 314 315 316
      call c_f_pointer(plist, list)
      link => list%first
      do i=2,index
         link => link%next
      end do
      pvariable = c_loc(link%target)
   end function

317 318 319 320 321
   subroutine link_list_finalize(plist) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: link_list_finalize
      type (c_ptr),  intent(in), value :: plist

      type (type_link_list),pointer :: list
Knut's avatar
Knut committed
322

323 324 325 326 327
      call c_f_pointer(plist, list)
      call list%finalize()
      deallocate(list)
   end subroutine

328 329 330 331 332 333
   subroutine get_variable_long_path(pvariable,length,long_name) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_long_path
      type (c_ptr),          intent(in), value  :: pvariable
      integer(c_int),        intent(in), value  :: length
      character(kind=c_char),intent(out),dimension(length) ::long_name

334
      type (type_internal_variable),pointer :: variable
335 336
      class (type_base_model),       pointer :: owner
      character(len=attribute_length)        :: long_name_
Knut's avatar
Knut committed
337

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
      call c_f_pointer(pvariable, variable)
      long_name_ = variable%long_name
      owner => variable%owner
      do while (associated(owner%parent))
         long_name_ = trim(owner%long_name)//'/'//trim(long_name_)
         owner => owner%parent
      end do
      call copy_to_c_string(long_name_,long_name)
   end subroutine get_variable_long_path

   subroutine get_variable_metadata_ptr(pvariable,length,name,units,long_name) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_metadata_ptr
      type (c_ptr),          intent(in), value  :: pvariable
      integer(c_int),        intent(in), value  :: length
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name

354
      type (type_internal_variable),pointer :: variable
355 356 357 358 359 360 361

      call c_f_pointer(pvariable, variable)
      call copy_to_c_string(variable%name,     name)
      call copy_to_c_string(variable%units,    units)
      call copy_to_c_string(variable%long_name,long_name)
   end subroutine get_variable_metadata_ptr

362
   subroutine get_model_metadata(name,length,long_name,user_created) bind(c)
363
      !DIR$ ATTRIBUTES DLLEXPORT :: get_model_metadata
364 365 366
      character(kind=c_char),intent(in), target :: name(*)
      integer(c_int),        intent(in), value  :: length
      character(kind=c_char),intent(out)        :: long_name(length)
367
      integer(c_int),        intent(out)        :: user_created
368

369 370
      character(len=attribute_length),pointer   :: pname
      class (type_base_model),        pointer   :: found_model
371 372 373

      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
374 375
      if (.not.associated(found_model)) call driver%fatal_error('get_model_metadata', &
         'model "'//pname(:index(pname,C_NULL_CHAR)-1)//'" not found.')
376
      call copy_to_c_string(found_model%long_name,long_name)
377
      user_created = logical2int(found_model%user_created)
378 379
   end subroutine

380 381 382 383 384 385 386 387 388 389 390 391 392 393
   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)
   end subroutine

   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
394

395 396 397
      value = model%state_variables(index)%initial_value
      call fabm_link_bulk_state_data(model,index,value)
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
398

399 400 401 402
   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
403

404 405 406
      value = model%surface_state_variables(index)%initial_value
      call fabm_link_surface_state_data(model,index,value)
   end subroutine
Knut's avatar
Knut committed
407

408 409 410 411 412 413 414 415 416 417 418
   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)
   end subroutine

   subroutine get_rates(pelagic_rates_) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_rates
419
      real(c_double),target,intent(in) :: pelagic_rates_(*)
420 421

      real(c_double),pointer :: pelagic_rates(:)
422
      real(rk)               :: ext
423

424 425
      call fabm_get_light_extinction(model,ext)
      call fabm_get_light(model)
426 427
      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
428 429 430 431
      pelagic_rates = 0.0_rk
      call fabm_do(model,pelagic_rates)

      ! Compute rate of change in conserved quantities
432
      !call fabm_state_to_conserved_quantities(model,pelagic_rates,conserved_rates)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
433 434

      ! Normalize rate of change in conserved quantities to sum of absolute rates of change.
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
      !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
   end subroutine

   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))
   end subroutine

   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
451 452
   end subroutine

453
   subroutine finalize() bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
454 455 456 457 458
      call fabm_finalize(model)
      if (allocated(environment_names)) deallocate(environment_names)
      if (allocated(environment_units)) deallocate(environment_units)
   end subroutine

459
   subroutine reset_parameter(index) bind(c)
460
      !DIR$ ATTRIBUTES DLLEXPORT :: reset_parameter
461 462
      integer(c_int),value,intent(in) :: index
      class (type_property),pointer   :: property
463

464 465 466
      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
467 468

      ! Re-initialize the model using updated parameter values
469
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
470 471
   end subroutine

472 473
   subroutine set_real_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_real_parameter
474
      character(kind=c_char),target,    intent(in) :: name(*)
475 476 477 478 479 480
      real(c_double),value,intent(in) :: value

      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
481 482

      ! Re-initialize the model using updated parameter values
483
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
484 485
   end subroutine

486
   function get_real_parameter(index,default) bind(c) result(value)
487
      !DIR$ ATTRIBUTES DLLEXPORT :: get_real_parameter
488
      integer(c_int),value,intent(in) :: index,default
489
      real(c_double)                  :: value
490 491 492 493 494
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_real_property)
495
         if (int2logical(default)) then
496 497 498 499 500 501 502
            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
503 504
   end function

505 506
   subroutine set_integer_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_integer_parameter
507
      character(kind=c_char),target,    intent(in) :: name(*)
508 509 510 511 512 513
      integer(c_int),value,intent(in) :: value

      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
514 515

      ! Re-initialize the model using updated parameter values
516
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
517 518
   end subroutine

519
   function get_integer_parameter(index,default) bind(c) result(value)
520
      !DIR$ ATTRIBUTES DLLEXPORT :: get_integer_parameter
521
      integer(c_int),value,intent(in) :: index,default
522
      integer(c_int)                  :: value
523 524 525 526 527
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_integer_property)
528
         if (int2logical(default)) then
529 530 531 532 533 534 535
            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
536 537
   end function

538 539
   subroutine set_logical_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_logical_parameter
540
      character(kind=c_char),target,    intent(in) :: name(*)
541 542 543 544 545
      integer(c_int),value,intent(in) :: value

      character(len=attribute_length),pointer :: pname

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

      ! Re-initialize the model using updated parameter values
549
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
550 551
   end subroutine

552
   function get_logical_parameter(index,default) bind(c) result(value)
553
      !DIR$ ATTRIBUTES DLLEXPORT :: get_logical_parameter
554
      integer(c_int),value,intent(in) :: index,default
555
      integer(c_int)                  :: value
556 557 558 559 560
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_logical_property)
561 562
         if (int2logical(default)) then
            value = logical2int(property%default)
563
         else
564
            value = logical2int(property%value)
565 566 567 568
         end if
      class default
         call driver%fatal_error('get_logical_parameter','not a logical variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
569 570
   end function

571 572 573 574 575
   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
576

577 578 579
      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
580 581

      ! Re-initialize the model using updated parameter values
582
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
583 584
   end subroutine

585 586 587 588 589
   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)

590 591 592 593 594
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_string_property)
595
         if (int2logical(default)) then
596
            call copy_to_c_string(property%default, value)
597
         else
598
            call copy_to_c_string(property%value, value)
599 600 601 602
         end if
      class default
         call driver%fatal_error('get_string_parameter','not a string variable')
      end select
603
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
604

605
   subroutine python_driver_fatal_error(self,location,message)
606 607 608 609 610
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: location,message

      write (*,*) trim(location)//': '//trim(message)
      stop 1
611
   end subroutine
612

613
   subroutine python_driver_log_message(self,message)
614 615 616 617
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: message

      !write (*,*) trim(message)
618
   end subroutine
619

620 621 622 623 624 625 626 627
   subroutine copy_to_c_string(string,cstring)
      character(len=*),intent(in)  :: string
      character,       intent(out) :: cstring(:)
      integer i,n
      n = min(len_trim(string),size(cstring)-1)
      do i=1,n
         cstring(i) = string(i:i)
      end do
Knut's avatar
Knut committed
628
      cstring(n+1) = C_NULL_CHAR
629 630
   end subroutine

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
   function logical2int(value) result(ivalue)
      logical,intent(in) :: value
      integer            :: ivalue
      if (value) then
         ivalue = 1
      else
         ivalue = 0
      end if
   end function

   function int2logical(ivalue) result(value)
      integer,intent(in) :: ivalue
      logical            :: value
      value = ivalue/=0
   end function

Jorn Bruggeman's avatar
Jorn Bruggeman committed
647 648 649 650 651
   end module fabm_python

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