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

Class WallFieldSaverPrms

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

Base class describing parameters for saving wall-data to file.

Instance Methods [hide private]
 
__init__(...)
Base class for wall field savers
list of str
getWallNames(...)
Returns the list of wall names associated with these saver parameters.

Inherited from FieldSaverPrms: __reduce__, getBeginTimeStep, getEndTimeStep, getFieldName, getFileFormat, getFileName, 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__ = 152
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Base class for wall field savers

Parameters:
  • wallName (str or tuple or list of str) - Name of the wall(s) for which data are saved.
  • fieldName (string) - Name of the data field, e.g. 'Position'
  • fileName (string) - Name of the file where data are saved
  • fileFormat (string) - Format of the data, e.g. 'RAW_SERIES'
  • beginTimeStep (int) - start saving data at this time step
  • endTimeStep (int) - finish saving data at this time step
  • timeStepIncr (int) - save data every timeStepIncr time steps
Overrides: object.__init__

getWallNames(...)

 

Returns the list of wall names associated with these saver parameters.

Returns: list of str
Wall name list.