Package PyFoam :: Package Execution :: Module ConvergenceRunner :: Class ConvergenceRunner
[hide private]
[frames] | no frames]

Class ConvergenceRunner

source code

                       object --+            
                                |            
    AnalyzedCommon.AnalyzedCommon --+        
                                    |        
StepAnalyzedCommon.StepAnalyzedCommon --+    
                                        |    
                           object --+   |    
                                    |   |    
              BasicRunner.BasicRunner --+    
                                        |    
            AnalyzedRunner.AnalyzedRunner --+
                                            |
                                           ConvergenceRunner

It is assumed that the provided solver is a steady state solver. After all the linear solvers have initial residuals below their limits the run is assumed to be convergent and the run is stopped by setting

stopAt nextWrite; writeInterval 1;

in the controlDict

Instance Methods [hide private]
 
__init__(self, analyzer, argv=None, silent=False, logname="PyFoamSolve", server=False, lam=None, restart=False, compressLog=False, noLog=False, remark=None, jobId=None)
See AnalyzedRunner
source code
 
lineHandle(self, line)
Not to be called: Stops the solver
source code

Inherited from AnalyzedRunner.AnalyzedRunner: firstClockTime, firstCpuTime, lastTime, stopHandle, totalClockTime, totalCpuTime

Inherited from StepAnalyzedCommon.StepAnalyzedCommon: timeChanged, timeHandle

Inherited from AnalyzedCommon.AnalyzedCommon: addAnalyzer, addTrigger, createPlots, getAnalyzer, getDirname, getTime, hasAnalyzer, listAnalyzers, picklePlots, reset, tearDown

Inherited from BasicRunner.BasicRunner: addEndTrigger, getSolutionDirectory, logName, runOK, start, startHandle, stopGracefully, writeResults

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, analyzer, argv=None, silent=False, logname="PyFoamSolve", server=False, lam=None, restart=False, compressLog=False, noLog=False, remark=None, jobId=None)
(Constructor)

source code 

See AnalyzedRunner

Parameters:
  • analyzer - the analyzer for the output argv, silent, logname, server, lam, noLog - see BasicRunner
Overrides: object.__init__

lineHandle(self, line)

source code 

Not to be called: Stops the solver

Overrides: BasicRunner.BasicRunner.lineHandle