Package PyFoam :: Module FoamInformation
[show private | hide private]
[frames | no frames]

Module PyFoam.FoamInformation

Getting Information about the Foam-Installation (like the installation directory)
Function Summary
  foamMPI()
@return the used MPI-Implementation
  foamTutorials()
Return directory in which the tutorials reside
  foamVersion()
Return tuple that represents the Foam-version as found in $WM_PROJECT_VERSION
  foamVersionNumber()
Return tuple that represents the Foam-Version-Number (without strings
string getPathFromEnviron(name)
Gets a path from an environment variable

Imported modules:
posixpath (as path)
Imported variables:
environ
Function Details

foamMPI()

@return the used MPI-Implementation

foamTutorials()

Returns:
directory in which the tutorials reside

foamVersion()

Returns:
tuple that represents the Foam-version as found in $WM_PROJECT_VERSION

foamVersionNumber()

Returns:
tuple that represents the Foam-Version-Number (without strings

getPathFromEnviron(name)

Gets a path from an environment variable
Parameters:
name - the name of the environment variable
Returns:
the path
           (type=string)

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