Package esys :: Package modellib :: Module input :: Class Sequencer
[hide private]
[frames] | no frames]

Class Sequencer

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

Runs through time until t_end is reached.

Instance Methods [hide private]
 
__init__(self, **kwargs)
Creates a model.
 
doInitialization(self)
initialize time integration
 
doStepPostprocessing(self, dt)
Finalises the time step.
 
doStepPreprocessing(self, dt)
Sets up a time step of step size dt.
 
finalize(self)
returns true when t has reached t_end
 
getSafeTimeStepSize(self, dt)
returns dt_max

Inherited from escript.modelframe.Model: __str__, doFinalization, doInitialPostprocessing, doInitialStep, doStep, 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]
float dt_max
maximum time step size, default Model.UNDEF_DT (in)
float t
current time stamp (in/out).
float t_end
model is terminated when t_end is passed, default 1 (in).
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__

doInitialization(self)

 

initialize time integration

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)

doStepPreprocessing(self, dt)

 

Sets up a time step of step size dt.

This function may be overwritten.

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

finalize(self)

 

returns true when t has reached t_end

Overrides: escript.modelframe.Model.finalize

getSafeTimeStepSize(self, dt)

 

returns dt_max

Overrides: escript.modelframe.Model.getSafeTimeStepSize

Instance Variable Details [hide private]

t

current time stamp (in/out). By default it is initialized with zero.
Type:
float