esys.modellib.probe.Probe

Package esys :: Package modellib :: Module probe :: Class Probe

[show private | hide private]

Type Probe

    object --+            
             |            
LinkableObject --+        
                 |        
      ParameterSet --+    
                     |    
                 Model --+
                         |
                        Probe

Tests values against a expression which may depend on time and spatial coordinates.

It prints out the relative error in each time step and the maximum relative error over all time steps at the end.

Warning: this class use python's eval function!!!!!

Method Summary
	`__init__(self, debug)` Set up parameters
	`doFinalization(self)` Print out the maximum error.
	`doInitialization(self)` Initializes values
	`doStepPostprocessing(self, dt)` Finalalizes the time step.
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.
	`getSafeTimeStepSize(self, dt)` Returns a time step size which can safely be used.
	`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
	`expression (in)`: expressions defining expression values to test against.
	`line_tag (in)`: tag to be used when printing error
	`max_error (out)`: maximum error
	`t (in)`: current time
	`t_max (out)`: time of maximum error
	`value (in)`: values to be tested

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)

Set up parameters

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

doFinalization(self)

Print out the maximum error.

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

doInitialization(self)

Initializes values

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

doStepPostprocessing(self, dt)

Finalalizes the time step.

dt is the currently used time step size.

This function may be overwritten.

Overrides:: esys.escript.modelframe.Model.doStepPostprocessing (inherited documentation)

Instance Variable Details

expression (in)

expressions defining expression values to test against. If None only value is reported.

line_tag (in)

tag to be used when printing error

max_error (out)

maximum error

t (in)

current time

t_max (out)

time of maximum error

value (in)

values to be tested

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

http://epydoc.sf.net