Package PyFoam :: Package Infrastructure :: Module Hardcoded
[hide private]
[frames] | no frames]

Module Hardcoded

source code

Hardcoded values

Functions [hide private]
 
assertDirectory(name)
Makes sure that the directory exists
source code
 
globalConfigDir()
Returns: The name of the global configuration directory where .cfg-files can be placed
source code
 
globalConfigFile()
Returns: The name of the global configuration File
source code
 
globalDirectory()
Returns: the global directory
source code
 
logDirectory()
Path to the log directory that this user may write to.
source code
 
siteConfigDir()
Returns: The name of the site configuration directory where .cfg-files can be placed
source code
 
siteConfigFile()
Returns: The name of the site configuration File
source code
 
siteDirectory()
Returns: the site directory
source code
 
userConfigDir()
Returns: The name of the user configuration directory where .cfg-files can be placed
source code
 
userConfigFile()
Returns: The name of the user configuration File
source code
 
userDirectory()
Returns: the user directory
source code
 
userName()
Returns: name of the current user
source code
Variables [hide private]
  PY3 = False
  __package__ = 'PyFoam.Infrastructure'
  _pyFoamConfigName = 'pyfoamrc'
  _pyFoamDirName = 'pyFoam'
  environ = {'M4_SYSTEM': '1', 'CMAKE_SYSTEM': '1', 'WM_NCOMPPRO...
  pyFoamSiteVar = 'PYFOAM_SITE_DIR'

Imports: makedirs, path


Function Details [hide private]

assertDirectory(name)

source code 

Makes sure that the directory exists

Parameters:
  • name - the directory

globalConfigDir()

source code 
Returns:
The name of the global configuration directory where .cfg-files can be placed

globalConfigFile()

source code 
Returns:
The name of the global configuration File

globalDirectory()

source code 
Returns:
the global directory

logDirectory()

source code 

Path to the log directory that this user may write to. /var/log/pyFoam for root, ~/.pyFoam/log for all others

Returns:
path to the log directory.

siteConfigDir()

source code 
Returns:
The name of the site configuration directory where .cfg-files can be placed

siteConfigFile()

source code 
Returns:
The name of the site configuration File

siteDirectory()

source code 
Returns:
the site directory

userConfigDir()

source code 
Returns:
The name of the user configuration directory where .cfg-files can be placed

userConfigFile()

source code 
Returns:
The name of the user configuration File

userDirectory()

source code 
Returns:
the user directory

userName()

source code 
Returns:
name of the current user

Variables Details [hide private]

environ

Value:
{'M4_SYSTEM': '1', 'CMAKE_SYSTEM': '1', 'WM_NCOMPPROCS': '1', 'WM_MPLI\
B': 'MACPORTOPENMPI', 'METIS_SYSTEM': '1', 'LESS': '-R', 'WM_CXXFLAGS'\
: '-m64 -fPIC', 'WM_COMPILER_ARCH': '', 'HWLOC_SYSTEM': '1', 'DBUS_LAU\
NCHD_SESSION_BUS_SOCKET': '/tmp/launch-YT2LFL/unix_domain_listener', '\
FOAM_LIB': '/Users/bgschaid/foam/foam-extend-3.1/lib', 'SHELL': '/bin/\
zsh', 'WM_ARCH_BASE': 'darwin', 'SECURITYSESSIONID': '186a4', 'WM_OPTI\
ONS': 'darwinIntel64Gcc48DPDebug', 'FLEX_SYSTEM': '1', 'PARMETIS_DIR':\
 '/opt/local', 'FOAM_MPI_LIBBIN': '/Users/bgschaid/foam/foam-extend-3.\
...