Functions
std::string	getCompilationDate ()
	Return the day PLUMED was compiled. More...

std::string	getCompilationTime ()
	Return the time at which PLUMED was compiled. More...

std::string	getEnvCommand ()
	Return a string containing a sequence of environment variables. More...

std::string	getMakefile ()
	Return the content of `Makefile.conf` in a single string. More...

std::string	getPlumedHtmldir ()
	Return path to documentation. More...

std::string	getPlumedIncludedir ()
	Return path to the include directory. More...

std::string	getPlumedProgramName ()
	Return the name used for installing PLUMED. More...

std::string	getPlumedRoot ()
	Return path to the root of the PLUMED package. More...

std::string	getSoExt ()
	Return the extension of shared libraries on this system. More...

std::string	getVersion ()
	Return the short PLUMED version. More...

std::string	getVersionGit ()
	Return the git PLUMED version E.g. More...

std::string	getVersionLong ()
	Return the long PLUMED version. More...

bool	hasCregex ()

bool	hasDlopen ()

bool	hasExternalMolfile ()

bool	hasMatheval ()

bool	hasMolfile ()

bool	hasXdrfile ()

bool	hasZlib ()

bool	isInstalled ()

Function Documentation

◆ getCompilationDate()

std::string PLMD::config::getCompilationDate ( )

Return the day PLUMED was compiled.

E.g. "Apr 16 2018"

◆ getCompilationTime()

std::string PLMD::config::getCompilationTime ( )

Return the time at which PLUMED was compiled.

E.g. "13:27:58"

◆ getEnvCommand()

std::string PLMD::config::getEnvCommand ( )

Return a string containing a sequence of environment variables.

The returned string has the form:

env PLUMED_ROOT=/path env PLUMED_HTMLDIR=/path ... etc

This string is used internally in PLUMED to run scripts located in plumedroot/script. For instance, the patch script can be run executing the following command:

config::getEnvCommand()+" \""+getPlumedRoot()+"\"/scripts/patch.sh";

Notice that the getPlumedRoot() output is enclosed in escaped quotes. This allows this directory to have spaces in its name.

◆ getMakefile()

std::string PLMD::config::getMakefile ( )

Return the content of Makefile.conf in a single string.

Can be used to inspect the variables used to customize PLUMED. Notice that this reflects the content of the Makefile.conf file. Since some of the there defined variables can be overwritten at install (e.g., one can use make install prefix=/new/path to change the installation path) their values could be not faithful

◆ getPlumedHtmldir()

std::string PLMD::config::getPlumedHtmldir ( )

Return path to documentation.

User documentation is located in getPlumedHtmldir()+"/user-doc/html/index.html" Developer documentation is located in getPlumedHtmldir()+"/developer-doc/html/index.html"

◆ getPlumedIncludedir()

std::string PLMD::config::getPlumedIncludedir ( )

Return path to the include directory.

The header file for PLUMED wrapper is in getPlumedIncludedir()+getPlumedProgramName()+"/wrapper/Plumed.h"

◆ getPlumedProgramName()

std::string PLMD::config::getPlumedProgramName ( )

Return the name used for installing PLUMED.

E.g. if PLUMED has been compiled with ./configure --program-suffix _mpi it returns "plumed_mpi"

◆ getPlumedRoot()

std::string PLMD::config::getPlumedRoot ( )

Return path to the root of the PLUMED package.

◆ getSoExt()

std::string PLMD::config::getSoExt ( )

Return the extension of shared libraries on this system.

It is either "so" or "dylib". In case shared libraries are disabled, it returns an empty string.

◆ getVersion()

std::string PLMD::config::getVersion ( )

Return the short PLUMED version.

E.g. "2.2"

◆ getVersionGit()

std::string PLMD::config::getVersionGit ( )

Return the git PLUMED version E.g.

"c5badb091cd30"

◆ getVersionLong()

std::string PLMD::config::getVersionLong ( )

Return the long PLUMED version.

E.g. "2.2.3"

◆ hasCregex()

bool PLMD::config::hasCregex ( )

◆ hasDlopen()

bool PLMD::config::hasDlopen ( )

◆ hasExternalMolfile()

bool PLMD::config::hasExternalMolfile ( )

◆ hasMatheval()

bool PLMD::config::hasMatheval ( )

◆ hasMolfile()

bool PLMD::config::hasMolfile ( )

◆ hasXdrfile()

bool PLMD::config::hasXdrfile ( )

◆ hasZlib()

bool PLMD::config::hasZlib ( )

◆ isInstalled()

bool PLMD::config::isInstalled ( )

Functions