Sundance::SundanceGlobal Class Reference

List of all members.

Static Public Member Functions
static void	setOption (const std::string &optionName, int &value, const std::string &helpMsg)
static void	setOption (const std::string &optionName, std::string &value, const std::string &helpMsg)
static void	setOption (const std::string &optionName, double &value, const std::string &helpMsg)
static void	setOption (const std::string &optionTrueName, const std::string &optionFalseName, bool &value, const std::string &helpMsg)
static int	init (int *argc, char ***argv)
static int	finalize ()
static void	handleException (std::exception &e)
static Teuchos::FancyOStream &	os ()
static bool	passFailTest (bool pass)
static bool	passFailTest (double error, double tol)
static bool	passFailTest (const std::string &statusMsg, bool status, double error, double tol)
static bool &	showStartupMessage ()
static bool &	skipTimingOutput ()
static int &	testStatus ()
static CommandLineProcessor &	clp ()
static bool	checkTest (double error, double tol)

---

Detailed Description

Class Sundance provides several static methods for managing the environment of a simulation. Every simulation code should begin with a call to Sundance::init() and end with a call to Sundance::finalize().

Definition at line 227 of file Sundance.hpp.

---

Member Function Documentation

static bool Sundance::SundanceGlobal::checkTest	(	double	error,
		double	tol
	)			[static]

CommandLineProcessor & clp

(

)

[inline, static]

Definition at line 303 of file Sundance.hpp.

Referenced by Sundance::clp().

int finalize

(

)

[static]

Do finalization steps such as calling MPI_finalize() (if necessary), and collecting and printing timing information.

Referenced by Sundance::finalize().

void handleException

(

std::exception &

e

)

[static]

Referenced by Sundance::handleException().

int init	(	int *	argc,
		char ***	argv
	)			[static]

Do initialization steps such as starting MPI (if necessary), parsing the Unix command line, and reading runtime options from the configuration file. MPI is initialized through a call to Teuchos::GlobalMPISession, which in turn checks whether MPI needs initialization and calls MPI_Init() if necessary. If some other library you're using has its own MPI initialization system, it is thus perfectly safe to call Sundance::init() as well.

Referenced by Sundance::init().

static Teuchos::FancyOStream& Sundance::SundanceGlobal::os

(

)

[static]

bool passFailTest	(	const std::string &	statusMsg,
		bool	status,
		double	error,
		double	tol
	)			[static]

bool passFailTest	(	double	error,
		double	tol
	)			[static]

bool passFailTest

(

bool

pass

)

[static]

Referenced by Sundance::passFailTest().

static void Sundance::SundanceGlobal::setOption	(	const std::string &	optionTrueName,
		const std::string &	optionFalseName,
		bool &	value,
		const std::string &	helpMsg
	)			[static]

static void Sundance::SundanceGlobal::setOption	(	const std::string &	optionName,
		double &	value,
		const std::string &	helpMsg
	)			[static]

static void Sundance::SundanceGlobal::setOption	(	const std::string &	optionName,
		std::string &	value,
		const std::string &	helpMsg
	)			[static]

static void Sundance::SundanceGlobal::setOption	(	const std::string &	optionName,
		int &	value,
		const std::string &	helpMsg
	)			[static]

Referenced by Sundance::setOption().

static bool& Sundance::SundanceGlobal::showStartupMessage

(

)

[static]

Set to true if a message should be written by each processor at startup.

static bool& Sundance::SundanceGlobal::skipTimingOutput

(

)

[inline, static]

Decide whether to skip timing outputs to work around a trilinos 6.0.x bug

Definition at line 295 of file Sundance.hpp.

int & testStatus

(

)

[inline, static]

Definition at line 299 of file Sundance.hpp.

Referenced by Sundance::testStatus().