Package esys :: Package lsm :: Package sim :: Module WavePropagation :: Class WaveSource
[hide private]
[frames] | no frames]

Class WaveSource

 object --+        
          |        
??.instance --+    
              |    
 LsmPy.Runnable --+
                  |
                 WaveSource

Helper class which moves a source particle during each time step.

Instance Methods [hide private]
 
__init__(self, prms, lsm)
Constructs the source Runnable.
 
getLsm(self)
 
getPrms(self)
 
getParticleId(self)
 
getInitialPosn(self)
 
run(self)
Method for running.

Inherited from LsmPy.Runnable: __reduce__

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 LsmPy.Runnable: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, prms, lsm)
(Constructor)

 

Constructs the source Runnable.

Parameters:
  • prms - object which governs the source particle trajectory. This object is expected to define a getPosn(t) method which returns a relative position for time t, and also define a getInitialPosn() method which returns the location of the source disturbance.
  • lsm (esys.lsm.sim.WavePropagation.WavePropagation) - a WavePropagation lattice solid model object. A source particle in this model is moved according to the trajectory specifed by the prms argument.
Overrides: object.__init__

run(self)

 

Method for running.

Method for running.

Overrides: LsmPy.Runnable.run
(inherited documentation)