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

Class SolutionDirectory

Utilities --+
            |
           SolutionDirectory


Represents a solution directory

In the solution directory subdirectories whose names are numbers are assumed to be solutions for a specific time-step

A sub-directory (called the Archive) is created to which solution data is copied
Method Summary
  __init__(self, name, archive)
name - Name of the solution directory archive - name of the directory where the lastToArchive-method should copy files
  addBackup(self, pth)
add file to list of files that are to be copied to the archive
  clearResults(self)
remove all time-directories except for the first (initial condition)
  getLast(self)
return the last time for which a solution exists
  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)
  makeFile(self, name)
create a file in the solution directory and return a corresponding BasicFile-object
  reread(self)
Rescan the directory for the time directories
    Inherited from Utilities
  execute(self, cmd)
Execute the command cmd

Method Details

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

name - Name of the solution directory archive - name of the directory where the lastToArchive-method should copy files
Overrides:
PyFoam.Basics.Utilities.Utilities.__init__

addBackup(self, pth)

add file to list of files that are to be copied to the archive

clearResults(self)

remove all time-directories except for the first (initial condition)

getLast(self)

return the last time for which a solution exists

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)

name - name of the sub-directory in the archive

makeFile(self, name)

create a file in the solution directory and return a corresponding BasicFile-object

name - Name of the file

reread(self)

Rescan the directory for the time directories

Generated by Epydoc 2.1 on Mon Aug 15 20:51:53 2005 http://epydoc.sf.net