python_fabm.F90 18.9 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
20
   use fabm_types, only:rk,attribute_length,type_model_list_node,type_base_model,factory
21
   use fabm_driver, only: type_base_driver, driver
22
   use fabm_properties
Jorn Bruggeman's avatar
Jorn Bruggeman committed
23 24 25 26 27 28 29
   use fabm_python_helper

   implicit none
!
! !PUBLIC MEMBER FUNCTIONS:
   public

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

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

   type (type_property_dictionary),save,private :: forced_parameters
42 43 44

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

   contains

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

76
      if (associated(model)) call finalize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
77

78 79
      if (.not.associated(driver)) allocate(type_python_driver::driver)

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

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

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

95 96 97 98 99 100
      ! Retrieve arrays to hold values for environmental variables and corresponding metadata.
      call get_environment_metadata(model,environment_names,environment_units)

   end subroutine initialize
!EOC

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

      ! Re-create original models
      node => model%root%children%first
      do while (associated(node))
         if (node%model%type_name/='') then
            call factory%create(node%model%type_name,childmodel)
            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))
132
         if (.not. model%root%parameters%retrieved%contains(property%name)) then
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
            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)
   end subroutine

148 149 150 151 152
   subroutine check_ready()
      !DIR$ ATTRIBUTES DLLEXPORT :: check_ready
      call fabm_check_ready(model)
   end subroutine

153
   integer(c_int) function model_count() bind(c)
154 155 156 157 158 159 160 161 162
      !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
163
      end do
164 165
   end function

166 167
   subroutine get_variable_counts(nstate_bulk,nstate_surface,nstate_bottom,ndiagnostic_bulk,ndiagnostic_horizontal,nconserved, &
      ndependencies,nparameters) bind(c)
168 169 170 171 172 173 174 175 176 177 178 179 180 181
      !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
      integer(c_int),intent(out) :: nconserved,ndependencies,nparameters
      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()
   end subroutine

182
   subroutine get_variable_metadata(category,index,length,name,units,long_name,path) bind(c)
183 184
      !DIR$ ATTRIBUTES DLLEXPORT :: get_variable_metadata
      integer(c_int),intent(in), value             :: category,index,length
185
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name,path
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206

      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
      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)
207
      call copy_to_c_string(variable%path,     path)
208
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
209

210
   subroutine get_parameter_metadata(index,length,name,units,long_name,typecode,has_default) bind(c)
211
      !DIR$ ATTRIBUTES DLLEXPORT :: get_parameter_metadata
212
      integer(c_int),        intent(in), value             :: index,length
213
      character(kind=c_char),intent(out),dimension(length) :: name,units,long_name
214
      integer(c_int),        intent(out)                   :: typecode,has_default
215 216 217 218 219 220 221 222 223 224

      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
225 226
      end do

227 228 229 230
      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()
231 232 233 234 235
      if (property%has_default) then
         has_default = 1
      else
         has_default = 0
      end if
236
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
237

238 239 240
   subroutine get_dependency_metadata(index,length,name,units) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_dependency_metadata
      integer(c_int),intent(in), value             :: index,length
241
      character(kind=c_char),intent(out),dimension(length) :: name,units
Jorn Bruggeman's avatar
Jorn Bruggeman committed
242

243 244 245 246
      call copy_to_c_string(environment_names(index),name)
      call copy_to_c_string(environment_units(index),units)
   end subroutine

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
   subroutine get_model_metadata(name,length,long_name) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: get_model_metadata
      character(kind=c_char),intent(in)        :: name(*)
      integer(c_int),        intent(in), value :: length
      character(kind=c_char),intent(out)       :: long_name(length)

      character(len=attribute_length),pointer :: pname
      class (type_base_model),        pointer :: found_model

      call c_f_pointer(c_loc(name), pname)
      found_model => model%root%find_model(pname(:index(pname,C_NULL_CHAR)-1))
      if (.not.associated(found_model)) call driver%fatal_error('get_model_metadata','model "'//pname(:index(pname,C_NULL_CHAR)-1)//'" not found.')
      call copy_to_c_string(found_model%long_name,long_name)
   end subroutine

262 263 264 265 266 267 268 269 270 271 272 273 274 275
   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
276

277 278 279
      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
280

281 282 283 284
   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
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
      value = model%surface_state_variables(index)%initial_value
      call fabm_link_surface_state_data(model,index,value)
   end subroutine
   
   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
301
      real(c_double),target,intent(in) :: pelagic_rates_(*)
302 303 304

      real(c_double),pointer :: pelagic_rates(:)

305 306
      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
307 308 309 310
      pelagic_rates = 0.0_rk
      call fabm_do(model,pelagic_rates)

      ! Compute rate of change in conserved quantities
311
      !call fabm_state_to_conserved_quantities(model,pelagic_rates,conserved_rates)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
312 313

      ! Normalize rate of change in conserved quantities to sum of absolute rates of change.
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
      !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
330 331
   end subroutine

332
   subroutine finalize() bind(c)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
333 334 335 336 337
      call fabm_finalize(model)
      if (allocated(environment_names)) deallocate(environment_names)
      if (allocated(environment_units)) deallocate(environment_units)
   end subroutine

338
   subroutine reset_parameter(index) bind(c)
339
      !DIR$ ATTRIBUTES DLLEXPORT :: reset_parameter
340 341
      integer(c_int),value,intent(in) :: index
      class (type_property),pointer   :: property
342

343 344 345
      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
346 347

      ! Re-initialize the model using updated parameter values
348
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
349 350
   end subroutine

351 352
   subroutine set_real_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_real_parameter
353
      character(kind=c_char),target,    intent(in) :: name(*)
354 355 356 357 358 359
      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
360 361

      ! Re-initialize the model using updated parameter values
362
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
363 364
   end subroutine

365
   function get_real_parameter(index,default) bind(c) result(value)
366
      !DIR$ ATTRIBUTES DLLEXPORT :: get_real_parameter
367
      integer(c_int),value,intent(in) :: index,default
368
      real(c_double)                  :: value
369 370 371 372 373 374 375 376 377 378 379 380 381
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_real_property)
         if (default/=0) then
            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
382 383
   end function

384 385
   subroutine set_integer_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_integer_parameter
386
      character(kind=c_char),target,    intent(in) :: name(*)
387 388 389 390 391 392
      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
393 394

      ! Re-initialize the model using updated parameter values
395
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
396 397
   end subroutine

398
   function get_integer_parameter(index,default) bind(c) result(value)
399
      !DIR$ ATTRIBUTES DLLEXPORT :: get_integer_parameter
400
      integer(c_int),value,intent(in) :: index,default
401
      integer(c_int)                  :: value
402 403 404 405 406 407 408 409 410 411 412 413 414
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_integer_property)
         if (default/=0) then
            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
415 416
   end function

417 418
   subroutine set_logical_parameter(name,value) bind(c)
      !DIR$ ATTRIBUTES DLLEXPORT :: set_logical_parameter
419
      character(kind=c_char),target,    intent(in) :: name(*)
420 421 422 423 424 425
      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_logical(pname(:index(pname,C_NULL_CHAR)-1),value/=0)
Jorn Bruggeman's avatar
Jorn Bruggeman committed
426 427

      ! Re-initialize the model using updated parameter values
428
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
429 430
   end subroutine

431
   function get_logical_parameter(index,default) bind(c) result(value)
432
      !DIR$ ATTRIBUTES DLLEXPORT :: get_logical_parameter
433
      integer(c_int),value,intent(in) :: index,default
434
      integer(c_int)                  :: value
435 436 437 438 439
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_logical_property)
440
         value = 0
441 442 443 444 445 446 447 448
         if (default/=0) then
            if (property%default) value = 1
         else
            if (property%value) value = 1
         end if
      class default
         call driver%fatal_error('get_logical_parameter','not a logical variable')
      end select
Jorn Bruggeman's avatar
Jorn Bruggeman committed
449 450
   end function

451 452 453 454 455 456 457 458 459
   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
      
      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
460 461

      ! Re-initialize the model using updated parameter values
462
      call reinitialize()
Jorn Bruggeman's avatar
Jorn Bruggeman committed
463 464
   end subroutine

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

470 471 472 473 474 475
      class (type_property),pointer   :: property

      property => model%root%parameters%get_property(index)
      select type (property)
      class is (type_string_property)
         if (default/=0) then
476
            call copy_to_c_string(property%default, value)
477
         else
478
            call copy_to_c_string(property%value, value)
479 480 481 482
         end if
      class default
         call driver%fatal_error('get_string_parameter','not a string variable')
      end select
483
   end subroutine
Jorn Bruggeman's avatar
Jorn Bruggeman committed
484

485
   subroutine python_driver_fatal_error(self,location,message)
486 487 488 489 490
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: location,message

      write (*,*) trim(location)//': '//trim(message)
      stop 1
491
   end subroutine
492

493
   subroutine python_driver_log_message(self,message)
494 495 496 497
      class (type_python_driver),intent(inout) :: self
      character(len=*),          intent(in)    :: message

      !write (*,*) trim(message)
498
   end subroutine
499

500 501 502 503 504 505 506 507 508 509 510
   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
      cstring(n+1) = C_NULL_CHAR 
   end subroutine

Jorn Bruggeman's avatar
Jorn Bruggeman committed
511 512 513 514 515
   end module fabm_python

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