Functions/Subroutines
subroutine	test_register ()

subroutine	test_deregister ()

subroutine	test_component_information ()

subroutine	test_component_removal_callbacks ()

subroutine	test_component_callbacks ()

subroutine	test_component_replacement_callbacks ()

integer function	calculate_remaining_calls (orig_value, a, b)

subroutine	insert_component_callbacks (init_callbacks, timestep_callbacks, consolidation_callbacks, modelDump_callbacks, finalisation_callbacks)

subroutine	generate_dummy_callbacks (init_callbacks, timestep_callbacks, consolidation_callbacks, modelDump_callbacks, finalisation_callbacks)

subroutine	internal_test_init (current_state)

subroutine	internal_test_timestep (current_state)

subroutine	internal_test_consolidation (current_state)

subroutine	internal_test_modeldump (current_state)

subroutine	internal_test_finalisation (current_state)

character(len=15) function	str (k)

subroutine	init_random_seed ()

subroutine	clear_counters ()

Variables
integer	init_calls = 0

integer	timestep_calls = 0

integer	consolidation_calls = 0

integer	modeldump_calls = 0

integer	finalisation_calls = 0

Function/Subroutine Documentation

◆ calculate_remaining_calls()

integer function test_registry_mod::calculate_remaining_calls	(	integer, intent(in)	orig_value,
		integer, intent(in)	a,
		integer, intent(in)	b
	)

Definition at line 210 of file test_registry.F90.

     integer, intent(in) :: orig_value, a, b
  
     if (orig_value .ge. a) then
       calculate_remaining_calls = orig_value - merge(orig_value - a+1, a+1, orig_value .le. b)
     else
       calculate_remaining_calls = orig_value
     end if

Here is the caller graph for this function:

◆ clear_counters()

subroutine test_registry_mod::clear_counters

Definition at line 327 of file test_registry.F90.

     init_calls = 0
     timestep_calls = 0
     consolidation_calls = 0
     modeldump_calls = 0
     finalisation_calls = 0

Here is the caller graph for this function:

◆ generate_dummy_callbacks()

subroutine test_registry_mod::generate_dummy_callbacks	(	integer, intent(in)	init_callbacks,
		integer, intent(in)	timestep_callbacks,
		integer, intent(in)	consolidation_callbacks,
		integer, intent(in)	modelDump_callbacks,
		integer, intent(in)	finalisation_callbacks
	)

Definition at line 247 of file test_registry.F90.

  
     integer, intent(in) :: init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modelDump_callbacks, finalisation_callbacks
     type(component_descriptor_type), pointer :: descriptor
     integer :: i
  
     do i=1,100
       allocate(descriptor)
       descriptor%name="Test "//str(i)
       descriptor%version=100-i
       if (i .le. init_callbacks) descriptor%initialisation=>internal_test_init
       if (i .le. timestep_callbacks) descriptor%timestep=>internal_test_timestep
       if (i .le. consolidation_callbacks) descriptor%consolidation=>internal_test_consolidation
       if (i .le. modeldump_callbacks) descriptor%modeldump=>internal_test_modeldump
       if (i .le. finalisation_callbacks) descriptor%finalisation=>internal_test_finalisation
       call register_component(descriptor)
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init_random_seed()

subroutine test_registry_mod::init_random_seed

Definition at line 311 of file test_registry.F90.

     integer :: i, n, clock
     integer, dimension(:), allocatable :: seed
  
     call random_seed(size = n)
     allocate(seed(n))
  
     call system_clock(count=clock)
  
     seed = clock + 37 * (/ (i - 1, i = 1, n) /)
     call random_seed(put = seed)
  
     deallocate(seed)

Here is the caller graph for this function:

◆ insert_component_callbacks()

subroutine test_registry_mod::insert_component_callbacks	(	integer, intent(out)	init_callbacks,
		integer, intent(out)	timestep_callbacks,
		integer, intent(out)	consolidation_callbacks,
		integer, intent(out)	modelDump_callbacks,
		integer, intent(out)	finalisation_callbacks
	)

Definition at line 222 of file test_registry.F90.

  
     integer, intent(out) :: init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modelDump_callbacks, finalisation_callbacks
     real :: r
  
     call init_random_seed()
  
     call random_number(r)
     init_callbacks = int(r*99)+1
     call random_number(r)
     timestep_callbacks = int(r*99)+1
     call random_number(r)
     consolidation_callbacks = int(r*99)+1
     call random_number(r)
     modeldump_callbacks = int(r*99)+1
     call random_number(r)
     finalisation_callbacks = int(r*99)+1
  
     call generate_dummy_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modeldump_callbacks, finalisation_callbacks)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ internal_test_consolidation()

subroutine test_registry_mod::internal_test_consolidation ( type(model_state_type), intent(inout), target current_state )

Definition at line 283 of file test_registry.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     consolidation_calls = consolidation_calls + 1

Here is the caller graph for this function:

◆ internal_test_finalisation()

subroutine test_registry_mod::internal_test_finalisation ( type(model_state_type), intent(inout), target current_state )

Definition at line 297 of file test_registry.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     finalisation_calls = finalisation_calls + 1

Here is the caller graph for this function:

◆ internal_test_init()

subroutine test_registry_mod::internal_test_init ( type(model_state_type), intent(inout), target current_state )

Definition at line 269 of file test_registry.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     init_calls = init_calls + 1

Here is the caller graph for this function:

◆ internal_test_modeldump()

subroutine test_registry_mod::internal_test_modeldump ( type(model_state_type), intent(inout), target current_state )

Definition at line 290 of file test_registry.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     modeldump_calls = modeldump_calls + 1

Here is the caller graph for this function:

◆ internal_test_timestep()

subroutine test_registry_mod::internal_test_timestep ( type(model_state_type), intent(inout), target current_state )

Definition at line 276 of file test_registry.F90.

     type(model_state_type), target, intent(inout) :: current_state
  
     timestep_calls = timestep_calls + 1

Here is the caller graph for this function:

◆ str()

character(len=15) function test_registry_mod::str ( integer, intent(in) k )

Definition at line 304 of file test_registry.F90.

     integer, intent(in) :: k
     write (str, *) k
     str = adjustl(str)

Here is the caller graph for this function:

◆ test_component_callbacks()

subroutine test_registry_mod::test_component_callbacks

Definition at line 155 of file test_registry.F90.

     type(model_state_type) :: testing_state
     integer :: init_callbacks, timestep_callbacks, consolidation_callbacks, modeldump_callbacks, finalisation_callbacks
  
     call clear_counters()
     call free_registry() ! Clear the registry to remove any residue from previous unit tests
     call insert_component_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modeldump_callbacks, finalisation_callbacks)
  
     ! Call the callbacks for each stage
     call execute_initialisation_callbacks(testing_state)
     call execute_timestep_callbacks(testing_state)
     call execute_consolidation_callbacks(testing_state)
     call execute_modeldump_callbacks(testing_state)
     call execute_finalisation_callbacks(testing_state)
  
     ! Check that the number of callback calls is consistent with what we expected for each stage
     call assert_equals(init_callbacks, init_calls, "Number of initialisation call-backs")
     call assert_equals(timestep_callbacks, timestep_calls, "Number of timestep call-backs")
     call assert_equals(consolidation_callbacks, consolidation_calls, "Number of consolidation call-backs")
     call assert_equals(modeldump_callbacks, modeldump_calls, "Number of model dump call-backs")
     call assert_equals(finalisation_callbacks, finalisation_calls, "Number of finalisation call-backs")

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_component_information()

subroutine test_registry_mod::test_component_information

Definition at line 78 of file test_registry.F90.

     type(model_state_type) :: testing_state
     type(component_descriptor_type), pointer :: data
     integer :: init_callbacks, timestep_callbacks, consolidation_callbacks, modeldump_callbacks,&
       finalisation_callbacks, i
  
     call free_registry() ! Clear the registry to eliminate residue of previous unit tests
     call insert_component_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
       modeldump_callbacks, finalisation_callbacks)
  
     do i=1,120
       data => get_component_info("Test "//str(i))
       if (i .le. 100) then
         call assert_true(associated(data), "Testing there is some component information if less than 100")
         call assert_equals("Test "//str(i), data%name, "Compare registered and expected name")
         call assert_equals(real(100-i), data%version, "Compare registered and expected version")
         ! Check each callback is associated if i is within range or not if i is not
         call assert_equals(merge(.true., .false., i .le. init_callbacks), associated(data%initialisation), &
           "Consistency of initialisation call-back")
         call assert_equals(merge(.true., .false., i .le. timestep_callbacks), associated(data%timestep), &
           "Consistency of timestep call-back")
         call assert_equals(merge(.true., .false., i .le. consolidation_callbacks), associated(data%consolidation), &
           "Consistency of consolidation call-back")
         call assert_equals(merge(.true., .false., i .le. modeldump_callbacks), associated(data%modeldump), &
           "Consistency of model dump call-back")
         call assert_equals(merge(.true., .false., i .le. finalisation_callbacks), associated(data%finalisation), &
           "Consistency of finalisation all-back")
       else
         call assert_false(associated(data), "No component if greater than 100") ! Not registered i>100 so should be NULL
       end if
     end do
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_component_removal_callbacks()

subroutine test_registry_mod::test_component_removal_callbacks

Definition at line 115 of file test_registry.F90.

     type(model_state_type) :: testing_state
     integer :: init_callbacks, timestep_callbacks, consolidation_callbacks, modeldump_callbacks,&
       finalisation_callbacks, i
  
     call clear_counters()
     call free_registry() ! Clear the registry to eliminate residue of previous unit tests
     call insert_component_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
       modeldump_callbacks, finalisation_callbacks)
  
     do i=25,50
       ! Now deregister 25-50 callbacks
       call deregister_component("Test "//str(i))
     end do
  
     ! In reference to the 25-50 inclusive removals, recalculate the expected number of each stage's callback
     init_callbacks = calculate_remaining_calls(init_callbacks, 25, 50)
     timestep_callbacks = calculate_remaining_calls(timestep_callbacks, 25, 50)
     consolidation_callbacks = calculate_remaining_calls(consolidation_callbacks, 25, 50)
     modeldump_callbacks = calculate_remaining_calls(modeldump_callbacks, 25, 50)
     finalisation_callbacks = calculate_remaining_calls(finalisation_callbacks, 25, 50)
  
     ! Call the stages
     call execute_initialisation_callbacks(testing_state)
     call execute_timestep_callbacks(testing_state)
     call execute_consolidation_callbacks(testing_state)
     call execute_modeldump_callbacks(testing_state)
     call execute_finalisation_callbacks(testing_state)
  
     ! Check number of calls in each stages's callbacks are appropriate
     call assert_equals(init_callbacks, init_calls, "Number of initialisation call-backs post removal")
     call assert_equals(timestep_callbacks, timestep_calls, "Number of timestep call-backs post removal")
     call assert_equals(consolidation_callbacks, consolidation_calls, "Number of consolidation call-backs post removal")
     call assert_equals(modeldump_callbacks, modeldump_calls, "Number of model dump call-backs post removal")
     call assert_equals(finalisation_callbacks, finalisation_calls, "Number of finalisation call-backs post removal")
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_component_replacement_callbacks()

subroutine test_registry_mod::test_component_replacement_callbacks

Definition at line 181 of file test_registry.F90.

     type(model_state_type), target :: testing_state
     integer :: init_callbacks, timestep_callbacks, consolidation_callbacks, modeldump_callbacks, finalisation_callbacks
  
     call clear_counters()
     call free_registry() ! Clear the registry to remove any residue of previous unit tests
     call insert_component_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modeldump_callbacks, finalisation_callbacks)
     ! Recreate our callbacks
     call generate_dummy_callbacks(init_callbacks, timestep_callbacks, consolidation_callbacks, &
          modeldump_callbacks, finalisation_callbacks)
  
     ! Execute callbacks for each stage
     call execute_initialisation_callbacks(testing_state)
     call execute_timestep_callbacks(testing_state)
     call execute_consolidation_callbacks(testing_state)
     call execute_modeldump_callbacks(testing_state)
     call execute_finalisation_callbacks(testing_state)
  
     ! Check the number of calls to each callback is consistent with what we initially expected
     call assert_equals(init_callbacks, init_calls, "Number of initialisation call-backs post replacement")
     call assert_equals(timestep_callbacks, timestep_calls, "Number of timestep call-backs post replacement")
     call assert_equals(consolidation_callbacks, consolidation_calls, "Number of consolidation call-backs post replacement")
     call assert_equals(modeldump_callbacks, modeldump_calls, "Number of model dump call-backs post replacement")
     call assert_equals(finalisation_callbacks, finalisation_calls, "Number of finalisation call-backs post replacement")

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_deregister()

subroutine test_registry_mod::test_deregister

Definition at line 53 of file test_registry.F90.

     type(component_descriptor_type), pointer :: descriptor
     type(map_type) :: component_info
     integer :: i
  
     do i=1,10
       allocate(descriptor)
       descriptor%version=100-i
       descriptor%name="Test "//str(i)
       call register_component(descriptor)
     end do
  
     component_info = get_all_registered_components()
     call assert_equals(10, c_size(component_info), "Number of registered components after registrations")
  
     do i=1,10
       call deregister_component("Test "//str(i))
       component_info = get_all_registered_components()
       call assert_equals(10-i, c_size(component_info), "Component at i has de-registered")
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

◆ test_register()

subroutine test_registry_mod::test_register

Definition at line 22 of file test_registry.F90.

     type(component_descriptor_type), pointer :: descriptor
     type(map_type) :: component_info
     class(*), pointer :: data
     integer :: i
  
     call set_unit_name('test_register')
     do i=1,10
       allocate(descriptor)
       descriptor%version=100-i
       descriptor%name="Test "//str(i)
       call register_component(descriptor)
     end do
  
     component_info = get_all_registered_components()
     call assert_equals(10, c_size(component_info), "Number of registered components after registrations")
  
     do i=1,10
       call assert_equals("Test "//str(i), c_key_at(component_info, i))
       data => c_value_at(component_info, i)
       select type(data)
         type is (real)
         call assert_equals(real(100-i), data, "Version number of component at i correct")
         class default
         call add_fail("Unknown type")
       end select
     end do

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ consolidation_calls

integer test_registry_mod::consolidation_calls = 0

Definition at line 15 of file test_registry.F90.

15 integer :: consolidation_calls = 0

◆ finalisation_calls

integer test_registry_mod::finalisation_calls = 0

Definition at line 17 of file test_registry.F90.

17 integer :: finalisation_calls = 0

◆ init_calls

integer test_registry_mod::init_calls = 0

Definition at line 13 of file test_registry.F90.

13 integer :: init_calls = 0

◆ modeldump_calls

integer test_registry_mod::modeldump_calls = 0

Definition at line 16 of file test_registry.F90.

16 integer :: modeldump_calls = 0

◆ timestep_calls

integer test_registry_mod::timestep_calls = 0

Definition at line 14 of file test_registry.F90.

14 integer :: timestep_calls = 0

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ calculate_remaining_calls()

◆ clear_counters()

◆ generate_dummy_callbacks()

◆ init_random_seed()

◆ insert_component_callbacks()

◆ internal_test_consolidation()

◆ internal_test_finalisation()

◆ internal_test_init()

◆ internal_test_modeldump()

◆ internal_test_timestep()

◆ str()

◆ test_component_callbacks()

◆ test_component_information()

◆ test_component_removal_callbacks()

◆ test_component_replacement_callbacks()

◆ test_deregister()

◆ test_register()

Variable Documentation

◆ consolidation_calls

◆ finalisation_calls

◆ init_calls

◆ modeldump_calls

◆ timestep_calls