Package esys :: Package modellib :: Module probe :: Class Probe
[hide private]
[frames] | no frames]

Class Probe

                       object --+            
                                |            
escript.modelframe.LinkableObject --+        
                                    |        
      escript.modelframe.ParameterSet --+    
                                        |    
                 escript.modelframe.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 uses python's eval function!!!!!

Instance Methods [hide private]
 
__init__(self, **kwargs)
Set up parameters
 
doFinalization(self)
Print out the maximum error.
 
doInitialization(self)
Initializes values
 
doStepPostprocessing(self, dt)
Finalises the time step.

Inherited from escript.modelframe.Model: __str__, doInitialPostprocessing, doInitialStep, doStep, doStepPreprocessing, finalize, getSafeTimeStepSize, 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

Instance Variables [hide private]
  expression
expressions defining expression values to test against.
  line_tag
tag to be used when printing error.
  max_error
maximum error (out)
  t
current time (in)
  t_max
time of maximum error (out)
  value
values to be tested (in)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kwargs)
(Constructor)

 

Set up parameters

Overrides: object.__init__

doFinalization(self)

 

Print out the maximum error.

Overrides: escript.modelframe.Model.doFinalization

doInitialization(self)

 

Initializes values

Overrides: escript.modelframe.Model.doInitialization

doStepPostprocessing(self, dt)

 

Finalises the time step.

dt is the currently used time step size.

This function may be overwritten.

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

Instance Variable Details [hide private]

expression

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

line_tag

tag to be used when printing error. (in)