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

Class FieldSaverPrms

 object --+    
          |    
??.instance --+
              |
             FieldSaverPrms
Known Subclasses:

Base class for parameters defining field savers to store model data.

Instance Methods [hide private]
 
__init__(...)
Base class for field saver parameters.
 
__reduce__(...)
helper for pickle
int
getBeginTimeStep(...)
Returns time step when data is first saved.
int
getEndTimeStep(...)
Returns time step when data is last saved.
string
getFieldName(...)
Returns name of save field.
string
getFileFormat(...)
Returns format of saved data.
string
getFileName(...)
Returns name of file where data is to be saved.
int
getTimeStepIncr(...)
Returns number of time steps between data saves.

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__ = 128
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Base class for field saver parameters.

Parameters:
  • fieldName (string) - Name of a data-field.
  • fileName (string) - Name of the file where the data is saved.
  • fileFormat (string) - Format of the data which is saved to file.
  • beginTimeStep (int) - Time step when first data is saved.
  • endTimeStep (int) - Time step when last data is saved.
  • timeStepIncr (int) - Number of time steps between data saves.
Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

getBeginTimeStep(...)

 

Returns time step when data is first saved.

Returns: int
Time step.

getEndTimeStep(...)

 

Returns time step when data is last saved.

Returns: int
Time step.

getFieldName(...)

 

Returns name of save field.

Returns: string
Field name

getFileFormat(...)

 

Returns format of saved data.

Returns: string
Name of saved data format.

getFileName(...)

 

Returns name of file where data is to be saved.

Returns: string
File name.

getTimeStepIncr(...)

 

Returns number of time steps between data saves.

Returns: int
number of time steps.