Package PyFoam :: Package RunDictionary :: Module SolutionDirectory :: Class ChemkinSolutionDirectory
[show private | hide private]
[frames | no frames]

Class ChemkinSolutionDirectory

    Utilities --+    
                |    
SolutionDirectory --+
                    |
                   ChemkinSolutionDirectory


Solution directory with a directory for the Chemkin-files
Method Summary
  __init__(self, name, archive)
str chemkinDir(self)
Return the directory with the Chemkin-Files
    Inherited from SolutionDirectory
  addBackup(self, pth)
add file to list of files that are to be copied to the archive
  addToClone(self, name)
add directory to the list that is needed to clone this case
str blockMesh(self)
Return the name of the blockMeshDict if it exists.
  clearResults(self, after)
remove all time-directories after a certain time.
SolutionDirectory or correct subclass cloneCase(self, name)
create a clone of this case directory.
str constantDir(self)
Return the name of the constant-directory
str controlDict(self)
Return the name of the controlDict
str getLast(self)
Return the last time for which a solution exists
  getTimes(self)
Return list of all the available times
str initialDir(self)
Return the name of the first time-directory (==initial conditions
  lastToArchive(self, name)
copy the last solution (plus the backup-files to the archive)
str latestDir(self)
Return the name of the first last-directory (==simulation results)
BasicFile makeFile(self, name)
create a file in the solution directory and return a corresponding BasicFile-object
str polyMeshDir(self)
Return the name of the polyMesh
  reread(self)
Rescan the directory for the time directories
  sorttimes(self, x, y)
Sort function for the solution files
str systemDir(self)
Return the name of the system-directory
    Inherited from Utilities
  execute(self, cmd, debug)
Execute the command cmd
  listDirectory(self, d)
Lists the files in a directory, but excludes certain names and files with certain endings
  writeDictionaryHeader(self, f)
Writes a dummy header so OpenFOAM accepts the file as a dictionary

Class Variable Summary
str chemkinName = 'chemkin'
    Inherited from Utilities
list excludeNames = ['^.svn$', '~$']

Method Details

__init__(self, name, archive='ArchiveDir')
(Constructor)

Parameters:
name - Name of the solution directory
archive - name of the directory where the lastToArchive-method should copy files, if None no archive is created
Overrides:
PyFoam.RunDictionary.SolutionDirectory.SolutionDirectory.__init__ (inherited documentation)

chemkinDir(self)

Returns:
The directory with the Chemkin-Files
           (type=str)

Class Variable Details

chemkinName

Type:
str
Value:
'chemkin'                                                              

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net