esys.lsm.LsmPy.WallVectorFieldSaverPrms

Class WallVectorFieldSaverPrms

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

Parameters for saving vector wall-data to file.

Instance Methods

__init__(...)
Defines parameters for a vector wall field saver

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__

Properties

[hide private]

Inherited from object: __class__

init(...)
(Constructor)

Defines parameters for a vector wall field saver

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__

Class WallVectorFieldSaverPrms

__init__(...) (Constructor)

init(...)
(Constructor)