foamVersion.H File Reference
Include dependency graph for foamVersion.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 Foam::foamVersion
 Namespace for OpenFOAM version information.
 
 Foam
 Namespace for OpenFOAM.
 

Macros

#define FOAM_RESOURCE_USER_CONFIG_DIRNAME   ".OpenFOAM"
 The directory name for user-resources within the HOME directory. More...
 
#define FOAM_RESOURCE_SITE_ENVNAME   "WM_PROJECT_SITE"
 The env name for site-resources to obtain a site-resources directory. More...
 
#define FOAM_RESOURCE_SITE_FALLBACK_ENVNAME   "WM_PROJECT_DIR"
 
#define FOAMversion   foamVersion::version.c_str()
 
#define FOAMbuild   foamVersion::build.c_str()
 
#define FOAMbuildArch   foamVersion::buildArch
 

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...
 

Detailed Description

Original source file foamVersion.H

Definition in file foamVersion.H.

Macro Definition Documentation

◆ FOAM_RESOURCE_USER_CONFIG_DIRNAME

#define FOAM_RESOURCE_USER_CONFIG_DIRNAME   ".OpenFOAM"

The directory name for user-resources within the HOME directory.

Default: ".OpenFOAM" Used by foamEtcFiles(), stringOps::expand(), Foam::JobInfo

Definition at line 64 of file foamVersion.H.

◆ FOAM_RESOURCE_SITE_ENVNAME

#define FOAM_RESOURCE_SITE_ENVNAME   "WM_PROJECT_SITE"

The env name for site-resources to obtain a site-resources directory.

Default: "WM_PROJECT_SITE" Used by foamEtcFiles() and stringOps::expand()

Definition at line 70 of file foamVersion.H.

◆ FOAM_RESOURCE_SITE_FALLBACK_ENVNAME

#define FOAM_RESOURCE_SITE_FALLBACK_ENVNAME   "WM_PROJECT_DIR"

The env name for determining a fallback directory name for site-resources when the directory corresponding to FOAM_RESOURCE_SITE_ENVNAME is empty.

The fallback search appends "/site" to the directory.

Default: "WM_PROJECT_DIR" Used by foamEtcFiles() and stringOps::expand()

Definition at line 78 of file foamVersion.H.

◆ FOAMversion

#define FOAMversion   foamVersion::version.c_str()

Definition at line 152 of file foamVersion.H.

◆ FOAMbuild

#define FOAMbuild   foamVersion::build.c_str()

Definition at line 153 of file foamVersion.H.

◆ FOAMbuildArch

#define FOAMbuildArch   foamVersion::buildArch

Definition at line 154 of file foamVersion.H.