Package esys :: Package modellib :: Module tsunami :: Class TsunamiInDeepWater
[hide private]
[frames] | no frames]

Class TsunamiInDeepWater

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

Runs the deep water tsunami model based on a simplified form of the shallow water equation.

d^2 h/dt^2 =div(c grad(h))

where h is the wave height above sea level, and c=sqrt(g*H), with H - depth of the water level, g - gravity constant

The simulation uses the Verlet scheme.

Instance Methods [hide private]
 
__init__(self, **kwargs)
Creates a model.
 
doInitialization(self)
Initializes the time integration scheme
 
doStepPostprocessing(self, dt)
Performs the time step using the Verlet scheme
float
getSafeTimeStepSize(self, dt)
Returns new step size

Inherited from escript.modelframe.Model: __str__, doFinalization, 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.LinkableObject: __getattr__, __setattr__, getAttributeObject, hasAttribute, trace

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

Class Methods [hide private]

Inherited from escript.modelframe.ParameterSet: fromDom

Class Variables [hide private]

Inherited from escript.modelframe.Model: UNDEF_DT

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

 

Creates a model.

Just calls the parent constructor.

Overrides: object.__init__
(inherited documentation)

doInitialization(self)

 

Initializes the time integration scheme

Overrides: escript.modelframe.Model.doInitialization

doStepPostprocessing(self, dt)

 

Performs the time step using the Verlet scheme

Parameters:
  • dt (float) - time step size to be used
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 safely be used
Overrides: escript.modelframe.Model.getSafeTimeStepSize