PyFoam.FoamInformation module

Getting Information about the Foam-Installation (like the installation directory)

class PyFoam.FoamInformation.VersionTuple(iterable=(), /)

Bases: tuple

Wrapper around the regular tuple that is printed in a way that can be parsed as a tuple in a OF-dictionary

__dict__ = mappingproxy({'__module__': 'PyFoam.FoamInformation', '__doc__': 'Wrapper around the regular tuple that is printed in a way that\n    can be parsed as a tuple in a OF-dictionary\n\n    ', '__str__': <function VersionTuple.__str__>, '__dict__': <attribute '__dict__' of 'VersionTuple' objects>, '__annotations__': {}})

__module__ = 'PyFoam.FoamInformation'

__str__()

Return str(self).

PyFoam.FoamInformation.changeFoamVersion(new, force64=False, force32=False, compileOption=None, foamCompiler=None, wmCompiler=None)

Changes the used FoamVersion. Only valid during the runtime of the interpreter (the script or the Python session) :param new: The new Version :param force64: Forces the 64-bit-version to be chosen :param force32: Forces the 32-bit-version to be chosen :param compileOption: Forces Debug or Opt :param wmCompiler: Force new value for WM_COMPILER :param foamCompiler: Force system or OpenFOAM-Compiler

PyFoam.FoamInformation.ensureDynamicLibraries()

Ensure that the dynamic library path is set for systems where it was erased for security rasons (for instance Mac OS X 10.11)

PyFoam.FoamInformation.findInstallationDir(newVersion)

PyFoam.FoamInformation.findInstalledVersions(basedir, valid, forkName='openfoam')

PyFoam.FoamInformation.findThirdPartyDir(newVersion)

PyFoam.FoamInformation.foamCaseDicts()

Returns:

the caseDicts-directory of the distro

PyFoam.FoamInformation.foamEtc()

Returns:

the etc-directory of the distro

PyFoam.FoamInformation.foamFork()

The currently used fork of OpenFOAM/Foam

PyFoam.FoamInformation.foamInstalledVersions()

Returns:

A list with the installed versions of OpenFOAM

PyFoam.FoamInformation.foamMPI()

Returns:

the used MPI-Implementation

PyFoam.FoamInformation.foamPostProcessing()

Returns:

the caseDicts/postProcessing-directory of the distro

PyFoam.FoamInformation.foamTutorials()

Returns:

directory in which the tutorials reside

PyFoam.FoamInformation.foamVersion(useConfigurationIfNoInstallation=False)

Returns:

tuple that represents the Foam-version as found

in $WM_PROJECT_VERSION

PyFoam.FoamInformation.foamVersionNumber(useConfigurationIfNoInstallation=False)

Returns:

tuple that represents the Foam-Version-Number (without

strings

PyFoam.FoamInformation.foamVersionString(useConfigurationIfNoInstallation=False)

Returns:

string for the Foam-version as found

in $WM_PROJECT_VERSION

PyFoam.FoamInformation.getAuthenticatedKeys()

PyFoam.FoamInformation.getPathFromEnviron(name)

Gets a path from an environment variable :return: the path :rtype: string :param name: the name of the environment variable

PyFoam.FoamInformation.getPublicKey()

PyFoam.FoamInformation.getUserName()

Get the current username

PyFoam.FoamInformation.getUserTempDir()

Return path to a user-specific private directory. Create directory if not existing

PyFoam.FoamInformation.injectVariables(script, forceArchOption=None, compileOption=None, foamCompiler=None, wmCompiler=None)

Executes a script in a subshell and changes the current environment with the enivironment after the execution :param script: the script that is executed :param forceArchOption: To which architecture Option should be forced :param compileOption: to which value the WM_COMPILE_OPTION should be forced :param wmCompiler: Force new value for WM_COMPILER :param foamCompiler: Force system or OpenFOAM-Compiler

PyFoam.FoamInformation.installationPath()

Path to the installation

PyFoam.FoamInformation.oldAppConvention()

Returns true if the version of OpenFOAM is older than 1.5 and it therefor uses the ‘old’ convention to call utilities (“dot, case”)

PyFoam.FoamInformation.oldTutorialStructure()

Returns true if the version of OpenFOAM is older than 1.6 and it therefor uses the ‘old’ (flat) structure for the tutorials

PyFoam.FoamInformation.shellExecutionPrefix(ensureDynamic=True, asList=False)

Stuff to prefix to a call that is passed to the shell. Main application is currently to work around a security feature of Mac OS X 10.11 that doesn’t pass the load paths for the dynamic libraries to a shell