modelsynopsis_mod Module Reference

Displays information about the current state_mod of the model run. More...

Functions/Subroutines
type(component_descriptor_type) function, public	modelsynopsis_get_descriptor ()
	Provides a description of this component for the core to register. More...
subroutine	initialisation_callback (current_state)
subroutine	timestep_callback (current_state)
	Timestep callback hook which performs the halo swapping for each prognostic field. More...
subroutine	finalisation_callback (current_state)
	Called at the end of the MONC run, will log the reason why the model is terminating. More...

Variables
integer	previous_ts
integer	reporting_frequency
double precision	start_time

Detailed Description

Displays information about the current state_mod of the model run.

Function/Subroutine Documentation

finalisation_callback()

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

private

Called at the end of the MONC run, will log the reason why the model is terminating.

Parameters

current_state

The current model state

Definition at line 67 of file modelsynopsis.F90.

    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

Here is the caller graph for this function:

initialisation_callback()

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

private

Definition at line 34 of file modelsynopsis.F90.

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

Here is the caller graph for this function:

modelsynopsis_get_descriptor()

type(component_descriptor_type) function, public modelsynopsis_mod::modelsynopsis_get_descriptor

Provides a description of this component for the core to register.

Returns

The descriptor containing registration information for this component

Definition at line 26 of file modelsynopsis.F90.

    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

Here is the call graph for this function:

timestep_callback()

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

private

Timestep callback hook which performs the halo swapping for each prognostic field.

In parallel this is performed with MPI communication calls and wrapping around. In serial still need to wrap data around

Parameters

current_state

The current model state_mod

Definition at line 47 of file modelsynopsis.F90.

    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

Here is the caller graph for this function:

Variable Documentation

previous_ts

integer modelsynopsis_mod::previous_ts

private

Definition at line 17 of file modelsynopsis.F90.

  integer :: previous_ts, reporting_frequency

reporting_frequency

integer modelsynopsis_mod::reporting_frequency

private

Definition at line 17 of file modelsynopsis.F90.

start_time

double precision modelsynopsis_mod::start_time

private

Definition at line 18 of file modelsynopsis.F90.

  double precision :: start_time