Package esys :: Package lsm :: Module LsmPy :: Class CheckPointPrms

Class CheckPointPrms

 object --+    
          |    
??.instance --+
              |
             CheckPointPrms

Known Subclasses:

RestartCheckPointPrms

Parameters for specifying check-pointing intervals.

Instance Methods

[hide private]

__init__(...)
Defines CheckPoint snapshot saver parameters

__reduce__(...)
helper for pickle

int@return: Timestep when snapshot saving commences

getBeginTimeStep(...)

int@return: Timestep when snapshot saving ceases

getEndTimeStep(...)

list

getFileNameList(...)
Returns: List of 'master' check-point file names.

string

getFileNamePrefix(...)
Returns: prefix of files where checkpoint data is saved.

int@return: Number of timesteps between each snapshot

getTimeStepIncr(...)

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

__instance_size__ = 40

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

Defines CheckPoint snapshot saver parameters

Parameters:

fileNamePrefix (string) - prefix of files where checkpoint data is saved.
beginTimeStep (int) - time step when checkpoint saving begins.
endTimeStep (int) - time step when checkpoint saving stops.
timeStepIncr (int) - a checkpoint is made everytimeStepIncr time-steps.

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

getFileNameList(...)

Returns: list: List of 'master' check-point file names.

getFileNamePrefix(...)

Returns: string: prefix of files where checkpoint data is saved.

Class CheckPointPrms

__init__(...) (Constructor)

__reduce__(...)

getFileNameList(...)

getFileNamePrefix(...)

init(...)
(Constructor)

reduce(...)