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

Class WallVectorFieldSaverPrms

 object --+            
          |            
??.instance --+        
              |        
 FieldSaverPrms --+    
                  |    
 WallFieldSaverPrms --+
                      |
                     WallVectorFieldSaverPrms

Parameters for saving vector wall-data to file.

Instance Methods [hide private]
 
__init__(...)
Base class for field saver parameters.

Inherited from WallFieldSaverPrms: getWallNames

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]

Inherited from WallFieldSaverPrms: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 

Base class for field saver parameters.

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