Package esys :: Package lsm :: Module LsmPy :: Class ParticleScalarFieldSaverPrms

Class ParticleScalarFieldSaverPrms

    object --+            
             |            
   ??.instance --+        
                 |        
    FieldSaverPrms --+    
                     |    
ParticleFieldSaverPrms --+
                         |
                        ParticleScalarFieldSaverPrms

Known Subclasses:

TaggedParticleScalarFieldSaverPrms

Parameters for saving scalar particle-data to file.

Instance Methods

[hide private]

__init__(...)
Defines particle scalar field 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]

Inherited from FieldSaverPrms: __instance_size__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(...)
(Constructor)

Defines particle scalar field saver parameters

Parameters:

fieldName (string) - Name of the data field, e.g. 'e_kin'
fileName (string) - Name of the file where data is saved
fileFormat (string) - Format of the data, e.g. 'SUM' or 'MAX'
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 ParticleScalarFieldSaverPrms

__init__(...) (Constructor)

init(...)
(Constructor)