diagnostic_federator_mod Module Reference

This diagnostics federator will take in data fields sent from a MONC, perform operators on these as required by the diagnostics definition to produce diagnostic instantaneous fields which are then sent along to anything interested in them. More...

Data Types
type	all_diagnostics_at_timestep_type
type	diagnostics_activity_type
type	diagnostics_at_timestep_type
type	diagnostics_type

Functions/Subroutines
type(hashmap_type) function, public	initialise_diagnostic_federator (io_configuration)
	Initialises the diagnostics action and sets up the diagnostics master definitions. More...
logical function, public	check_diagnostic_federator_for_completion (io_configuration)
	Checks whether the diagnostics federator has completed or not, this is really checking all the underlying operations and communications to ensure that the data has been sent all the way through. More...
subroutine, public	finalise_diagnostic_federator (io_configuration)
	Finalises the diagnostics federator, waiting for all outstanding requests and then freeing data. More...
type(hashmap_type) function, public	determine_diagnostics_fields_available (monc_field_names)
	Determines the diagnostics fields that are available based upon the input MONC fields on registration that will be sent from MONC to the IO server. More...
subroutine, public	pass_fields_to_diagnostics_federator (io_configuration, source, data_id, data_dump)
	Entry point into the diagnostics federator this runs the diagnostics, executing the defined rules based upon the input data. More...
subroutine	check_all_activities_against_completed_fields (io_configuration, timestep_entry, diagnostics_by_timestep)
	Checks all pending activities against the completed fields and runs them if the required fields are now available. More...
logical function	handle_operator_completion (io_configuration, timestep_entry, specific_activity)
	Handles the completion of the operator. More...
subroutine	handle_completion (io_configuration, values, field_name, timestep)
	Handles inter io reduction completion, it adds the resulting value to the appropriate completion lists and then checks the pending activities and runs them if we can execute any of these based upon this value. More...
subroutine	handle_completion_for_specific_monc_timestep_entry (io_configuration, result_to_add, field_name, timestep_entry, diagnostics_by_timestep)
	This handles inter IO completion for a specific timestep entry. This is required as at a timestep there can be multiple entires based on each MONC which communicates with the IO server so we handle an individual one here. More...
subroutine	handle_diagnostic_calculation_completed (io_configuration, diagnostic_index, timestep_entry, diagnostics_by_timestep)
	Handles completion of a diagnostic calculation and will then pass this onto interested parties. More...
logical function	are_fields_available_for_activity (timestep_entry, activity)
	Determines whether the fields required for an activity are available so that activity can be run. More...
subroutine	perform_inter_io_communication (io_configuration, timestep_entry, all_entries_at_timestep, activity, value_to_send, communication_field_name)
	Performs the actual inter IO communication by calling out to the appropriate inter IO module. More...
subroutine	issue_communication_calls (io_configuration, timestep_entry, diagnostics_by_timestep, source, data_id, data_dump)
	Issues any inter io communucation calls that are appropriate based upon the data recieved from MONC. More...
subroutine	check_diagnostics_entries_against_data (io_configuration, source, data_id, data_dump, timestep_diagnostics_entry)
	Checks the outstanding fields of a time step entry against the data recieved from MONC and moves any acquired data from the outstanding set to the completed, along with its value. More...
subroutine	clean_diagnostic_states (current_timestep)
	Cleans the diagnostic states if required (based on the timestep period) More...
subroutine	deallocate_diagnostics_at_timestep (key)
	Deallocates all the diagnostics at a specific timestep, this removes all the individual MONC timestep entries and deallocates internal all diagnostic data, but keeps the all diagnostic entry in the list (which is removed by the caller) More...
type(data_values_type) function, pointer	get_value_from_monc_data (io_configuration, source, data_id, data_dump, field_name)
	Retrieves a value from the communicated MONC data. If this was an integer then converts to a real. More...
integer function	get_datatype_of_field (fields, field_name)
	Retrieves the data type of a field or 0 if the field was not found. More...
type(diagnostics_at_timestep_type) function, pointer	find_or_register_timestep_entry (io_configuration, timestep, source, time)
	Locates or registers a new (if it does not exist) time step entry based upon the timestep and source MONC process. This is a timestep/source specific state which represents progress through the overall diagnostic configuration. More...
type(diagnostics_at_timestep_type) function, pointer	create_timestep_entry (io_configuration, timestep, time, source)
	Creates a timestep entry and processes all members, determining activities their required fields etc... More...
subroutine	add_required_fields_if_needed (required_fields)
	Adds the required fields of an activity to the overall required fields which are cloned for each new timestep entry. More...
type(diagnostics_activity_type) function, pointer	retrieve_next_activity (iterator)
	Retrieves the next activity in a collection being iterated over by an iterator. More...
type(diagnostics_at_timestep_type) function, pointer	get_timestep_entry (timestep, source, do_lock)
	Retrieves the timestep at a specific timestep and source MONC. More...
type(all_diagnostics_at_timestep_type) function, pointer	find_or_add_diagnostics_by_timestep (timestep)
	Finds or adds diagnostics by timestep. This is used to maintain a list of all diagnostic entries for a specific timestep for every MONC source process. More...
type(all_diagnostics_at_timestep_type) function, pointer	get_diagnostics_by_timestep (timestep, do_lock)
	Retrieves the diagnostics list (each MONC source) at a specific timestep. More...
type(diagnostics_at_timestep_type) function, pointer	retrieve_next_specific_monc_timestep_entry (iterator)
	Retrieves the next MONC timestep entry from the all diagnostics based upon a collections iterator. More...
type(all_diagnostics_at_timestep_type) function, pointer	get_diagnostic_by_key (key)
	Retrieves all diagnostics at a timestep by its key. More...
type(all_diagnostics_at_timestep_type) function, pointer	retrieve_diagnostics (mapentry)
	Retrieves the all diagnostics at a specific timestep from its map entry. More...
type(diagnostics_activity_type) function, pointer	get_comm_activity_from_fieldname (diagnostics_by_timestep, field_name)
	Retrieves a communication activity from its field name. More...
type(io_configuration_misc_item_type) function, pointer	get_misc_action_at_index (action_members, index)
	Retrieves a misc action from the parsed user XML configuration at a specific index. More...
subroutine	define_diagnostics (io_configuration, diagnostic_generation_frequency)
	Based upon the IO configuration this will define the diagnostics structure. It is done once at initialisation and then this same information is used for execution at each data arrival point. More...
type(diagnostics_activity_type) function, pointer	get_diagnostic_activity_by_result_name (result_name, diagnostic_entry_index)
	Retrives a diagnostic activity based upon its result name or null if none is found. More...
subroutine	process_auto_dimensions (io_configuration, diagnostic_configuration, entry_index)
	Processes all auto dimensions by looking them up and resolving them based upon the operators. More...
integer function	get_diagnostic_generation_frequency (io_configuration, required_fields)
	Retrieves the max diagnostic generation frequency for a set of fields. More...
integer function	get_field_frequency (io_configuration, field_name)
	Retrieves the generation frequency for a specific field. More...
character(len=string_length) function	generate_activity_diagnostic_key (diagnostic, activity)
	Generates a unique key for an activity within a diagnostic, which is unique amongst all diagnostics and their activities. More...

Variables
integer, parameter	operator_type =1
integer, parameter	reduction_type =2
integer, parameter	broadcast_type =3
integer, parameter	allreduction_type =4
integer, parameter	perform_clean_every =100
	A wrapper type containing all the diagnostics for MONC source processes at a specific timestep. More...
type(hashmap_type), volatile	diagnostics_per_monc_at_timestep
type(hashmap_type), volatile	all_diagnostics_at_timestep
type(hashset_type), volatile	all_outstanding_fields
type(hashset_type), volatile	available_fields
type(diagnostics_type), dimension(:), allocatable, volatile	diagnostic_definitions
integer, volatile	timestep_entries_rwlock
integer, volatile	all_diagnostics_per_timestep_rwlock
integer, volatile	clean_progress_mutex
integer, volatile	previous_clean_point
integer, volatile	previous_viewed_timestep
integer, volatile	current_point

Detailed Description

This diagnostics federator will take in data fields sent from a MONC, perform operators on these as required by the diagnostics definition to produce diagnostic instantaneous fields which are then sent along to anything interested in them.

Function/Subroutine Documentation

add_required_fields_if_needed()

subroutine diagnostic_federator_mod::add_required_fields_if_needed ( type(list_type), intent(inout)  required_fields )

private

Adds the required fields of an activity to the overall required fields which are cloned for each new timestep entry.

Parameters

required_fields

The required fields of an activity

Definition at line 880 of file diagnostic_federator.F90.

    type(list_type), intent(inout) :: required_fields

    type(iterator_type) :: iterator

    if (.not. c_is_empty(required_fields)) then
      iterator=c_get_iterator(required_fields)
      do while (c_has_next(iterator))
        call c_add_string(all_outstanding_fields, c_next_string(iterator))
      end do     
    end if

Here is the caller graph for this function:

are_fields_available_for_activity()

logical function diagnostic_federator_mod::are_fields_available_for_activity ( type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(diagnostics_activity_type)  activity  )

private

Determines whether the fields required for an activity are available so that activity can be run.

Parameters

timestep_entry	The timestep entry that we are checking the completed fields for
activity	The activity that we are checking

Returns

Whether the required fields for the activity are available

Definition at line 475 of file diagnostic_federator.F90.

    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    type(diagnostics_activity_type) :: activity

    character(len=STRING_LENGTH) :: field_name
    type(iterator_type) :: iterator

    are_fields_available_for_activity=.true.
    if (.not. c_is_empty(activity%required_fields)) then      
      call check_thread_status(forthread_rwlock_rdlock(timestep_entry%completed_fields_rwlock))
      iterator=c_get_iterator(activity%required_fields)
      do while (c_has_next(iterator))
        field_name=c_next_string(iterator)
        if (.not. c_contains(timestep_entry%completed_fields, field_name)) then          
          are_fields_available_for_activity=.false.
          exit
        end if
      end do      
      call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))
    end if

Here is the caller graph for this function:

check_all_activities_against_completed_fields()

subroutine diagnostic_federator_mod::check_all_activities_against_completed_fields ( type(io_configuration_type), intent(inout)  io_configuration, type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(all_diagnostics_at_timestep_type), intent(inout)  diagnostics_by_timestep  )

private

Checks all pending activities against the completed fields and runs them if the required fields are now available.

Parameters

io_configuration	The IO server configuration
timestep_entry	The timestep entry that we are checking against

Definition at line 232 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    type(all_diagnostics_at_timestep_type), intent(inout) :: diagnostics_by_timestep

    integer :: j, num_diags
    type(diagnostics_activity_type), pointer :: activity
    character(len=STRING_LENGTH) :: field_name, activity_diag_key
    logical :: updated_entry, entry_in_completed_diagnostics, operator_produced_values
    type(data_values_type) :: value_to_send
    type(iterator_type) :: activities_iterator

    updated_entry=.true.
    
    call check_thread_status(forthread_mutex_lock(timestep_entry%activity_completion_mutex))
    do while (updated_entry)
      updated_entry=.false.      
      num_diags=size(diagnostic_definitions)
      do j=1, num_diags
        call check_thread_status(forthread_rwlock_rdlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
        entry_in_completed_diagnostics=c_contains(diagnostics_by_timestep%completed_diagnostics, &
             diagnostic_definitions(j)%diagnostic_name)
        call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
        if (diagnostic_definitions(j)%collective .or. .not. entry_in_completed_diagnostics) then
          activities_iterator=c_get_iterator(diagnostic_definitions(j)%activities)
          do while (c_has_next(activities_iterator))
            activity=>retrieve_next_activity(activities_iterator)
            activity_diag_key=generate_activity_diagnostic_key(diagnostic_definitions(j), activity)
            if (.not. c_contains(timestep_entry%completed_activities, activity_diag_key)) then
              if (are_fields_available_for_activity(timestep_entry, activity)) then
                call c_add_string(timestep_entry%completed_activities, activity_diag_key)
                updated_entry=.true.              
                if (activity%activity_type == operator_type) then                        
                  operator_produced_values=handle_operator_completion(io_configuration, timestep_entry, activity)
                  if (operator_produced_values .and. activity%result_name == diagnostic_definitions(j)%diagnostic_name) then
                    call handle_diagnostic_calculation_completed(io_configuration, j, timestep_entry, diagnostics_by_timestep)
                  end if
                else if (activity%activity_type == reduction_type .or. activity%activity_type == broadcast_type &
                     .or. activity%activity_type == allreduction_type) then
                  field_name=c_get_string(activity%required_fields, 1)
                  call check_thread_status(forthread_rwlock_rdlock(timestep_entry%completed_fields_rwlock))
                  value_to_send=get_data_value_by_field_name(timestep_entry%completed_fields, field_name)
                  call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))
                  call check_thread_status(forthread_mutex_unlock(timestep_entry%activity_completion_mutex))
                  call perform_inter_io_communication(io_configuration, timestep_entry, diagnostics_by_timestep, &
                       activity, value_to_send, field_name)
                  call check_thread_status(forthread_mutex_lock(timestep_entry%activity_completion_mutex))
                end if
              end if
            end if
          end do
        end if
      end do  
    end do
    call check_thread_status(forthread_mutex_unlock(timestep_entry%activity_completion_mutex))

Here is the call graph for this function:

Here is the caller graph for this function:

check_diagnostic_federator_for_completion()

logical function, public diagnostic_federator_mod::check_diagnostic_federator_for_completion

(

type(io_configuration_type), intent(inout)

io_configuration

)

Checks whether the diagnostics federator has completed or not, this is really checking all the underlying operations and communications to ensure that the data has been sent all the way through.

Parameters

io_configuration

Configuration state of the IO server

Returns

Whether the federator has completed

Definition at line 111 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration

    check_diagnostic_federator_for_completion=check_reduction_inter_io_for_completion(io_configuration)
    if (check_diagnostic_federator_for_completion) then
      check_diagnostic_federator_for_completion=check_broadcast_inter_io_for_completion(io_configuration)
      if (check_diagnostic_federator_for_completion) then
        check_diagnostic_federator_for_completion=check_allreduction_inter_io_for_completion(io_configuration)
      end if      
    end if

Here is the caller graph for this function:

check_diagnostics_entries_against_data()

subroutine diagnostic_federator_mod::check_diagnostics_entries_against_data ( type(io_configuration_type), intent(inout)  io_configuration, integer, intent(in)  source, integer, intent(in)  data_id, character, dimension(:), intent(in), allocatable  data_dump, type(diagnostics_at_timestep_type), intent(inout)  timestep_diagnostics_entry  )

private

Checks the outstanding fields of a time step entry against the data recieved from MONC and moves any acquired data from the outstanding set to the completed, along with its value.

Parameters

io_configuration	Configuration of the IO server
source	The source PID of the MONC process
data_id	The ID of the data definition that is represented by the dump
data_dump	The data we have received from MONC
timestep_diagnostics_entry	The timestep entry

Definition at line 598 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: source, data_id
    character, dimension(:), allocatable, intent(in) :: data_dump
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_diagnostics_entry

    type(iterator_type) :: iterator
    character(len=STRING_LENGTH) :: field_name
    type(data_values_type), pointer :: field_value
    type(hashset_type) :: removed_entries
    class(*), pointer :: generic
        
    if (.not. c_is_empty(timestep_diagnostics_entry%outstanding_fields)) then
      call check_thread_status(forthread_rwlock_rdlock(timestep_diagnostics_entry%outstanding_fields_rwlock))
      iterator=c_get_iterator(timestep_diagnostics_entry%outstanding_fields)
      do while (c_has_next(iterator))
        field_name=c_next_string(iterator)
        if (is_field_present(io_configuration, source, data_id, field_name)) then
          field_value=>get_value_from_monc_data(io_configuration, source, data_id, data_dump, field_name)
          generic=>field_value
          call check_thread_status(forthread_rwlock_wrlock(timestep_diagnostics_entry%completed_fields_rwlock))
          call c_put_generic(timestep_diagnostics_entry%completed_fields, trim(field_name), generic, .false.)
          call check_thread_status(forthread_rwlock_unlock(timestep_diagnostics_entry%completed_fields_rwlock))
          call c_add_string(removed_entries, field_name)
        end if
      end do
      call check_thread_status(forthread_rwlock_unlock(timestep_diagnostics_entry%outstanding_fields_rwlock))
      if (.not. c_is_empty(removed_entries)) then
        iterator=c_get_iterator(removed_entries)
        call check_thread_status(forthread_rwlock_wrlock(timestep_diagnostics_entry%outstanding_fields_rwlock))
        do while (c_has_next(iterator))
          call c_remove(timestep_diagnostics_entry%outstanding_fields, c_next_string(iterator))
        end do
        call check_thread_status(forthread_rwlock_unlock(timestep_diagnostics_entry%outstanding_fields_rwlock))
      end if
    end if
    call c_free(removed_entries)

Here is the call graph for this function:

Here is the caller graph for this function:

clean_diagnostic_states()

subroutine diagnostic_federator_mod::clean_diagnostic_states ( integer, intent(in)  current_timestep )

private

Cleans the diagnostic states if required (based on the timestep period)

Parameters

current_timestep

The current timestep which is checked against the previous run timestep

Definition at line 639 of file diagnostic_federator.F90.

    integer, intent(in) :: current_timestep

    integer :: have_lock, outstanding_diags, outstanding_datas
    type(list_type) :: entries_to_remove
    type(iterator_type) :: iterator, all_diagnostics_iterator
    type(mapentry_type) :: all_diag_mapentry
    type(all_diagnostics_at_timestep_type), pointer :: specific_all_diagnostics_for_ts
    type(diagnostics_at_timestep_type), pointer :: specific_monc_timestep_entry
    logical :: all_completed
    character(len=STRING_LENGTH) :: entry_key

    have_lock=forthread_mutex_trylock(clean_progress_mutex)
    if (have_lock == 0) then
      if (previous_viewed_timestep .ne. current_timestep) then
        current_point=current_point+1
        previous_viewed_timestep=current_timestep
      end if
      if (previous_clean_point + perform_clean_every .lt. current_point) then
        previous_clean_point=current_point
        call check_thread_status(forthread_rwlock_rdlock(all_diagnostics_per_timestep_rwlock))
        all_diagnostics_iterator=c_get_iterator(all_diagnostics_at_timestep)
        do while(c_has_next(all_diagnostics_iterator))
          all_diag_mapentry=c_next_mapentry(all_diagnostics_iterator)
          specific_all_diagnostics_for_ts=>retrieve_diagnostics(all_diag_mapentry)
          call check_thread_status(forthread_mutex_lock(specific_all_diagnostics_for_ts%completed_num_mutex))
          if (specific_all_diagnostics_for_ts%completed_num == 0) then
            iterator=c_get_iterator(specific_all_diagnostics_for_ts%diagnostic_entries)
            all_completed=.true.
            do while (c_has_next(iterator))
              specific_monc_timestep_entry=>retrieve_next_specific_monc_timestep_entry(iterator)
              call check_thread_status(forthread_mutex_lock(specific_monc_timestep_entry%deletion_metric_mutex))
              outstanding_diags=specific_monc_timestep_entry%number_diags_outstanding
              outstanding_datas=specific_monc_timestep_entry%number_datas_outstanding
              call check_thread_status(forthread_mutex_unlock(specific_monc_timestep_entry%deletion_metric_mutex))
              if (outstanding_diags .gt. 0 .or. outstanding_datas .gt. 0) then
                all_completed=.false.
                exit
              end if
            end do
            if (all_completed) then
              call c_add_string(entries_to_remove, all_diag_mapentry%key)
            end if
          end if
          call check_thread_status(forthread_mutex_unlock(specific_all_diagnostics_for_ts%completed_num_mutex))
        end do
        call check_thread_status(forthread_rwlock_unlock(all_diagnostics_per_timestep_rwlock))

        if (.not. c_is_empty(entries_to_remove)) then
          call check_thread_status(forthread_rwlock_wrlock(all_diagnostics_per_timestep_rwlock))
          iterator=c_get_iterator(entries_to_remove)
          do while (c_has_next(iterator))
            entry_key=c_next_string(iterator)
            call deallocate_diagnostics_at_timestep(entry_key)
            call c_remove(all_diagnostics_at_timestep, entry_key)
          end do
          call check_thread_status(forthread_rwlock_unlock(all_diagnostics_per_timestep_rwlock))
          call c_free(entries_to_remove)
        end if
      end if
      call check_thread_status(forthread_mutex_unlock(clean_progress_mutex))
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

create_timestep_entry()

type(diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::create_timestep_entry ( type(io_configuration_type), intent(inout)  io_configuration, integer, intent(in)  timestep, real(kind=default_precision), intent(in)  time, integer, intent(in)  source  )

private

Creates a timestep entry and processes all members, determining activities their required fields etc...

Parameters

timestep

The timestep that we are locating for

Returns

The new timestep entry

Definition at line 838 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: timestep, source
    real(kind=DEFAULT_PRECISION), intent(in) :: time
    type(diagnostics_at_timestep_type), pointer :: create_timestep_entry

    type(iterator_type) :: iterator
    integer :: i, matched_datadefn_index

    allocate(create_timestep_entry)
    create_timestep_entry%timestep=timestep
    create_timestep_entry%time=time
    create_timestep_entry%number_diags_outstanding=c_size(available_fields)
    create_timestep_entry%source=source
    create_timestep_entry%source_location=get_monc_location(io_configuration, source)
    create_timestep_entry%number_datas_outstanding=0
    do i=1, size(io_configuration%registered_moncs(create_timestep_entry%source_location)%definition_names)
      matched_datadefn_index=retrieve_data_definition(io_configuration, &
           io_configuration%registered_moncs(create_timestep_entry%source_location)%definition_names(i))
      if (matched_datadefn_index .gt. 0) then
        if (io_configuration%data_definitions(matched_datadefn_index)%frequency .gt. 0) then
          if (mod(timestep, io_configuration%data_definitions(matched_datadefn_index)%frequency) == 0) then
            create_timestep_entry%number_datas_outstanding=create_timestep_entry%number_datas_outstanding+1
          end if
        end if
      else
        call log_log(log_warn, "IO server can not find data definition with name "&
             //io_configuration%registered_moncs(create_timestep_entry%source_location)%definition_names(i))
      end if
    end do
    iterator=c_get_iterator(all_outstanding_fields)
    do while (c_has_next(iterator))      
      call c_add_string(create_timestep_entry%outstanding_fields, c_next_string(iterator))
    end do
    call check_thread_status(forthread_mutex_init(create_timestep_entry%activity_completion_mutex, -1))
    call check_thread_status(forthread_mutex_init(create_timestep_entry%deletion_metric_mutex, -1))
    call check_thread_status(forthread_rwlock_init(create_timestep_entry%completed_fields_rwlock, -1))
    call check_thread_status(forthread_rwlock_init(create_timestep_entry%outstanding_fields_rwlock, -1))

Here is the caller graph for this function:

deallocate_diagnostics_at_timestep()

subroutine diagnostic_federator_mod::deallocate_diagnostics_at_timestep ( character(len=*), intent(in)  key )

private

Deallocates all the diagnostics at a specific timestep, this removes all the individual MONC timestep entries and deallocates internal all diagnostic data, but keeps the all diagnostic entry in the list (which is removed by the caller)

Parameters

key	The look up key which corresponds to the all diagnostics entry

Definition at line 706 of file diagnostic_federator.F90.

    character(len=*), intent(in) :: key

    type(all_diagnostics_at_timestep_type), pointer :: all_diagnostics_at_ts
    type(diagnostics_at_timestep_type), pointer :: specific_monc_timestep_entry
    type(data_values_type), pointer :: field_data_value
    integer :: cfentries, j
    type(iterator_type) :: iterator, completed_fields_iterator
    class(*), pointer :: generic

    all_diagnostics_at_ts=>get_diagnostic_by_key(key)
    if (associated(all_diagnostics_at_ts)) then
      iterator=c_get_iterator(all_diagnostics_at_ts%diagnostic_entries)
      do while (c_has_next(iterator))
        specific_monc_timestep_entry=>retrieve_next_specific_monc_timestep_entry(iterator)
        call check_thread_status(forthread_rwlock_destroy(specific_monc_timestep_entry%completed_fields_rwlock))
        call check_thread_status(forthread_rwlock_destroy(specific_monc_timestep_entry%outstanding_fields_rwlock))
        call check_thread_status(forthread_mutex_destroy(specific_monc_timestep_entry%activity_completion_mutex))
        call check_thread_status(forthread_mutex_destroy(specific_monc_timestep_entry%deletion_metric_mutex))
        call c_free(specific_monc_timestep_entry%outstanding_fields)
        call c_free(specific_monc_timestep_entry%completed_activities)
        completed_fields_iterator=c_get_iterator(specific_monc_timestep_entry%completed_fields)
        do while (c_has_next(completed_fields_iterator))
          field_data_value=>get_data_value_from_map_entry(c_next_mapentry(completed_fields_iterator))
          if (allocated(field_data_value%values)) deallocate(field_data_value%values)
          deallocate(field_data_value)
        end do                
        call c_free(specific_monc_timestep_entry%completed_fields)
      end do
      call c_free(all_diagnostics_at_ts%completed_diagnostics)
      call c_free(all_diagnostics_at_ts%communication_corresponding_activities)
      iterator=c_get_iterator(all_diagnostics_at_ts%diagnostic_entries)
      do while (c_has_next(iterator))
        generic=>c_next_generic(iterator)
        if (associated(generic)) deallocate(generic)
      end do
      call c_free(all_diagnostics_at_ts%diagnostic_entries)
      call check_thread_status(forthread_rwlock_destroy(all_diagnostics_at_ts%communication_corresponding_activities_rwlock))
      call check_thread_status(forthread_rwlock_destroy(all_diagnostics_at_ts%completed_diagnostics_rwlock))
      call check_thread_status(forthread_mutex_destroy(all_diagnostics_at_ts%completed_num_mutex))
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

define_diagnostics()

subroutine diagnostic_federator_mod::define_diagnostics ( type(io_configuration_type), intent(inout)  io_configuration, type(hashmap_type), intent(out)  diagnostic_generation_frequency  )

private

Based upon the IO configuration this will define the diagnostics structure. It is done once at initialisation and then this same information is used for execution at each data arrival point.

Parameters

io_configuration	The IO server configuration
diagnostic_generation_frequency	Map of diagnostic name to the frequency (in timesteps) of generation

Definition at line 1104 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(hashmap_type), intent(out) :: diagnostic_generation_frequency

    integer :: i, j, entries, action_entities, activity_freq
    type(io_configuration_misc_item_type), pointer :: misc_action
    type(diagnostics_activity_type), pointer :: item
    character(len=STRING_LENGTH) :: activity_name

    class(*), pointer :: generic

    entries=io_configuration%number_of_diagnostics
    if (entries .gt. 0) then
      allocate(diagnostic_definitions(entries))

      do i=1, entries
        diagnostic_definitions(i)%uuid=conv_to_string(i)
        diagnostic_definitions(i)%generation_timestep_frequency=0
        diagnostic_definitions(i)%diagnostic_name=io_configuration%diagnostics(i)%name
        diagnostic_definitions(i)%diagnostic_namespace=io_configuration%diagnostics(i)%namespace
        diagnostic_definitions(i)%collective=io_configuration%diagnostics(i)%collective
        action_entities=c_size(io_configuration%diagnostics(i)%members)
        if (action_entities .gt. 0) then
          do j=1, action_entities
            misc_action=>get_misc_action_at_index(io_configuration%diagnostics(i)%members, j)
            allocate(item)
            item%uuid=conv_to_string(j)
            item%result_name=c_get_string(misc_action%embellishments, "result")
            if (c_contains(misc_action%embellishments, "root")) then
              if (get_action_attribute_string(misc_action%embellishments, "root") .eq. "auto") then
                item%root=mod(i, io_configuration%number_of_io_servers)
              else
                item%root=get_action_attribute_integer(misc_action%embellishments, "root")
              end if
            else
              item%root=-1
            end if
            if (misc_action%type .eq. "operator") then
              activity_name=c_get_string(misc_action%embellishments, "name")
              item%activity_name=activity_name
              item%required_fields=get_operator_required_fields(activity_name, misc_action%embellishments)
              item%activity_attributes=misc_action%embellishments
              item%operator_procedure=>get_operator_perform_procedure(activity_name)
              item%activity_type=operator_type          
            else if (misc_action%type .eq. "communication") then
              if (item%root .lt. 0) call log_log(log_error, "Root must be supplied and 0 or greater for communication actions")
              activity_name=c_get_string(misc_action%embellishments, "name")
              if (activity_name .eq. "reduction" .or. activity_name .eq. "allreduction") then            
                call c_add_string(item%required_fields, c_get_string(misc_action%embellishments, "field"))
                item%activity_type=merge(reduction_type, allreduction_type, activity_name .eq. "reduction")
                item%communication_operator=get_reduction_operator(c_get_string(misc_action%embellishments, "operator"))
              else if (activity_name .eq. "broadcast") then            
                call c_add_string(item%required_fields, c_get_string(misc_action%embellishments, "field"))
                item%activity_type=broadcast_type
              end if
            end if
            call add_required_fields_if_needed(item%required_fields)
            activity_freq=get_diagnostic_generation_frequency(io_configuration, item%required_fields)
            if (diagnostic_definitions(i)%generation_timestep_frequency .lt. activity_freq) then
              diagnostic_definitions(i)%generation_timestep_frequency=activity_freq
            end if
            generic=>item
            call c_add_generic(diagnostic_definitions(i)%activities, generic, .false.)
          end do
        end if
        call c_put_integer(diagnostic_generation_frequency, diagnostic_definitions(i)%diagnostic_name, &
             diagnostic_definitions(i)%generation_timestep_frequency)
        call process_auto_dimensions(io_configuration, io_configuration%diagnostics(i), i)
      end do
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

determine_diagnostics_fields_available()

type(hashmap_type) function, public diagnostic_federator_mod::determine_diagnostics_fields_available

(

type(hashset_type), intent(inout)

monc_field_names

)

Determines the diagnostics fields that are available based upon the input MONC fields on registration that will be sent from MONC to the IO server.

Parameters

monc_field_names

Set of field names that are made available from MONC to the IO server

Returns

The set of available diagnostics

Definition at line 142 of file diagnostic_federator.F90.

    type(hashset_type), intent(inout) :: monc_field_names

    integer :: i, k, num_fields, diag_root
    type(diagnostics_activity_type) :: specific_activity
    type(hashset_type) :: result_names_for_activities
    type(iterator_type) :: required_fields_iterator, activities_iterator
    character(len=STRING_LENGTH) :: specific_field_name
    logical :: diagnostic_provided

    if (.not. allocated(diagnostic_definitions)) return

    do i=1, size(diagnostic_definitions)
      diag_root=-1
      diagnostic_provided=.true.
      activities_iterator=c_get_iterator(diagnostic_definitions(i)%activities)
      do while (c_has_next(activities_iterator))
        specific_activity=retrieve_next_activity(activities_iterator)
        call c_add_string(result_names_for_activities, specific_activity%result_name)
      end do

      activities_iterator=c_get_iterator(diagnostic_definitions(i)%activities)
      do while (c_has_next(activities_iterator))
        specific_activity=retrieve_next_activity(activities_iterator)
        if (specific_activity%root .ne. -1 .and. diag_root == -1) diag_root=specific_activity%root
        required_fields_iterator=c_get_iterator(specific_activity%required_fields)
        do while (c_has_next(required_fields_iterator))
          specific_field_name=c_next_string(required_fields_iterator)
          if (.not. c_contains(result_names_for_activities, specific_field_name) .and. &
               .not. c_contains(monc_field_names, specific_field_name)) then            
            diagnostic_provided=.false.
            exit
          end if
        end do        
        if (.not. diagnostic_provided) exit
      end do
      if (diagnostic_provided) then
        call c_put_integer(determine_diagnostics_fields_available, diagnostic_definitions(i)%diagnostic_name, diag_root)
        call c_add_string(available_fields, diagnostic_definitions(i)%diagnostic_name)
      end if
      call c_free(result_names_for_activities)
    end do    

Here is the call graph for this function:

Here is the caller graph for this function:

finalise_diagnostic_federator()

subroutine, public diagnostic_federator_mod::finalise_diagnostic_federator

(

type(io_configuration_type), intent(inout)

io_configuration

)

Finalises the diagnostics federator, waiting for all outstanding requests and then freeing data.

Parameters

io_configuration

Configuration state of the IO server

Definition at line 125 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration

    call finalise_broadcast_inter_io()
    call finalise_reduction_inter_io(io_configuration)
    call finalise_allreduction_inter_io(io_configuration)
    call finalise_global_callback_inter_io(io_configuration)
    call check_thread_status(forthread_rwlock_destroy(timestep_entries_rwlock))
    call check_thread_status(forthread_rwlock_destroy(all_diagnostics_per_timestep_rwlock))
    call check_thread_status(forthread_mutex_destroy(clean_progress_mutex))
    call finalise_operators()   

Here is the caller graph for this function:

find_or_add_diagnostics_by_timestep()

type(all_diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::find_or_add_diagnostics_by_timestep ( integer, intent(in)  timestep )

private

Finds or adds diagnostics by timestep. This is used to maintain a list of all diagnostic entries for a specific timestep for every MONC source process.

Parameters

timestep

The corresponding timestep

Returns

The diagnostics at the timestep or a new diagnostics if none was found

Definition at line 943 of file diagnostic_federator.F90.

    integer, intent(in) :: timestep
    type(all_diagnostics_at_timestep_type), pointer :: find_or_add_diagnostics_by_timestep

    class(*), pointer :: generic

    find_or_add_diagnostics_by_timestep=>get_diagnostics_by_timestep(timestep, .true.)
    if (.not. associated(find_or_add_diagnostics_by_timestep)) then
      call check_thread_status(forthread_rwlock_wrlock(all_diagnostics_per_timestep_rwlock))
      find_or_add_diagnostics_by_timestep=>get_diagnostics_by_timestep(timestep, .false.)
      if (.not. associated(find_or_add_diagnostics_by_timestep)) then
        allocate(find_or_add_diagnostics_by_timestep)
        call check_thread_status(forthread_rwlock_init(&
             find_or_add_diagnostics_by_timestep%communication_corresponding_activities_rwlock, -1))
        call check_thread_status(forthread_rwlock_init(find_or_add_diagnostics_by_timestep%completed_diagnostics_rwlock, -1))
        call check_thread_status(forthread_mutex_init(find_or_add_diagnostics_by_timestep%completed_num_mutex, -1))
        find_or_add_diagnostics_by_timestep%completed_num=0
        generic=>find_or_add_diagnostics_by_timestep
        call c_put_generic(all_diagnostics_at_timestep, conv_to_string(timestep), generic, .false.)
      end if
      call check_thread_status(forthread_rwlock_unlock(all_diagnostics_per_timestep_rwlock))
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

find_or_register_timestep_entry()

type(diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::find_or_register_timestep_entry ( type(io_configuration_type), intent(inout)  io_configuration, integer, intent(in)  timestep, integer, intent(in)  source, real(kind=default_precision), intent(in)  time  )

private

Locates or registers a new (if it does not exist) time step entry based upon the timestep and source MONC process. This is a timestep/source specific state which represents progress through the overall diagnostic configuration.

Parameters

timestep	The timestep that we are locating for
source	The source MONC process ID

Returns

The specific timestep entry

Definition at line 808 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: timestep, source
    real(kind=DEFAULT_PRECISION), intent(in) :: time
    type(diagnostics_at_timestep_type), pointer :: find_or_register_timestep_entry

    class(*), pointer :: generic
    type(all_diagnostics_at_timestep_type), pointer :: all_diags_by_timestep

    find_or_register_timestep_entry=>get_timestep_entry(timestep, source, .true.)
    if (.not. associated(find_or_register_timestep_entry)) then
      call check_thread_status(forthread_rwlock_wrlock(timestep_entries_rwlock))
      find_or_register_timestep_entry=>get_timestep_entry(timestep, source, .false.)
      if (.not. associated(find_or_register_timestep_entry)) then
        find_or_register_timestep_entry=>create_timestep_entry(io_configuration, timestep, time, source)
        generic=>find_or_register_timestep_entry
        call c_put_generic(diagnostics_per_monc_at_timestep, conv_to_string(timestep)//"#"//conv_to_string(source), &
             generic, .false.)
        all_diags_by_timestep=>find_or_add_diagnostics_by_timestep(timestep)
        call check_thread_status(forthread_rwlock_wrlock(all_diagnostics_per_timestep_rwlock))
        call c_add_generic(all_diags_by_timestep%diagnostic_entries, generic, .false.)
        call check_thread_status(forthread_rwlock_unlock(all_diagnostics_per_timestep_rwlock))
      end if
      call check_thread_status(forthread_rwlock_unlock(timestep_entries_rwlock))
    end if    

Here is the call graph for this function:

Here is the caller graph for this function:

generate_activity_diagnostic_key()

character(len=string_length) function diagnostic_federator_mod::generate_activity_diagnostic_key ( type(diagnostics_type), intent(in)  diagnostic, type(diagnostics_activity_type), intent(in)  activity  )

private

Generates a unique key for an activity within a diagnostic, which is unique amongst all diagnostics and their activities.

Parameters

diagnostic	The diagnostic part of the key
activity	The activity part of the key

Returns

A unique activity-diagnostic key

Definition at line 1275 of file diagnostic_federator.F90.

    type(diagnostics_type), intent(in) :: diagnostic
    type(diagnostics_activity_type), intent(in) :: activity

    generate_activity_diagnostic_key=trim(diagnostic%uuid)//"#"//trim(activity%uuid)

Here is the caller graph for this function:

get_comm_activity_from_fieldname()

type(diagnostics_activity_type) function, pointer diagnostic_federator_mod::get_comm_activity_from_fieldname ( type(all_diagnostics_at_timestep_type), intent(inout)  diagnostics_by_timestep, character(len=*), intent(in)  field_name  )

private

Retrieves a communication activity from its field name.

Parameters

timestep_entry	The timestep entry to base the look up upon
field_name	The field name to look up

Returns

The activity or null if none is found

Definition at line 1058 of file diagnostic_federator.F90.

    type(all_diagnostics_at_timestep_type), intent(inout) :: diagnostics_by_timestep
    character(len=*), intent(in) :: field_name
    type(diagnostics_activity_type), pointer :: get_comm_activity_from_fieldname

    class(*), pointer :: generic
    
    call check_thread_status(forthread_rwlock_rdlock(diagnostics_by_timestep%communication_corresponding_activities_rwlock))
    generic=>c_get_generic(diagnostics_by_timestep%communication_corresponding_activities, field_name)
    call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%communication_corresponding_activities_rwlock))
    if (associated(generic)) then
      select type(generic)
        type is(diagnostics_activity_type)
          get_comm_activity_from_fieldname=>generic
      end select      
    else
      get_comm_activity_from_fieldname=>null()
    end if    

Here is the caller graph for this function:

get_datatype_of_field()

integer function diagnostic_federator_mod::get_datatype_of_field ( type(io_configuration_field_type), dimension(:), intent(in)  fields, character(len=*), intent(in)  field_name  )

private

Retrieves the data type of a field or 0 if the field was not found.

Parameters

fields	Array of fields to search
field_name	The name of the field to locate

Returns

The data type of this field or 0 if the field was not found

Definition at line 788 of file diagnostic_federator.F90.

    type(io_configuration_field_type), dimension(:), intent(in) :: fields
    character(len=*), intent(in) :: field_name

    integer :: i

    do i=1, size(fields)
      if (fields(i)%name .eq. field_name) then
        get_datatype_of_field=fields(i)%data_type
        return
      end if      
    end do
    get_datatype_of_field=0

Here is the caller graph for this function:

get_diagnostic_activity_by_result_name()

type(diagnostics_activity_type) function, pointer diagnostic_federator_mod::get_diagnostic_activity_by_result_name ( character(len=string_length), intent(inout)  result_name, integer, intent(in)  diagnostic_entry_index  )

private

Retrives a diagnostic activity based upon its result name or null if none is found.

Parameters

result_name	The name of the result we are looking up
diagnostic_entry_index	The diagnostic index that we are concerned with

Returns

The corresponding activity or null if none is found

Definition at line 1180 of file diagnostic_federator.F90.

    character(len=STRING_LENGTH), intent(inout) :: result_name
    integer, intent(in) :: diagnostic_entry_index
    type(diagnostics_activity_type), pointer :: get_diagnostic_activity_by_result_name

    type(iterator_type) :: iterator

    iterator=c_get_iterator(diagnostic_definitions(diagnostic_entry_index)%activities)
    do while (c_has_next(iterator))
      get_diagnostic_activity_by_result_name=>retrieve_next_activity(iterator)
      if (get_diagnostic_activity_by_result_name%result_name == result_name) then
        return
      end if      
    end do
    get_diagnostic_activity_by_result_name=>null()

Here is the call graph for this function:

Here is the caller graph for this function:

get_diagnostic_by_key()

type(all_diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::get_diagnostic_by_key ( character(len=*), intent(in)  key )

private

Retrieves all diagnostics at a timestep by its key.

Parameters

key	The key to look up

Returns

The corresponding all diagnostics at this timestep or null if none is found

Definition at line 1015 of file diagnostic_federator.F90.

    character(len=*), intent(in) :: key

    type(all_diagnostics_at_timestep_type), pointer :: get_diagnostic_by_key

    class(*), pointer :: generic
    
    generic=>c_get_generic(all_diagnostics_at_timestep, key)    
    if (associated(generic)) then
      select type(generic)
      type is(all_diagnostics_at_timestep_type)
        get_diagnostic_by_key=>generic
      end select
    else
      get_diagnostic_by_key=>null()
    end if

Here is the caller graph for this function:

get_diagnostic_generation_frequency()

integer function diagnostic_federator_mod::get_diagnostic_generation_frequency ( type(io_configuration_type), intent(inout)  io_configuration, type(list_type), intent(inout)  required_fields  )

private

Retrieves the max diagnostic generation frequency for a set of fields.

Parameters

io_configuration	The IO server configuration
required_fields	List of required fields that we are looking up

Returns

The max generation frequency

Definition at line 1236 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(list_type), intent(inout) :: required_fields

    integer :: field_freq
    type(iterator_type) :: iterator

    get_diagnostic_generation_frequency=0
    iterator=c_get_iterator(required_fields)
    do while (c_has_next(iterator))
      field_freq=get_field_frequency(io_configuration, c_next_string(iterator))
      if (get_diagnostic_generation_frequency .lt. field_freq) get_diagnostic_generation_frequency=field_freq
    end do    

Here is the call graph for this function:

Here is the caller graph for this function:

get_diagnostics_by_timestep()

type(all_diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::get_diagnostics_by_timestep ( integer, intent(in)  timestep, logical, intent(in)  do_lock  )

private

Retrieves the diagnostics list (each MONC source) at a specific timestep.

Parameters

timestep	The timestep to look up
do_lock	Whether to issue read locks

Returns

The diagnostics container at this timestep or null if none is found

Definition at line 971 of file diagnostic_federator.F90.

    integer, intent(in) :: timestep
    logical, intent(in) :: do_lock
    type(all_diagnostics_at_timestep_type), pointer :: get_diagnostics_by_timestep

    class(*), pointer :: generic
    
    if (do_lock) call check_thread_status(forthread_rwlock_rdlock(all_diagnostics_per_timestep_rwlock))
    generic=>c_get_generic(all_diagnostics_at_timestep, conv_to_string(timestep))
    if (do_lock) call check_thread_status(forthread_rwlock_unlock(all_diagnostics_per_timestep_rwlock))
    if (associated(generic)) then
      select type(generic)
      type is(all_diagnostics_at_timestep_type)
        get_diagnostics_by_timestep=>generic
      end select
    else
      get_diagnostics_by_timestep=>null()
    end if

Here is the caller graph for this function:

get_field_frequency()

integer function diagnostic_federator_mod::get_field_frequency ( type(io_configuration_type), intent(inout)  io_configuration, character(len=*), intent(in)  field_name  )

private

Retrieves the generation frequency for a specific field.

Parameters

io_configuration	IO server configuration
field_name	The name of the field we are looking up

Returns

The generation frequency for this specific field

Definition at line 1255 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    character(len=*), intent(in) :: field_name

    integer :: i, j
    do i=1, io_configuration%number_of_data_definitions
      do j=1, io_configuration%data_definitions(i)%number_of_data_fields
        if (io_configuration%data_definitions(i)%fields(j)%name == field_name) then
          get_field_frequency=io_configuration%data_definitions(i)%frequency
          return
        end if
      end do
    end do
    get_field_frequency=0

Here is the caller graph for this function:

get_misc_action_at_index()

type(io_configuration_misc_item_type) function, pointer diagnostic_federator_mod::get_misc_action_at_index ( type(list_type), intent(inout)  action_members, integer, intent(in)  index  )

private

Retrieves a misc action from the parsed user XML configuration at a specific index.

Parameters

action_members	The members to extract from
index	The index to look up

Returns

The misc item at this index or null if none is found

Definition at line 1082 of file diagnostic_federator.F90.

    type(list_type), intent(inout) :: action_members
    integer, intent(in) :: index
    type(io_configuration_misc_item_type), pointer :: get_misc_action_at_index

    class(*), pointer :: generic

    generic=>c_get_generic(action_members, index)
    if (associated(generic)) then
      select type(generic)
      type is(io_configuration_misc_item_type)
        get_misc_action_at_index=>generic
      end select
    else
      get_misc_action_at_index=>null()
    end if

Here is the caller graph for this function:

get_timestep_entry()

type(diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::get_timestep_entry ( integer, intent(in)  timestep, integer, intent(in)  source, logical, intent(in)  do_lock  )

private

Retrieves the timestep at a specific timestep and source MONC.

Parameters

timestep	The timestep to look up
source	The source MONC process id
do_lock	Whether to issue a read lock over the timeseries collection

Returns

The timestep entry or null if none is found

Definition at line 919 of file diagnostic_federator.F90.

    integer, intent(in) :: timestep, source
    logical, intent(in) :: do_lock
    type(diagnostics_at_timestep_type), pointer :: get_timestep_entry
    
    class(*), pointer :: generic

    if (do_lock) call check_thread_status(forthread_rwlock_rdlock(timestep_entries_rwlock))
    generic=>c_get_generic(diagnostics_per_monc_at_timestep, conv_to_string(timestep)//"#"//conv_to_string(source))
    if (do_lock) call check_thread_status(forthread_rwlock_unlock(timestep_entries_rwlock))
    if (associated(generic)) then
      select type(generic)
        type is(diagnostics_at_timestep_type)
          get_timestep_entry=>generic
      end select      
    else
      get_timestep_entry=>null()
    end if

Here is the caller graph for this function:

get_value_from_monc_data()

type(data_values_type) function, pointer diagnostic_federator_mod::get_value_from_monc_data ( type(io_configuration_type), intent(inout)  io_configuration, integer, intent(in)  source, integer, intent(in)  data_id, character, dimension(:), intent(in), allocatable  data_dump, character(len=*), intent(in)  field_name  )

private

Retrieves a value from the communicated MONC data. If this was an integer then converts to a real.

Parameters

io_configuration	Configuration of the IO server
source	The source PID of the MONC process
data_id	The ID of the data definition that is represented by the dump
data_dump	The data we have received from MONC
field_name	The field to retrieve

Returns

Data value wrapper containing the values and meta-data

Definition at line 756 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: source, data_id
    character, dimension(:), allocatable, intent(in) :: data_dump
    character(len=*), intent(in) :: field_name
    type(data_values_type), pointer :: get_value_from_monc_data

    integer :: field_data_type, i
    integer, dimension(:), allocatable :: int_values
    
    allocate(get_value_from_monc_data)
    field_data_type=get_datatype_of_field(io_configuration%data_definitions(data_id)%fields, field_name)
    if (field_data_type == 0) then
      call log_log(log_error, "No data type for field '"//trim(field_name)//"'")
    end if
    get_value_from_monc_data%dimensions=get_number_field_dimensions(io_configuration, field_name, source, data_id)
    if (field_data_type == double_data_type) then
      get_value_from_monc_data%values=get_array_double_from_monc(io_configuration, source, data_id, data_dump, field_name)
    else if (field_data_type == integer_data_type) then
      int_values=get_array_integer_from_monc(io_configuration, source, data_id, data_dump, field_name)
      allocate(get_value_from_monc_data%values(size(int_values)))
      do i=1, size(int_values)
        get_value_from_monc_data%values(i)=conv_to_real(int_values(i))
      end do
      deallocate(int_values)
    end if    

Here is the call graph for this function:

Here is the caller graph for this function:

handle_completion()

subroutine diagnostic_federator_mod::handle_completion ( type(io_configuration_type), intent(inout)  io_configuration, real(default_precision), dimension(:)  values, character(len=string_length)  field_name, integer  timestep  )

private

Handles inter io reduction completion, it adds the resulting value to the appropriate completion lists and then checks the pending activities and runs them if we can execute any of these based upon this value.

Parameters

io_configuration	Configuration of the IO server
values	Array of values resulting from the communication
field_name	Corresponding field name
timestep	Corresponding timestep

Definition at line 330 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    real(DEFAULT_PRECISION), dimension(:) :: values
    character(len=STRING_LENGTH) :: field_name
    integer :: timestep

    type(all_diagnostics_at_timestep_type), pointer :: diagnostics_by_timestep
    type(data_values_type), pointer :: result_to_add
    type(iterator_type) :: iterator

    diagnostics_by_timestep=>get_diagnostics_by_timestep(timestep, .true.)
    call check_thread_status(forthread_mutex_lock(diagnostics_by_timestep%completed_num_mutex))
    diagnostics_by_timestep%completed_num=diagnostics_by_timestep%completed_num+1
    call check_thread_status(forthread_mutex_unlock(diagnostics_by_timestep%completed_num_mutex))
    if (.not. c_is_empty(diagnostics_by_timestep%diagnostic_entries)) then
      iterator=c_get_iterator(diagnostics_by_timestep%diagnostic_entries)
      do while (c_has_next(iterator))
        allocate(result_to_add)
        allocate(result_to_add%values(size(values)), source=values)
        call handle_completion_for_specific_monc_timestep_entry(io_configuration, result_to_add, &
             field_name, retrieve_next_specific_monc_timestep_entry(iterator), diagnostics_by_timestep)
      end do
    end if
    call check_thread_status(forthread_rwlock_wrlock(diagnostics_by_timestep%communication_corresponding_activities_rwlock))
    call c_remove(diagnostics_by_timestep%communication_corresponding_activities, trim(field_name))
    call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%communication_corresponding_activities_rwlock))
    call check_thread_status(forthread_mutex_lock(diagnostics_by_timestep%completed_num_mutex))
    diagnostics_by_timestep%completed_num=diagnostics_by_timestep%completed_num-1
    call check_thread_status(forthread_mutex_unlock(diagnostics_by_timestep%completed_num_mutex))

Here is the call graph for this function:

Here is the caller graph for this function:

handle_completion_for_specific_monc_timestep_entry()

subroutine diagnostic_federator_mod::handle_completion_for_specific_monc_timestep_entry ( type(io_configuration_type), intent(inout)  io_configuration, type(data_values_type), intent(in), pointer  result_to_add, character(len=string_length), intent(in)  field_name, type(diagnostics_at_timestep_type), pointer  timestep_entry, type(all_diagnostics_at_timestep_type), intent(inout)  diagnostics_by_timestep  )

private

This handles inter IO completion for a specific timestep entry. This is required as at a timestep there can be multiple entires based on each MONC which communicates with the IO server so we handle an individual one here.

Parameters

io_configuration	Configuration of the IO server
values	Array of values resulting from the communication
field_name	Corresponding field name
timestep	Corresponding timestep
timestep_entry	The specific timestep entry which relates to an individual MONC communicating with the IO server

Definition at line 369 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(data_values_type), pointer, intent(in) :: result_to_add
    character(len=STRING_LENGTH), intent(in) :: field_name
    type(diagnostics_at_timestep_type), pointer :: timestep_entry
    type(all_diagnostics_at_timestep_type), intent(inout) :: diagnostics_by_timestep

    logical :: entry_in_completed_diagnostics
    type(diagnostics_activity_type), pointer :: activity
    class(*), pointer :: generic
    integer :: i
    
    activity=>get_comm_activity_from_fieldname(diagnostics_by_timestep, field_name)
        
    generic=>result_to_add
    call check_thread_status(forthread_rwlock_wrlock(timestep_entry%completed_fields_rwlock))
    call c_put_generic(timestep_entry%completed_fields, trim(activity%result_name), generic, .false.)
    call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))

    call check_thread_status(forthread_rwlock_wrlock(timestep_entry%outstanding_fields_rwlock))
    ! is field name here correct?
    call c_remove(timestep_entry%outstanding_fields, trim(field_name))
    call check_thread_status(forthread_rwlock_unlock(timestep_entry%outstanding_fields_rwlock))
        
    do i=1, size(diagnostic_definitions)
      if (activity%result_name == diagnostic_definitions(i)%diagnostic_name) then                      
        if (diagnostic_definitions(i)%collective) then          
          call handle_diagnostic_calculation_completed(io_configuration, i, timestep_entry, diagnostics_by_timestep)
        else
          call check_thread_status(forthread_rwlock_rdlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
          entry_in_completed_diagnostics=c_contains(diagnostics_by_timestep%completed_diagnostics, &
               diagnostic_definitions(i)%diagnostic_name)
          call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
          if (.not. entry_in_completed_diagnostics) then
            call handle_diagnostic_calculation_completed(io_configuration, i, timestep_entry, diagnostics_by_timestep)
          end if
        end if
        exit
      end if
    end do
    call check_all_activities_against_completed_fields(io_configuration, timestep_entry, diagnostics_by_timestep)

Here is the call graph for this function:

Here is the caller graph for this function:

handle_diagnostic_calculation_completed()

subroutine diagnostic_federator_mod::handle_diagnostic_calculation_completed ( type(io_configuration_type), intent(inout)  io_configuration, integer, intent(in)  diagnostic_index, type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(all_diagnostics_at_timestep_type), intent(inout)  diagnostics_by_timestep  )

private

Handles completion of a diagnostic calculation and will then pass this onto interested parties.

Parameters

diagnostic_index	The diagnostics which has completed
timestep_entry	The timestep entry which has just completed this diagnostic

Definition at line 415 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: diagnostic_index
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    type(all_diagnostics_at_timestep_type), intent(inout) :: diagnostics_by_timestep

    type(data_values_type), pointer :: diagnostics_value_entry
    type(iterator_type) :: iterator
    type(diagnostics_at_timestep_type), pointer :: activity_at_index

    call check_thread_status(forthread_rwlock_rdlock(timestep_entry%completed_fields_rwlock))
    diagnostics_value_entry=>get_data_value_by_field_name(timestep_entry%completed_fields, &
         trim(diagnostic_definitions(diagnostic_index)%diagnostic_name))
    call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))

    if (diagnostic_definitions(diagnostic_index)%collective) then      
      call provide_field_to_writer_federator(io_configuration, diagnostic_definitions(diagnostic_index)%diagnostic_name, &
           diagnostic_definitions(diagnostic_index)%diagnostic_namespace, diagnostics_value_entry%values, &
           timestep_entry%timestep, timestep_entry%time, &
           diagnostic_definitions(diagnostic_index)%generation_timestep_frequency, timestep_entry%source)
      call check_thread_status(forthread_mutex_lock(timestep_entry%deletion_metric_mutex))
      timestep_entry%number_diags_outstanding=timestep_entry%number_diags_outstanding-1
      call check_thread_status(forthread_mutex_unlock(timestep_entry%deletion_metric_mutex))
      if (allocated(diagnostics_value_entry%values)) deallocate(diagnostics_value_entry%values)
    else
      call check_thread_status(forthread_rwlock_rdlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
      if (.not. c_contains(diagnostics_by_timestep%completed_diagnostics, &
           diagnostic_definitions(diagnostic_index)%diagnostic_name)) then
        call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
        call check_thread_status(forthread_rwlock_wrlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
        if (.not. c_contains(diagnostics_by_timestep%completed_diagnostics,&
             diagnostic_definitions(diagnostic_index)%diagnostic_name)) then
          call c_add_string(diagnostics_by_timestep%completed_diagnostics, &
               diagnostic_definitions(diagnostic_index)%diagnostic_name)
          call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
          call provide_field_to_writer_federator(io_configuration, diagnostic_definitions(diagnostic_index)%diagnostic_name, &
               diagnostic_definitions(diagnostic_index)%diagnostic_namespace, diagnostics_value_entry%values, &
               timestep_entry%timestep, timestep_entry%time, &
               diagnostic_definitions(diagnostic_index)%generation_timestep_frequency)
          iterator=c_get_iterator(diagnostics_by_timestep%diagnostic_entries)
          do while (c_has_next(iterator))
            activity_at_index=>retrieve_next_specific_monc_timestep_entry(iterator)
            call check_thread_status(forthread_mutex_lock(activity_at_index%deletion_metric_mutex))
            activity_at_index%number_diags_outstanding=activity_at_index%number_diags_outstanding-1
            call check_thread_status(forthread_mutex_unlock(activity_at_index%deletion_metric_mutex))
          end do          
          if (allocated(diagnostics_value_entry%values)) deallocate(diagnostics_value_entry%values)
        else
          call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
        end if
      else
        call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
      end if
    end if        

Here is the call graph for this function:

Here is the caller graph for this function:

handle_operator_completion()

logical function diagnostic_federator_mod::handle_operator_completion ( type(io_configuration_type), intent(inout)  io_configuration, type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(diagnostics_activity_type), intent(inout)  specific_activity  )

private

Handles the completion of the operator.

Parameters

timestep_entry	The specific timestep entry
specific_activity	The specific activity that just completed

Definition at line 292 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    type(diagnostics_activity_type), intent(inout) :: specific_activity

    type(data_values_type), pointer :: operator_result
    real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: operator_result_values
    class(*), pointer :: generic

    call check_thread_status(forthread_rwlock_rdlock(timestep_entry%completed_fields_rwlock))
    call specific_activity%operator_procedure(io_configuration, timestep_entry%completed_fields, &
         specific_activity%activity_attributes, timestep_entry%source_location, timestep_entry%source, operator_result_values)    
    call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))

    if (allocated(operator_result_values)) then
      allocate(operator_result)
      allocate(operator_result%values(size(operator_result_values)), source=operator_result_values)
      operator_result%values=operator_result_values
      deallocate(operator_result_values)
      generic=>operator_result
      call check_thread_status(forthread_rwlock_wrlock(timestep_entry%completed_fields_rwlock))
      call c_put_generic(timestep_entry%completed_fields, specific_activity%result_name, generic, .false.)
      call check_thread_status(forthread_rwlock_unlock(timestep_entry%completed_fields_rwlock))
      call check_thread_status(forthread_rwlock_wrlock(timestep_entry%outstanding_fields_rwlock))       
      call c_remove(timestep_entry%outstanding_fields, specific_activity%result_name)        
      call check_thread_status(forthread_rwlock_unlock(timestep_entry%outstanding_fields_rwlock)) 
      handle_operator_completion=.true.
    else
      handle_operator_completion=.false.
    end if

Here is the caller graph for this function:

initialise_diagnostic_federator()

type(hashmap_type) function, public diagnostic_federator_mod::initialise_diagnostic_federator

(

type(io_configuration_type), intent(inout)

io_configuration

)

Initialises the diagnostics action and sets up the diagnostics master definitions.

Parameters

io_configuration

The IO server configuration

Returns

The map of diagnostic fields to the frequency (in timesteps) of generation

Definition at line 90 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration

    call initialise_operators()
    call check_thread_status(forthread_rwlock_init(timestep_entries_rwlock, -1))
    call check_thread_status(forthread_rwlock_init(all_diagnostics_per_timestep_rwlock, -1))
    call check_thread_status(forthread_mutex_init(clean_progress_mutex, -1))    
    call init_reduction_inter_io(io_configuration)
    call init_broadcast_inter_io(io_configuration)
    call init_allreduction_inter_io(io_configuration)
    call init_global_callback_inter_io(io_configuration)
    call define_diagnostics(io_configuration, initialise_diagnostic_federator)
    previous_clean_point=0
    previous_viewed_timestep=0
    current_point=0

Here is the call graph for this function:

Here is the caller graph for this function:

issue_communication_calls()

subroutine diagnostic_federator_mod::issue_communication_calls ( type(io_configuration_type), intent(inout)  io_configuration, type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(all_diagnostics_at_timestep_type), intent(inout)  diagnostics_by_timestep, integer, intent(in)  source, integer, intent(in)  data_id, character, dimension(:), intent(in), allocatable  data_dump  )

private

Issues any inter io communucation calls that are appropriate based upon the data recieved from MONC.

Parameters

io_configuration	Configuration of the IO server
timestep_entry	The timestep entry
source	The source PID of the MONC process
data_id	The ID of the data definition that is represented by the dump
data_dump	The data we have received from MONC

Definition at line 543 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    integer, intent(in) :: source, data_id
    character, dimension(:), allocatable, intent(in) :: data_dump
    type(all_diagnostics_at_timestep_type), intent(inout) :: diagnostics_by_timestep

    logical :: completed_diagnostics_entry
    integer :: j, num_diags
    type(iterator_type) :: iterator
    type(diagnostics_activity_type), pointer :: activity
    character(len=STRING_LENGTH) :: communication_field_name, activity_diag_key
    
    call check_thread_status(forthread_mutex_lock(timestep_entry%activity_completion_mutex))
    num_diags=size(diagnostic_definitions)
    do j=1, num_diags
      call check_thread_status(forthread_rwlock_rdlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
      completed_diagnostics_entry=c_contains(diagnostics_by_timestep%completed_diagnostics, &
           diagnostic_definitions(j)%diagnostic_name)
      call check_thread_status(forthread_rwlock_unlock(diagnostics_by_timestep%completed_diagnostics_rwlock))
      if (.not. completed_diagnostics_entry) then
        iterator=c_get_iterator(diagnostic_definitions(j)%activities)
        do while (c_has_next(iterator))
          activity=>retrieve_next_activity(iterator)
          activity_diag_key=generate_activity_diagnostic_key(diagnostic_definitions(j), activity)
          if (.not. c_contains(timestep_entry%completed_activities, activity_diag_key)) then
            if ((activity%activity_type == reduction_type .or. activity%activity_type == broadcast_type &
                 .or. activity%activity_type == allreduction_type)) then
              if (.not. c_is_empty(activity%required_fields)) then
                communication_field_name=c_get_string(activity%required_fields, 1)
                if (is_field_present(io_configuration, source, data_id, communication_field_name)) then
                  call c_add_string(timestep_entry%completed_activities, activity_diag_key)
                  call check_thread_status(forthread_mutex_unlock(timestep_entry%activity_completion_mutex))
                  call perform_inter_io_communication(io_configuration, timestep_entry, diagnostics_by_timestep, activity, &
                       get_value_from_monc_data(io_configuration, source, data_id, data_dump, communication_field_name), &
                       communication_field_name)            
                  call check_thread_status(forthread_mutex_lock(timestep_entry%activity_completion_mutex))
                end if
              end if
            end if
          end if
        end do
      end if
    end do
    call check_thread_status(forthread_mutex_unlock(timestep_entry%activity_completion_mutex))

Here is the call graph for this function:

Here is the caller graph for this function:

pass_fields_to_diagnostics_federator()

subroutine, public diagnostic_federator_mod::pass_fields_to_diagnostics_federator	(	type(io_configuration_type), intent(inout)	io_configuration,
		integer, intent(in)	source,
		integer, intent(in)	data_id,
		character, dimension(:), intent(in), allocatable	data_dump
	)

Entry point into the diagnostics federator this runs the diagnostics, executing the defined rules based upon the input data.

Parameters

io_configuration	Configuration of the IO server
source	The source PID of the MONC process
data_id	The ID of the data definition that is represented by the dump
data_dump	The data we have received from MONC

Definition at line 192 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    integer, intent(in) :: source, data_id
    character, dimension(:), allocatable, intent(in) :: data_dump

    integer :: timestep
    real(kind=DEFAULT_PRECISION) :: time
    logical :: terminated
    type(diagnostics_at_timestep_type), pointer :: timestep_entry
    type(all_diagnostics_at_timestep_type), pointer :: diagnostics_by_timestep

    if (.not. allocated(diagnostic_definitions)) return
    if (c_is_empty(available_fields)) return

    if (is_field_present(io_configuration, source, data_id, "timestep") .and. &
         is_field_present(io_configuration, source, data_id, "time")) then
      timestep=get_scalar_integer_from_monc(io_configuration, source, data_id, data_dump, "timestep")
      time=get_scalar_real_from_monc(io_configuration, source, data_id, data_dump, "time")
      timestep_entry=>find_or_register_timestep_entry(io_configuration, timestep, source, time)
      diagnostics_by_timestep=>get_diagnostics_by_timestep(timestep, .true.)
      terminated=.false.
      if (is_field_present(io_configuration, source, data_id, "terminated")) then
        terminated=get_scalar_logical_from_monc(io_configuration, source, data_id, data_dump, "terminated")
      end if
      if (.not. terminated) call clean_diagnostic_states(timestep)
      call issue_communication_calls(io_configuration, timestep_entry, diagnostics_by_timestep, source, data_id, data_dump)      
      call check_diagnostics_entries_against_data(io_configuration, source, data_id, data_dump, timestep_entry)
      call check_all_activities_against_completed_fields(io_configuration, timestep_entry, diagnostics_by_timestep)
      
      call check_thread_status(forthread_mutex_lock(timestep_entry%deletion_metric_mutex))
      timestep_entry%number_datas_outstanding=timestep_entry%number_datas_outstanding-1
      call check_thread_status(forthread_mutex_unlock(timestep_entry%deletion_metric_mutex))
    else
      call log_log(log_warn, "Can not run the diagnostics federator without a timestep and time field in the MONC data")
    end if    

Here is the call graph for this function:

Here is the caller graph for this function:

perform_inter_io_communication()

subroutine diagnostic_federator_mod::perform_inter_io_communication ( type(io_configuration_type), intent(inout)  io_configuration, type(diagnostics_at_timestep_type), intent(inout)  timestep_entry, type(all_diagnostics_at_timestep_type), intent(inout)  all_entries_at_timestep, type(diagnostics_activity_type), intent(in), pointer  activity, type(data_values_type), intent(in)  value_to_send, character(len=string_length), intent(in)  communication_field_name  )

private

Performs the actual inter IO communication by calling out to the appropriate inter IO module.

Parameters

io_configuration	Configuration of the IO server
timestep_entry	The timestep entry
activity	The activity this is executing
value_to_send	The value to communicate
communication_field_name	Name of the field that we are communicating

Definition at line 504 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(diagnostics_at_timestep_type), intent(inout) :: timestep_entry
    type(all_diagnostics_at_timestep_type), intent(inout) :: all_entries_at_timestep
    type(diagnostics_activity_type), pointer, intent(in) :: activity
    type(data_values_type), intent(in) :: value_to_send
    character(len=STRING_LENGTH), intent(in) :: communication_field_name

    class(*), pointer :: generic

    generic=>activity
    call check_thread_status(forthread_rwlock_wrlock(all_entries_at_timestep%communication_corresponding_activities_rwlock))
    call c_put_generic(all_entries_at_timestep%communication_corresponding_activities, trim(communication_field_name), &
         generic, .false.)
    call check_thread_status(forthread_rwlock_unlock(all_entries_at_timestep%communication_corresponding_activities_rwlock))

    if (activity%activity_type == reduction_type) then
      call perform_inter_io_reduction(io_configuration, value_to_send%values, size(value_to_send%values), &
           communication_field_name, activity%communication_operator, activity%root, timestep_entry%timestep, handle_completion)
      if (activity%root .ne. io_configuration%my_io_rank) then
        call check_thread_status(forthread_mutex_lock(timestep_entry%deletion_metric_mutex))
        timestep_entry%number_diags_outstanding=timestep_entry%number_diags_outstanding-1
        call check_thread_status(forthread_mutex_unlock(timestep_entry%deletion_metric_mutex))
      end if
    else if (activity%activity_type == allreduction_type) then
      call perform_inter_io_allreduction(io_configuration, value_to_send%values, size(value_to_send%values), &
           communication_field_name, activity%communication_operator, activity%root, timestep_entry%timestep, handle_completion)
    else if (activity%activity_type == broadcast_type) then
      call perform_inter_io_broadcast(io_configuration, value_to_send%values, size(value_to_send%values), &
           communication_field_name, activity%root, timestep_entry%timestep, handle_completion)
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

process_auto_dimensions()

subroutine diagnostic_federator_mod::process_auto_dimensions ( type(io_configuration_type), intent(inout)  io_configuration, type(io_configuration_diagnostic_field_type), intent(inout)  diagnostic_configuration, integer, intent(in)  entry_index  )

private

Processes all auto dimensions by looking them up and resolving them based upon the operators.

Parameters

io_configuration	Configuration of the IO server
diagnostic_configuration	Configuration of the diagnostic field
entry_index	The specific diagnostic entry that we care about

Definition at line 1201 of file diagnostic_federator.F90.

    type(io_configuration_type), intent(inout) :: io_configuration
    type(io_configuration_diagnostic_field_type), intent(inout) :: diagnostic_configuration
    integer, intent(in) :: entry_index

    integer :: i, auto_index, diag_modified_dim_size
    character(len=STRING_LENGTH) :: specific_dimension
    type(diagnostics_activity_type), pointer :: diagnostic_activity

    diagnostic_activity=>get_diagnostic_activity_by_result_name(diagnostic_definitions(entry_index)%diagnostic_name, entry_index)
    if (associated(diagnostic_activity)) then
      if (diagnostic_activity%activity_type==operator_type) then
        do i=1, diagnostic_configuration%dimensions
          auto_index=index(diagnostic_configuration%dim_size_defns(i), "-auto")
          if (auto_index .ne. 0) then
            specific_dimension=diagnostic_configuration%dim_size_defns(i)(1:auto_index-1)
            diag_modified_dim_size=get_operator_auto_size(io_configuration, diagnostic_activity%activity_name, &
                 specific_dimension, diagnostic_activity%activity_attributes)
            if (diag_modified_dim_size .ge. 0) then
              specific_dimension=trim(specific_dimension)//"_"//trim(conv_to_string(diag_modified_dim_size))
              diagnostic_configuration%dim_size_defns(i)=specific_dimension
              call c_put_integer(io_configuration%dimension_sizing, specific_dimension, diag_modified_dim_size)
            else
              diagnostic_configuration%dim_size_defns(i)=specific_dimension
            end if
          end if
        end do
      end if
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

retrieve_diagnostics()

type(all_diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::retrieve_diagnostics ( type(mapentry_type), intent(in)  mapentry )

private

Retrieves the all diagnostics at a specific timestep from its map entry.

Parameters

mapentry

The map entry to extract the all diagnostics from

Returns

The corresponding all diagnostics or null if none is found

Definition at line 1036 of file diagnostic_federator.F90.

    type(mapentry_type), intent(in) :: mapentry
    type(all_diagnostics_at_timestep_type), pointer :: retrieve_diagnostics

    class(*), pointer :: generic
        
    generic=>c_get_generic(mapentry)
    
    if (associated(generic)) then
      select type(generic)
      type is(all_diagnostics_at_timestep_type)
        retrieve_diagnostics=>generic
      end select
    else
      retrieve_diagnostics=>null()
    end if

Here is the caller graph for this function:

retrieve_next_activity()

type(diagnostics_activity_type) function, pointer diagnostic_federator_mod::retrieve_next_activity ( type(iterator_type), intent(inout)  iterator )

private

Retrieves the next activity in a collection being iterated over by an iterator.

Parameters

iterator

The iterator we are using to iterate over the collection

Returns

The next activity or null if none is found

Definition at line 896 of file diagnostic_federator.F90.

    type(iterator_type), intent(inout) :: iterator
    type(diagnostics_activity_type), pointer :: retrieve_next_activity

    class(*), pointer :: generic

    generic=>c_next_generic(iterator)

    if (associated(generic)) then
      select type(generic)
        type is(diagnostics_activity_type)
          retrieve_next_activity=>generic
      end select      
    else
      retrieve_next_activity=>null()
    end if

Here is the caller graph for this function:

retrieve_next_specific_monc_timestep_entry()

type(diagnostics_at_timestep_type) function, pointer diagnostic_federator_mod::retrieve_next_specific_monc_timestep_entry ( type(iterator_type), intent(inout)  iterator )

private

Retrieves the next MONC timestep entry from the all diagnostics based upon a collections iterator.

Parameters

iterator

The iterator we are using to iterate ove the collection

Returns

The next MONC timestep entry or null if none is found

Definition at line 994 of file diagnostic_federator.F90.

    type(iterator_type), intent(inout) :: iterator
    type(diagnostics_at_timestep_type), pointer :: retrieve_next_specific_monc_timestep_entry

    class(*), pointer :: generic

    generic=>c_next_generic(iterator)

    if (associated(generic)) then
      select type(generic)
      type is (diagnostics_at_timestep_type)
        retrieve_next_specific_monc_timestep_entry=>generic
      end select
    else
      retrieve_next_specific_monc_timestep_entry=>null()
    end if

Here is the caller graph for this function:

Variable Documentation

all_diagnostics_at_timestep

type(hashmap_type), volatile diagnostic_federator_mod::all_diagnostics_at_timestep

private

Definition at line 76 of file diagnostic_federator.F90.

all_diagnostics_per_timestep_rwlock

integer, volatile diagnostic_federator_mod::all_diagnostics_per_timestep_rwlock

private

Definition at line 79 of file diagnostic_federator.F90.

all_outstanding_fields

type(hashset_type), volatile diagnostic_federator_mod::all_outstanding_fields

private

Definition at line 77 of file diagnostic_federator.F90.

  type(hashset_type), volatile :: all_outstanding_fields, available_fields

allreduction_type

integer, parameter diagnostic_federator_mod::allreduction_type =4

private

Definition at line 39 of file diagnostic_federator.F90.

available_fields

type(hashset_type), volatile diagnostic_federator_mod::available_fields

private

Definition at line 77 of file diagnostic_federator.F90.

broadcast_type

integer, parameter diagnostic_federator_mod::broadcast_type =3

private

Definition at line 39 of file diagnostic_federator.F90.

clean_progress_mutex

integer, volatile diagnostic_federator_mod::clean_progress_mutex

private

Definition at line 79 of file diagnostic_federator.F90.

current_point

integer, volatile diagnostic_federator_mod::current_point

private

Definition at line 79 of file diagnostic_federator.F90.

diagnostic_definitions

type(diagnostics_type), dimension(:), allocatable, volatile diagnostic_federator_mod::diagnostic_definitions

private

Definition at line 78 of file diagnostic_federator.F90.

  type(diagnostics_type), volatile, dimension(:), allocatable :: diagnostic_definitions

diagnostics_per_monc_at_timestep

type(hashmap_type), volatile diagnostic_federator_mod::diagnostics_per_monc_at_timestep

private

Definition at line 76 of file diagnostic_federator.F90.

  type(hashmap_type), volatile :: diagnostics_per_monc_at_timestep, all_diagnostics_at_timestep

operator_type

integer, parameter diagnostic_federator_mod::operator_type =1

private

Definition at line 39 of file diagnostic_federator.F90.

  integer, parameter :: operator_type=1, reduction_type=2, broadcast_type=3, allreduction_type=4, perform_clean_every=100

perform_clean_every

integer, parameter diagnostic_federator_mod::perform_clean_every =100

private

A wrapper type containing all the diagnostics for MONC source processes at a specific timestep.

Definition at line 39 of file diagnostic_federator.F90.

previous_clean_point

integer, volatile diagnostic_federator_mod::previous_clean_point

private

Definition at line 79 of file diagnostic_federator.F90.

previous_viewed_timestep

integer, volatile diagnostic_federator_mod::previous_viewed_timestep

private

Definition at line 79 of file diagnostic_federator.F90.

reduction_type

integer, parameter diagnostic_federator_mod::reduction_type =2

private

Definition at line 39 of file diagnostic_federator.F90.

timestep_entries_rwlock

integer, volatile diagnostic_federator_mod::timestep_entries_rwlock

private

Definition at line 79 of file diagnostic_federator.F90.

  integer, volatile :: timestep_entries_rwlock, all_diagnostics_per_timestep_rwlock, clean_progress_mutex, &
       previous_clean_point, previous_viewed_timestep, current_point