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

Class ParameterFile

Utilities --+        
            |        
    FileBasis --+    
                |    
  FileBasisBackup --+
                    |
                   ParameterFile


Represents a OpenFOAM parameter file
Method Summary
  __init__(self, name, backup)
  parameterPattern(self, parameter)
creates a regular expression that looks for aparameter
  readParameter(self, parameter)
reads the value of a parameter
  replaceParameter(self, parameter, newval)
writes the value of a parameter
    Inherited from FileBasisBackup
  restore(self)
if a backup-copy was made the file is restored from this
    Inherited from FileBasis
  closeFile(self)
closes the file
  copyRest(self, l, out)
Copy the rest of the file
  goMatch(self, l, exp, out, stop)
Read lines until a regular expression is matched
  goTo(self, l, s, out, echoLast, stop)
Read lines until a token is found
  makeString(self)
Build a string from self.content, to be overriden by sub-classes
  makeTemp(self)
creates a temporary file
  openFile(self, keepContent, mode)
opens the file.
  parse(self, cnt)
Parse a string that is to be the content, to be overriden by the sub-classes
  purgeFile(self)
Undo all the manipulations done by PyFOAM
  readFile(self)
read the whole File into memory
  writeFile(self)
write the whole File from memory
    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
    Inherited from FileBasis
str addedString = '//PyFoamAdded'
str removedString = '//PyFoamRemoved: '
    Inherited from Utilities
list excludeNames = ['^.svn$', '~$']

Method Details

__init__(self, name, backup=False)
(Constructor)

Parameters:
name - The name of the parameter file
backup - create a backup-copy of the file
Overrides:
PyFoam.RunDictionary.FileBasis.FileBasisBackup.__init__

parameterPattern(self, parameter)

creates a regular expression that looks for aparameter

parameter - name of the parameter

readParameter(self, parameter)

reads the value of a parameter

parameter - name of the parameter

replaceParameter(self, parameter, newval)

writes the value of a parameter
Parameters:
parameter - name of the parameter
newval - the new value
Returns:
old value of the parameter

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