esys.modellib.visualization.Visualization

Package esys :: Package modellib :: Module visualization :: Class Visualization

[show private | hide private]

Type Visualization

    object --+            
             |            
LinkableObject --+        
                 |        
      ParameterSet --+    
                     |    
                 Model --+
                         |
                        Visualization

Known Subclasses:: ArrowPlot, EllipsoidPlot, ShadePlot, WriteVTK

Generic visualization of scalar, vector and tensorial data (not implemeted yet)

Method Summary
	`__init__(self, debug)` Initialisation of the visualisation model object
	`doFinalization(self)` Finalises the visualisation.
	`doInitialization(self)` Does some kind of initialisation
	`doStepPostprocessing(self, dt)` renders the scene
	`getFrameCounter(self)`
`float`	`getSafeTimeStepSize(self, dt)` returns new step size
	`writeFrame(self)`
Inherited from Model
	`__str__(self)`
	`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

Instance Variable Summary
	`dt`: increment for output
	`filename`: name of the output file
	`n`: frame counter
	`scalar`: scalar data set
	`t`: current time
	`tensor`: tensor data set
	`vector`: vector data set

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

init(self, debug=False)
(Constructor)

Initialisation of the visualisation model object

Parameters:: debug - Debugging flag

Overrides:: esys.escript.modelframe.Model.__init__

doFinalization(self)

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

Overrides:: esys.escript.modelframe.Model.doFinalization

Note: to be overwritten

doInitialization(self)

Does some kind of initialisation

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

doStepPostprocessing(self, dt)

renders the scene

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

Note: to be overwritten

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

Instance Variable Details

dt

increment for output

filename

name of the output file

n

frame counter

scalar

scalar data set

t

current time

tensor

tensor data set

vector

vector data set

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

http://epydoc.sf.net