This component will check for termination conditions at stages of the model run and terminate that specific stage if the parameters have been met. More...

Functions/Subroutines
type(component_descriptor_type) function, public	terminationcheck_get_descriptor ()
	Provides the descriptor back to the caller and is used in component registration. More...

subroutine	init_callback (current_state)
	Called upon model initialisation. Will basically read from the options database and set options in the database that are appropriate. More...

subroutine	timestep_callback (current_state)
	Timestep hook which is called at each timestep to determine whether or not to terminate timestep iterations. More...

integer function	check_messages_file (current_state)
	Checks the messages file for commands which determine user control of the model. More...

Variables
integer, parameter	file_line_len =100

integer, parameter	file_unit =10

integer	max_timesteps

integer	check_messages_file_frequency

integer	check_walltime_frequency

integer	max_walltime_secs

real(kind=default_precision)	termination_time

character(len=string_length)	messages_file_name

logical	check_for_walltime

Detailed Description

This component will check for termination conditions at stages of the model run and terminate that specific stage if the parameters have been met.

Function/Subroutine Documentation

◆ check_messages_file()

integer function terminationcheck_mod::check_messages_file ( type(model_state_type), intent(inout), target current_state )

private

Checks the messages file for commands which determine user control of the model.

Parameters

current_state The current model state

Definition at line 129 of file terminationcheck.F90.

     type(model_state_type), target, intent(inout) :: current_state
 
     character(len=FILE_LINE_LEN) :: msg_line
     integer :: ierr
 
     check_messages_file=0
     open (unit=file_unit, file=messages_file_name, status='OLD', iostat=ierr)
     if (ierr == 0) then
       read(file_unit,"(A)",iostat=ierr) msg_line
       if (ierr == 0) then
         if (trim(msg_line) .eq. "terminate") then
           check_messages_file=1
           current_state%continue_timestep=.false.
         end if
       end if      
     end if    
     close(file_unit)

Here is the caller graph for this function:

◆ init_callback()

subroutine terminationcheck_mod::init_callback ( type(model_state_type), intent(inout), target current_state )

private

Called upon model initialisation. Will basically read from the options database and set options in the database that are appropriate.

Parameters

current_state The current model state_mod

Definition at line 41 of file terminationcheck.F90.

     type(model_state_type), target, intent(inout) :: current_state
     integer :: i, idx, pidx, walltime_secs, walltime_mins, walltime_hours
     character(len=STRING_LENGTH) :: walltime_string
     logical :: mangled
 
     max_timesteps=options_get_integer(current_state%options_database, "nn_timesteps")
     termination_time=options_get_real(current_state%options_database, "termination_time")
     check_messages_file_frequency=options_get_integer(current_state%options_database, "check_msg_frequency")
     messages_file_name=options_get_string(current_state%options_database, "msg_filename")
     check_walltime_frequency=options_get_integer(current_state%options_database, "check_walltime_frequency")
     walltime_string=options_get_string(current_state%options_database, "walltime_limit")
     check_for_walltime=trim(walltime_string) /= "none"
     if (check_for_walltime) then
       pidx=1
       mangled=.false.
       do i=1, 2
         idx=index(walltime_string(pidx:), ":")
         if (idx .gt. 0) then
           if (i==1) walltime_hours=conv_to_integer(walltime_string(pidx:pidx+idx-2))
           if (i==2) walltime_mins=conv_to_integer(walltime_string(pidx:pidx+idx-2))
           pidx=pidx+idx
         else
           call log_master_log(log_warn, "Walltime limit of  `"//trim(walltime_string)//&
                "` does not contains hh:mm:ss, defaulting to no limit")
           check_for_walltime=.false.
           exit
         end if
       end do            
       if (check_for_walltime) then
          walltime_secs=conv_to_integer(walltime_string(pidx:))
         if (walltime_mins .lt. 0 .or. walltime_mins .gt. 59) then
           walltime_mins=0
           mangled=.true.
         end if
         if (walltime_secs .lt. 0 .or. walltime_secs .gt. 59) then
           walltime_secs=0
           mangled=.true.
         end if
         if (mangled) then
           call log_master_log(log_warn, "Walltime limit of `"//trim(walltime_string)//"` mangled, defaulting to "//&
                trim(conv_to_string(walltime_hours))//":"//trim(conv_to_string(walltime_mins))//":"//&
                trim(conv_to_string(walltime_secs)))
         end if
         max_walltime_secs=(walltime_hours*60*60)+(walltime_mins*60)+walltime_secs
       end if
     end if    

Here is the caller graph for this function:

◆ terminationcheck_get_descriptor()

type(component_descriptor_type) function, public terminationcheck_mod::terminationcheck_get_descriptor ( )

Provides the descriptor back to the caller and is used in component registration.

Returns: The termination check component descriptor

Definition at line 31 of file terminationcheck.F90.

     terminationcheck_get_descriptor%name="termination_check"
     terminationcheck_get_descriptor%version=0.1
     terminationcheck_get_descriptor%initialisation=>init_callback
     terminationcheck_get_descriptor%timestep=>timestep_callback

Here is the call graph for this function:

◆ timestep_callback()

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

private

Timestep hook which is called at each timestep to determine whether or not to terminate timestep iterations.

Parameters

current_state The current model state_mod

Definition at line 92 of file terminationcheck.F90.

     type(model_state_type), target, intent(inout) :: current_state
 
     integer :: ierr, file_message_status
 
     if (max_timesteps .gt. 0) then
       current_state%continue_timestep=mod(current_state%timestep, max_timesteps) /= 0
       if (.not. current_state%continue_timestep) current_state%termination_reason=timestep_termination_reason
     else
       current_state%continue_timestep=.true.
     end if
     if (current_state%continue_timestep) then
       current_state%continue_timestep = current_state%time .lt. termination_time
       if (.not. current_state%continue_timestep) current_state%termination_reason=time_termination_reason
     end if
     if (current_state%continue_timestep .and. check_for_walltime .and. &
          mod(current_state%timestep, check_walltime_frequency) == 0) then
       current_state%continue_timestep=int(mpi_wtime() - current_state%model_start_wtime) .lt. max_walltime_secs
       call mpi_allreduce(mpi_in_place, current_state%continue_timestep, 1, mpi_logical, mpi_lor, &
            current_state%parallel%monc_communicator, ierr)
       if (.not. current_state%continue_timestep) current_state%termination_reason=walltime_termination_reason
     end if    
 
     if (current_state%continue_timestep .and. mod(current_state%timestep, check_messages_file_frequency) == 0) then
       if (current_state%parallel%my_rank == 0) then
         file_message_status=check_messages_file(current_state)
         call mpi_bcast(file_message_status, 1, mpi_int, 0, current_state%parallel%monc_communicator, ierr)
       else
         call mpi_bcast(file_message_status, 1, mpi_int, 0, current_state%parallel%monc_communicator, ierr)
         if (file_message_status == 1) current_state%continue_timestep=.false.
       end if
       if (.not. current_state%continue_timestep) current_state%termination_reason=message_termination_reason
     end if    

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ check_for_walltime

logical terminationcheck_mod::check_for_walltime

private

Definition at line 22 of file terminationcheck.F90.

22 logical :: check_for_walltime

◆ check_messages_file_frequency

integer terminationcheck_mod::check_messages_file_frequency

private

Definition at line 19 of file terminationcheck.F90.

◆ check_walltime_frequency

integer terminationcheck_mod::check_walltime_frequency

private

Definition at line 19 of file terminationcheck.F90.

◆ file_line_len

integer, parameter terminationcheck_mod::file_line_len =100

private

Definition at line 18 of file terminationcheck.F90.

18 integer, parameter :: file_line_len=100, file_unit=10

◆ file_unit

integer, parameter terminationcheck_mod::file_unit =10

private

Definition at line 18 of file terminationcheck.F90.

◆ max_timesteps

integer terminationcheck_mod::max_timesteps

private

Definition at line 19 of file terminationcheck.F90.

19 integer :: max_timesteps, check_messages_file_frequency, check_walltime_frequency, max_walltime_secs

◆ max_walltime_secs

integer terminationcheck_mod::max_walltime_secs

private

Definition at line 19 of file terminationcheck.F90.

◆ messages_file_name

character(len=string_length) terminationcheck_mod::messages_file_name

private

Definition at line 21 of file terminationcheck.F90.

21 character(len=STRING_LENGTH) :: messages_file_name

◆ termination_time

real(kind=default_precision) terminationcheck_mod::termination_time

private

Definition at line 20 of file terminationcheck.F90.

20 real(kind=DEFAULT_PRECISION) :: termination_time

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ check_messages_file()

◆ init_callback()

◆ terminationcheck_get_descriptor()

◆ timestep_callback()

Variable Documentation

◆ check_for_walltime

◆ check_messages_file_frequency

◆ check_walltime_frequency

◆ file_line_len

◆ file_unit

◆ max_timesteps

◆ max_walltime_secs

◆ messages_file_name

◆ termination_time