Package esys :: Package lsm :: Module LsmPy :: Class RestartCheckPointPrms
[hide private]
[frames] | no frames]

Class RestartCheckPointPrms

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

Parameters for specifying check-pointing intervals.

Instance Methods [hide private]
 
__init__(...)
Defines CheckPoint snapshot saver parameters with the output precision defaulting to 12 digits.
int
getPrecision(...)
Returns: output precision of checkpoint files.

Inherited from CheckPointPrms: __reduce__, getBeginTimeStep, getEndTimeStep, getFileNameList, getFileNamePrefix, getTimeStepIncr

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]

Inherited from CheckPointPrms: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Defines CheckPoint snapshot saver parameters with the output precision defaulting to 12 digits. This function is provided for backward compatibility.

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 every timeStepIncr time-steps.
  • Precision (int) - the number of digits in the output data, defaulting to twelve when not specified.
Overrides: object.__init__

getPrecision(...)

 
Returns: int
output precision of checkpoint files.