Home | Trees | Indices | Help |
---|
|
All Cluster-jobs are to be derived from this base-class
The actual jobs are implemented by overriding methods
There is a number of variables in this class that are used to 'communicate' information between the various stages
|
|||
|
__init__(self,
basename,
arrayJob=False,
hardRestart=False,
autoParallel=True,
foamVersion=None,
multiRegion=False) Initializes the Job |
||
| message(self, *txt) | ||
| setState(self, txt) | ||
|
jobFile(self) The file with the job information |
||
|
checkpointFile(self) The file that makes the job write a checkpoint |
||
|
stopFile(self) The file that makes the job write a checkpoint and end |
||
|
doIt(self) The central logic. |
||
|
casedir(self) Returns the actual directory of the case To be overridden if appropriate |
||
|
casename(self) Returns just the name of the case |
||
|
foamRun(self,
application,
args=[],
foamArgs=[],
steady=False,
multiRegion=None) Runs a foam utility on the case. |
||
|
autoDecompose(self) Automatically decomposes the grid with a metis-algorithm |
||
|
autoReconstruct(self) Default reconstruction of a parallel run |
||
|
setup(self,
parameters) Set up the job. |
||
|
postDecomposeSetup(self,
parameters) Additional setup, to be executed when the grid is already decomposed |
||
|
run(self,
parameters) Run the actual job. |
||
|
preReconstructCleanup(self,
parameters) Additional cleanup, to be executed when the grid is still decomposed |
||
|
cleanup(self,
parameters) Clean up after a job |
||
|
taskParameters(self,
id) Parameters for a specific task |
||
| writeCheckpoint(self) | ||
| stopJob(self) |
|
|
|
|
|
|
|
|
|
|
|
|
|
Set up the job. Called in the beginning if the job has not been restarted Usual tasks include grid conversion/setup, mesh decomposition etc
|
Additional setup, to be executed when the grid is already decomposed Usually for tasks that can be done on a decomposed grid
|
|
Additional cleanup, to be executed when the grid is still decomposed Usually for tasks that can be done on a decomposed grid
|
|
|
|
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0alpha3 on Fri Nov 23 23:44:28 2007 | http://epydoc.sourceforge.net |