Namespace for OpenFOAM version information. More...
Functions | |
bool | patched () |
unsigned | labelByteSize (const std::string &str) |
Extract label size (in bytes) from "label=" tag in string. More... | |
unsigned | scalarByteSize (const std::string &str) |
Extract scalar size (in bytes) from "scalar=" tag in string. More... | |
void | printBuildInfo (std::ostream &os, const bool full=true) |
Print information about version, build, arch to output stream. More... | |
std::string | configuredProjectDir () |
std::string | configuredEtcDir () |
Variables | |
const int | api |
const std::string | patch |
OpenFOAM patch number as a std::string. More... | |
const std::string | build |
OpenFOAM build information as a std::string. More... | |
const std::string | buildArch |
const std::string | version |
OpenFOAM version (name or stringified number) as a std::string. More... | |
Namespace for OpenFOAM version information.
Version information.
For example,
FOAM_EXTRA_CXXFLAGS='-DFOAM_CONFIGURED_PROJECT_ETC=\"/etc/openfoam\"'
The foamVersion.H file is located directly in the src/OpenFOAM/include directory for easier use by external packages and to allow easier modification during packaging.
bool patched | ( | ) |
Test if the patch string appears to be in use, which is when it is defined (non-zero).
Referenced by argList::parse(), error::write(), and IOerror::write().
unsigned labelByteSize | ( | const std::string & | str | ) |
Extract label size (in bytes) from "label=" tag in string.
Referenced by IOobject::parseHeader().
unsigned scalarByteSize | ( | const std::string & | str | ) |
Extract scalar size (in bytes) from "scalar=" tag in string.
Referenced by IOobject::parseHeader().
void printBuildInfo | ( | std::ostream & | os, |
const bool | full = true |
||
) |
Print information about version, build, arch to output stream.
Eg,
os | the output stream |
full | includes Arch information |
Referenced by argList::argList(), argList::parse(), and argList::printUsage().
std::string configuredProjectDir | ( | ) |
Compile-time definition of the OpenFOAM project directory or empty if not defined.
Functional equivalent to WM_PROJECT_DIR.
std::string configuredEtcDir | ( | ) |
Compile-time definition of the OpenFOAM etc/ directory or empty if not defined.
Functional equivalent to WM_PROJECT_DIR/etc
|
extern |
OpenFOAM api number (integer) corresponding to the value of OPENFOAM at the time of compilation.
The value is 0 if OPENFOAM was not defined.
Referenced by Foam::apiYear(), dynamicCode::checkSecurity(), argList::displayDoc(), Foam::etcDirs(), Foam::findEtcEntries(), argList::parse(), argList::printMan(), systemCall::read(), error::warnAboutAge(), error::write(), IOerror::write(), and IOobject::writeBanner().
|
extern |
OpenFOAM patch number as a std::string.
Referenced by argList::parse(), error::write(), and IOerror::write().
|
extern |
OpenFOAM build information as a std::string.
Referenced by argList::parse(), and profilingSysInfo::write().
|
extern |
OpenFOAM build architecture information (machine endian, label/scalar sizes) as a std::string
Referenced by argList::parse(), and IOobject::writeHeaderContent().
|
extern |
OpenFOAM version (name or stringified number) as a std::string.
Referenced by argList::parse(), Foam::setversion(), and profilingSysInfo::write().