modelsynopsis.F90

Go to the documentation of this file.

module modelsynopsis_mod
  use datadefn_mod, only : default_precision
  use monc_component_mod, only : component_descriptor_type
  use state_mod, only : model_state_type, time_termination_reason, timestep_termination_reason, message_termination_reason, &
       walltime_termination_reason
  use logging_mod, only : log_info, log_log, log_is_master, log_newline
  use conversions_mod, only : conv_to_string
  use optionsdatabase_mod, only : options_get_integer, options_get_real, options_get_string
  use mpi, only : mpi_wtime
  implicit none

#ifndef TEST_MODE
  private
#endif

  integer :: previous_ts, reporting_frequency
  double precision :: start_time

  public modelsynopsis_get_descriptor

contains

  type(component_descriptor_type) function modelsynopsis_get_descriptor()
    modelsynopsis_get_descriptor%name="model_synopsis"
    modelsynopsis_get_descriptor%version=0.1
    modelsynopsis_get_descriptor%initialisation=>initialisation_callback
    modelsynopsis_get_descriptor%timestep=>timestep_callback
    modelsynopsis_get_descriptor%finalisation=>finalisation_callback
  end function modelsynopsis_get_descriptor

  subroutine initialisation_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    reporting_frequency=options_get_integer(current_state%options_database, "display_synopsis_frequency")
    previous_ts=current_state%timestep
    start_time=mpi_wtime()
  end subroutine initialisation_callback  

  subroutine timestep_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    double precision :: end_time

    if (mod(current_state%timestep, reporting_frequency)==0 .and. log_is_master()) then
      end_time=mpi_wtime()
      call log_newline()
      call log_log(log_info, "Number of completed timesteps "//conv_to_string(current_state%timestep))
      call log_log(log_info, "Completed "//trim(conv_to_string((current_state%timestep-previous_ts)+1))//&
           " timesteps in "//trim(conv_to_string(int((end_time-start_time) * 1000)))//"ms")
      call log_log(log_info, "Model time "//trim(conv_to_string(current_state%time, 5))//" seconds; dtm="//&
           trim(conv_to_string(current_state%dtm, 5)))
      previous_ts=current_state%timestep
      start_time=mpi_wtime()
    end if
  end subroutine timestep_callback

  subroutine finalisation_callback(current_state)
    type(model_state_type), target, intent(inout) :: current_state

    if (log_is_master()) then
      call log_newline()
      if (current_state%termination_reason == time_termination_reason) then
        call log_log(log_info, "Model run complete due to model time "//&
             trim(conv_to_string(current_state%time, 2))//" exceeding limit of "//&
             trim(conv_to_string(options_get_real(current_state%options_database, "termination_time"), 2)))
      else if (current_state%termination_reason == timestep_termination_reason) then
        call log_log(log_info, "Model run complete due to timestep completion, model time is "//&
             trim(conv_to_string(current_state%time, 2)))
      else if (current_state%termination_reason == message_termination_reason) then
        call log_log(log_info, "Model run complete due to messages file containing termination command, model time is "//&
             trim(conv_to_string(current_state%time, 2)))
      else if (current_state%termination_reason == walltime_termination_reason) then
        call log_log(log_info, "Model run complete due to walltime limit of '"//&
             trim(options_get_string(current_state%options_database, "walltime_limit"))//"' reached, model time is "//&
             trim(conv_to_string(current_state%time, 2)))
      else
        call log_log(log_info, "Model run complete due to unknown reason, model time is "//&
             trim(conv_to_string(current_state%time, 2)))
      end if
    end if
  end subroutine finalisation_callback
end module modelsynopsis_mod