esys.modellib.tsunami.TsunamiInDeepWater

Package esys :: Package modellib :: Module tsunami :: Class TsunamiInDeepWater

[show private | hide private]

Type TsunamiInDeepWater

    object --+            
             |            
LinkableObject --+        
                 |        
      ParameterSet --+    
                     |    
                 Model --+
                         |
                        TsunamiInDeepWater

Runs the deep water tsunami model based on a simplfied 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 with H the depth of the water level and g is the gravity constant c=sqrt(g*H).

The simulation uses the Verlet scheme.

Method Summary
	`__init__(self, debug)`
	`doInitialization(self)` Initializes the time integartion scheme
	`doStepPostprocessing(self, dt)` perform the time step using the Valet scheme
`float`	`getSafeTimeStepSize(self, dt)` returns new step size
Inherited from Model
	`__str__(self)`
	`doFinalization(self)` Finalizes the time stepping.
	`doStep(self, dt)` Executes an iteration step at a time step.
	`doStepPreprocessing(self, dt)` Sets up a time step of step size dt.
	`finalize(self)` Returns False if the time stepping is finalized.
	`terminateIteration(self)` Returns True if iteration on a time step is terminated.
	`toDom(self, document, node)` `toDom` method of Model class
	`writeXML(self, ostream)` Writes the object as an XML object into an output stream.
Inherited from ParameterSet
	`__delattr__(self, name)` Removes the attribute name.
	`__iter__(self)` Creates an iterator over the parameter and their values.
	`__repr__(self)`
	`declareParameter(self, **parameters)` Declares a new parameter(s) and its (their) initial value.
	`declareParameters(self, parameters)` Declares a set of parameters.
	`fromDom(cls, doc)` (Class method)
	`releaseParameters(self, name)` Removes parameter name from the paramameters.
	`showParameters(self)` Returns a descrition of the parameters.
Inherited from LinkableObject
	`__getattr__(self, name)` Returns the value of attribute name.
	`__setattr__(self, name, value)` Sets the value for attribute name.
	`getAttributeObject(self, name)` Return the object stored for attribute name.
	`hasAttribute(self, name)` Returns True if self as attribute name.
	`trace(self, msg)` If debugging is on, print the message, otherwise do nothing
Inherited from object
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle

Class Variable Summary
Inherited from Model
`float`	`UNDEF_DT` = 1.0000000000000001e+300
Inherited from LinkableObject
`count`	`number_sequence` = `<itertools.count object at 0x401ff100>`

Instance Method Details

doInitialization(self)

Initializes the time integartion scheme

Overrides:: esys.escript.modelframe.Model.doInitialization

doStepPostprocessing(self, dt)

perform the time step using the Valet scheme

Parameters:: dt - time step size to be used
(type=float)

Overrides:: esys.escript.modelframe.Model.doStepPostprocessing

getSafeTimeStepSize(self, dt)

returns new step size

Parameters:: dt - last time step size used
(type=float)

Returns:: time step size that can savely be used
(type=float)

Overrides:: esys.escript.modelframe.Model.getSafeTimeStepSize

Generated by Epydoc 2.1 on Thu Apr 27 11:16:24 2006

http://epydoc.sf.net