Package solvcon :: Package kerpak :: Module cuse :: Class CflHook

[frames] | no frames]

Class CflHook

object --+    
         |    
 hook.Hook --+
             |
            CflHook

Makes sure CFL number is bounded and print averaged CFL number over time. Reports CFL information per time step and on finishing. Implements (i) postmarch() and (ii) postloop() methods.

Instance Methods

__init__(self, cse, **kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

drop_anchor(self, svr)
Drop the anchor(s) to the solver object.

source code

_notify(self, msg)

source code

postmarch(self)
Things to do after the time march for a specific time step.

source code

postloop(self)
Things to do after the time-marching loop.

source code

Inherited from hook.Hook: preloop, premarch

Inherited from hook.Hook (private): _depend, _makedir

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods

Inherited from hook.Hook (private): _deliver_anchor

Instance Variables

aCFL
accumulated CFL.

aadj
number of adjusted CFL accumulated since last report.

cflmax
CFL number should be less than the value.

cflmin
CFL number should be greater than or equal to the value.

fullstop
flag to stop when CFL is out of bound.

haadj
total number of adjusted CFL since simulation started.

hnCFL
hereditary minimal CFL.

hxCFL
hereditary maximal CFL.

mCFL
mean CFL.

name
name of the CFL tool.

rsteps
steps to run.

Inherited from hook.Hook: cse, info, kws, psteps

Properties

Inherited from object: __class__

Method Details

init(self, cse, **kw)
(Constructor)

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:

cse - Case object.

Overrides: object.__init__

(inherited documentation)

drop_anchor(self, svr)

Drop the anchor(s) to the solver object.

Parameters:

svr - the solver object on which the anchor(s) is dropped.

Returns:

nothing

Overrides: hook.Hook.drop_anchor

(inherited documentation)

postmarch(self)

Things to do after the time march for a specific time step.

Overrides: hook.Hook.postmarch: (inherited documentation)

postloop(self)

Things to do after the time-marching loop.

Overrides: hook.Hook.postloop: (inherited documentation)

Instance Variable Details

fullstop

flag to stop when CFL is out of bound. Default True.