ExecutableSupport Class Reference

#include <ExecutableSupport.hpp>

Collaboration diagram for ExecutableSupport:

Static Public Member Functions
static void	InitializePetsc (int pArgc, char **pArgv)
static void	ShowCopyright ()
static void	ShowParallelLaunching ()
static void	SetOutputDirectory (const std::string &rOutputDirectory)
static void	WriteMachineInfoFile (std::string fileBaseName)
static void	WriteProvenanceInfoFile ()
static void	GetBuildInfo (std::string &rInfo)
static void	StandardStartup (int pArgc, char **pArgv)
static void	PrintError (const std::string &rMessage, bool masterOnly=false)
static void	Print (const std::string &rMessage)
static void	FinalizePetsc ()
Static Public Attributes
static const int	EXIT_OK = 0
static const int	EXIT_ERROR = 1
static const int	EXIT_BAD_ARGUMENTS = 2
Static Private Attributes
static FileFinder	mOutputDirectory

Detailed Description

Various helpful static methods for people writing their own executables within the Chaste framework.

Most executables will just need to call StandardStartup as the first thing in their main() function, and FinalizePetsc before quitting. The other methods allow you to fine-tune what output is presented to users.

Definition at line 51 of file ExecutableSupport.hpp.

Member Function Documentation

void ExecutableSupport::FinalizePetsc ( ) [static]

Shut down PETSc so we exit cleanly.

Definition at line 442 of file ExecutableSupport.cpp.

References PetscSetupUtils::CommonFinalize().

void ExecutableSupport::GetBuildInfo ( std::string & rInfo ) [static]

Get information about library and compiler versions in XML-like format.

Parameters:

rInfo

a string to populate with library info.

Definition at line 334 of file ExecutableSupport.cpp.

References ChasteBuildInfo::GetBuilderUnameInfo(), ChasteBuildInfo::GetBuildInformation(), ChasteBuildInfo::GetBuildTime(), ChasteBuildInfo::GetCompilerFlags(), ChasteBuildInfo::GetCompilerType(), ChasteBuildInfo::GetCompilerVersion(), ChasteBuildInfo::GetVersionString(), ChasteBuildInfo::GetXsdVersion(), ChasteBuildInfo::IsWorkingCopyModified(), and ChasteBuildInfo::rGetProjectVersions().

Referenced by AbstractCellBasedSimulation< ELEMENT_DIM, SPACE_DIM >::OutputSimulationSetup(), and WriteProvenanceInfoFile().

void ExecutableSupport::InitializePetsc	(	int *	pArgc,
		char ***	pArgv
	)			`[static]`

Initialise PETSc from the command line arguments.

Parameters:

	pArgc	pointer to the number of arguments
	pArgv	pointer to the argument list

Definition at line 100 of file ExecutableSupport.cpp.

References RelativeTo::ChasteTestOutput, CommandLineArguments::Instance(), FileFinder::IsPathSet(), mOutputDirectory, CommandLineArguments::p_argc, CommandLineArguments::p_argv, and FileFinder::SetPath().

Referenced by StandardStartup().

void ExecutableSupport::Print ( const std::string & rMessage ) [static]

Display an informative message to the user, on stdout. Message is only displayed by master process

Parameters:

rMessage

the message to display

Definition at line 433 of file ExecutableSupport.cpp.

References PetscTools::AmMaster().

void ExecutableSupport::PrintError	(	const std::string &	rMessage,
		bool	masterOnly = `false`
	)			`[static]`

Display an error message to the user, on stderr.

Parameters:

	rMessage	the message to display
	masterOnly	whether only the master process should display the error

Definition at line 411 of file ExecutableSupport.cpp.

References PetscTools::AmMaster(), RelativeTo::ChasteTestOutput, PetscTools::GetMyRank(), FileFinder::IsPathSet(), mOutputDirectory, OutputFileHandler::OpenOutputFile(), and FileFinder::SetPath().

void ExecutableSupport::SetOutputDirectory ( const std::string & rOutputDirectory ) [static]

Set the directory to which the files created by WriteMachineInfoFile, and WriteProvenanceInfoFile will be written. By default they will write to the CHASTE_TEST_OUTPUT folder.

Parameters:

rOutputDirectory

the directory to write to

Definition at line 88 of file ExecutableSupport.cpp.

References RelativeTo::Absolute, RelativeTo::ChasteTestOutput, FileFinder::IsAbsolutePath(), mOutputDirectory, and FileFinder::SetPath().

Referenced by CardiacSimulation::CardiacSimulation().

void ExecutableSupport::ShowCopyright ( ) [static]

Display Chaste's copyright information.

Definition at line 117 of file ExecutableSupport.cpp.

References PetscTools::AmMaster(), ChasteBuildInfo::GetBuilderUnameInfo(), ChasteBuildInfo::GetBuildInformation(), ChasteBuildInfo::GetBuildTime(), ChasteBuildInfo::GetLicenceText(), and ChasteBuildInfo::GetRevisionNumber().

Referenced by StandardStartup().

void ExecutableSupport::ShowParallelLaunching ( ) [static]