This provides restart/checkpointing functions. More...

Functions
function util	CheckCheckpointData (cp)

function util	GetStdCheckpointData ()

function util	nilstr (s)

function util	ReadCheckpointFromDir (u, dir, name, verbose)

function util	ReadStateCheckpoint (gf_names, id, name)

function util	WriteCheckpoint (u, id, myData, name, verbose)

function util	WriteCheckpointIntervallic (u, id, myData, name, IntervalMS)

function util	WriteStateCheckpoint (gf_names, id, myData, name)

Variables
location	__pad0__

location	name

location	verbose

Detailed Description

This provides restart/checkpointing functions.

Author: Martin Rupp

example writing a checkpoint (std is every 10s) util.WriteCheckpointIntervallic(u, time, {time=time, step=step})

example reading a checkpoint local restart = util.HasParamOption("-restart") if restart then cp = util.ReadCheckpoint(u)

– re-get our additional data time = cp.myData.time step = cp.myData.step end

Note: The used SaveToFile/ReadFromFile functions for u assume that u has exactly the same structure as in the checkpoint. That means approxSpace, grid and so on have to be the same This will normally exclude adaptive calculations from restarting, unless you add code which also reads/writes the adapted grid. See also util.GetStdCheckpointData for variables which are automatically checked to be the same between runs.

Function Documentation

◆ CheckCheckpointData()

function util CheckCheckpointData ( cp )

check that the stdData is same in file and current run

See also: util.GetStdCheckpointData

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :88-114

References dim, pcl::NumProcs(), and numRefs.

◆ GetStdCheckpointData()

function util GetStdCheckpointData ( )

the standard checkpoint data data in this table will be checked between loaded checkpoints and the current run. e.g. numRefs and numCores should be the same note that values which are nil are NOT saved in the table so it is OK to add values here which are not defined in every script

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :72-79

function util.GetStdCheckpointData()
  return {
    numRefs=numRefs, 
    numPreRefs=numPreRefs,
    dim=dim,
    numCores=NumProcs()
  }
end

◆ nilstr()

function util nilstr ( s )

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :81-83

function util.nilstr(s)
  if s == nil then return "(nil)" else return s end
end

◆ ReadCheckpointFromDir()

function util ReadCheckpointFromDir	(	u	,
		dir	,
		name	,
		verbose
	)

util.ReadCheckpointFromDir

Parameters

u	the GridFunction to read into
dir	the GridFunction to read into
name	name of Lua checkpoint file. may be nil.

Returns: the checkpoint data cp. (see util.WriteCheckpoint) myData will be saved cp.myData.

Parameters

verbose if verbose defined then print additional debug output to console

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :218-241

◆ ReadStateCheckpoint()

function util ReadStateCheckpoint	(	gf_names	,
		id	,
		name
	)

util.ReadStateCheckpoint

Parameters

gf_names	a table of names of grid functions to save (e.g. {u=u, lsf=lsf})
id	the id for the current solution (e.g. the current time)
name	name used when writing the checkpoint (may be nil).

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :306-339

◆ WriteCheckpoint()

function util WriteCheckpoint	(	u	,
		id	,
		myData	,
		name	,
		verbose
	)

util.WriteCheckpoint

Parameters

u	current solution to write (a GridFunction)
id	the id for the current solution (like, the current time)
myData	additional Data in Form of a table. Will be available as cp.myData when loading the checkpoint Can contain all LUA types (tables, arrays, strings, numbers etc.), but no userdata! Can also be nil.
name	name to use when writing the checkpoint. may be nil.
verbose	if verbose defined then print additional debug output to console

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :126-155

◆ WriteCheckpointIntervallic()

function util WriteCheckpointIntervallic	(	u	,
		id	,
		myData	,
		name	,
		IntervalMS
	)

util.WriteCheckpointIntervallic

See also: util.WriteCheckpoint use this function to write checkpoint data in time intervals

Parameters

IntervalMS write checkpoint every IntervalMS milliseconds. can be null, then defaults to util.checkpoint.stdIntervalMS

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :162-172

function util.WriteCheckpointIntervallic(u, id, myData, name, IntervalMS)
  local timeMS = GetClockS()*1000
  
  if IntervalMS == nil then IntervalMS = util.checkpoint.stdIntervalMS end
  if util.checkpoint.lastCheckpointTimeMS == nil 
    or timeMS -util.checkpoint.lastCheckpointTimeMS > IntervalMS then
    
    util.WriteCheckpoint(u, id, myData, name)
    util.checkpoint.lastCheckpointTimeMS = timeMS
  end 
end

◆ WriteStateCheckpoint()

function util WriteStateCheckpoint	(	gf_names	,
		id	,
		myData	,
		name
	)

util.WriteStateCheckpoint

Parameters

gf_names	a table of names of grid functions to save (e.g. {u=u, lsf=lsf})
id	the id for the current solution (e.g. the current time)
myData	additional Data in Form of a table. Will be available as cp.myData when loading the checkpoint Can contain all LUA types (tables, arrays, strings, numbers etc.), but no userdata! Can also be nil.
name	name to use when writing the checkpoint (may be nil).

location: /home/runner/work/docs/docs/ug4/ugcore/scripts/util / checkpoint_util.lua :252-299

Variable Documentation

◆ pad0

location __pad0__

util.ReadCheckpoint

Parameters

u	the GridFunction to read into
name	name to use when writing the checkpoint. may be nil.

Returns: the checkpoint data cp. (see util.WriteCheckpoint) myData will be saved cp.myData.

Parameters

verbose if verbose defined then print additional debug output to console

/** LoadTheCheckpoint is a function defined in the the lua binding:

See also: ugcore/ugbase/bindings/lua/lua_serialization.cpp

◆ name

location name

◆ verbose

location verbose

Referenced by CreatePostProcessor(), ug::bridge::InitUG(), TableToText(), ug::TestDomainInterfaces(), ug::TestGridLayoutMap(), and ug::TestHorizontalAlgebraLayouts().

Functions

Variables

Detailed Description

Function Documentation

◆ CheckCheckpointData()

◆ GetStdCheckpointData()

◆ nilstr()

◆ ReadCheckpointFromDir()

◆ ReadStateCheckpoint()

◆ WriteCheckpoint()

◆ WriteCheckpointIntervallic()

◆ WriteStateCheckpoint()

Variable Documentation

◆ __pad0__

◆ name

◆ verbose

◆ pad0