Package PyFoam :: Package Infrastructure :: Module ClusterJob :: Class SolverJob
[hide private]
[frames] | no frames]

Class SolverJob

source code

ClusterJob --+
             |
            SolverJob

A Cluster-Job that executes a solver. It implements the run-function. If a template-case is specified, the case is copied

Instance Methods [hide private]
 
__init__(self, basename, solver, template=None, cloneParameters=[], arrayJob=False, hardRestart=False, autoParallel=True, doAutoReconstruct=True, foamVersion=None, useFoamMPI=False, steady=False, multiRegion=False, progress=False, solverProgress=False, solverNoLog=False)
Initializes the Job
source code
 
run(self, parameters)
Run the actual job.
source code

Inherited from ClusterJob: additionalReconstruct, autoDecompose, autoReconstruct, casedir, casename, checkpointFile, cleanup, doIt, foamRun, fullJobId, jobFile, message, postDecomposeSetup, preReconstructCleanup, setState, setup, stopFile, stopJob, taskParameters, writeCheckpoint

Method Details [hide private]

__init__(self, basename, solver, template=None, cloneParameters=[], arrayJob=False, hardRestart=False, autoParallel=True, doAutoReconstruct=True, foamVersion=None, useFoamMPI=False, steady=False, multiRegion=False, progress=False, solverProgress=False, solverNoLog=False)
(Constructor)

source code 

Initializes the Job

Parameters:
  • template - Name of the template-case. It is assumed that it resides in the same directory as the actual case
  • cloneParameters - a list with additional parameters for the CloneCase-object that copies the template
  • solverProgress - Only writes the current time of the solver
Overrides: ClusterJob.__init__

run(self, parameters)

source code 

Run the actual job. Usually the solver.

Parameters:
  • parameters - a dictionary with parameters
Overrides: ClusterJob.run
(inherited documentation)