Checkpointing routines

Checkpointing routines for toolbox. More...

Collaboration diagram for Checkpointing routines:

Modules
	Dummy checkpointing
	Dummy routines for checkpointing.
	Multistep checkpointing
	Multistep checkpointing for DNS, MHD and linear simulations.

Files
file	chkpt.f
	Set of checkpoint routines.

Functions
subroutine	chkpt_register ()
	Register checkpointing module. More...
subroutine	chkpt_init ()
	Initilise checkpointing module. More...
logical function	chkpt_is_initialised ()
	Check if module was initialised. More...
subroutine	chkpt_main
	Main checkpoint interface. More...
subroutine	chkpt_get_fset (step_cnt, set_out)
	Get step count to the checkpoint and a set number. More...

Detailed Description

Checkpointing routines for toolbox.

This is the main interface to I/O checkpointing.

Module interface:

Global interface list:

Interface provided:

1. chkpt_register
2. chkpt_init
3. chkpt_is_initialised
4. chkpt_main
5. chkpt_get_fset

Global interface dependency:

Interface required:

1. multiple interfaces from Frame module, Runtime parameters and Monitoring module modules
2. chkpts_register; provided by submodule
3. chkpts_init; provided by submodule
4. chkpts_read; provided by submodule
5. chkpts_write; provided by submodule

Module interface usage:

!======================================================================
      subroutine userchk
      include 'TSTEP'
      
       if (istep.eq.0) then
!     start framework
         call frame_start
      endif
 
!     monitor simulation
      call frame_monitor
 
!     save/load files for full-restart
      call chkpt_main
 
!     finalise framework
      if (istep.eq.nsteps.or.lastep.eq.1) then
         call frame_end
      endif
 
      return
      end
!======================================================================
      subroutine frame_usr_register
      implicit none
 
      include 'SIZE'
      include 'FRAMELP'
!-----------------------------------------------------------------------
!     register modules
      call chkpt_register
 
      return
      end subroutine
!======================================================================
      subroutine frame_usr_init
      implicit none
 
      include 'SIZE'
      include 'FRAMELP'
!-----------------------------------------------------------------------
!     initialise modules
      call chkpt_init
 
      return
      end subroutine
!======================================================================
      subroutine frame_usr_end
      implicit none
 
      include 'SIZE'
      include 'FRAMELP'
!-----------------------------------------------------------------------
 
      return
      end subroutine
!======================================================================

Module parameters:

Global parameter list:

Parameters provided by checkpoint module (include file - CHKPTD):

Varaible	Type	Runtime parameter	Description
chpt_ifrst	logical	_chkpt:readchkpt	start simulation form checkpoint
chpt_fnum	integer	_chkpt:chkpFnumber	restart file number
chpt_step	integer	_chkpt:chkpInterval	checkpiont dump frequency (number of time steps)

Module parameter usage:

[_CHKPT]
readchkpt = yes
chkpFnumber = 1
chkpInterval = 500

Function Documentation

chkpt_get_fset()

subroutine chkpt_get_fset	(	integer	step_cnt,
		integer	set_out
	)

Get step count to the checkpoint and a set number.

Parameters

[out]	step_cnt	decreasing step count in checkpoint writinh phase (otherwise -1)
[out]	set_out	set number

Definition at line 255 of file chkpt.f.

Here is the caller graph for this function:

chkpt_init()

subroutine chkpt_init

Initilise checkpointing module.

Note

This routine should be called in frame_usr_init

Definition at line 86 of file chkpt.f.

References chkpts_init(), mntr_abort(), mntr_get_step_delay(), mntr_tmr_add(), mntr_warn(), and rprm_rp_get().

Here is the call graph for this function:

chkpt_is_initialised()

logical function chkpt_is_initialised

Check if module was initialised.

Returns

chkpt_is_initialised

Definition at line 185 of file chkpt.f.

chkpt_main()

subroutine chkpt_main

Main checkpoint interface.

Note

This routine should be called in userchk as a first framework call

Definition at line 200 of file chkpt.f.

References chkpts_read(), chkpts_write(), and mntr_get_step_delay().

Here is the call graph for this function:

chkpt_register()

subroutine chkpt_register

Register checkpointing module.

Note

This routine should be called in frame_usr_register

Definition at line 10 of file chkpt.f.

References chkpts_register(), mntr_abort(), mntr_mod_is_name_reg(), mntr_mod_reg(), mntr_set_step_delay(), mntr_tmr_add(), mntr_tmr_is_name_reg(), mntr_tmr_reg(), mntr_warn(), rprm_rp_reg(), rprm_sec_reg(), and rprm_sec_set_act().

Here is the call graph for this function: