checkpointer_mod Module Reference

Checkpointing NetCDF functionality. More...

Functions/Subroutines
type(component_descriptor_type) function, public	checkpointer_get_descriptor ()
	Provides registry information for the component. More...
subroutine	initialisation_callback (current_state)
	Initialisation hook, if appropriate (depends on command line arguments) then will read in an existing checkpoint file and use this as the basis for model state. More...
subroutine	timestep_callback (current_state)
	The timestep hook will dump out model state_mod to a checkpoint file. More...
subroutine	finalisation_callback (current_state)
	Called on termination to write out the status of the model run to checkpoint. More...
subroutine	perform_checkpoint_dump (current_state)
	Performs the checkpoint dump and timings. This can be called as part of the timestep or at the end of a model run. More...
subroutine	log_dump_stats (current_state, start_time, end_time)
	Will dump out the model dump statistics. More...
subroutine	generate_unique_filename (current_state, new_name)
	Generates a unique filename based upon the base one specified and the number of completed timesteps. More...

Variables
character(len=string_length), save	checkpoint_file
	The checkpoint write file base name. More...
logical, save	unique_per_dump
	Whether to make each model dump a unique filename. More...
logical, save	enable_write
integer, save	checkpoint_frequency

Detailed Description

Checkpointing NetCDF functionality.

Both reads and initalises the model based upon a checkpoint and writes (dumps) model status to a checkpoint

Function/Subroutine Documentation

checkpointer_get_descriptor()

type(component_descriptor_type) function, public checkpointer_mod::checkpointer_get_descriptor

Provides registry information for the component.

Returns

The component descriptor that describes this component

Definition at line 31 of file checkpointer.F90.

    checkpointer_get_descriptor%name="checkpointer"
    checkpointer_get_descriptor%version=0.1
    checkpointer_get_descriptor%initialisation=>initialisation_callback
    checkpointer_get_descriptor%timestep=>timestep_callback
    checkpointer_get_descriptor%finalisation=>finalisation_callback

Here is the call graph for this function:

finalisation_callback()

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

private

Called on termination to write out the status of the model run to checkpoint.

Parameters

current_state

The current model state

Definition at line 77 of file checkpointer.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (enable_write) call perform_checkpoint_dump(current_state)

Here is the call graph for this function:

Here is the caller graph for this function:

generate_unique_filename()

subroutine checkpointer_mod::generate_unique_filename ( type(model_state_type), intent(inout)  current_state, character(len=string_length), intent(out)  new_name  )

private

Generates a unique filename based upon the base one specified and the number of completed timesteps.

Parameters

current_state	The current model state
newName	The new name that is produced by this subroutine

Definition at line 122 of file checkpointer.F90.

    type(model_state_type), intent(inout) :: current_state
    character(len=STRING_LENGTH), intent(out) :: new_name
 
    integer :: dot_posn
    
    dot_posn=index(checkpoint_file, ".")
    if (dot_posn .gt. 0) then
      new_name = checkpoint_file(1:dot_posn-1)
    else
      new_name=checkpoint_file
    end if
    new_name=trim(new_name)//"_"//trim(conv_to_string(current_state%timestep))
    if (dot_posn .gt. 0) then
      new_name=trim(new_name)//checkpoint_file(dot_posn:len(checkpoint_file))
    end if    

Here is the caller graph for this function:

initialisation_callback()

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

private

Initialisation hook, if appropriate (depends on command line arguments) then will read in an existing checkpoint file and use this as the basis for model state.

Parameters

current_state

The current model state

Definition at line 42 of file checkpointer.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    character(len=STRING_LENGTH) :: internal_write_mode
 
    checkpoint_frequency=options_get_integer(current_state%options_database, "checkpoint_frequency")
    checkpoint_file=options_get_string(current_state%options_database, "checkpoint_file")
    unique_per_dump=options_get_logical(current_state%options_database, "checkpoint_unique_per_dump")
    internal_write_mode=options_get_string(current_state%options_database, "checkpoint_internal_write")
    if (trim(internal_write_mode) .eq. "always") then
      enable_write=.true.
    else if (trim(internal_write_mode) .eq. "never") then
      enable_write=.false.
    else
      ! Auto mode
      enable_write=.not. current_state%io_server_enabled
    end if
 
    if (options_has_key(current_state%options_database, "checkpoint")) then
      call read_checkpoint_file(current_state, options_get_string(current_state%options_database, "checkpoint"))
    end if

Here is the caller graph for this function:

log_dump_stats()

subroutine checkpointer_mod::log_dump_stats ( type(model_state_type), intent(inout)  current_state, real  start_time, real  end_time  )

private

Will dump out the model dump statistics.

Parameters

current_state	The current model state
startTime	The start CPU time of the dump
endTime	The end CPU time of the dump

Definition at line 110 of file checkpointer.F90.

    type(model_state_type), intent(inout) :: current_state
    real :: start_time, end_time
 
    call log_master_newline()
    call log_master_log(log_info, "Model dump completed in "//trim(conv_to_string(int((end_time-start_time)*1000)))//"ms")

Here is the caller graph for this function:

perform_checkpoint_dump()

subroutine checkpointer_mod::perform_checkpoint_dump ( type(model_state_type), intent(inout), target  current_state )

private

Performs the checkpoint dump and timings. This can be called as part of the timestep or at the end of a model run.

Parameters

current_state

The current model state

Definition at line 86 of file checkpointer.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    character(len=STRING_LENGTH) :: unique_fn
    real :: start_dump_time, end_dump_time
    integer :: ierr
 
    call cpu_time(start_dump_time)
    if (unique_per_dump) then
      call generate_unique_filename(current_state, unique_fn)
      call write_checkpoint_file(current_state, unique_fn)
    else
      call write_checkpoint_file(current_state, checkpoint_file)
    end if
    ! Barrier here to ensure all processes dumped before log_log stats (is there a better way?)
    call mpi_barrier(current_state%parallel%monc_communicator, ierr)
    call cpu_time(end_dump_time)
    call log_dump_stats(current_state, start_dump_time, end_dump_time)

Here is the call graph for this function:

Here is the caller graph for this function:

timestep_callback()

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

private

The timestep hook will dump out model state_mod to a checkpoint file.

Parameters

current_state

The current model state

Definition at line 67 of file checkpointer.F90.

    type(model_state_type), target, intent(inout) :: current_state
 
    if (enable_write .and. checkpoint_frequency .gt. 0) then
      if (mod(current_state%timestep, checkpoint_frequency) == 0) call perform_checkpoint_dump(current_state)
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

checkpoint_file

character(len=string_length), save checkpointer_mod::checkpoint_file

private

The checkpoint write file base name.

Definition at line 20 of file checkpointer.F90.

  character(len=STRING_LENGTH), save :: checkpoint_file

checkpoint_frequency

integer, save checkpointer_mod::checkpoint_frequency

private

Definition at line 23 of file checkpointer.F90.

  integer, save :: checkpoint_frequency

enable_write

logical, save checkpointer_mod::enable_write

private

Definition at line 21 of file checkpointer.F90.

unique_per_dump

logical, save checkpointer_mod::unique_per_dump

private

Whether to make each model dump a unique filename.

Definition at line 21 of file checkpointer.F90.

  logical, save :: unique_per_dump, &     !< Whether to make each model dump a unique filename
       enable_write