Package esys :: Package modellib :: Module tsunami :: Class SurfMovie

[frames] | no frames]

Class SurfMovie

                       object --+            
                                |            
escript.modelframe.LinkableObject --+        
                                    |        
      escript.modelframe.ParameterSet --+    
                                        |    
                 escript.modelframe.Model --+
                                            |
                                           SurfMovie

movie from a wave propagation on the sea

Instance Methods

__init__(self, **kwargs)
Creates a model.

doFinalization(self)
Finalises the visualisation.

doInitialization(self)
Initializes the time integration scheme

doStepPostprocessing(self, dt)
Does any necessary postprocessing after each step

float

getSafeTimeStepSize(self, dt)
returns new step size

saveImage(self, prefix)
Saves current state as PNM image by saving a VTK file with the wave height first and reading it back afterwards.

Inherited from escript.modelframe.Model: __str__, doInitialPostprocessing, doInitialStep, doStep, doStepPreprocessing, finalize, setUp, terminateInitialIteration, terminateIteration, toDom

Inherited from escript.modelframe.ParameterSet: __delattr__, __iter__, __repr__, checkLinkTargets, declareParameter, declareParameters, releaseParameters, showParameters, writeXML

Inherited from escript.modelframe.ParameterSet (private): _parametersToDom

Inherited from escript.modelframe.LinkableObject: __getattr__, __setattr__, getAttributeObject, hasAttribute, trace

Inherited from object: __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__

Class Methods

Inherited from escript.modelframe.ParameterSet: fromDom

Class Variables

Inherited from escript.modelframe.Model: UNDEF_DT

Instance Variables

bathymetry
scalar data set

filename
name of the movie file

time
current time

wave_height
vector data set

Properties

Inherited from object: __class__

Method Details

init(self, **kwargs)
(Constructor)

Creates a model.

Just calls the parent constructor.

Overrides: object.__init__: (inherited documentation)

doFinalization(self)

Finalises the visualisation. For instance, makes a movie of the image files.

Overrides: escript.modelframe.Model.doFinalization

doInitialization(self)

Initializes the time integration scheme

Overrides: escript.modelframe.Model.doInitialization

doStepPostprocessing(self, dt)

Does any necessary postprocessing after each step

Parameters:

dt

Overrides: escript.modelframe.Model.doStepPostprocessing

getSafeTimeStepSize(self, dt)

returns new step size

Parameters:

dt (float) - last time step size used

Returns: float

time step size that can savely be used

Overrides: escript.modelframe.Model.getSafeTimeStepSize